Chapter 23. Revision History: Installation and Configuration

Installing Prerequisites

Added instructions for installing and using the atomic-openshift-excluder and atomic-openshift-docker-excluder scripts during cluster installations and upgrades.

Installing Quick Installation

Installing Advanced Installation

Upgrading Manual Upgrades

Upgrading Automated Upgrades

Installing Prerequisites

Aded Note box to the Software Prerequisites section about subscription names.

Installing Advanced Installation

Added more information to the openshift_master_portal_net parameter description in the Configuring Cluster Variables section.

Configuring Persistent Storage Volume Security

Fixed formatting of the oc get project default -o yaml example output within the SCCs, Defaults, and Allowed Ranges section.

Installing Advanced Installation

Updated the Multiple Masters Using HAProxy Inventory File example with a line about enabling ntp on masters to ensure proper failover as part of HA configuration.

Working with HTTP Proxies

Added more information about the NO_PROXY variable.

Installing Disconnected Install

Fixed the tag references of images to be more generic.

Aggregating Container Logs

Removed oc set volume references, as oc volume is the correct command until OpenShift Enterprise 3.2.

Enabling Cluster Metrics

Added clarifying details to the Providing Your Own Certificates section.

Upgrading Performing Manual Cluster Upgrades

Added manual upgrade steps to get the latest templates from openshift-ansible-roles.

Aggregating Container Logs

Added information on log locations within Kibana to the Deploying the EFK Stack section.

Installing Prerequisites

