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.
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.
Install base dependencies:
Requirements:
- Ansible >= 2.4.3.0, 2.5.x is not currently supported for OCP installations
- 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
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
See README_CONTAINER_IMAGE.md for information on how to package openshift-ansible as a container image.
See the hooks documentation.
See the contribution guide.
See the build instructions.