okd

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

The master branch tracks our current work in development and should be compatible with the Origin master branch (code in development).

In addition to the master 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.

Getting the right openshift-ansible release

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

Origin	OpenShift-Ansible
1.3	3.3
1.4	3.4
1.X	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

1. Install base dependencies:

   ---

   Requirements:

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

   ---

   Fedora:

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

2. Setup for a specific cloud:

   • AWS
   • GCE
   • local VMs
   • Bring your own host deployments:
     • OpenShift Enterprise
     • OpenShift Origin

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.