Bug 700609 - RHUI Installer: Answers File
Summary: RHUI Installer: Answers File
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Update Infrastructure for Cloud Providers
Classification: Red Hat
Component: Documentation
Version: 2.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Lana Brindley
QA Contact: wes hayutin
URL:
Whiteboard:
Depends On:
Blocks: 689309
TreeView+ depends on / blocked
 
Reported: 2011-04-28 19:13 UTC by Jay Dobies
Modified: 2016-02-18 06:02 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2011-07-29 04:45:05 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Jay Dobies 2011-04-28 19:13:38 UTC
A sample answers file can be found at /etc/rhui/answers.sample.

The answers file is used to describe the RHUI environment. Once filled out, it is passed to the installer script to generate the appropriate configuration RPMs:

rhui-installer ./my-rhui-answers.conf

I'll describe each section of the file below.

Comment 1 Jay Dobies 2011-04-28 19:21:12 UTC
General

The general section is a collection of values that apply to both RHUA and CDS configuration RPMs. There isn't much here.

version: Version number of the configuration RPMs to generate. This will apply to all configuration RPMs created from this answers file. It can be overridden in any of the subsections for just that subsection.

For instance, given:

[general]
version: 2.0

[rhua]
version: 2.5

All of the CDS RPMs would be version 2.0, while the RHUA RPM would be 2.5.

dest_dir: Full path to where the generated RPMs should be created. Each RPM will be located in this directory after it runs. Additionally, any temporary files used in the RPM creation will be located in a subdirectory in this directory, where the subdirectory's name is the same as the RPM.

For instance, given:

[general]
dest_dir: /tmp/rhui-cds-rpm-test
version: 2.0

[cds-1]
rpm-name: test-cds-config


The following exists after running the installer:

ll  /tmp/rhui-cds-rpm-test
drwxrwxr-x. 4 jdob jdob 4096 Apr 26 12:09 test-cds-config-2.0
-rw-r--r--. 1 jdob jdob 4262 Apr 26 12:09 test-cds-config-2.0-2.fc14.noarch.rpm

Inside of test-cds-config-2.0 are the files that were used to create the RPM.




From answers.sample:

# The [general] section contains configuration options that apply to the RHUI installation
# as a whole.
[general]

# This will be used as the version for all RPMs that are created by this answers file.
# Individual components may override this value with the "rpm_version" attribute.
version: 2.0

# Local directory into which RHUI tools will place any temporary files as well as the
# built RPMs. If this directory exists prior to running RHUI tools, the user executing
# it must have write permissions.
dest_dir: /tmp/rhui

Comment 2 Jay Dobies 2011-04-28 19:26:53 UTC
RHUA

There must be one and only one [rhua] section in the answers file. It contains values that are used to configure the RHUA server.

rpm_name: Name of the RPM that will be created. The actual RPM name will also include the version and architecture in it.

hostname: Fully qualified domain name of the RHUA instance. This cannot be an IP, it must be a resolvable DNS name. Furthermore, the SSL certificate (see below) must be created for this DNS name (i.e. the CN of the certificate must match this).

ssl_cert and ssl_key: Full paths to the SSL certificate and private key to install in Apache on the RHUA instance. The Apache configuration itself will be modified with these values.

Optional:
proxy_server_host, proxy_server_port, proxy_server_username, proxy_server_password: If specified, these values will be used as a proxy server when the RHUA attempts to access the Internet (external to the cloud) to download packages from Red Hat. Omitting these means no proxy server will be used. For non-authenticating proxy servers, just host and port need to be specified.


(note: there may be a few more values in here when we finish up with the RHUA <-> CDS security part, but it won't be too much)



From answers.sample:

# The [rhua] section contains attributes describing a particular RHUA instance.
[rhua]

# Name of the RHUA configuration RPM created by RHUI tools.
rpm_name: rh-rhua-config

# Fully qualified hostname of the RHUA instance.
hostname: rhua.example.com

# SSL certificate and private key to be installed on the RHUA. The CN of this certificate
# must match the hostname listed above.
ssl_cert: rhua.crt
ssl_key: rhua.key

# If a proxy server is needed for the RHUA to connect to the internet, this is the hostname
# of that server. If this is not specified, no proxy server will be used.
# proxy_server_host: proxy.example.com

# Port to access on the proxy server. This value has no effect if proxy_server_host is
# not specified.
# proxy_server_port: 443

# Proxy server username. Omit if the proxy server does not require authentication.
# proxy_server_username: admin

# Proxy server password.
# proxy_server_password: password

Comment 3 Jay Dobies 2011-04-28 19:30:05 UTC
CDS

Technically speaking, these can be omitted entirely, but we might want to phrase it that they should specify one or more CDS instances to be configured. Just like in 1.2, multiple CDS instances are specified by appending a unique value to the "cds-" prefix in the section name. The values are unused by the RPM itself, they simply exist to uniquely separate multiple CDS configurations.

For instance:
[cds-1]
-- stuff for a CDS --

[cds-2]
-- stuff for a different CDS --

For each CDS instance, the following must be specified:

rpm_name: Same description as for the RHUA's rpm_name value.

hostname: Same description as for the RHUA's hostname value.

ssl_cert, ssl_key: Actually, this is the same as for the RHUA too.

That's it though, proxies are not supported for CDS to RHUA communication.




From answers.sample:

# There should be one [cds-*] section for each CDS to be used in the RHUI infrastructure.
# The name between the [ ] must begin with "cds", however the remainder is arbitrary and must
# only be unique with respect to other cds sections. There will be one CDS configuration RPM
# generated for each section found.

[cds-1]

# Name of the RPM that will be created for this CDS configuration.
rpm_name: rh-cds1-config

# Fully qualified name of this CDS instance.
hostname: cds1.example.com

# SSL certificate and private key to be used by this CDS instance. The CN of this
# certificate must match the hostname listed above.
ssl_cert: cds1.crt
ssl_key: cds1.key

# [cds-2]
# rpm_name: rh-cds2-config
# hostname: cds2.example.com
# ssl_cert: cds2.crt
# ssl_key: cds2.key

Comment 4 Lana Brindley 2011-04-28 20:44:41 UTC
Installation/RHUI Installer/Answers File

LKB

Comment 5 Lana Brindley 2011-04-28 21:16:45 UTC
(In reply to comment #4)
> Installation/RHUI Installer/Answers File

After some pondering, moved Answers File to its own section, now in:

Installation/Answers File

LKB

Comment 6 Lana Brindley 2011-05-06 02:48:02 UTC
(In reply to comment #5)
> (In reply to comment #4)
> > Installation/RHUI Installer/Answers File
> 
> After some pondering, moved Answers File to its own section, now in:
> 
> Installation/Answers File
> 
> LKB

And now I've moved it back.

I'll get there eventually, promise!

LKB

Comment 7 Lana Brindley 2011-05-06 04:12:28 UTC
Revision 1-7

LKB

Comment 8 wes hayutin 2011-05-27 02:37:26 UTC
looks ready for QE

Comment 9 Sachin Ghai 2011-06-13 11:56:00 UTC
Verified in the stage doc at:
http://documentation-stage.bne.redhat.com/docs/en-US/Red_Hat_Update_Infrastructure/2.0/pdf/Installation_Guide/Red_Hat_Update_Infrastructure-2.0-Installation_Guide-en-US.pdf

There is a section "3.1 Answer File" at page 11, which includes all above description in 3 sections : General, RHUA and CDS.

Comment 10 Lana Brindley 2011-07-29 04:45:05 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


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