okd

OpenShift Ansible

This repository contains Ansible code 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.

Branches and tags

The master branch tracks our current work and should be compatible with both Origin master branch and the most recent Origin stable release. Currently that's v1.4 and v1.3.x. In addition to the master branch, we maintain stable branches corresponding to upstream Origin releases, e.g.: release-1.2. The most recent branch will often receive minor feature backports and fixes. Older branches will receive only critical fixes.

Releases are tagged periodically from active branches and are versioned 3.x corresponding to Origin releases 1.x. We unfortunately started with 3.0 and it's not practical to start over at 1.0.

Directory structure

• bin/cluster - Python script to easily create clusters
• docs/ - documentation for the project
• filter_plugins/ - custom filters used to manipulate data in Ansible
• inventory/ - Ansible dynamic inventory scripts
• playbooks/ - host-type Ansible playbooks (launch, config, destroy, vars)
• roles/ - shareable Ansible tasks

Setup

1. Install base dependencies:

   ---

   Requirements:

   • Ansible >= 2.1.0 (>= 2.2 is preferred for performance reasons)
   • Jinja >= 2.7 ***

   Fedora:

   dnf install -y ansible pyOpenSSL python-cryptography
   

2. Setup for a specific cloud:

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

• Build
  • How to build the openshift-ansible rpms

Contributing

• Best Practices Guide
• Core Concepts
• Style Guide