Bug 704611

Summary: Staging Review: RHUI Installer
Product: Red Hat Update Infrastructure for Cloud Providers Reporter: Jay Dobies <jason.dobies>
Component: DocumentationAssignee: Lana Brindley <lbrindle>
Status: CLOSED CURRENTRELEASE QA Contact: wes hayutin <whayutin>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 2.0CC: kbidarka, mhideo, tsanders
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2011-07-29 04:46:27 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Jay Dobies 2011-05-13 18:38:06 UTC
Intro

"This is achieved through an answers file which you complete with all the information required"

Might want to rephrase to something like "with information describing the environment in which the RHUI will be installed". Just provides a bit more of a nudge towards the idea that each answers file describes a whole RHUI installation.

-----

Intro

"RHUI Installer will then create the configuration RPMs it needs, and install them."

Comma feels awkward there...

... which is a bit of a moot point, since the installer doesn't actually install the generated RPMs.

-----

Intro

"This chapter explains how to perform an initial installation of Red Hat Update Infrastructure, using RHUI Installer."

Should there be a comma after Infrastructure?

-----

Note

"You must be using Red Hat Enterprise Linux"

Probably want to mention it's RHEL 6 here. We won't run on RHEL 5. Bad, bad things will happen. Like drop bears sort of bad.

-----

Storage

"Make a note of the mount point for the volume where the Red Hat Update Infrastructure RPMs are stored. You will be asked for this information during configuration of the RHUA and CDS instances."

Not anymore. Packages go in /var/lib/pulp now. If they need that to be a different volume, they have to manually dork with that mount point on their own.

-----

3.1 Procedure

"In order to install Red Hat Update Infrastructure, you need to be subscribed to the appropriate rhel-rhui and MRG channels for your system on Red Hat Network (RHN)."

You can take this out, this step isn't used for RHEL 6.

-----

3.1 Answers File

"These are created by RHUI Installer, using an answers file."

No comma after Installer.

----

"These RPMs will be given the version number 1.0 Is that right? by default"

2.0, not 1.0.

-----

"Every RPM will be located in this directory after it runs, and temporary files will be located in a sub-directory. "

Should the comma be there?

-----

"Ensure that your SSL certificate has been created for this DNS name, as they must match exactly"

