Plugins » Katello

h1. Katello on Existing Foreman

h2. Summary

Goals:

# I am a user and I want to install Katello on my existing production Foreman.

# I am Foreman developer, and I want to add Katello to my development environment.

h2. Targeted Release

TBD

h2. Targeted Persona

[[Personas-SystemEngineer| Samuel - System Engineer]] - production Foreman

[[Personas-Developer| Daniel - Developer]] - development environment

h2. Initial Research

Based on https://groups.google.com/forum/#!searchin/foreman-dev/katello$20on/foreman-dev/rMc1rWJMmBg/gTjEDJuD_a0J

h3. Data -- bbuckingham/sloranz

*Databases*

Katello currently only tests and supports Postgres. 

Issues:

# Do we add MySQL support?

*Backends*

Katello has three main backends that store data: Pulp, Candlepin and Elasticsearch. Some Katello objects has corresponding objects in one or all backends. 

Issues:

# Do we remove the use of ES? Some work has already gone into investigating performance differences and in to converting entities away from ES. The question then is, do we remove ES before we allow Katello to be added to an existing Foreman?

# Existing Organizations need to be created in Candlepin

# Organization-less Foreman's will need to have them enabled and an initial one created

# Users will need to be created in Pulp, and the anonymous_admin and anonymous_api_admin will need to have the correct remote_id to correspond to the Pulp admin user.

# Locations would have to be turned on and if existing Locations then there will have to be a default location created or one of the existing locations converted to.

h3. Installation/Configuration -- ehelms/sloranz

*Certs*

Katello requires a number of certificates in order to deploy all of the services that are involved. For a summary of all the certs that are used and deployed see [1]. In order for us to install the Katello plugin alongside an existing Foreman installation, we will need to support deploying certs for new services as well as, in some situations, changing the certs currently being used by Foreman.

The current design of our certs management is:

# We use a centralized puppet-certs that contains manifests for each service

# puppet-certs handles generating a CA that is used for each set of certs

# puppet-certs handles user supplied server certificates

# puppet-certs uses Puppet providers that currently only work with the katello-certs-tools library

# katello-certs-tools is a python based command line tool that uses RPMs to wrap certs and deploy them

Issues:

# Do we keep the singular puppet-certs for managing and orchestrating our certs or break it up so that each module is managing what it requires certs wise with parameters?

# Do we ditch katello-certs-tools in favor of puppet-openssl [2] ? This may require pushing some changes into the library for our needs. We will still need a way to generate and deploy our bootstrap RPM.

# Do we detangle and ditch our nssdb management in favor of puppet-nsstools [3] ? Should the nssdb management be moved into our puppet-qpid since nss is predominantly required by qpid?

# What is the best strategy for de-coupling our puppet modules and ensuring they can be imported to manage the configuration of the server itself?

# How do we handle the answers file from older Foreman installations?

*Rake Tasks*

Katello currently relies on installing and configuring itself and then letting the Foreman installation happen as normal. This is so that as rake tasks such as migrate, seed and api pie cache are run, the Katello migrations, seeds and APIs are included. Further, Katello requires services (Pulp, Candlepin, Elasticsearch) to be running in order to seed the database.

Issues:

# Foreman rake tasks in puppet are currently designed to run once, how do we modify this behavior such that Katello can come along and run them for it's needs?

# Katello seeds need to be updated to ensure that backend users are created properly

# Katello seeds needs to be updated to ensure organizations get created in Candlepin

*Answers file vs. Orchestration Module*

Katello currently uses a single module to orchestrate all services and certs being done in the correct order [4]. The Kafo answers file also serves as a method for combining a number of services and orchestrating parameters to them. Further, only module declared within the answers file can be tuned via parameters. Thus, if a module, such as Pulp, exposed a new configuration option the orchestration module would have to also be updated to expose this. In the answers file method, this option would be exposed to the user by simply updating the Pulp module within the installer.

Issues:

# Does a single orchestration module make the most sense or should we be taking advantage of the answers file method?

h3. Capsules -- lzap

Katello deploys Capsules which includes deploying the following:

* Smart Proxy

* Pulp Node or Pulp Master

* Certs

* Qpid

* Puppet Master

Issues:

# Existing smart proxies would require updated certs based on the Katello certs deployment.

# Are Capsules really just Smart Proxies? or does the current paradigm of Capsules being Smart Proxies + additional services (e.g. Pulp, qpid, reverse proxy) still make sense?

# puppet-capsule currently wraps foreman-proxy, thus to expose new foreman-proxy options we have to expose them in puppet-capsule as options

Packaging

h2. Documentation

h3. Bugs/RFE

* Tracker http://projects.theforeman.org/issues/7605 

h3. Use Cases

h3. Requirements