The OKD Orchestrator

A Container Runtime Orchestrator for the Origin Community Distribution of Kubernetes (OKD) v3.11 and beyond.

A project sponsored by OpenRiskNet.

OpenRiskNet: Open e-Infrastructure to Support Data Sharing, Knowledge Integration and in silico Analysis and Modelling in Risk Assessment

—Project Number 731075

Contents:

• Orientation
• Architecture
• Getting Started
• Compiling Machine Images
• Anatomy of a Deployment Configuration
• Generating SSL Certificates
• Creating a Cluster
• Destroying a Cluster
• Advanced Topics
• Frequently Asked Questions

The OKD Orchestrator is a tool to simplify the cloud-deployment of the OpenShift Origin OKD container runtime. The project contains tools to build base images for cloud providers and then deploy, with minimal effort, a Bastion and OpenShift cluster based on those images.

The reader should have some familiarity with cloud environments (like the AWS EC2 platform) and the RedHat OpenShift Origin/OKD framework.

To run the Simple AWS example discussed in the Orientation, the user is required to have an AWS EC2 account and credentials to allow API access.

The OKD Orchestrator is inspired by the open-source KubeNow project, a cloud-agnostic platform for Docker and Kubernetes.

Don’t Panic! There’s a lot of stuff in this repository but, depending on what you expect to do, you may not need to understand everything that’s going on here.

• If you’re new to the OKD Orchestrator, start by familiarising yourself with the Orientation document. Then, before building your first cluster follow the Getting Started guide

Building the Documentation

A pre-built HTML rendition of the documentation can be found in the docs/build directory, where you’ll find an index.html file.

The source of this documentation can be found in the orchestrator’s docs/source directory. It is written using Sphinx and, once you have installed the basic tools described in the Getting Started section, you can be build it from docs.

To build the HTML version of this documentation move to the docs directory and execute the following:

$ ./make-docs.sh

The resultant index page will be called build/html/index.html and it and the rest of the generated files must be committed to revision control as changes to the documentation are made.