A reference configuration implemented using Ansible playbooks is available as the advanced installation method for installing a OpenShift Origin cluster. Familiarity with Ansible is assumed, however you can use this configuration as a reference to create your own implementation using the configuration management tool of your choosing.
|
While RHEL Atomic Host is supported for running containerized OpenShift Origin services, the advanced installation method utilizes Ansible, which is not available in RHEL Atomic Host, and must therefore be run from a supported version of Fedora, CentOS, or RHEL. The host initiating the installation does not need to be intended for inclusion in the OpenShift Origin cluster, but it can be. Alternatively, a containerized version of the installer is available as a system container, which is currently a Technology Preview feature. |
|
To install OpenShift Origin as a stand-alone registry, see Installing a Stand-alone Registry. |
Before installing OpenShift Origin, you must first see the Prerequisites and Host Preparation topics to prepare your hosts. This includes verifying system and environment requirements per component type and properly installing and configuring Docker. It also includes installing Ansible version 2.3 or later, as the advanced installation method is based on Ansible playbooks and as such requires directly invoking Ansible.
If you are interested in installing OpenShift Origin using the containerized method (optional for RHEL but required for RHEL Atomic Host), see Installing on Containerized Hosts to ensure that you understand the differences between these methods, then return to this topic to continue.
For large-scale installs, including suggestions for optimizing install time, see the Scaling and Performance Guide.
After following the instructions in the Prerequisites topic, deciding between the RPM and containerized methods and choosing from the on-premises or cloud scenarios, you can continue in this topic to Configuring Ansible Inventory Files.
OpenShift Origin VMs can be provisioned in a cloud environment.
You can use Ansible playbooks to automate defining of your cloud hosted infrastructure and applying post-provision configuration for the supported cloud providers. Follow these advanced installation to help you create the needed playbooks.
As an alternate, you can install OpenShift Origin using the OpenStack CLI. For more information, See the reference architecture for OpenShift Origin 3.6 and Red Hat OpenStack Platform 10.
As a prerequisite to using the Openstack CLI, first provision VMs and configure the cloud infrastructure, such as networking, storage, firewall and security groups. For information on these configuration tasks using the reference architecture, see the cloud provider considerations and Ansible playbooks to automate it. See also Configuring for OpenStack and Configuring Ansible Inventory Files.
The /etc/ansible/hosts file is Ansible’s inventory file for the playbook used to install OpenShift Origin. The inventory file describes the configuration for your OpenShift Origin cluster. You must replace the default contents of the file with your desired configuration.
The following sections describe commonly-used variables to set in your inventory file during an advanced installation, followed by example inventory files you can use as a starting point for your installation.
Many of the Ansible variables described are optional. Accepting the default values should suffice for development environments, but for production environments it is recommended you read through and become familiar with the various options available.
The example inventories describe various environment topographies, including using multiple masters for high availability. You can choose an example that matches your requirements, modify it to match your own environment, and use it as your inventory file when running the advanced installation.
Images require a version number policy in order to maintain updates. See the Image Version Tag Policy section in the Architecture Guide for more information.
To assign environment variables during the Ansible install that apply more globally to your OpenShift Origin cluster overall, indicate the desired variables in the /etc/ansible/hosts file on separate, single lines within the [OSEv3:vars] section. For example:
[OSEv3:vars]
openshift_master_identity_providers=[{'name': 'htpasswd_auth',
'login': 'true', 'challenge': 'true',
'kind': 'HTPasswdPasswordIdentityProvider',
'filename': '/etc/origin/master/htpasswd'}]
openshift_master_default_subdomain=apps.test.example.com
The following table describes variables for use with the Ansible installer that can be assigned cluster-wide:
| Variable | Purpose |
|---|---|
|
This variable sets the SSH user for the installer to use and defaults to
|
|
If |
|
This variable sets which INFO messages are logged to the
For more information on debug log levels, see Configuring Logging Levels. |
|
If set to |
|
This variable sets the parameter and arbitrary JSON values as per the requirement in your inventory hosts file. |
|
This variable enables API service auditing. See Audit Configuration for more information. |
|
This variable overrides the host name for the cluster, which defaults to the host name of the master. |
|
This variable overrides the public host name for the cluster, which defaults to the host name of the master. |
|
Optional. This variable defines the HA method when deploying multiple masters.
Supports the |
|
This variable enables rolling restarts of HA masters (i.e., masters are taken
down one at a time) when
running
the upgrade playbook directly. It defaults to |
|
This variable configures which
OpenShift SDN plug-in to
use for the pod network, which defaults to |
|
This variable overrides the identity provider, which defaults to Deny All. |
|
These variables are used to configure custom certificates which are deployed as part of the installation. See Configuring Custom Certificates for more information. |
|
|
|
Validity of the auto-generated registry certificate in days. Defaults to |
|
Validity of the auto-generated CA certificate in days. Defaults to |
|
Validity of the auto-generated node certificate in days. Defaults to |
|
Validity of the auto-generated master certificate in days. Defaults to |
|
Validity of the auto-generated external etcd certificates in days. Controls
validity for etcd CA, peer, server and client certificates. Defaults to |
|
Set to |
|
These variables override defaults for session options in the OAuth configuration. See Configuring Session Options for more information. |
|
|
|
|
|
|
|
This variable configures |
|
This variable configures the subnet in which
services
will be created within the
OpenShift Origin
SDN. This network block should be private and must not conflict with any
existing network blocks in your infrastructure to which pods, nodes, or the
master may require access to, or the installation will fail. Defaults to
|
|
This variable overrides the default subdomain to use for exposed routes. |
|
Sets |
|
This variable specifies the
service
proxy mode to use: either |
|
Default node selector for automatically deploying router pods. See Configuring Node Host Labels for details. |
|
Default node selector for automatically deploying registry pods. See Configuring Node Host Labels for details. |
|
This variable enables the template service broker by specifying one or more namespaces whose templates will be served by the broker. |
|
This variable overrides the node selector that projects will use by default when placing pods. |
|
This variable overrides the
SDN
cluster network CIDR block. This is the network from which pod IPs are
assigned. This network block should be a private block and must not conflict
with existing network blocks in your infrastructure to which pods, nodes, or the
master may require access. Defaults to |
|
This variable specifies the size of the per host subnet allocated for pod IPs
by
OpenShift Origin
SDN. Defaults to |
|
This variable enables flannel as an alternative networking layer instead of
the default SDN. If enabling flannel, disable the default SDN with the
|
|
OpenShift Origin adds the specified additional registry or registries to the docker configuration. These are the registries to search. |
|
OpenShift Origin adds the specified additional insecure registry or registries to
the docker configuration. For any of these registries, secure sockets layer
(SSL) is not verified. Also, add these registries to
|
|
OpenShift Origin adds the specified blocked registry or registries to the
docker configuration. Block the listed registries. Setting this to |
|
This variable sets the host name for integration with the metrics console by
overriding |
|
This variable is a cluster identifier unique to the AWS Availability Zone. Using this avoids potential issues in Amazon Web Service (AWS) with multiple zones or multiple clusters. See Labeling Clusters for AWS for details. |
|
Use this variable to specify a container image tag to install or configure. |
|
Use this variable to specify an RPM version to install or configure. |
|
If you modify the
|
Various defaults used throughout the playbooks and roles used by the installer are based on the deployment type configuration (usually defined in an Ansible inventory file).
Ensure the openshift_deployment_type parameter in your inventory file’s [OSEv3:vars]
section is set to origin to install the OpenShift Origin variant:
[OSEv3:vars] openshift_deployment_type=origin
To assign environment variables to hosts during the Ansible installation, indicate the desired variables in the /etc/ansible/hosts file after the host entry in the [masters] or [nodes] sections. For example:
[masters] ec2-52-6-179-239.compute-1.amazonaws.com openshift_public_hostname=ose3-master.public.example.com
The following table describes variables for use with the Ansible installer that can be assigned to individual host entries:
| Variable | Purpose |
|---|---|
|
This variable overrides the internal cluster host name for the system. Use this when the system’s default IP address does not resolve to the system host name. |
|
This variable overrides the system’s public host name. Use this for cloud installations, or for hosts on networks using a network address translation (NAT). |
|
This variable overrides the cluster internal IP address for the system. Use this when using an interface that is not configured with the default route. |
|
This variable overrides the system’s public IP address. Use this for cloud installations, or for hosts on networks using a network address translation (NAT). |
|
If set to true, containerized OpenShift Origin services are run on the target master and node hosts instead of installed using RPM packages. If set to false or unset, the default RPM method is used. RHEL Atomic Host requires the containerized method, and is automatically selected for you based on the detection of the /run/ostree-booted file. See Installing on Containerized Hosts for more details. |
|
This variable adds labels to nodes during installation. See Configuring Node Host Labels for more details. |
|
This variable is used to configure |
|
This variable configures additional "--log-driver json-file --log-opt max-size=1M --log-opt max-file=3" "--log-driver journald" Do not use when
running |
|
This variable configures whether the host is marked as a schedulable node, meaning that it is available for placement of new pods. See Configuring Schedulability on Masters. |
To configure the default ports used by the master API and web console, configure the following variables in the /etc/ansible/hosts file:
| Variable | Purpose |
|---|---|
|
This variable sets the port number to access the OpenShift Origin API. |
|
This variable sets the console port number to access the OpenShift Origin console with a web browser. |
For example:
openshift_master_api_port=3443 openshift_master_console_port=8756
Pre-install checks are a set of diagnostic tasks that run as part of the openshift_health_checker Ansible role. They run prior to an Ansible installation of OpenShift Origin, ensure that required inventory values are set, and identify potential issues on a host that can prevent or interfere with a successful installation.
The following table describes available pre-install checks that will run before every Ansible installation of OpenShift Origin:
| Check Name | Purpose |
|---|---|
|
This check ensures that a host has the recommended amount of memory for the
specific deployment of OpenShift Origin. Default values have been derived from
the
latest
installation documentation. A user-defined value for minimum memory
requirements may be set by setting the |
|
This check only runs on etcd, master, and node hosts. It ensures that the mount
path for an OpenShift Origin installation has sufficient disk space remaining.
Recommended disk values are taken from the
latest
installation documentation. A user-defined value for minimum disk space
requirements may be set by setting |
|
Only runs on hosts that depend on the docker daemon (nodes and containerized
installations). Checks that docker's total usage does not exceed a
user-defined limit. If no user-defined limit is set, docker's maximum usage
threshold defaults to 90% of the total size available. The threshold limit for
total percent usage can be set with a variable in your inventory file:
|
|
Ensures that the docker daemon is using a storage driver supported by
OpenShift Origin. If the
|
|
Attempts to ensure that images required by an OpenShift Origin installation are available either locally or in at least one of the configured container image registries on the host machine. |
|
Runs on |
|
Runs prior to non-containerized installations of OpenShift Origin. Ensures that RPM packages required for the current installation are available. |
|
Checks whether a |
To disable specific pre-install checks, include the variable
openshift_disable_check with a comma-delimited list of check names in your
inventory file. For example:
openshift_disable_check=memory_availability,disk_availability
|
A similar set of health checks meant to run for diagnostics on existing clusters can be found in Ansible-based Health Checks. Another set of checks for checking certificate expiration can be found in Redeploying Certificates. |
|
All system container components are Tech Preview features in OpenShift Origin 3.7. They must not be used in production and they are not supported for upgrades to OpenShift Origin 3.7. During this phase, they are only meant for use with new cluster installations in non-production environments. |
System containers provide a way to containerize services that need to run before
the docker daemon is running. They are Docker-formatted containers that use:
System containers are therefore stored and run outside of the traditional
docker service. For more details on system container technology, see
Running System Containers in the Red Hat Enterprise Linux Atomic Host: Managing Containers documentation.
You can configure your OpenShift Origin installation to run certain components as
system containers instead of their RPM or standard containerized methods.
Currently, the docker and etcd components can be run as system containers in
OpenShift Origin.
|
System containers are currently OS-specific because they require specific
versions of |
|
All system container components are Tech Preview features in OpenShift Origin 3.7. They must not be used in production and they are not supported for upgrades to OpenShift Origin 3.7. During this phase, they are only meant for use with new cluster installations in non-production environments. |
The traditional method for using docker in an OpenShift Origin cluster is an
RPM package installation. For Red Hat Enterprise Linux (RHEL) systems, it must be
specifically installed; for RHEL Atomic Host systems, it is provided by default.
However, you can configure your OpenShift Origin installation to alternatively
run docker on node hosts as a system container. When using the system
container method, the container-engine container image and systemd service is
used on the host instead of the docker package and service.
To run docker as a system container:
Because the default storage back end for Docker on RHEL 7 is a thin pool on
loopback devices, for any RHEL systems you must still configure a thin pool
logical volume for docker to use before running the OpenShift Origin
installation. You can skip these steps for any RHEL Atomic Host systems.
For any RHEL systems, perform the steps described in the following sections:
After completing the storage configuration steps, you can leave the RPM installed.
Set the following cluster variable to True in your inventory file in the
[OSEv3:vars] section:
openshift_docker_use_system_container=True
When using the system container method, the following inventory variables for
docker are ignored:
docker_version
docker_upgrade
Further, the following inventory variable must not be used:
openshift_docker_options
You can also force docker in the system container to use a specific container
registry and repository when pulling the container-engine image instead of
from the default registry.access.redhat.com/openshift3/. To do so, set the
following cluster variable in your inventory file in the [OSEv3:vars] section:
openshift_docker_systemcontainer_image_override="<registry>/<user>/<image>:<tag>"
|
All system container components are Tech Preview features in OpenShift Origin 3.7. They must not be used in production and they are not supported for upgrades to OpenShift Origin 3.7. During this phase, they are only meant for use with new cluster installations in non-production environments. |
When using the RPM-based installation method for OpenShift Origin, etcd is
installed using RPM packages on any RHEL systems. When using the containerized
installation method, the rhel7/etcd image is used instead for RHEL or RHEL
Atomic Hosts.
However, you can configure your OpenShift Origin installation to alternatively
run etcd as a system container. Whereas the standard containerized method uses
a systemd service named etcd_container, the system container method uses the
service name etcd, same as the RPM-based method. The data directory for etcd
using this method is /var/lib/etcd.
To run etcd as a system container, set the following cluster variable in your
inventory file in the [OSEv3:vars] section:
openshift_use_etcd_system_container=True
If you are using an image registry other than the default at
registry.access.redhat.com, specify the desired registry within the
/etc/ansible/hosts file.
oreg_url={registry}/openshift3/ose-${component}:${version}
openshift_examples_modify_imagestreams=true
| Variable | Purpose |
|---|---|
|
Set to the alternate image location. Necessary if you are not using the default registry at |
|
Set to |
|
Specify the additional registry or registries. |
For example:
oreg_url=example.com/openshift3/ose-${component}:${version}
openshift_examples_modify_imagestreams=true
openshift_docker_additional_registries=example.com
If you are using a Cockpit registry console image other than the default or require a specific version of the console, specify the desired registry within the /etc/ansible/hosts file.
openshift_cockpit_deployer_prefix=<registry-name>/<namespace>/ openshift_cockpit_deployer_version=<cockpit-image-tag>
| Variable | Purpose |
|---|---|
|
Specify the URL and path to the directory where the image is located. |
|
Specify the Cockpit image verion. |
For example: If your image is at registry.example.com/openshift3/registry-console and you require version 1.4.1, enter:
openshift_cockpit_deployer_prefix='registry.example.com/openshift3/' openshift_cockpit_deployer_version='1.4.1'
There are several options for enabling registry storage when using the advanced install:
When the following variables are set, an NFS volume is created during an
advanced install with the path <nfs_directory>/<volume_name> on the host
within the [nfs] host group. For example, the volume path using these options
would be /exports/registry:
[OSEv3:vars] openshift_hosted_registry_storage_kind=nfs openshift_hosted_registry_storage_access_modes=['ReadWriteMany'] openshift_hosted_registry_storage_nfs_directory=/exports openshift_hosted_registry_storage_nfs_options='*(rw,root_squash)' openshift_hosted_registry_storage_volume_name=registry openshift_hosted_registry_storage_volume_size=10Gi
To use an external NFS volume, one must already exist with a path of <nfs_directory>/<volume_name> on the storage host. The remote volume path using the following options would be nfs.example.com:/exports/registry.
[OSEv3:vars] openshift_hosted_registry_storage_kind=nfs openshift_hosted_registry_storage_access_modes=['ReadWriteMany'] openshift_hosted_registry_storage_host=nfs.example.com openshift_hosted_registry_storage_nfs_directory=/exports openshift_hosted_registry_storage_volume_name=registry openshift_hosted_registry_storage_volume_size=10Gi
An OpenStack storage configuration must already exist.
openshift_hosted_registry_storage_kind=openstack openshift_hosted_registry_storage_access_modes=['ReadWriteOnce'] openshift_hosted_registry_storage_openstack_filesystem=ext4 openshift_hosted_registry_storage_openstack_volumeID=3a650b4f-c8c5-4e0a-8ca5-eaee11f16c57 openshift_hosted_registry_storage_volume_size=10Gi
The simple storage solution (S3) bucket must already exist.
#openshift_hosted_registry_storage_kind=object #openshift_hosted_registry_storage_provider=s3 #openshift_hosted_registry_storage_s3_accesskey=access_key_id #openshift_hosted_registry_storage_s3_secretkey=secret_access_key #openshift_hosted_registry_storage_s3_bucket=bucket_name #openshift_hosted_registry_storage_s3_region=bucket_region #openshift_hosted_registry_storage_s3_chunksize=26214400 #openshift_hosted_registry_storage_s3_rootdirectory=/registry #openshift_hosted_registry_pullthrough=true #openshift_hosted_registry_acceptschema2=true #openshift_hosted_registry_enforcequota=true
If you are using a different S3 service, such as Minio or ExoScale, also add the region endpoint parameter:
openshift_hosted_registry_storage_s3_regionendpoint=https://myendpoint.example.com/
GlusterFS can be configured to provide peristent storage and dynamic provisioning for OpenShift Origin. It can be used both containerized within OpenShift Origin and non-containerized on its own nodes.
See Running Containerized GlusterFS in Kubernetes for additional information on containerized storage using GlusterFS.
|
See Containerized GlusterFS Considerations for specific host preparations and prerequisites. |
In your inventory file, add glusterfs in the [OSEv3:children] section to
enable the [glusterfs] group:
[OSEv3:children] masters nodes glusterfs
(Optional) Include any of the following role variables in the [OSEv3:vars]
section you wish to change:
[OSEv3:vars] openshift_storage_glusterfs_namespace=glusterfs (1) openshift_storage_glusterfs_name=storage (2)
| 1 | The project (namespace) to host the storage pods. Defaults to glusterfs. |
| 2 | A name to identify the GlusterFS cluster, which will be used in resource names.
Defaults to storage. |
Add a [glusterfs] section with entries for each storage node that will host
the GlusterFS storage and include the glusterfs_ip and
glusterfs_devices parameters in the form:
<hostname_or_ip> glusterfs_ip=<ip_address> glusterfs_devices='[ "</path/to/device1/>", "</path/to/device2>", ... ]'
For example:
[glusterfs] 192.168.10.11 glusterfs_ip=192.168.10.11 glusterfs_devices='[ "/dev/xvdc", "/dev/xvdd" ]' 192.168.10.12 glusterfs_ip=192.168.10.12 glusterfs_devices='[ "/dev/xvdc", "/dev/xvdd" ]' 192.168.10.13 glusterfs_ip=192.168.10.13 glusterfs_devices='[ "/dev/xvdc", "/dev/xvdd" ]'
Set glusterfs_devices to a list of raw block devices that will be completely
managed as part of a GlusterFS cluster. There must be at least one device
listed. Each device must be bare, with no partitions or LVM PVs. Set
glusterfs_ip to the IP address that will be used by pods to communicate with
the GlusterFS node.
Add the hosts listed under [glusterfs] to the [nodes] group as well:
[nodes] 192.168.10.11 192.168.10.12 192.168.10.13
After completing the cluster installation per Running the Advanced Installation, run the following from a master to verify the necessary objects were successfully created:
Verfiy that the GlusterFS StorageClass was created:
# oc get storageclass NAME TYPE glusterfs-storage kubernetes.io/glusterfs
Verify that the route was created:
# oc get routes NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD heketi-glusterfs-route heketi-glusterfs-default.cloudapps.example.com heketi-glusterfs <all> None
|
The name for the route will be |
Use curl to verify the route works correctly:
# curl http://heketi-glusterfs-default.cloudapps.example.com/hello Hello from Heketi.
After successful installation, see Operations on a Red Hat Gluster Storage Pod in an OpenShift Environment to check the status of the GlusterFS clusters.
Dynamic provisioning of GlusterFS volumes can occur by creating a PVC to request storage.
Additional configuration options are available at installation time for the OpenShift Container Registry.
If no registry storage options are used, the default OpenShift Origin registry is ephermal and all data will be lost if the pod no longer exists. OpenShift Origin also supports a single node NFS-backed registry, but this option lacks redundancy and reliability compared with the GlusterFS-backed option.
Similar to configuring containerized GlusterFS for persistent storage, GlusterFS storage can be configured and deployed for an OpenShift Container Registry during the initial installation of the cluster to offer redundant and more reliable storage for the registry.
|
See Containerized GlusterFS Considerations for specific host preparations and prerequisites. |
Configuration of storage for an OpenShift Container Registry is very similar to configuration for GlusterFS persistent storage in that it can be either containerized or non-containerized. For this containerized method, the following exceptions and additions apply:
In your inventory file, add glusterfs_registry in the [OSEv3:children] section
to enable the [glusterfs_registry] group:
[OSEv3:children] masters nodes glusterfs_registry
Add the following role variable in the [OSEv3:vars] section to enable the
GlusterFS-backed registry, provided that the glusterfs_registry group name and
the [glusterfs_registry] group exist:
[OSEv3:vars] openshift_hosted_registry_storage_kind=glusterfs
It is recommended to have at least three registry pods, so set the following
role variable in the [OSEv3:vars] section:
openshift_hosted_registry_replicas=3
If you want to specify the volume size for the GlusterFS-backed registry, set
the following role variable in [OSEv3:vars] section:
openshift_hosted_registry_storage_volume_size=10Gi
If unspecified, the volume size defaults to 5Gi.
The installer will deploy the OpenShift Container Registry pods and associated
routers on nodes containing the region=infra label. Add this label on at least
one node entry in the [nodes] section, otherwise the registry deployment will
fail. For example:
[nodes]
192.168.10.14 openshift_schedulable=True openshift_node_labels="{'region': 'infra'}"
Add a [glusterfs_registry] section with entries for each storage node that
will host the GlusterFS-backed registry and include the glusterfs_ip and
glusterfs_devices parameters in the form:
<hostname_or_ip> glusterfs_ip=<ip_address> glusterfs_devices='[ "</path/to/device1/>", "</path/to/device2>", ... ]'
For example:
[glusterfs_registry] 192.168.10.14 glusterfs_ip=192.168.10.14 glusterfs_devices='[ "/dev/xvdc", "/dev/xvdd" ]' 192.168.10.15 glusterfs_ip=192.168.10.15 glusterfs_devices='[ "/dev/xvdc", "/dev/xvdd" ]' 192.168.10.16 glusterfs_ip=192.168.10.16 glusterfs_devices='[ "/dev/xvdc", "/dev/xvdd" ]'
Set glusterfs_devices to a list of raw block devices that will be completely
managed as part of a GlusterFS cluster. There must be at least one device
listed. Each device must be bare, with no partitions or LVM PVs. Set
glusterfs_ip to the IP address that will be used by pods to communicate with
the GlusterFS node.
Add the hosts listed under [glusterfs_registry] to the [nodes] group as well:
[nodes] 192.168.10.14 192.168.10.15 192.168.10.16
After successful installation, see Operations on a Red Hat Gluster Storage Pod in an OpenShift Environment to check the status of the GlusterFS clusters.
If your hosts require use of a HTTP or HTTPS proxy in order to connect to external hosts, there are many components that must be configured to use the proxy, including masters, Docker, and builds. Node services only connect to the master API requiring no external access and therefore do not need to be configured to use a proxy.
In order to simplify this configuration, the following Ansible variables can be specified at a cluster or host level to apply these settings uniformly across your environment.
|
See Configuring Global Build Defaults and Overrides for more information on how the proxy environment is defined for builds. |
| Variable | Purpose |
|---|---|
|
This variable specifies the |
|
This variable specifices the |
|
This variable is used to set the |
|
This boolean variable specifies whether or not the names of all defined
OpenShift hosts and |
|
This variable defines the |
|
This variable defines the |
|
This variable defines the |
|
This variable defines the HTTP proxy used by |
|
This variable defines the HTTPS proxy used by |
If any of:
openshift_no_proxy
openshift_https_proxy
openshift_http_proxy
are set, then all cluster hosts will have an automatically generated NO_PROXY
environment variable injected into several service configuration scripts. The
default .svc domain and your cluster’s dns_domain (typically
.cluster.local) will also be added.
|
Setting |
|
If you are changing the default firewall, ensure that each host in your cluster is using the same firewall type to prevent inconsistencies. |
|
While iptables is the default firewall, firewalld is recommended for new installations. |
OpenShift Origin uses iptables as the default firewall, but you can configure your cluster to use firewalld during the install process.
Because iptables is the default firewall, OpenShift Origin is designed to have it configured automatically. However, iptables rules can break OpenShift Origin if not configured correctly. The advantages of firewalld include allowing multiple objects to safely share the firewall rules.
To use firewalld as the firewall for an OpenShift Origin installation, add the
os_firewall_use_firewalld variable to the list of configuration variables in
the Ansible host file at install:
[OSEv3:vars] os_firewall_use_firewalld=True
Any hosts you designate as masters during the installation process should also
be configured as nodes so that the masters are configured as part of the
OpenShift SDN. You must do so by adding entries for these hosts to the [nodes] section:
[nodes] master.example.com
In order to ensure that your masters are not burdened with running pods, they
are automatically marked unschedulable by default by the installer, meaning that
new pods cannot be placed on the hosts. This is the same as setting the
openshift_schedulable=false host variable.
You can manually set a master host to schedulable during installation using the
openshift_schedulable=true host variable, though this is not recommended in
production environments:
[nodes] master.example.com openshift_schedulable=true
If you want to change the schedulability of a host post-installation, see Marking Nodes as Unschedulable or Schedulable.
You can assign
labels to
node hosts during the Ansible install by configuring the /etc/ansible/hosts
file. Labels are useful for determining the placement of pods onto nodes using
the scheduler.
Other than region=infra (discussed in
Configuring Dedicated Infrastructure Nodes), the actual label names and values are arbitrary and can
be assigned however you see fit per your cluster’s requirements.
To assign labels to a node host during an Ansible install, use the
openshift_node_labels variable with the desired labels added to the desired
node host entry in the [nodes] section. In the following example, labels are
set for a region called primary and a zone called east:
[nodes]
node1.example.com openshift_node_labels="{'region': 'primary', 'zone': 'east'}"
The openshift_router_selector and openshift_registry_selector Ansible
settings determine the label selectors used when placing registry and router
pods. They are set to region=infra by default:
# default selectors for router and registry services # openshift_router_selector='region=infra' # openshift_registry_selector='region=infra'
The registry and router are only able to run on node hosts with the region=infra label.
Ensure that at least one node host in your OpenShift Origin environment has the region=infra label. For example:
[nodes]
infra-node1.example.com openshift_node_labels="{'region': 'infra','zone': 'default'}"
|
If there is not a node in the [nodes] section that matches the selector settings,
the default router and registry will be deployed as failed with |
It is recommended for production environments that you maintain dedicated infrastructure nodes where the registry and router pods can run separately from pods used for user applications.
If you do not intend to use OpenShift Origin to manage the registry and router, configure the following Ansible settings:
openshift_hosted_manage_registry=false openshift_hosted_manage_router=false
If you are using an image registry other than the default registry.access.redhat.com,
you need to specify the desired registry
in the /etc/ansible/hosts file.
As described in Configuring
Schedulability on Masters, master hosts are marked unschedulable by default. If
you label a master host with region=infra and have no other dedicated
infrastructure nodes, you must also explicitly mark these master hosts as
schedulable. Otherwise, the registry and router pods cannot be placed anywhere:
[nodes]
master.example.com openshift_node_labels="{'region': 'infra','zone': 'default'}" openshift_schedulable=true
Session
options in the OAuth configuration are configurable in the inventory file. By
default, Ansible populates a sessionSecretsFile with generated
authentication and encryption secrets so that sessions generated by one master
can be decoded by the others. The default location is
/etc/origin/master/session-secrets.yaml, and this file will only be
re-created if deleted on all masters.
You can set the session name and maximum number of seconds with
openshift_master_session_name and openshift_master_session_max_seconds:
openshift_master_session_name=ssn openshift_master_session_max_seconds=3600
If provided, openshift_master_session_auth_secrets and
openshift_master_encryption_secrets must be equal length.
For openshift_master_session_auth_secrets, used to authenticate sessions
using HMAC, it is recommended to use secrets with 32 or 64 bytes:
openshift_master_session_auth_secrets=['DONT+USE+THIS+SECRET+b4NV+pmZNSO']
For openshift_master_encryption_secrets, used to encrypt sessions, secrets
must be 16, 24, or 32 characters long, to select AES-128, AES-192, or AES-256:
openshift_master_session_encryption_secrets=['DONT+USE+THIS+SECRET+b4NV+pmZNSO']
Custom serving certificates for the public host names of the OpenShift Origin API and web console can be deployed during an advanced installation and are configurable in the inventory file.
|
Custom certificates should only be configured for the host name associated with
the |
Certificate and key file paths can be configured using the
openshift_master_named_certificates cluster variable:
openshift_master_named_certificates=[{"certfile": "/path/to/custom1.crt", "keyfile": "/path/to/custom1.key", "cafile": "/path/to/custom-ca1.crt"}]
File paths must be local to the system where Ansible will be run. Certificates are copied to master hosts and are deployed within the /etc/origin/master/named_certificates/ directory.
Ansible detects a certificate’s Common Name and Subject Alternative Names.
Detected names can be overridden by providing the "names" key when setting
openshift_master_named_certificates:
openshift_master_named_certificates=[{"certfile": "/path/to/custom1.crt", "keyfile": "/path/to/custom1.key", "names": ["public-master-host.com"], "cafile": "/path/to/custom-ca1.crt"}]
Certificates configured using openshift_master_named_certificates are cached
on masters, meaning that each additional Ansible run with a different set of
certificates results in all previously deployed certificates remaining in place
on master hosts and within the master configuration file.
If you would like openshift_master_named_certificates to be overwritten with
the provided value (or no value), specify the
openshift_master_overwrite_named_certificates cluster variable:
openshift_master_overwrite_named_certificates=true
For a more complete example, consider the following cluster variables in an inventory file:
openshift_master_cluster_method=native openshift_master_cluster_hostname=lb.openshift.com openshift_master_cluster_public_hostname=custom.openshift.com
To overwrite the certificates on a subsequent Ansible run, you could set the following:
openshift_master_named_certificates=[{"certfile": "/root/STAR.openshift.com.crt", "keyfile": "/root/STAR.openshift.com.key", "names": ["custom.openshift.com"]}]
openshift_master_overwrite_named_certificates=true
By default, the certificates used to govern the etcd, master, and kubelet expire after two to five years. The validity (length in days until they expire) for the auto-generated registry, CA, node, and master certificates can be configured during installation using the following variables (default values shown):
[OSEv3:vars] openshift_hosted_registry_cert_expire_days=730 openshift_ca_cert_expire_days=1825 openshift_node_cert_expire_days=730 openshift_master_cert_expire_days=730 etcd_ca_default_days=1825
These values are also used when redeploying certificates via Ansible post-installation.
Starting with OpenShift Origin 3.7, cluster metrics are set to deploy automatically by default during installation:
|
To disable automatic deployment, set the following cluster variable: openshift_metrics_install_metrics=false |
The OpenShift Origin web console uses the data coming from the Hawkular Metrics
service to display its graphs. The metrics public URL can be set during cluster
installation using the openshift_metrics_hawkular_hostname Ansible variable,
which defaults to:
https://hawkular-metrics.{{openshift_master_default_subdomain}}/hawkular/metrics
If you alter this variable, ensure the host name is accessible via your router.
The openshift_metrics_cassandra_storage_type variable must be set in order to
use persistent storage for metrics. If
openshift_metrics_cassandra_storage_type is not set, then cluster metrics data
is stored in an emptyDir volume, which will be deleted when the Cassandra pod
terminates.
There are three options for enabling cluster metrics storage when using the advanced install:
When the following variables are set, an NFS volume is created during an
advanced install with path <nfs_directory>/<volume_name> on the host within
the [nfs] host group. For example, the volume path using these options would
be /exports/metrics:
[OSEv3:vars] openshift_metrics_storage_kind=nfs openshift_metrics_storage_access_modes=['ReadWriteOnce'] openshift_metrics_storage_nfs_directory=/exports openshift_metrics_storage_nfs_options='*(rw,root_squash)' openshift_metrics_storage_volume_name=metrics openshift_metrics_storage_volume_size=10Gi
To use an external NFS volume, one must already exist with a path of <nfs_directory>/<volume_name> on the storage host.
[OSEv3:vars] openshift_metrics_storage_kind=nfs openshift_metrics_storage_access_modes=['ReadWriteOnce'] openshift_metrics_storage_host=nfs.example.com openshift_metrics_storage_nfs_directory=/exports openshift_metrics_storage_volume_name=metrics openshift_metrics_storage_volume_size=10Gi
The remote volume path using the following options would be nfs.example.com:/exports/metrics.
Use the following variable if your OpenShift Origin environment supports dynamic volume provisioning for your cloud provider:
[OSEv3:vars] openshift_metrics_cassandra_storage_type=dynamic
Cluster logging is not set to automatically deploy by default. Set the following to enable cluster logging when using the advanced installation method:
[OSEv3:vars] openshift_logging_install_logging=true
The openshift_logging_storage_kind variable must be set in order to use
persistent storage for logging. If openshift_logging_storage_kind is
not set, then cluster logging data is stored in an emptyDir volume, which will
be deleted when the Elasticsearch pod terminates.
There are three options for enabling cluster logging storage when using the advanced install:
When the following variables are set, an NFS volume is created during an
advanced install with path <nfs_directory>/<volume_name> on the host within
the [nfs] host group. For example, the volume path using these options would be
/exports/logging:
[OSEv3:vars] openshift_logging_storage_kind=nfs openshift_logging_storage_access_modes=['ReadWriteOnce'] openshift_logging_storage_nfs_directory=/exports openshift_logging_storage_nfs_options='*(rw,root_squash)' openshift_logging_storage_volume_name=logging openshift_logging_storage_volume_size=10Gi
To use an external NFS volume, one must already exist with a path of <nfs_directory>/<volume_name> on the storage host.
[OSEv3:vars] openshift_logging_storage_kind=nfs openshift_logging_storage_access_modes=['ReadWriteOnce'] openshift_logging_storage_host=nfs.example.com openshift_logging_storage_nfs_directory=/exports openshift_logging_storage_volume_name=logging openshift_logging_storage_volume_size=10Gi
The remote volume path using the following options would be nfs.example.com:/exports/logging.
Use the following variable if your OpenShift Origin environment supports dynamic volume provisioning for your cloud provider:
[OSEv3:vars] openshift_logging_storage_kind=dynamic
Starting with OpenShift Origin 3.7, the service catalog is enabled by default during installation. Enabling the service broker allows service brokers to be registered with the catalog. The web console is also configured to enable an updated landing page for browsing the catalog.
|
To disable automatic deployment, set the following cluster variables in your inventory file: openshift_enable_service_catalog=false openshift_service_catalog_image_prefix=openshift/origin- openshift_service_catalog_image_version=latest |
When the service catalog is enabled, the web console shows the updated landing page. The OpenShift Ansible broker and template service broker are both enabled as well; see Configuring the OpenShift Ansible Broker and Configuring the Template Service Broker for more information.
Starting with OpenShift Origin 3.7, the OpenShift Ansible broker (OAB) is enabled by default. However, further configuration may be required for use.
The OAB deploys its own etcd instance separate from the etcd used by the rest of
the OpenShift Origin cluster. The OAB’s etcd instance requires separate storage
using persistent volumes (PVs) to function. If no PV is available, etcd will
wait until the PV can be satisfied. The OAB application will enter a CrashLoop
state until its etcd instance is available.
Some Ansible playbook bundles (APBs) may also require a PV for their own usage. Two APBs are currently provided with OpenShift Origin 3.7: MediaWiki and PostgreSQL. Both of these require their own PV to deploy.
|
The following example shows usage of an NFS host to provide the required PVs, but other persistent storage providers can be used instead. |
To configure persistent storage for the OAB:
In your inventory file, add nfs to the [OSEv3:children] section to enable
the [nfs] group:
[OSEv3:children] masters nodes nfs
Add a [nfs] group section and add the host name for the system that will
be the NFS host:
[nfs] master1.example.com
Add the following in the [OSEv3:vars] section:
openshift_hosted_etcd_storage_kind=nfs
openshift_hosted_etcd_storage_nfs_options="*(rw,root_squash,sync,no_wdelay)"
openshift_hosted_etcd_storage_nfs_directory=/opt/osev3-etcd (1)
openshift_hosted_etcd_storage_volume_name=etcd-vol2 (1)
openshift_hosted_etcd_storage_access_modes=["ReadWriteOnce"]
openshift_hosted_etcd_storage_volume_size=1G
openshift_hosted_etcd_storage_labels={'storage': 'etcd'}
ansible_service_broker_image_prefix=openshift/
ansible_service_broker_registry_url="registry.access.redhat.com"
ansible_service_broker_registry_user=<user_name> (2)
ansible_service_broker_registry_password=<password> (2)
ansible_service_broker_registry_organization=<organization> (2)
| 1 | An NFS volume will be created with path <nfs_directory>/<volume_name> on the
host within the [nfs] group. For example, the volume path using these options
would be /opt/osev3-etcd/etcd-vol2. |
| 2 | Only required if ansible_service_broker_registry_url is set to a registry that
requires authentication for pulling APBs. |
These settings create a persistent volume that is attached to the OAB’s etcd instance during cluster installation.
In order to do APB development with the OpenShift Container Registry in conjunction with the OAB, a whitelist of images the OAB can access must be defined. If a whitelist is not defined, the broker will ignore APBs and users will not see any APBs available.
By default, the whitelist is empty so that a user cannot add APB images to the
broker without a cluster administrator configuring the broker. To whitelist all
images that end in -apb:
In your inventory file, add the following to the [OSEv3:vars] section:
ansible_service_broker_local_registry_whitelist=['.*-apb$']
Starting with OpenShift Origin 3.7, the template service broker (TSB) is enabled by default.
To configure the TSB, one or more projects must be defined as the broker’s
source namespace(s) for loading templates and image streams into the service
catalog. Set the desired projects by modifying the following in your inventory
file’s [OSEv3:vars] section:
openshift_template_service_broker_namespaces=['openshift','myproject']
The following Ansible variables set master configuration options for customizing the web console. See Customizing the Web Console for more details on these customization options.
| Variable | Purpose |
|---|---|
|
Sets |
|
Sets |
|
Sets |
|
Sets |
|
Sets the OAuth template in the master configuration. See Customizing the Login Page for details. Example value: |
|
Sets |
|
Sets |
You can configure an environment with a single master and multiple nodes, and either a single or multiple number of external etcd hosts.
|
Moving from a single master cluster to multiple masters after installation is not supported. |
The following table describes an example environment for a single
master
(with a single etcd on the same host), two
nodes
for hosting user applications, and two nodes with the region=infra label for hosting
dedicated infrastructure:
| Host Name | Infrastructure Component to Install |
|---|---|
master.example.com |
Master, etcd, and node |
node1.example.com |
Node |
node2.example.com |
|
infra-node1.example.com |
Node (with |
infra-node2.example.com |
You can see these example hosts present in the [masters], [etcd], and [nodes] sections of the following example inventory file:
# Create an OSEv3 group that contains the masters, nodes, and etcd groups
[OSEv3:children]
masters
nodes
etcd
# Set variables common for all OSEv3 hosts
[OSEv3:vars]
# SSH user, this user should allow ssh based auth without requiring a password
ansible_ssh_user=root
# If ansible_ssh_user is not root, ansible_become must be set to true
#ansible_become=true
openshift_deployment_type=origin
# uncomment the following to enable htpasswd authentication; defaults to DenyAllPasswordIdentityProvider
#openshift_master_identity_providers=[{'name': 'htpasswd_auth', 'login': 'true', 'challenge': 'true', 'kind': 'HTPasswdPasswordIdentityProvider', 'filename': '/etc/origin/master/htpasswd'}]
# host group for masters
[masters]
master.example.com
# host group for etcd
[etcd]
master.example.com
# host group for nodes, includes region info
[nodes]
master.example.com
node1.example.com openshift_node_labels="{'region': 'primary', 'zone': 'east'}"
node2.example.com openshift_node_labels="{'region': 'primary', 'zone': 'west'}"
infra-node1.example.com openshift_node_labels="{'region': 'infra', 'zone': 'default'}"
infra-node2.example.com openshift_node_labels="{'region': 'infra', 'zone': 'default'}"
To use this example, modify the file to match your environment and specifications, and save it as /etc/ansible/hosts.
The following table describes an example environment for a single
master,
three
etcd
hosts, two
nodes
for hosting user applications, and two nodes with the region=infra label for hosting
dedicated infrastructure:
| Host Name | Infrastructure Component to Install |
|---|---|
master.example.com |
Master and node |
etcd1.example.com |
etcd |
etcd2.example.com |
|
etcd3.example.com |
|
node1.example.com |
Node |
node2.example.com |
|
infra-node1.example.com |
Node (with |
infra-node2.example.com |
|
When specifying multiple etcd hosts, external etcd is installed and configured. Clustering of OpenShift Origin’s embedded etcd is not supported. |
You can see these example hosts present in the [masters], [nodes], and [etcd] sections of the following example inventory file:
# Create an OSEv3 group that contains the masters, nodes, and etcd groups
[OSEv3:children]
masters
nodes
etcd
# Set variables common for all OSEv3 hosts
[OSEv3:vars]
ansible_ssh_user=root
openshift_deployment_type=origin
# uncomment the following to enable htpasswd authentication; defaults to DenyAllPasswordIdentityProvider
#openshift_master_identity_providers=[{'name': 'htpasswd_auth', 'login': 'true', 'challenge': 'true', 'kind': 'HTPasswdPasswordIdentityProvider', 'filename': '/etc/origin/master/htpasswd'}]
# host group for masters
[masters]
master.example.com
# host group for etcd
[etcd]
etcd1.example.com
etcd2.example.com
etcd3.example.com
# host group for nodes, includes region info
[nodes]
master.example.com
node1.example.com openshift_node_labels="{'region': 'primary', 'zone': 'east'}"
node2.example.com openshift_node_labels="{'region': 'primary', 'zone': 'west'}"
infra-node1.example.com openshift_node_labels="{'region': 'infra', 'zone': 'default'}"
infra-node2.example.com openshift_node_labels="{'region': 'infra', 'zone': 'default'}"
To use this example, modify the file to match your environment and specifications, and save it as /etc/ansible/hosts.
You can configure an environment with multiple masters, multiple etcd hosts, and multiple nodes. Configuring multiple masters for high availability (HA) ensures that the cluster has no single point of failure.
|
Moving from a single master cluster to multiple masters after installation is not supported. |
When configuring multiple masters, the advanced installation supports the
native high availability (HA) method. This method leverages the native HA
master capabilities built into OpenShift Origin and can be combined with any load
balancing solution.
If a host is defined in the [lb] section of the inventory file, Ansible installs and configures HAProxy automatically as the load balancing solution. If no host is defined, it is assumed you have pre-configured an external load balancing solution of your choice to balance the master API (port 8443) on all master hosts.
|
This HAProxy load balancer is intended to demonstrate the API server’s HA mode and is not recommended for production environments. If you are deploying to a cloud provider, Red Hat recommends deploying a cloud-native TCP-based load balancer or take other steps to provide a highly available load balancer. |
For an external load balancing solution, you must have:
A pre-created load balancer VIP configured for SSL passthrough.
A VIP listening on the port specified by the openshift_master_api_port and openshift_master_console_port
values (8443 by default) and proxying back to all master hosts on that port.
A domain name for VIP registered in DNS.
The domain name will become the value of both
openshift_master_cluster_public_hostname and
openshift_master_cluster_hostname in the OpenShift Origin installer.
See External Load Balancer Integrations for more information. For more on the high availability master architecture, see Kubernetes Infrastructure.
|
The advanced installation method does not currently support multiple HAProxy load balancers in an active-passive setup. See the Load Balancer Administration documentation for post-installation amendments. |
To configure multiple masters, refer to the following section.
The following describes an example environment for three
masters
using the native HA method:, one HAProxy load balancer, three
etcd
hosts, two
nodes
for hosting user applications, and two nodes with the region=infra label for hosting
dedicated infrastructure:
| Host Name | Infrastructure Component to Install |
|---|---|
master1.example.com |
Master (clustered using native HA) and node |
master2.example.com |
|
master3.example.com |
|
lb.example.com |
HAProxy to load balance API master endpoints |
etcd1.example.com |
etcd |
etcd2.example.com |
|
etcd3.example.com |
|
node1.example.com |
Node |
node2.example.com |
|
infra-node1.example.com |
Node (with |
infra-node2.example.com |
|
When specifying multiple etcd hosts, external etcd is installed and configured. Clustering of OpenShift Origin’s embedded etcd is not supported. |
You can see these example hosts present in the [masters], [etcd], [lb], and [nodes] sections of the following example inventory file:
# Create an OSEv3 group that contains the master, nodes, etcd, and lb groups.
# The lb group lets Ansible configure HAProxy as the load balancing solution.
# Comment lb out if your load balancer is pre-configured.
[OSEv3:children]
masters
nodes
etcd
lb
# Set variables common for all OSEv3 hosts
[OSEv3:vars]
ansible_ssh_user=root
openshift_deployment_type=origin
# Uncomment the following to enable htpasswd authentication; defaults to
# DenyAllPasswordIdentityProvider.
#openshift_master_identity_providers=[{'name': 'htpasswd_auth', 'login': 'true', 'challenge': 'true', 'kind': 'HTPasswdPasswordIdentityProvider', 'filename': '/etc/origin/master/htpasswd'}]
# Native high availbility cluster method with optional load balancer.
# If no lb group is defined installer assumes that a load balancer has
# been preconfigured. For installation the value of
# openshift_master_cluster_hostname must resolve to the load balancer
# or to one or all of the masters defined in the inventory if no load
# balancer is present.
openshift_master_cluster_method=native
openshift_master_cluster_hostname=openshift-cluster.example.com
openshift_master_cluster_public_hostname=openshift-cluster.example.com
# apply updated node defaults
openshift_node_kubelet_args={'pods-per-core': ['10'], 'max-pods': ['250'], 'image-gc-high-threshold': ['90'], 'image-gc-low-threshold': ['80']}
# enable ntp on masters to ensure proper failover
openshift_clock_enabled=true
# host group for masters
[masters]
master1.example.com
master2.example.com
master3.example.com
# host group for etcd
[etcd]
etcd1.example.com
etcd2.example.com
etcd3.example.com
# Specify load balancer host
[lb]
lb.example.com
# host group for nodes, includes region info
[nodes]
master[1:3].example.com
node1.example.com openshift_node_labels="{'region': 'primary', 'zone': 'east'}"
node2.example.com openshift_node_labels="{'region': 'primary', 'zone': 'west'}"
infra-node1.example.com openshift_node_labels="{'region': 'infra', 'zone': 'default'}"
infra-node2.example.com openshift_node_labels="{'region': 'infra', 'zone': 'default'}"
To use this example, modify the file to match your environment and specifications, and save it as /etc/ansible/hosts.
The following describes an example environment for three
masters
using the native HA method (with
etcd
on each host), one HAProxy load balancer, two
nodes
for hosting user applications, and two nodes with the region=infra label for hosting
dedicated infrastructure:
| Host Name | Infrastructure Component to Install |
|---|---|
master1.example.com |
Master (clustered using native HA) and node with etcd on each host |
master2.example.com |
|
master3.example.com |
|
lb.example.com |
HAProxy to load balance API master endpoints |
node1.example.com |
Node |
node2.example.com |
|
infra-node1.example.com |
Node (with |
infra-node2.example.com |
You can see these example hosts present in the [masters], [etcd], [lb], and [nodes] sections of the following example inventory file:
# Create an OSEv3 group that contains the master, nodes, etcd, and lb groups.
# The lb group lets Ansible configure HAProxy as the load balancing solution.
# Comment lb out if your load balancer is pre-configured.
[OSEv3:children]
masters
nodes
etcd
lb
# Set variables common for all OSEv3 hosts
[OSEv3:vars]
ansible_ssh_user=root
openshift_deployment_type=openshift-enterprise
# Uncomment the following to enable htpasswd authentication; defaults to
# DenyAllPasswordIdentityProvider.
#openshift_master_identity_providers=[{'name': 'htpasswd_auth', 'login': 'true', 'challenge': 'true', 'kind': 'HTPasswdPasswordIdentityProvider', 'filename': '/etc/origin/master/htpasswd'}]
# Native high availability cluster method with optional load balancer.
# If no lb group is defined installer assumes that a load balancer has
# been preconfigured. For installation the value of
# openshift_master_cluster_hostname must resolve to the load balancer
# or to one or all of the masters defined in the inventory if no load
# balancer is present.
openshift_master_cluster_method=native
openshift_master_cluster_hostname=openshift-cluster.example.com
openshift_master_cluster_public_hostname=openshift-cluster.example.com
# host group for masters
[masters]
master1.example.com
master2.example.com
master3.example.com
# host group for etcd
[etcd]
master1.example.com
master2.example.com
master3.example.com
# Specify load balancer host
[lb]
lb.example.com
# host group for nodes, includes region info
[nodes]
master[1:3].example.com
node1.example.com openshift_node_labels="{'region': 'primary', 'zone': 'east'}"
node2.example.com openshift_node_labels="{'region': 'primary', 'zone': 'west'}"
infra-node1.example.com openshift_node_labels="{'region': 'infra', 'zone': 'default'}"
infra-node2.example.com openshift_node_labels="{'region': 'infra', 'zone': 'default'}"
To use this example, modify the file to match your environment and specifications, and save it as /etc/ansible/hosts.
After you have configured Ansible by defining an inventory file in /etc/ansible/hosts, you run the advanced installation playbook via Ansible. OpenShift Origin installations are currently supported using the RPM-based installer, while the containerized installer is currently a Technology Preview feature.
The installer uses modularized playbooks allowing administrators to install specific components as needed. By breaking up the roles and playbooks, there is better targeting of ad hoc administration tasks. This results in an increased level of control during installations and results in time savings.
|
The playbooks and their ordering are detailed below in Running Individual Component Playbooks. |
The RPM-based installer uses Ansible installed via RPM packages to run playbooks
and configuration files available on the local host. To run the installer, use
the following command, specifying -i if your inventory file located somewhere
other than /etc/ansible/hosts:
# ansible-playbook [-i /path/to/inventory] \
~/openshift-ansible/playbooks/deploy_cluster.yml
If for any reason the installation fails, before re-running the installer, see Known Issues to check for any specific instructions or workarounds.
The openshift/origin-ansible image is a containerized version of the OpenShift Origin installer. This installer image provides the same functionality as the RPM-based installer, but it runs in a containerized environment that provides all of its dependencies rather than being installed directly on the host. The only requirement to use it is the ability to run a container.
|
All system container components are Tech Preview features in OpenShift Origin 3.7. They must not be used in production and they are not supported for upgrades to OpenShift Origin 3.7. During this phase, they are only meant for use with new cluster installations in non-production environments. |
The installer image can be used as a system container. System containers are stored and run outside of the traditional docker service. This enables running the installer image from one of the target hosts without concern for the install restarting docker on the host.
As the root user, use the Atomic CLI to run the installer as a run-once system container:
# atomic install --system \
--storage=ostree \
--set INVENTORY_FILE=/path/to/inventory \ (1)
docker.io/openshift/origin-ansible:v3.7
| 1 | Specify the location on the local host for your inventory file. |
This command initiates the cluster installation by using the inventory file specified and the root user’s
SSH configuration. It logs the output on the terminal and also saves it in the /var/log/ansible.log file.
The first time this command is run, the image is imported into
OSTree
storage (system containers use this rather than docker daemon storage).
On subsequent runs, it reuses the stored image.
If for any reason the installation fails, before re-running the installer, see Known Issues to check for any specific instructions or workarounds.
You can use the PLAYBOOK_FILE environment variable to specify other playbooks
you want to run by using the containerized installer. The default value of the PLAYBOOK_FILE is
/usr/share/ansible/openshift-ansible/playbooks/deploy_cluster.yml, which is the
main cluster installation playbook, but you can set it to the path of another
playbook inside the container.
For example, to run the pre-install checks playbook before installation, use the following command:
# atomic install --system \
--storage=ostree \
--set INVENTORY_FILE=/path/to/inventory \
--set PLAYBOOK_FILE=/usr/share/ansible/openshift-ansible/playbooks/openshift-checks/pre-install.yml \ (1)
--set OPTS="-v" \ (2)
docker.io/openshift/origin-ansible:v3.7
| 1 | Set PLAYBOOK_FILE to the full path of the playbook starting at the
playbooks/ directory. Playbooks are located in the same locations as with
the RPM-based installer. |
| 2 | Set OPTS to add command line options to ansible-playbook. |
The installer image can also run as a docker container anywhere that docker can run.
|
This method must not be used to run the installer on one of the hosts being configured, as the install may restart docker on the host, disrupting the installer container execution. |
|
Although this method and the system container method above use the same image, they run with different entry points and contexts, so runtime parameters are not the same. |
At a minimum, when running the installer as a docker container you must provide:
SSH key(s), so that Ansible can reach your hosts.
An Ansible inventory file.
The location of the Ansible playbook to run against that inventory.
Here is an example of how to run an install via docker.
Note that this must be run by a non-root user with access to docker.
$ docker run -t -u `id -u` \ (1)
-v $HOME/.ssh/id_rsa:/opt/app-root/src/.ssh/id_rsa:Z \ (2)
-v $HOME/ansible/hosts:/tmp/inventory:Z \ (3)
-e INVENTORY_FILE=/tmp/inventory \ (3)
-e PLAYBOOK_FILE=playbooks/deploy_cluster.yml \ (4)
-e OPTS="-v" \ (5)
docker.io/openshift/origin-ansible:v3.7
| 1 | -u `id -u` makes the container run with the same UID as the current
user, which allows that user to use the SSH key inside the container (SSH
private keys are expected to be readable only by their owner). |
| 2 | -v $HOME/.ssh/id_rsa:/opt/app-root/src/.ssh/id_rsa:Z mounts your
SSH key ($HOME/.ssh/id_rsa) under the container user’s $HOME/.ssh
(/opt/app-root/src is the $HOME of the user in the container). If
you mount the SSH key into a non-standard location you can add an
environment variable with -e ANSIBLE_PRIVATE_KEY_FILE=/the/mount/point
or set ansible_ssh_private_key_file=/the/mount/point as a variable in
the inventory to point Ansible at it.
Note that the SSH key is mounted with the |
| 3 | -v $HOME/ansible/hosts:/tmp/inventory:Z and -e INVENTORY_FILE=/tmp/inventory
mount a static Ansible inventory file into the container as
/tmp/inventory and set the corresponding environment variable to
point at it. As with the SSH key, the inventory file SELinux labels may
need to be relabeled by using the :Z flag to allow reading in the container,
depending on the existing label (for files in a user $HOME directory
this is likely to be needed). So again you may prefer to copy the
inventory to a dedicated location before mounting it.
The inventory file can also be downloaded from a web server if you specify
the |
| 4 | -e PLAYBOOK_FILE=playbooks/deploy_cluster.yml specifies the playbook
to run (in this example, the default installer) as a relative path from the
top level directory of openshift-ansible content. The full path from the
RPM can also be used, as well as the path to any other playbook file in
the container. |
| 5 | -e OPTS="-v" supplies arbitrary command line options (in this case,
-v to increase verbosity) to the ansible-playbook command that runs
inside the container. |
The main installation playbook ~/openshift-ansible/playbooks/deploy_cluster.yml runs a set of individual component playbooks in a specific order, and the installer reports back at the end what phases you have gone through. If the installation fails during a phase, you are notified on the screen along with the errors from the Ansible run.
After you resolve the issue, rather than run the entire installation over again, you can pick up from the failed phase. You must then run each of the remaining playbooks in order:
# ansible-playbook [-i /path/to/inventory] <playbook_file_location>
The following table is sorted in order of when each individual component playbook is run:
| Playbook Name | File Location |
|---|---|
Health Check |
~/openshift-ansible/playbooks/openshift-checks/pre-install.yml |
etcd Install |
~/openshift-ansible/playbooks/openshift-etcd/config.yml |
NFS Install |
~/openshift-ansible/playbooks/openshift-nfs/config.yml |
Load Balancer Install |
~/openshift-ansible/playbooks/openshift-loadbalancer/config.yml |
Master Install |
~/openshift-ansible/playbooks/openshift-master/config.yml |
Master Additional Install |
~/openshift-ansible/playbooks/openshift-master/additional_config.yml |
Node Install |
~/openshift-ansible/playbooks/openshift-node/config.yml |
GlusterFS Install |
~/openshift-ansible/playbooks/openshift-glusterfs/config.yml |
Hosted Install |
~/openshift-ansible/playbooks/openshift-hosted/config.yml |
Web Console Install |
~/openshift-ansible/playbooks/openshift-web-console/config.yml |
Metrics Install |
~/openshift-ansible/playbooks/openshift-metrics/config.yml |
Logging Install |
~/openshift-ansible/playbooks/openshift-logging/config.yml |
Prometheus Install |
~/openshift-ansible/playbooks/openshift-prometheus/config.yml |
Service Catalog Install |
~/openshift-ansible/playbooks/openshift-service-catalog/config.yml |
Management Install |
~/openshift-ansible/playbooks/openshift-management/config.yml |
After the installation completes:
Verify that the master is started and nodes are registered and reporting in Ready status. On the master host, run the following as root:
# oc get nodes NAME STATUS AGE master.example.com Ready,SchedulingDisabled 165d node1.example.com Ready 165d node2.example.com Ready 165d
To verify that the web console is installed correctly, use the master host name and the web console port number to access the web console with a web browser.
For example, for a master host with a host name of master.openshift.com and
using the default port of 8443, the web console would be found at https://master.openshift.com:8443/console.
|
The default port for the console is |
If you installed multiple etcd hosts:
First, verify that the etcd package, which provides the etcdctl
command, is installed:
# yum install etcd
On a master host, verify the etcd cluster health, substituting for the FQDNs of your etcd hosts in the following:
# etcdctl -C \
https://etcd1.example.com:2379,https://etcd2.example.com:2379,https://etcd3.example.com:2379 \
--ca-file=/etc/origin/master/master.etcd-ca.crt \
--cert-file=/etc/origin/master/master.etcd-client.crt \
--key-file=/etc/origin/master/master.etcd-client.key cluster-health
Also verify the member list is correct:
# etcdctl -C \
https://etcd1.example.com:2379,https://etcd2.example.com:2379,https://etcd3.example.com:2379 \
--ca-file=/etc/origin/master/master.etcd-ca.crt \
--cert-file=/etc/origin/master/master.etcd-client.crt \
--key-file=/etc/origin/master/master.etcd-client.key member list
If you installed multiple masters using HAProxy as a load balancer, browse to the following URL according to your [lb] section definition and check HAProxy’s status:
http://<lb_hostname>:9000
You can verify your installation by consulting the HAProxy Configuration documentation.
You can uninstall OpenShift Origin hosts in your cluster by running the uninstall.yml playbook. This playbook deletes OpenShift Origin content installed by Ansible, including:
Configuration
Containers
Default templates and image streams
Images
RPM packages
The playbook will delete content for any hosts defined in the inventory file that you specify when running the playbook. If you want to uninstall OpenShift Origin across all hosts in your cluster, run the playbook using the inventory file you used when installing OpenShift Origin initially or ran most recently:
# ansible-playbook [-i /path/to/file] \
~/openshift-ansible/playbooks/adhoc/uninstall.yml
You can also uninstall node components from specific hosts using the uninstall.yml playbook while leaving the remaining hosts and cluster alone:
|
This method should only be used when attempting to uninstall specific node hosts and not for specific masters or etcd hosts, which would require further configuration changes within the cluster. |
First follow the steps in Deleting Nodes to remove the node object from the cluster, then continue with the remaining steps in this procedure.
Create a different inventory file that only references those hosts. For example, to only delete content from one node:
[OSEv3:children]
nodes (1)
[OSEv3:vars]
ansible_ssh_user=root
openshift_deployment_type=origin
[nodes]
node3.example.com openshift_node_labels="{'region': 'primary', 'zone': 'west'}" (2)
| 1 | Only include the sections that pertain to the hosts you are interested in uninstalling. |
| 2 | Only include hosts that you want to uninstall. |
Specify that new inventory file using the -i option when running the
uninstall.yml playbook:
# ansible-playbook -i /path/to/new/file \
~/openshift-ansible/playbooks/adhoc/uninstall.yml
When the playbook completes, all OpenShift Origin content should be removed from any specified hosts.
On failover in multiple master clusters, it is possible for the controller manager to overcorrect, which causes the system to run more pods than what was intended. However, this is a transient event and the system does correct itself over time. See https://github.com/kubernetes/kubernetes/issues/10030 for details.
On failure of the Ansible installer, you must start from a clean operating system installation. If you are using virtual machines, start from a fresh image. If you are using bare metal machines, see Uninstalling OpenShift Origin for instructions.
Now that you have a working OpenShift Origin instance, you can:
Configure authentication; by default, authentication is set to Allow All.
Deploy an integrated Docker registry.
Deploy a router.
Populate your OpenShift Origin installation with a useful set of Red Hat-provided image streams and templates.