Bug 1155876 - Update units for RAM and other requirements
Summary: Update units for RAM and other requirements
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite 5
Classification: Red Hat
Component: Docs Proxy Installation Guide
Version: 570
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
Assignee: Dan Macpherson
QA Contact: Grant Gainey
URL:
Whiteboard:
Depends On:
Blocks: sat-docs
TreeView+ depends on / blocked
 
Reported: 2014-10-23 04:45 UTC by David O'Brien
Modified: 2015-09-16 02:21 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Build Name: 22563, Proxy Installation Guide-5.7-1 Build Date: 10-10-2014 12:12:55 Topic ID: 27958-592730 [Latest]
Last Closed: 2015-09-16 02:21:13 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description David O'Brien 2014-10-23 04:45:41 UTC
Title: Hardware Requirements

Describe the issue:

Section uses inconsistent and incorrect units:

2G of memory required; 4G of memory recommended
At least 5 GB storage for base install of Red Hat Enterprise Linux
6 GB storage per distribution/channel 

Suggestions for improvement:

Follow style guide.

Additional information:

Comment 1 David O'Brien 2014-10-24 07:59:33 UTC
To git.lab.tlv.redhat.com:satellite5-docs/proxy-installation-guide.git
   1672faa..8424d78  master -> master

https://url.corp.redhat.com/3e69621

This bug was only against h/w requirements but I would ask that somebody review all of Chapter 2 (Requirements) for accuracy for the 5.7 release. It's not that big, really...

Especially interested to know if there is anything there related to SSL and port numbers that needs updating.

Grant,
Can you volunteer somebody to look at this?

Thanks a lot.

Comment 2 Grant Gainey 2014-10-24 12:54:15 UTC
I'm on it - will update this BZ with comments as I go through the chapter!

Comment 3 Grant Gainey 2014-10-24 19:57:21 UTC
RE SSL and Ports - we haven't changed anything there for 5.7.  Poodle-fixes ("don't use SSLv3") is accompolished by updating Apache, Proxy doesn't do its own thing in that arena.

Other comments:

2.1 (and elsewhere) - "Satellite Proxy is supported on Red Hat Enterprise Linux 5 and 6."

Satellite5.7 and Satellite Proxy 5.7 are only supported on RHEL6. Maybe add this to the "Important" starred section?

2.2 Hardware Requirements

"6 GB of storage per distribution/channel."

This is still true in the current use-case.  With 5.7, we are adding the ability to 'pre-seed' entire channels.  Doing so requires the same amount of space one allocates for channels on Satellite (I believe 20G/base-channel is our current guidance?)  We probably want to add this, with a pointer to the Satellite guidance.

2.3 Disk Space Requirements

See the above.  We appear to repeat the 6G requirement in 2.3, so we should discuss the pre-seed implications here as well.  Or perhaps instead-of under 2.2?

