openshift_management_project |
No |
openshift-management |
Namespace for the installation. |
openshift_management_project_description |
No |
CloudForms Management Engine |
Namespace/project description. |
openshift_management_install_management |
No |
false |
Boolean, set to true to install the application |
openshift_management_install_beta |
No |
false |
Boolean, by setting this value to true you acknowledge that this software is currently in BETA and support may be limited. Only required for openshift-enterprise users. |
openshift_management_username |
No |
admin |
Default management username. Changing this values does not change the username. Only change this value if you have changed the name already and are running integration scripts (such as the add container provider script) |
openshift_management_password |
No |
smartvm |
Default management password. Changing this values does not change the password. Only change this value if you have changed the password already and are running integration scripts (such as the add-container-provider script) |
| PRODUCT CHOICE |
|
|
|
openshift_management_app_template |
No |
miq-template |
The project flavor to install. Choices: miq-template: ManageIQ using a podified database-
miq-template-ext-db: ManageIQ using an external database cfme-template: CloudForms using a podified database[1]-
cfme-template-ext-db: CloudForms using an external database.[1]
|
| STORAGE CLASSES |
|
|
|
openshift_management_storage_class |
No |
nfs |
Storage type to use, choices: nfs - Best used for proof-of-concept installs. Will setup NFS on a cluster host (defaults to your first master in the inventory file) to back the required PVCs. The application requires a PVC and the database (which may be hosted externally) may require a second. PVC minimum required sizes are 5GiB for the MIQ application, and 15GiB for the PostgreSQL database (20GiB minimum available space on a volume/partition if used specifically for NFS purposes)nfs_external - You are using an external NFS server, such as a netapp appliance. See the Configuration - Storage Classes section below for required information.preconfigured - This CFME role will do NOTHING to modify storage settings. This option assumes expert knowledge and that you have done everything required ahead of time.cloudprovider - You are using an OCP cloudprovider integration for your storage class. For this to work you must have already configured the required inventory parameters for your cloud provider. Ensure openshift_cloudprovider_kind is defined (aws or gce) and that the applicable cloudprovider parameters are provided.
|
openshift_management_storage_nfs_external_hostname |
No |
false |
If you are using an external NFS server, such as a netapp appliance, then you must set the hostname here. Leave the value as false if you are not using external NFS.
Additionally: External NFS REQUIRES that you create the NFS exports that will back the application PV and optionally the database PV. |
openshift_management_storage_nfs_base_dir |
No |
/exports/ |
If you are using External NFS then you may set the base path to the exports location here.
Local NFS Note: You may also change this value if you want to change the default path used for local NFS exports. |
openshift_management_storage_nfs_local_hostname |
No |
false |
If you do not have an [nfs] group in your inventory, or want to simply manually define the local NFS host in your cluster, set this parameter to the hostname of the preferred NFS server. The server must be a part of your OCP/Origin cluster. |
| CUSTOMIZATION OPTIONS |
|
|
|
openshift_management_template_parameters |
No |
{} |
A dictionary of any parameters you want to override in the application/pv templates. |
- [1] The
cfme-templates will be available and
automatically detected once CFME 4.6 is released
Getting Started
Below are some inventory snippets that can help you get started right
away.
If you want to install CFME/MIQ at the same time you install your
OCP/Origin cluster, ensure that openshift_management_install_management is set
to true in your inventory. Call the standard
playbooks/deploy_cluster.yml playbook to begin the cluster and CFME/MIQ
installation.
If you are installing CFME/MIQ on an already provisioned cluster
then you can call the CFME/MIQ playbook directly:
$ ansible-playbook -v -i <YOUR_INVENTORY> playbooks/openshift-management/config.yml
Note: Use miq-template in the following examples for ManageIQ installs
All Defaults
This example is the simplest. All of the default values and choices
are used. This will result in a fully podified CFME installation. All
application components, as well as the PostgreSQL database will be
created as pods in the container platform.
[OSEv3:vars]
openshift_management_app_template=cfme-template
External NFS Storage
This is as the previous example, except that instead of using local
NFS services in the cluster it will use an external NFS server (such
as a storage appliance). Note the two new parameters:
openshift_management_storage_class - set to nfs_externalopenshift_management_storage_nfs_external_hostname - set to the hostname
of the NFS server
[OSEv3:vars]
openshift_management_app_template=cfme-template
openshift_management_storage_class=nfs_external
openshift_management_storage_nfs_external_hostname=nfs.example.com
If the external NFS host exports directories under a different parent
directory, such as /exports/hosted/prod then we would add an
additional parameter, openshift_management_storage_nfs_base_dir:
# ...
openshift_management_storage_nfs_base_dir=/exports/hosted/prod
Override PV sizes
This example will override the PV sizes. Note that we set the PV sizes
in the template parameters, openshift_management_template_parameters. This
ensures that the application/db will be able to make claims on created
PVs without clobbering each other.
[OSEv3:vars]
openshift_management_app_template=cfme-template
openshift_management_template_parameters={'APPLICATION_VOLUME_CAPACITY': '10Gi', 'DATABASE_VOLUME_CAPACITY': '25Gi'}
Override Memory Requirements
In a test or proof-of-concept installation you may need to reduce the
application/database memory requirements to fit within your
capacity. Note that reducing memory limits can result in reduced
performance or a complete failure to initialize the application.
[OSEv3:vars]
openshift_management_app_template=cfme-template
openshift_management_template_parameters={'APPLICATION_MEM_REQ': '3000Mi', 'POSTGRESQL_MEM_REQ': '1Gi', 'ANSIBLE_MEM_REQ': '512Mi'}
Here we have instructed the installer to process the application
template with the parameter APPLICATION_MEM_REQ set to 3000Mi,
POSTGRESQL_MEM_REQ set to 1Gi, and ANSIBLE_MEM_REQ set to
512Mi.
These parameters can be combined with the PV size override parameters
displayed in the previous example.
External PostgreSQL Database
To use an external database you must change the
openshift_management_app_template parameter value to miq-template-ext-db
or cfme-template-ext-db.
Additionally, database connection information must be supplied in
the openshift_management_template_parameters customization parameter. See
Customization - Database - External for more
information.
[OSEv3:vars]
openshift_management_app_template=cfme-template-ext-db
openshift_management_template_parameters={'DATABASE_USER': 'root', 'DATABASE_PASSWORD': 'r1ck&M0r7y', 'DATABASE_IP': '10.10.10.10', 'DATABASE_PORT': '5432', 'DATABASE_NAME': 'cfme'}
NOTE: Ensure your are running PostgreSQL 9.5 or you may not be
able to deploy the app successfully.
Limitations
This release is the first OpenShift CFME release in the OCP 3.7
series. It is not complete yet.
Product Choice
Due to staggered release dates, CFME support is not
integrated. Presently this role will only deploy a ManageIQ
installation. This role will be updated once CFME 4.6 is released and
this limitation note will be removed.
Configuration
Before you can deploy CFME you must decide how you want to deploy
it. There are two major decisions to make:
- Do you want an external, or a podified database?
- Which storage class will back your PVs?
Database
Podified
Any POSTGRES_* or DATABASE_* template parameters in
miq-template.yaml or
cfme-template.yaml
may be customized through the openshift_management_template_parameters
hash.
External
Any POSTGRES_* or DATABASE_* template parameters in
miq-template-ext-db.yaml
or
cfme-template-ext-db.yaml
may be customized through the openshift_management_template_parameters
hash.
External PostgreSQL databases require you to provide database
connection parameters. You must set the required connection keys in
the openshift_management_template_parameters parameter in your
inventory. The following keys are required:
DATABASE_USERDATABASE_PASSWORDDATABASE_IPDATABASE_PORT - note: Most PostgreSQL servers run on port 5432DATABASE_NAME
NOTE: Ensure your are running PostgreSQL 9.5 or you may not be
able to deploy the app successfully.
Your inventory would contain lines similar to this:
[OSEv3:vars]
openshift_management_app_template=cfme-template-ext-db
openshift_management_template_parameters={'DATABASE_USER': 'root', 'DATABASE_PASSWORD': 'r1ck&M0r7y', 'DATABASE_IP': '10.10.10.10', 'DATABASE_PORT': '5432', 'DATABASE_NAME': 'cfme'}
Note the new value for the openshift_management_app_template
parameter, cfme-template-ext-db (ManageIQ installations would use
miq-template-ext-db instead).
At run time you may run into errors similar to this:
TASK [openshift_management : Ensure the CFME App is created] ***********************************
task path: /home/tbielawa/rhat/os/openshift-ansible/roles/openshift_management/tasks/main.yml:74
Tuesday 03 October 2017 15:30:44 -0400 (0:00:00.056) 0:00:12.278 *******
{"cmd": "/usr/bin/oc create -f /tmp/postgresql-ZPEWQS -n openshift-management",
"kind": "Endpoints", "results": {}, "returncode": 1, "stderr": "Error from server
(BadRequest): error when creating \"/tmp/postgresql-ZPEWQS\": Endpoints in version
\"v1\" cannot be handled as a Endpoints: [pos 218]: json: decNum: got first char
'f'\n", "stdout": ""}
Or like this:
TASK [openshift_management : Ensure the CFME App is created] ***********************************
task path: /home/tbielawa/rhat/os/openshift-ansible/roles/openshift_management/tasks/main.yml:74
Tuesday 03 October 2017 16:05:36 -0400 (0:00:00.052) 0:00:18.948 *******
fatal: [m01.example.com]: FAILED! => {"changed": true, "failed": true, "msg":
{"cmd": "/usr/bin/oc create -f /tmp/postgresql-igS5sx -n openshift-management", "kind":
"Endpoints", "results": {}, "returncode": 1, "stderr": "The Endpoints \"postgresql\"
is invalid: subsets[0].addresses[0].ip: Invalid value: \"doo\": must be a valid IP
address, (e.g. 10.9.8.7)\n", "stdout": ""},
While intimidating at first, there are useful bits of information in
here. Examine the error output closely and we can tell exactly what is
wrong.
In the first example we see Endpoints in version \"v1\" cannot be
handled as a Endpoints: [pos 218]: json: decNum: got first char
.... This is because in my example I used the value foo for the
parameter DATABASE_PORT.
In the second example we see The Endpoints \"postgresql\" is invalid:
subsets[0].addresses[0].ip: Invalid value: \"doo\": must be a valid IP
address .... This is because in my example I used the value doo in
the DATABASE_IP field.
Luckily for us when the templates are processed behind the scenes they
are also running type checking validation. So, don't worry, just look
closely at the errors and ensure you are providing the correct values
for each parameter.
Storage Classes
OpenShift CFME supports several storage class options.
NFS (Default)
The NFS storage class is best suited for proof-of-concept and
test/demo deployments. It is also the default storage class for
deployments. No additional configuration is required for this
choice.
Customization is provided through the following role variables:
openshift_management_storage_nfs_base_diropenshift_management_storage_nfs_local_hostname
NFS External
External NFS leans on pre-configured NFS servers to provide exports
for the required PVs. For external NFS you must have:
- For CFME: a
cfme-app and optionally a cfme-db (for podified database) exports
- For ManageIQ: an
miq-app and optionally an miq-db (for podified database) exports
Configuration is provided through the following role variables:
openshift_management_storage_nfs_external_hostnameopenshift_management_storage_nfs_base_dir
The openshift_management_storage_nfs_external_hostname parameter must be
set to the hostname or IP of your external NFS server.
If /exports is not the parent directory to your exports then you
must set the base directory via the
openshift_management_storage_nfs_base_dir parameter.
For example, if your server export is /exports/hosted/prod/cfme-app
then you must set
openshift_management_storage_nfs_base_dir=/exports/hosted/prod.
Cloud Provider
CFME can also use a cloud provider storage to back required PVs. For
this functionality to work you must have also configured the
openshift_cloudprovider_kind variable and all associated parameters
specific to your chosen cloud provider.
Using this storage class, when the application is created the required
PVs will automatically be provisioned using the configured cloud
provider storage integration.
There are no additional variables to configure the behavior of this
storage class.
Preconfigured (Expert Configuration Only)
The preconfigured storage class implies that you know exactly what
you're doing and that all storage requirements have been taken care
ahead of time. Typically this means that you've already created the
correctly sized PVs.
There are no additional variables to configure the behavior of this
storage class.
Customization
Application and database parameters may be customized by means of the
openshift_management_template_parameters inventory parameter.
For example, if you wanted to reduce the memory requirement of the
PostgreSQL pod then you could configure the parameter like this:
openshift_management_template_parameters={'POSTGRESQL_MEM_REQ': '1Gi'}
When the CFME template is processed 1Gi will be used for the value
of the POSTGRESQL_MEM_REQ template parameter.
Any parameter in the parameters section of the
miq-template.yaml or
miq-template-ext-db.yaml
may be overridden through the openshift_management_template_parameters
hash. This applies to CloudForms installations as well:
cfme-template.yaml,
cfme-template-ext-db.yaml.
Container Provider
There are two methods for enabling container provider integration. You
can manually add OCP/Origin as a container provider, or you can try
the playbooks included with this role.
Manually
See the online documentation for steps to manually add you cluster as
a container provider:
Automatically
Automated container provider integration can be accomplished using the
playbooks included with this role.
This playbook will:
- Gather the necessary authentication secrets
- Find the public routes to the Management app and the cluster API
- Make a REST call to add this cluster as a container provider
$ ansible-playbook -v -i <YOUR_INVENTORY> playbooks/openshift-management/add_container_provider.yml
Multiple Providers
As well as providing playbooks to integrate your current container
platform into the management service, this role includes a tech
preview script which allows you to add multiple container platforms
as container providers in any arbitrary MIQ/CFME server.
Using the multiple-provider script requires manual configuration and
setting an EXTRA_VARS parameter on the command-line.
- Copy the
container_providers.yml
example somewhere, such as
/tmp/cp.yml
- If you changed your CFME/MIQ name or password, update the
hostname, user, and password parameters in the
management_server key in the container_providers.yml file copy
- Fill in an entry under the
container_providers key for each OCP
or Origin cluster you want to add as container providers
Parameters Which MUST Be Configured:
auth_key - This is the token of a service account which has admin capabilities on the cluster.hostname - This is the hostname that points to the cluster API. Each container provider must have a unique hostname.name - This is the name of the cluster as displayed in the management server container providers overview. This must be unique.
Note: You can obtain the auth_key bearer token from your clusters
with this command: oc serviceaccounts get-token -n management-infra
management-admin
Parameters Which MAY Be Configured:
port - Update this key if your OCP/Origin cluster runs the API on a port other than 8443endpoint - You may enable SSL verification (verify_ssl) or change the validation setting to ssl-with-validation. Support for custom trusted CA certificates is not available at this time.
Let's see an example describing the following scenario:
- You copied
files/examples/container_providers.yml to /tmp/cp.yml
- You're adding two OCP clusters
- Your management server runs on
mgmt.example.com
You would customize /tmp/cp.yml as such:
---
container_providers:
- connection_configurations:
- authentication: {auth_key: "management-token-for-this-cluster", authtype: bearer, type: AuthToken}
endpoint: {role: default, security_protocol: ssl-without-validation, verify_ssl: 0}
hostname: "ocp-prod.example.com"
name: OCP Production
port: 8443
type: "ManageIQ::Providers::Openshift::ContainerManager"
- connection_configurations:
- authentication: {auth_key: "management-token-for-this-cluster", authtype: bearer, type: AuthToken}
endpoint: {role: default, security_protocol: ssl-without-validation, verify_ssl: 0}
hostname: "ocp-test.example.com"
name: OCP Testing
port: 8443
type: "ManageIQ::Providers::Openshift::ContainerManager"
management_server:
hostname: "mgmt.example.com"
user: admin
password: b3tt3r_p4SSw0rd
Then you will run the many-container-providers integration script. You
must provide the path to the container providers configuration
file as an EXTRA_VARS parameter to ansible-playbook. Use the -e
(or --extra-vars) parameter to set container_providers_config to
the config file path.
$ ansible-playbook -v -e container_providers_config=/tmp/cp.yml \
playbooks/openshift-management/add_many_container_providers.yml
Afterwards you will find two new container providers in your
management service. Navigate to Compute → Containers → Providers
to see an overview.
Uninstall
This role includes a playbook to uninstall and erase the CFME/MIQ
installation:
playbooks/openshift-management/uninstall.yml
NFS export definitions and data stored on NFS exports are not
automatically removed. You are urged to manually erase any data from
old application or database deployments before attempting to
initialize a new deployment.
Failure to erase old PostgreSQL data can result in cascading
errors. The postgres pod may enter a crashloopbackoff state. This
will block the management pod from ever starting. The cause of the
crashloopbackoff is due to incorrect file permissions on the
database NFS export created during a previous deployment.
To continue, erase all data from the postgres export and delete the
pod (not the deployer pod). For example, if you have pods like
such:
# oc get pods
NAME READY STATUS RESTARTS AGE
httpd-1-cx7fk 1/1 Running 1 21h
manageiq-0 0/1 Running 1 21h
memcached-1-vkc7p 1/1 Running 1 21h
postgresql-1-deploy 1/1 Running 1 21h
postgresql-1-6w2t4 0/1 CrashLoopBackOff 1 21h
Then you would:
- Erase the data from the database NFS export
oc delete postgresql-1-6w2t4
The postgres deployer pod will try to scale up a new postgres pod to
replace the one you deleted. Once the postgres pod is running the
manageiq pod will stop blocking and begin application initialization.
Additional Information
The upstream project,
@manageiq/manageiq-pods,
contains a wealth of additional information useful for managing and
operating your CFME installation. Topics include:
