OpenShift Installation and Configuration Management
Python Shell Other
Switch branches/tags
v3.11.0-alpha.0 v3.10.0 v3.10.0-rc.0 v3.0.2-2 v3.0.2-1 v3.0.1-1 v3.0.0 v3.0.0-rc v3.0.0-8 v3.0.0-7 v3.0.0-6 v3.0.0-5 v3.0.0-4 v3.0.0-3 v3.0.0-2 v3.0.0-1 v3-beta2-03-09-15 openshift-ansible-v3.6.77-stage openshift-ansible-v3.5.5.17-1 openshift-ansible-v3.4.1.26-1 openshift-ansible-v3.3.1.27-1 openshift-ansible-inventory-0.0.11-1 openshift-ansible-inventory-0.0.10-1 openshift-ansible-inventory-0.0.9-1 openshift-ansible-inventory-0.0.8-1 openshift-ansible-inventory-0.0.7-1 openshift-ansible-inventory-0.0.6-1 openshift-ansible-inventory-0.0.5-1 openshift-ansible-inventory-0.0.4-1 openshift-ansible-inventory-0.0.3-1 openshift-ansible-inventory-0.0.2-1 openshift-ansible-inventory-0.0.1-1 openshift-ansible-bin-0.0.21-1 openshift-ansible-bin-0.0.20-1 openshift-ansible-bin-0.0.19-1 openshift-ansible-bin-0.0.18-1 openshift-ansible-bin-0.0.17-1 openshift-ansible-bin-0.0.16-1 openshift-ansible-bin-0.0.15-1 openshift-ansible-bin-0.0.14-1 openshift-ansible-bin-0.0.13-1 openshift-ansible-bin-0.0.12-1 openshift-ansible-bin-0.0.11-1 openshift-ansible-bin-0.0.10-1 openshift-ansible-bin-0.0.9-1 openshift-ansible-bin-0.0.8-1 openshift-ansible-bin-0.0.7-1 openshift-ansible-bin-0.0.6-1 openshift-ansible-bin-0.0.5-1 openshift-ansible-bin-0.0.4-1 openshift-ansible-bin-0.0.3-1 openshift-ansible-bin-0.0.2-1 openshift-ansible-bin-0.0.1-1 openshift-ansible-Unexpected.0.0.0.0-1 openshift-ansible-Unexpected-1 openshift-ansible-3.11.0-0.17.0 openshift-ansible-3.11.0-0.16.0 openshift-ansible-3.11.0-0.15.0 openshift-ansible-3.11.0-0.14.0 openshift-ansible-3.11.0-0.13.0 openshift-ansible-3.11.0-0.12.0 openshift-ansible-3.11.0-0.11.0 openshift-ansible-3.11.0-0.10.0 openshift-ansible-3.11.0-0.9.0 openshift-ansible-3.11.0-0.8.0 openshift-ansible-3.11.0-0.7.0 openshift-ansible-3.11.0-0.6.0 openshift-ansible-3.11.0-0.5.0 openshift-ansible-3.11.0-0.1.0 openshift-ansible-3.11.0-0.0.0 openshift-ansible-3.10.29-1 openshift-ansible-3.10.28-1 openshift-ansible-3.10.27-2 openshift-ansible-3.10.27-1 openshift-ansible-3.10.26-1 openshift-ansible-3.10.25-1 openshift-ansible-3.10.24-1 openshift-ansible-3.10.23-1 openshift-ansible-3.10.22-1 openshift-ansible-3.10.21-1 openshift-ansible-3.10.20-1 openshift-ansible-3.10.19-1 openshift-ansible-3.10.18-1 openshift-ansible-3.10.17-1 openshift-ansible-3.10.16-1 openshift-ansible-3.10.15-1 openshift-ansible-3.10.14-1 openshift-ansible-3.10.13-1 openshift-ansible-3.10.12-1 openshift-ansible-3.10.11-1 openshift-ansible-3.10.10-1 openshift-ansible-3.10.9-1 openshift-ansible-3.10.8-1 openshift-ansible-3.10.7-1 openshift-ansible-3.10.6-1 openshift-ansible-3.10.5-1 openshift-ansible-3.10.3-1 openshift-ansible-3.10.2-1 openshift-ansible-3.10.1-1 openshift-ansible-3.10.0-0.69.0
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Remove atomic-openshift-utils Apr 6, 2018
.tito Automatic commit of package [openshift-ansible] release [3.11.0-0.17.0]. Aug 16, 2018
ansible-profile Add README file to link to the upstream ansible-profile Jul 3, 2015
docs Fix the docs, add additional .parr file description Jun 12, 2018
examples Update documentation links, docs.openshift.org -> docs.okd.io Aug 13, 2018
hack Fully qualify all openshift/origin and openshift3/ose images Jun 19, 2018
images/installer Cleanup logging and metrics deprecations Aug 14, 2018
inventory Update old documentation links Aug 14, 2018
meta Adding meta/main.yml to allow for Galaxy use of this repo Oct 4, 2017
playbooks Merge pull request #9652 from mtnbikenc/remove-3.10-upgrade Aug 17, 2018
roles Merge pull request #9622 from vrutkovs/skip-extra-pkg-check Aug 18, 2018
test Remove mentions of oo_hosts_containerized_managed_true group Jul 16, 2018
.coveragerc Lowering test coverage percentage. Mar 8, 2017
.dockerignore Move origin-gce roles and playbooks into openshift-ansible Jan 23, 2018
.flake8 Fix flake8 errors in utils/test Jan 4, 2018
.gitignore Add the DNS updates and rename the openstack vars Nov 7, 2017
.papr-master-ha.inventory PAPR: set docker log driver to journald so that journal artifacts con… Jun 17, 2018
.papr.all-in-one.inventory PAPR: set docker log driver to journald so that journal artifacts con… Jun 17, 2018
.papr.inventory PAPR: set docker log driver to journald so that journal artifacts con… Jun 17, 2018
.papr.sh PAPR: install new requirements during upgrade Jul 11, 2018
.papr.yml Disable papr on pull requests Jul 24, 2018
.pylintrc Start requiring Ansible 2.4 Nov 9, 2017
.release Branch for v3.11 Jun 15, 2018
.travis.yml Output useful logs in CI on failure Apr 17, 2018
.yamllint More toxification Jan 10, 2017
BUILD.md image builds: remove dependency on playbook2image Jul 18, 2017
CONTRIBUTING.md Add a bare minimum localhost hosts file Jan 30, 2018
DEPLOYMENT_TYPES.md Remove alternative oreg vars and update logic Jul 18, 2018
HOOKS.md Documents new node upgrade hooks. Apr 3, 2018
LICENSE move LICENSE to /usr/share/licenses/openshift-ansible-VERSION/ Sep 20, 2016
OWNERS Add OWNERS files Apr 18, 2018
README.md Require Ansible 2.6.2 Aug 17, 2018
README_CONTAINERIZED_INSTALLATION.md Replace OpenShift Enterprise references with OpenShift Container Plat… Aug 14, 2018
README_CONTAINER_IMAGE.md Update documentation links, docs.openshift.org -> docs.okd.io Aug 13, 2018
ansible.cfg Set log-path = ~/openshift-ansible.log Jul 18, 2018
conftest.py Configure pytest to run tests and coverage Feb 20, 2017
openshift-ansible.spec Require Ansible 2.6.2 Aug 17, 2018
pytest.ini Add unit tests for existing health checks Mar 17, 2017
requirements.txt Require Ansible 2.6.2 Aug 17, 2018
setup.cfg Remove atomic-openshift-utils Apr 6, 2018
setup.py Azure: add playbook May 8, 2018
test-requirements.txt integration tests: add CI scripts Apr 25, 2017
tox.ini Remove utils unit tests Apr 6, 2018

README.md

Join the chat at https://gitter.im/openshift/openshift-ansible Build Status Coverage Status

OpenShift Ansible

This repository contains Ansible roles and playbooks to install, upgrade, and manage OpenShift clusters.

Note: the Ansible playbooks in this repository require an RPM package that provides docker. Currently, the RPMs from dockerproject.org do not provide this requirement, though they may in the future. This limitation is being tracked by #2720.

Getting the correct version

When choosing an openshift release, ensure that the necessary origin packages are available in your distribution's repository. By default, openshift-ansible will not configure extra repositories for testing or staging packages for end users.

We recommend using a release branch. We maintain stable branches corresponding to upstream Origin releases, e.g.: we guarantee an openshift-ansible 3.2 release will fully support an origin 1.2 release.

The most recent branch will often receive minor feature backports and fixes. Older branches will receive only critical fixes.

In addition to the release branches, the master branch master branch tracks our current work in development and should be compatible with the Origin master branch (code in development).

Getting the right openshift-ansible release

Follow this release pattern and you can't go wrong:

Origin/OCP OpenShift-Ansible version openshift-ansible branch
1.3 / 3.3 3.3 release-1.3
1.4 / 3.4 3.4 release-1.4
1.5 / 3.5 3.5 release-1.5
3.X 3.X release-3.x

If you're running from the openshift-ansible master branch we can only guarantee compatibility with the newest origin releases in development. Use a branch corresponding to your origin version if you are not running a stable release.

Setup

Install base dependencies:

Requirements:

  • Ansible >= 2.6.2
  • Jinja >= 2.7
  • pyOpenSSL
  • python-lxml

Fedora:

dnf install -y ansible pyOpenSSL python-cryptography python-lxml

Additional requirements:

Logging:

  • java-1.8.0-openjdk-headless
  • patch

Metrics:

  • httpd-tools

Simple all-in-one localhost Installation

This assumes that you've installed the base dependencies and you're running on Fedora or RHEL

git clone https://github.com/openshift/openshift-ansible
cd openshift-ansible
sudo ansible-playbook -i inventory/hosts.localhost playbooks/prerequisites.yml
sudo ansible-playbook -i inventory/hosts.localhost playbooks/deploy_cluster.yml

Node Group Definition and Mapping

In 3.10 and newer all members of the [nodes] inventory group must be assigned an openshift_node_group_name. This value is used to select the configmap that configures each node. By default there are three configmaps created; one for each node group defined in openshift_node_groups and they're named node-config-master node-config-infra node-config-compute. It's important to note that the configmap is also the authoritative definition of node labels, the old openshift_node_labels value is effectively ignored.

There are also two configmaps that label nodes into multiple roles, these are not recommended for production clusters, however they're named node-config-all-in-one and node-config-master-infra if you'd like to use them to deploy non production clusters.

The default set of node groups is defined in [roles/openshift_facts/defaults/main.yml] like so

openshift_node_groups:
  - name: node-config-master
    labels:
      - 'node-role.kubernetes.io/master=true'
    edits: []
  - name: node-config-infra
    labels:
      - 'node-role.kubernetes.io/infra=true'
    edits: []
  - name: node-config-compute
    labels:
      - 'node-role.kubernetes.io/compute=true'
    edits: []
  - name: node-config-master-infra
    labels:
      - 'node-role.kubernetes.io/infra=true,node-role.kubernetes.io/master=true'
    edits: []
  - name: node-config-all-in-one
    labels:
      - 'node-role.kubernetes.io/infra=true,node-role.kubernetes.io/master=true,node-role.kubernetes.io/compute=true'
    edits: []

When configuring this in the INI based inventory this must be translated into a Python dictionary. Here's an example of a group named node-config-all-in-one which is suitable for an All-In-One installation with kubeletArguments.pods-per-core set to 20

openshift_node_groups=[{'name': 'node-config-all-in-one', 'labels': ['node-role.kubernetes.io/master=true', 'node-role.kubernetes.io/infra=true', 'node-role.kubernetes.io/compute=true'], 'edits': [{ 'key': 'kubeletArguments.pods-per-core','value': ['20']}]}]

For upgrades, the upgrade process will block until you have the required configmaps in the openshift-node namespace. Please define openshift_node_groups as explained above or accept the defaults and run the playbooks/openshift-master/openshift_node_group.yml playbook to have them created for you automatically.

Complete Production Installation Documentation:

Containerized OpenShift Ansible

See README_CONTAINER_IMAGE.md for information on how to package openshift-ansible as a container image.

Installer Hooks

See the hooks documentation.

Contributing

See the contribution guide.

Building openshift-ansible RPMs and container images

See the build instructions.