Comment 4 David O'Brien 2014-10-27 03:48:23 UTC
(In reply to Grant Gainey from comment #3)
> RE SSL and Ports - we haven't changed anything there for 5.7.  Poodle-fixes
> ("don't use SSLv3") is accompolished by updating Apache, Proxy doesn't do
> its own thing in that arena.
> 
ok. Didn't touch anything.


> Other comments:
> 
> 2.1 (and elsewhere) - "Satellite Proxy is supported on Red Hat Enterprise
> Linux 5 and 6."

I changed this to read:

"Satellite 5.7 and Satellite Proxy 5.7 are only supported on Red Hat Enterprise Linux 6"

> 
> Satellite5.7 and Satellite Proxy 5.7 are only supported on RHEL6. Maybe add
> this to the "Important" starred section?

The "Important" admonition talks about RHEL7; what can we do with this:
"Satellite Proxy can manage Red Hat Enterprise Linux 7 clients, but only when used with Satellite 5.6."

Can we update that to include 5.7?

> 
> 2.2 Hardware Requirements
> 
> "6 GB of storage per distribution/channel."
> 
> This is still true in the current use-case.  With 5.7, we are adding the
> ability to 'pre-seed' entire channels.  Doing so requires the same amount of
> space one allocates for channels on Satellite (I believe 20G/base-channel is
> our current guidance?)  We probably want to add this, with a pointer to the
> Satellite guidance.

tbh I have trouble reading and making sense of "distribution/channel". I don't know if it's supposed to read "and" or "or" or "and/or" (which makes no sense to me) or something different. Can you elaborate?

Added a note about pre-seeding, with ref to Sat Install Guide and xref to precaching section.

> 
> 2.3 Disk Space Requirements
> 
> See the above.  We appear to repeat the 6G requirement in 2.3, so we should
> discuss the pre-seed implications here as well.  Or perhaps instead-of under
> 2.2?

I removed 2.3 and put it all under 2.2.

wrt the following:

"The caching mechanism used by Satellite Proxy is the Squid HTTP proxy, which saves significant bandwidth for the clients. It should have a reasonable amount of space available."

What's "reasonable"? Won't this depend on what the proxy is expected to cache? Saying "reasonable" is pretty vague.

Updated draft is here:
https://url.corp.redhat.com/2a55f3b

8424d78..a72ac9b  master -> master

thanks a lot.

Comment 5 Grant Gainey 2014-10-27 12:31:53 UTC
(In reply to David O'Brien from comment #4)
> (In reply to Grant Gainey from comment #3)
> > 
> > Satellite5.7 and Satellite Proxy 5.7 are only supported on RHEL6. Maybe add
> > this to the "Important" starred section?
> 
> The "Important" admonition talks about RHEL7; what can we do with this:
> "Satellite Proxy can manage Red Hat Enterprise Linux 7 clients, but only
> when used with Satellite 5.6."
> 
> Can we update that to include 5.7?

Yes - "...when used with Satellite 5.6 or later", maybe?

> > 
> > 2.2 Hardware Requirements
> > 
> > "6 GB of storage per distribution/channel."
> > 
> > This is still true in the current use-case.  With 5.7, we are adding the
> > ability to 'pre-seed' entire channels.  Doing so requires the same amount of
> > space one allocates for channels on Satellite (I believe 20G/base-channel is
> > our current guidance?)  We probably want to add this, with a pointer to the
> > Satellite guidance.
> 
> tbh I have trouble reading and making sense of "distribution/channel". I
> don't know if it's supposed to read "and" or "or" or "and/or" (which makes
> no sense to me) or something different. Can you elaborate?

Hm. I'm not sure if the intent there was 'distribution or channel', 'distribution (i.e. channel)', or 'per distribution per channel' (i.e., RHEL6 on x86_64 and s390x is one dist and two channels?)

Proxy (unless you're pre-seeding) only caches the RPMs you ask for, and only for a limited amount of time (as opposed to all channel contents). The 6Gb number is, I believe, to cache sufficient RPMs *per RHEL release/arch* to make proxy useful as a performance enhancement.  So, you'd leave 6Gb for each of RHEL6/x86_64 and RHEL6/s390x.

Maybe change dist/channel to 'per architecture per release'?

> wrt the following:
> 
> "The caching mechanism used by Satellite Proxy is the Squid HTTP proxy,
> which saves significant bandwidth for the clients. It should have a
> reasonable amount of space available."
> 
> What's "reasonable"? Won't this depend on what the proxy is expected to
> cache? Saying "reasonable" is pretty vague.

Squid cache is why we talk about '6Gb', above.  If we want to say anything, we could say something like 'the more disk space the squid cache has to work with, the less likely it is to start evicting RPMs from its cache early.'

Or just refer to the 6G number 'as mentioned above'?

> 
> Updated draft is here:
> https://url.corp.redhat.com/2a55f3b
> 
> 8424d78..a72ac9b  master -> master
> 
> thanks a lot.

Comment 6 David O'Brien 2014-10-28 01:41:23 UTC
(In reply to Grant Gainey from comment #5)
> (In reply to David O'Brien from comment #4)
> > (In reply to Grant Gainey from comment #3)
> > > 
> > > Satellite5.7 and Satellite Proxy 5.7 are only supported on RHEL6. Maybe add
> > > this to the "Important" starred section?
> > 
> > The "Important" admonition talks about RHEL7; what can we do with this:
> > "Satellite Proxy can manage Red Hat Enterprise Linux 7 clients, but only
> > when used with Satellite 5.6."
> > 
> > Can we update that to include 5.7?
> 
> Yes - "...when used with Satellite 5.6 or later", maybe?

Fixed.


> 
> > > 
> > > 2.2 Hardware Requirements
> > > 
> > > "6 GB of storage per distribution/channel."
> > > 
> > > This is still true in the current use-case.  With 5.7, we are adding the
> > > ability to 'pre-seed' entire channels.  Doing so requires the same amount of
> > > space one allocates for channels on Satellite (I believe 20G/base-channel is
> > > our current guidance?)  We probably want to add this, with a pointer to the
> > > Satellite guidance.
> > 
> > tbh I have trouble reading and making sense of "distribution/channel". I
> > don't know if it's supposed to read "and" or "or" or "and/or" (which makes
> > no sense to me) or something different. Can you elaborate?
> 
> Hm. I'm not sure if the intent there was 'distribution or channel',
> 'distribution (i.e. channel)', or 'per distribution per channel' (i.e.,
> RHEL6 on x86_64 and s390x is one dist and two channels?)
> 
> Proxy (unless you're pre-seeding) only caches the RPMs you ask for, and only
> for a limited amount of time (as opposed to all channel contents). The 6Gb
> number is, I believe, to cache sufficient RPMs *per RHEL release/arch* to
> make proxy useful as a performance enhancement.  So, you'd leave 6Gb for
> each of RHEL6/x86_64 and RHEL6/s390x.
> 
> Maybe change dist/channel to 'per architecture per release'?

Fixed.

> 
> > wrt the following:
> > 
> > "The caching mechanism used by Satellite Proxy is the Squid HTTP proxy,
> > which saves significant bandwidth for the clients. It should have a
> > reasonable amount of space available."
> > 
> > What's "reasonable"? Won't this depend on what the proxy is expected to
> > cache? Saying "reasonable" is pretty vague.
> 
> Squid cache is why we talk about '6Gb', above.  If we want to say anything,
> we could say something like 'the more disk space the squid cache has to work
> with, the less likely it is to start evicting RPMs from its cache early.'
> 
> Or just refer to the 6G number 'as mentioned above'?

I updated this para and also moved it inside the list, as a "second para" to the list item about "6 GB storage/arch/release" to help tie the two bits together.

> 
> > 
> > Updated draft is here:
> > https://url.corp.redhat.com/2a55f3b
> > 
> > 8424d78..a72ac9b  master -> master
> > 
> > thanks a lot.


To git.lab.tlv.redhat.com:satellite5-docs/proxy-installation-guide.git
   824f688..30103c5  master -> master

https://url.corp.redhat.com/2a55f3b

Comment 7 Dan Macpherson 2015-09-16 02:21:13 UTC
Verified and pushed live. Closing bug.


Note You need to log in before you can comment on or make changes to this bug.