Comma feels weird there too (I may be wrong on these, just figured I'd ask).

-----

"Create a new sub-section under the CDS Instances heading for each CDS instances"

Just "section", not "sub-section".

-----

Comment 1 Jay Dobies 2011-05-13 18:38:30 UTC
There will be some minor additions to the answers file in the very near future. I'll file a new bug with them when they are ready.

Comment 2 Lana Brindley 2011-05-24 02:19:46 UTC
(In reply to comment #0)
> Intro
> 
> "This is achieved through an answers file which you complete with all the
> information required"
> 
> Might want to rephrase to something like "with information describing the
> environment in which the RHUI will be installed". Just provides a bit more of a
> nudge towards the idea that each answers file describes a whole RHUI
> installation.
> 
> -----
> 
> Intro
> 
> "RHUI Installer will then create the configuration RPMs it needs, and install
> them."
> 
> Comma feels awkward there...
> 
> ... which is a bit of a moot point, since the installer doesn't actually
> install the generated RPMs.
> 
> -----
> 
> Intro
> 
> "This chapter explains how to perform an initial installation of Red Hat Update
> Infrastructure, using RHUI Installer."
> 
> Should there be a comma after Infrastructure?

<para>
	RHUI Installer is used to configure &RHUI; and get it started. This is achieved through an <firstterm>answers file</firstterm> which you complete with information describing the environment in which RHUI will be installed. RHUI Installer will then create the configuration RPMs it needs. This configures and starts all the necessary services. Once RHUI Installer has completed, use RHUI Manager to interact with &RHUI;.
</para>
<para>
	This chapter explains how to perform an initial installation of &RHUI; using RHUI Installer. Ensure all the prerequisites described in <xref linkend="chap-Installation_Guide-Installation_Requirements" /> have been met before attempting to install &RHUI;.
</para>

> 
> -----
> 
> Note
> 
> "You must be using Red Hat Enterprise Linux"
> 
> Probably want to mention it's RHEL 6 here. We won't run on RHEL 5. Bad, bad
> things will happen. Like drop bears sort of bad.

<note>
	<title>Note</title>
	<para>
		You must be using &RHEL; 6 in order to successfully install and run &RHUI;. For more information on installing &RHEL;, refer to the <citetitle pubwork="book">&RHEL; Installation Guide</citetitle>.
	</para>
</note>

Drop bears aren't bad. We ride them to school every day.

> 
> -----
> 
> Storage
> 
> "Make a note of the mount point for the volume where the Red Hat Update
> Infrastructure RPMs are stored. You will be asked for this information during
> configuration of the RHUA and CDS instances."
> 
> Not anymore. Packages go in /var/lib/pulp now. If they need that to be a
> different volume, they have to manually dork with that mount point on their
> own.

Commented out the para.

> 
> -----
> 
> 3.1 Procedure
> 
> "In order to install Red Hat Update Infrastructure, you need to be subscribed
> to the appropriate rhel-rhui and MRG channels for your system on Red Hat
> Network (RHN)."
> 
> You can take this out, this step isn't used for RHEL 6.
> 

Gone.

> -----
> 
> 3.1 Answers File
> 
> "These are created by RHUI Installer, using an answers file."
> 
> No comma after Installer.

<para>
	In order to configure &RHUI;, a series of configuration RPMs are required. These are created by RHUI Installer using an <firstterm>answers file</firstterm>. &RHUI; includes an example answers file at <filename>/etc/rhui/answers.sample</filename> to use as a basis for creating your own answers file. There is also an example answers file at <xref linkend="exam-Installation_Guide-Answers_File-Example_Answers_File" />.
</para>

> 
> ----
> 
> "These RPMs will be given the version number 1.0 Is that right? by default"
> 
> 2.0, not 1.0.

<para>
	RHUI Installer needs to generate configuration RPMs. These RPMs will be given the version number <parameter>2.0</parameter> by default. To make the RPMs use a different version number, enter it here:
</para>

Removed the remark.

> 
> -----
> 
> "Every RPM will be located in this directory after it runs, and temporary files
> will be located in a sub-directory. "
> 
> Should the comma be there?

*shrug*

Doesn't much matter.

<para>
	Enter the full path to the location where RHUI Installer should create the configuration RPMs. Every RPM will be located in this directory after it runs and temporary files will be located in a sub-directory.
</para>

> 
> -----
> 
> "Ensure that your SSL certificate has been created for this DNS name, as they
> must match exactly"
> 
> Comma feels weird there too (I may be wrong on these, just figured I'd ask).

Yeah, every lecturer I've had, ever, has said, I use, too many, commas, as well ;)

<para>
	Enter the fully qualified domain name of the CDS instance. This must not be an IP address, but a resolvable DNS name. Ensure that your SSL certificate has been created for this DNS name as they must match exactly:
</para>

> 
> -----
> 
> "Create a new sub-section under the CDS Instances heading for each CDS
> instances"
> 
> Just "section", not "sub-section".

<para>
	The CDS section contains configuration options for each CDS instance. Create a new section under the CDS Instances heading for each CDS instance, giving each one a unique title with a <parameter>cds-</parameter> prefix, for example:
</para>

Also fixed the random pluralisation.



Revision 1-9

LKB

Comment 3 Kedar Bidarkar 2011-05-26 13:01:33 UTC
Felt like having a separate bug for Storage part and raised one https://bugzilla.redhat.com/show_bug.cgi?id=707954

Rest everything is covered.

Comment 4 Lana Brindley 2011-07-29 04:46:27 UTC
This book is now available at http://docs.redhat.com/docs/en-US/Red_Hat_Update_Infrastructure/2.0/html/Installation_Guide/index.html

Please raise a new bug for any further changes.

LKB