Puppet-based installer for Katello
Ruby Shell
Pull request Compare This branch is 84 commits behind Katello:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
checks
config
hooks
.gitignore
.travis.yml
Gemfile
LICENSE
Puppetfile
README.md
Rakefile
VERSION

README.md

Build Status

Katello Installer

A set of tools to properly configure Katello with Foreman in production and development.

Production Usage

$ yum install -y foreman-installer-katello

# install Katello with Foreman and smart proxy with Puppet and Puppetca
$ foreman-installer --scenario katello

Production Examples

# Install also provisioning-related services

foreman-installer --scenario                     "katello"\
                  --foreman-proxy-dns            "true"\
                  --foreman-proxy-dns-forwarders "8.8.8.8"
                  --foreman-proxy-dns-forwarders "8.8.4.4"\
                  --foreman-proxy-dns-interface  "virbr1"\
                  --foreman-proxy-dns-zone       "example.com"\
                  --foreman-proxy-dhcp           "true"\
                  --foreman-proxy-dhcp-interface "virbr1"\
                  --foreman-proxy-tftp           "true"\
                  --capsule-puppet               "true"\
                  --foreman-proxy-puppetca       "true"

# Install only DNS with smart proxy

foreman-installer --scenario                     "katello"\
                  --foreman-proxy-dns            "true"\
                  --foreman-proxy-dns-forwarders "8.8.8.8"
                  --foreman-proxy-dns-forwarders "8.8.4.4"\
                  --foreman-proxy-dns-interface  "virbr1"\
                  --foreman-proxy-dns-zone       "example.com"\
                  --capsule-puppet               "false"\
                  --foreman-proxy-puppetca       "false"

# Generate certificates for installing capsule on another system
capsule-certs-generate --capsule-fqdn "mycapsule.example.com"\
                       --certs-tar    "~/mycapsule.example.com-certs.tar"

# Copy the ~/mycapsule.example.com-certs.tar to the capsule system
# register the system to Katello and run:
foreman-installer --scenario                            "capsule"\
                  --capsule-parent-fqdn                 "master.example.com"\
                  --foreman-proxy-register-in-foreman   "true"\
                  --foreman-proxy-foreman-base-url      "https://master.example.com"\
                  --foreman-proxy-trusted-hosts         "master.example.com"\
                  --foreman-proxy-trusted-hosts         "mycapsule.example.com"\
                  --foreman-proxy-oauth-consumer-key    "foreman_oauth_key"\
                  --foreman-proxy-oauth-consumer-secret "foreman_oauth_secret"\
                  --capsule-pulp-oauth-secret           "pulp_oauth_secret"\
                  --capsule-certs-tar                   "/root/mycapsule.exampe.com-certs.tar"\
                  --capsule-puppet                      "true"\
                  --foreman-proxy-puppetca              "true"\
                  --foreman-proxy-dns                   "true"\
                  --foreman-proxy-dns-forwarders        "8.8.8.8"\
                  --foreman-proxy-dns-forwarders        "8.8.4.4"\
                  --foreman-proxy-dns-interface         "virbr1"\
                  --foreman-proxy-dns-zone              "example.com"\
                  --foreman-proxy-dhcp                  "true"\
                  --foreman-proxy-dhcp-interface        "virbr1"\
                  --foreman-proxy-tftp                  "true"\

Data Reset

If you run into an error during the initial installation or wish to reset your installation entirely, the installer provides a reset option. To reset the database and all subsystems:

foreman-installer --scenario katello --reset

To clear all of your on disk Pulp content:

foreman-installer --scenario katello --clear-pulp-content

To clear all Puppet environments on disk:

foreman-installer --scenario katello --clear-puppet-environments

Development Usage

Devel Installer

$ yum install -y foreman-installer-katello-devel

# install Katello with Foreman from git
$ foreman-installer --scenario katello-devel

Install with custom user

foreman-installer --scenario katello-devel\
                  --katello-devel-user testuser\
                  --certs-group testuser\
                  --katello-devel-deployment-dir /home/testuser

Install without RVM

foreman-installer --scenario katello-devel\
                  --katello-devel-use-rvm false

From Git

If you're working off the master branch, use Librarian to pull in all the modules to your local checkout:

$ git clone https://github.com/Katello/katello-installer.git
$ bundle install
$ librarian-puppet install --path modules/
$ bin/katello-installer

Certificates

Katello installer comes with a default CA used both for the server SSL certificates as well as the client certificates used for authentication of the subservices (pulp, foreman-proxy, subscription-manager etc.).