Updated Important boxes in the System Requirements and Installing Docker sections with more specific details regarding Docker versions and yum update. (BZ#1341142)

Aggregating Container Logs

Added that NFS is a not suitable for Lucene storage, NFS is not supported, and how to use local storage.

Routing from Edge Load Balancers

Added a link connecting F5 router and Routing from Edge Load Balancers topics within the Establishing a Tunnel Using a Ramp Node section.

Working With HTTP Proxies

Added Using Maven Behind a Proxy section.

Installing Prerequisites

Added TCP/UDP information to the xref:prereq-network-access[Network Access} tables.

Installing Disconnected Installation

Fixed command in Syncing Repositories section.

Configuring Persistent Storage

Added important box about changing fstype field in a persistent volume configuration in several files.

Installing Prerequisites

Added an Important box to the System Requirements section.

Corrected information in the Host Recommendations section.

Described which required ports are necessary for master self-communication.

Advanced LDAP Configuration

New set of topics for advanced LDAP configuration:

Aggregating Container Logs

Rewording and clarifications.

Expanded documentation on scaling up Elasticsearch instances.

Added a section on sending logs to an external source.

Enabling Cluster Metrics

Added a Template Parameters table to the Deployer Template Parameters section.

Aggregating Container Logs

Specified the correct units for ES_INSTANCE_RAM and ES_OPS_INSTANCE_RAM.

Persistent Storage Examples Mounting Volumes on Privileged Pods

Added Mounting Volumes on Privileged Pods file.

Deploying a Router

Added an Important box regarding default resource requests for router pods.

Deploying a Docker Registry

Updated the example of using an existing persistent volume claim (PVC) to a matching configuration for docker-registry PVC.

Installing Advanced Installation

Replaced the openshift_docker_log_options Ansible variable with openshift_docker_options in the Configuring Host Variables section.

Updated openshift_router_selector to its new name of openshift_hosted_router_selector.

Installing Deploying a Docker Registry

Fixed examples in the Securing the Registry section to use consistent --cert and --key values. Also, clarify the origin of the ca.crt file that must be installed per-node.

Configuring Authentication

Added a note on how to obtain the htpasswd utility.

Customizing the Web Console

Added that each time a user’s token to OpenShift Enterprise expires, the user is presented with a custom page. Also, added use cases for custom login pages.

Installing Advanced Installation

Updated the location of the scaleup.yml playbook in the Adding Nodes to an Existing Cluster section.

Installing Deploying a Docker Registry

Removed support information for upstream registry configuration not relevant to OpenShift Enterprise.

Installing Advanced Installation

Updated the parameter name docker_log_options to openshift_docker_log_options in the Host Variables table.

Installing Disconnected Installation

Fixed some outdated image names.

Installing Prerequisites

Added an Important box to the Sizing Recommendations section advising that oversubscribing the physical resources on a node affects resource guarantees the Kubernetes scheduler makes during pod placement.

Installing Deploying a Docker Registry

Added support information for upstream registry configuration.

Working with HTTP Proxies

Updated the example in the Configuring Default Templates for Proxies section to use https for GitHub access.

Persistent Storage Examples Backing Docker Registry with GlusterFS Storage

New topic about how to attach a GlusterFS persistent volume to the Docker Registry.

Upgrading Manual Upgrades

Added the Upgrading the EFK Logging Stack section.

Configuring Persistent Storage Persistent Storage Using GlusterFS

Updated for clarity throughout.

Enhanced the Volume Security section significantly.

Configuring Persistent Storage Persistent Storage Using Ceph Rados Block Device (RBD)

Updated for clarity throughout.

Added the Creating the Ceph Secret and Volume Security section.

Persistent Storage Examples

New topic category that includes the following topics:

Enabling Cluster Metrics

Updated the port value for the re-encrypting port to 8444 for OpenShift Enterprise, which is different from the value for OpenShift Origin, which uses 8443.

Simplified steps in the Cleanup section.

Added extra warnings for Cassandra and its disk size in the Persistent Storage and Deployer Template Parameters sections.

Configuring Persistent Storage Persistent Storage Using NFS

Updated the Export Settings section to note the no_wdelay NFS export option.

Installing Deploying a Docker Registry

Updated the Known Issues section to note the no_wdelay NFS export option.

Working with HTTP Proxies

Added specific /etc/sysconfig files to the Configuring Hosts for Proxies section.

Added information explaining that OpenShift does not accept an asterisk as a wildcard attached to a domain suffix.

Installing Advanced Installation

Fixed syntax of examples in the Configuring Custom Certificates section to be in proper INI format.

Added an Adding Nodes to an Existing Cluster section on using the scaleup.yml playbook. (BZ#1324571)

Added an Uninstalling Nodes section on using the uninstall.yml playbook for specific nodes.

Installing Disconnected Installation

New topic on disconnected installations, detailing how to install OpenShift Enterprise in datacenters that do not have access to the Internet.

Aggregating Container Logs

Removed references to non-existent roles in the Pre-deployment Configuration section. (BZ#1324571)

Installing Prerequisites

Updated the System Requirements and Installing Docker sections to take into account the release of Docker 1.9.

Added the Cloud Provider Considerations section and documented ports 2049, 5404, 5405, and 9000 in the Required Ports section.

Installing Advanced Installation

Added information about region=infra to the Configuring Node Host Labels section and added openshift_router_selector and openshift_registry_selector to the Host Variables table.

Aggregating Container Logs

Updated significantly throughout to fix errors and recommended practices.

Enabling Cluster Metrics

Fixed typo of the destinationCACertificate parameter name.

Deploying a Docker Registry

Added an Important box about writing to the host directory in the Storage for the Registry section.

Configuring Persistent Storage Persistent Storage Using NFS

Updated for clarity throughout.

Enhanced the Volume Security section significantly.

Added the Additional Configuration and Troubleshooting section.

Configuring Persistent Storage Volume Security

Updated significantly for clarity throughout.

Installing

Fixed broken links.

Loading the Default Image Streams and Templates

Moved and updated the "First Steps" topic to become the Loading the Default Image Streams and Templates topic

Upgrading Manual Upgrades

Changed a known issue to a fix regarding liveness and readiness probes.

Deploying a Docker Registry

Changed command to update the liveness probe to use oc patch instead of sed.

Enabling Cluster Metrics

Added the Using a Re-encrypting Route section.

Advanced Installation

Combined duplicate openshift_node_kubelet_args descriptions and moved all of the content to the Host Variables table.

Aggregating Container Logs

Fixed some errors and added some extra information.

Installing Advanced Installation

Clarified in the Configuring Ansible section that the services and cluster networks also cannot overlap with networks to which the master and nodes need access, and not just networks to which the pods need access.

Modified the SDN-related Ansible cluster variables in the Configuring Ansible section to be more consistent with each other in general.

Installing Deploying a Docker Registry

Mentioned default tag latest.

Clarified importance of the project name in the pull specification.

Added section Maintaining the Registry IP Address.

Upgrading

In the Automated Upgrades and Manual Upgrades sections, added guidance about verifying that custom configurations are added to the updated /etc/sysconfig/ paths after upgrading from OSE 3.0 to 3.1. (BZ#1284504)

Configuring the SDN

Added an Important box to the Configuring the Pod Network on Masters section noting that clusterNetworkCIDR can now be changed under certain conditions.

Configuring for AWS

Added the Applying Configuration Changes section. (BZ#1314085)

Persistent Storage Persistent Storage Using NFS

Updated the "SELinux and NFS Export Settings" section to distinguish between NFSv3 and NFSv4 port requirements.

Aggregating Container Logs

Added a Note box to the Pre-deployment Configuration section recommending use of node selectors.

Fixed a service account name reference.

Enabling Cluster Metrics

Added a Note box about the cluster metrics template location.

Upgrading

Converted the "Upgrading OpenShift" topic into its own Upgrading directory with separate topics for Performing Automated Cluster Upgrades and Performing Manual Cluster Upgrades.

Upgrading from Pacemaker to Native HA

New topic providing instructions on upgrading a multiple master cluster from Pacemaker to native HA.

Enabling Cluster Metrics

Removed the template in the "Creating the Deployer Template" section and fixed an incorrect file location.

Aggregating Container Logs

Added a step within the Pre-deployment Configuration section indicating that you must switch to your new project after creating it.

Prerequisites

Fixed the /etc/selinux/config file path in the SELinux section.

Advanced Installation

Added notes indicating that moving from a single master cluster to multiple masters after installation is not supported.

Configuring Custom Certificates

In the Configuring Custom Certificates section, replaced publicMasterURL with masterPublicURL.

Installing Prerequisites

Added an SELinux section to include guidance that SELinux must be enabled, or the installer will fail.

Enabling Cluster Metrics

Added the Cleanup section with instructions on how to remove a metrics deployment.

Syncing Groups With LDAP

Updated the Running LDAP Sync section with better example command formatting.

Configuring Authentication

Updated the "Apache Authentication Using RequestHeaderIdentityProvider" example to use the /etc/origin/master/htpasswd file path.

Added a section for the Keystone identity provider.

Advanced Installation

Updated example inventory files to show the /etc/origin/master/htpasswd file path.

Clarified in the Verifying the Installation section to run the oc get nodes command on the master host.

Routing from Edge Load Balancers

Corrected the /run/openshift-sdn/config.env path in the Establishing a Tunnel Using a Ramp Node section.

Installing Deploying a Docker Registry

Added the Advanced: Overriding the Registry Configuration section.

Installing Prerequisites

Added a new Managing Docker Container Logs section.

Updated to include guidance on how to check if Docker is running.

Installing Advanced Installation

Listed docker_log_options as an host variable in the Configuring Ansible section.

Aggregating Container Logs

Added a Note box about json-file logging driver options.

Installing Prerequisites

Updated the System Requirements section to clarify that instances can be running on a private IaaS, not just a public one.

Installing Deploying a Docker Registry

Updated the Securing the Registry section to account for the liveness probe that is now added to new registries by default starting in OpenShift Enterprise 3.1.1. (BZ#1302956)

Configuring for AWS

Fixed the default node configuration file path.

Corrected instructions on setting access key environment variables.

Configuring for GCE

Fixed the default node configuration file path.

Configuring Persistent Storage Dynamically Provisioning Persistent Volumes

New topic on the experimental feature for allowing users to request dynamically provisioned persistent storage based on the configured cloud provider. Available in Technology Preview starting in OpenShift Enterprise 3.1.1.

Configuring for OpenStack

Changed <instance_ID> to <instance_name> in the Configuring Nodes section for readability.

Installing Prerequisites

Updated to include support for RHEL Atomic Host.

Installing RPM vs Containerized

New topic discussing differences between RPM and containerized installations.

Installing Quick Installation

Updated to include support for RHEL Atomic Host and containerized installations.

The former "Prerequisites" section in this topic has been renamed to Before You Begin and enhanced to differentiate from the actual Prerequisites topic.

Installing Advanced Installation

Updated to include support for RHEL Atomic Host and containerized installations.

The former "Prerequisites" section in this topic has been renamed to Before You Begin and enhanced to differentiate from the actual Prerequisites topic.

Upgrading

Added the Upgrading to OpenShift Enterprise 3.1 Asynchronous Releases section and various enhancements to support the OpenShift Enterprise 3.1.1 release.

Syncing Groups With LDAP

Updated to promote the openshift ex sync-groups command to oadm groups sync and added the Running a Group Pruning Job section.

Enabling Cluster Metrics

Fixed the metrics-deployer.yaml file path.

Installing Prerequisites

Added a Warning box about wildcards and DNS server entries in the /etc/resolv.conf file.

Configuring Persistent Storage Persistent Storage Using Ceph Rados Block Device (RBD)

Fixed the ceph-common package name.

Configuring Persistent Storage Persistent Storage Using NFS

Removed a contradictory Note box about NFS and SELinux.

Installing Advanced Installation

Added custom certificate parameters and added the Configuring Custom Certificates section.

Installing Deploying a Docker Registry

Enhanced the Accessing the Registry Directly section, including organizing all user-related requirements under a User Prerequisites subsection. (BZ#1273412)

Downgrading OpenShift

New topic for downgrading from OpenShift Enterprise 3.1 to 3.0.

Configuring Custom Certificates

New topic for configuring custom certificates after initial installation.

Configuring Authentication

Added the mappingMethod parameter to all examples.

Configuring for OpenStack

Added references to nodeName in the Configuring Nodes section.

Fixed the default node configuration file path.

Aggregating Container Logs

Fixed the path to the logging-deployer.yaml file.

Enabling Cluster Metrics

Added information about Metrics Deployer certificates and the nothing=/dev/null option.

Added clarification about required host names for the Hawkular Metrics certificate.