Custom Server Certificates

Katello-installer runs a validation script for passed input certificate files. One can run it manually as follows:

katello-certs-check -c ~/path/to/server.crt\
                    -r ~/path/to/server.crt.req\
                    -k ~/path/to/server.key\
                    -b ~/path/to/cacert.crt

The check is performed also as part of the installer script. In case the script marked the certs as invalid incorrectly, one can skip this check by passing --certs-skip-check to the installer.

When running the installer for the first time:

foreman-installer --scenario katello\
                  --certs-server-cert ~/path/to/server.crt\
                  --certs-server-cert-req ~/path/to/server.crt.req\
                  --certs-server-key ~/path/to/server.key\
                  --certs-server-ca-cert ~/path/to/cacert.crt

Where the --certs-server-ca-ca-cert is the CA used for issuing the server certs (this CA gets distributed to the consumers and capsules).

For the capsule, these options are passed as part of the capsule-certs-generate script:

capsule-certs-generate --capsule-fqdn "$CAPSULE"\
                       --certs-tar "~/$CAPSULE-certs.tar"\
                       --server-cert ~/path/to/server.crt\
                       --server-cert-req ~/path/to/server.crt.req\
                       --server-key ~/path/to/server.key\
                       --server-ca-cert ~/cacert.crt

The rest of the procedure is identical to the default CA setup.

Setting custom certificates after 'foreman-installer --scenario katello' was already run.

The first run of foreman-installer --scenario katello uses the default CA for both server and client certificates. To enforce the custom certificates to be deployed, on needs to set --certs-update-server for updating the CA certificate and --certs-update-server-ca because the server CA changed as well (and new katello-ca-consumer rpm needs to be regenerated):

foreman-installer --scenario katello\
                  --certs-server-cert ~/path/to/server.crt\
                  --certs-server-cert-req ~/path/to/server.crt.req\
                  --certs-server-key ~/path/to/server.crt.req\
                  --certs-server-ca-cert ~/path/to/cacert.crt\
                  --certs-update-server --certs-update-server-ca

After the server CA changes, the new version of the consumer-ca-consumer rpm needs to be installed on the consumers, as well as:

rpm -Uvh http://katello.example.com/pub/katello-ca-consumer-latest.noarch.rpm

When using the custom server CA, the CA needs to be used for the server certificates on the capsules as well. The certificates for the capsule are deployed to the capsule through the use of the capsule-certs-generate script (followed by copying the certs tar to the capsule and running the 'foreman-installer --scenario capsule' to refresh the certificates).:

capsule-certs-generate --capsule-fqdn "$CAPSULE"\
                       --certs-tar "~/$CAPSULE-certs.tar"\
                       --server-cert ~/path/to/server.crt\
                       --server-cert-req ~/path/to/server.crt.req\
                       --server-key ~/path/to/server.key\
                       --server-ca-cert ~/cacert.crt\
                       --certs-update-server

Updating Certificates

On a server

To regenerate the server certificates when using the default CA or enforce deploying new certificates for the custom server CA run the 'foreman-installer --scenario katello' with --certs-update-server option:

foreman-installer --scenario katello --certs-update-server

To regenerate all the certificates used in the Katello server, there is a --certs-update-all. This will generate and deploy the certificates as well as restart corresponding services.

On a capsule

For updating the certificates on a capsule pass the same options (either --certs-update-server or --certs-update-all) to the capsule-certs-generate script. The new certs tar gets generated that needs to be transferred to the capsule and then foreman-installer --scenario capsule needs to be re-run to apply the updates and restart corresponding services.

Filing and Fixing Issues

All issues are tracked using Redmine. There are two types of issues that may arise:

  • A bug within an individual module
  • A bug within the hooks or scripts of the installer

Module Bugs

For bugs found within an individual module, the following needs doing:

  • A bug should be filed under the Katello Installer category
  • Fix and open a PR against the module itself, in some cases this may be a module own by the Katello, or the Foreman or may be a third party module (see the Puppetfile for a list of modules and their locations)
  • Once the fix is available within the module, follow the Updating Packages section and open a PR with the updates

Installer Bugs

For bugs found within the hooks, config, answer or script files, please do the following:

  • Open a Redmine issues describing the problem
  • Fix and open a PR against the installer

Updating Packages

This repository uses the gems librarian and librarian-puppet to handle the dependent puppet modules.

gem install librarian librarian-puppet puppet
librarian-puppet update

tito is used for doing the releases.