Deploying to Bare Metal

So you have your own hardware, it’s all setup and you want to take advantage of the OKD orchestrator to simplify the installation of the OKD container platform. Here you just need to provide the details of your cluster in a short YAML section of the deployment file.


Familiarise yourself with basic, automated installations but reading Before you can use the orchestrator on your own cluster the cluster instances must satisfy the system and environment requirements defined in the official OKD documentation. For v3.11 this can be found here.

Additionally, in case it’s not obvious…

  • Your cluster must have access to the outside world so that additional packages can be downloaded

  • You must be able to SSH to the designated Bastion from your development machine (i.e. where you have a copy of the orchestrator) using the keypair available to the Orchestrator (i.e. the keypair you

  • You need to have installed git so that this repository can be cloned to the designated control machine in your cluster.

Populating my_machines

In order to deploy OKD to you cluster the orchestrator has to know about the machines that will be involved. This is achieved by adding a my_machines section to your deployment configuration.

The values you provide are used to populate the rendered OKD inventory file, which would be part of the automatic step that would be managed by Terraform when using the Orchestrator to create the cluster. As you have created the machines then you provide the values that Terraform would have provided.

Instructions for populating the configuration can be found in the reference configuration file (deployments/compact-aws-frankfurt-3-11). Just look for the annotated my_machines section in the configuration file.

Deploying OKD

With a my_machines section populated, the cluster setup is like any other…

  • Craft a suitable (in provider-env)

  • Start and enter the OKD container with ./

  • Run ./ --cluster. You will need to add the name of the relevant deployment if the orchestrator finds more than one in the deployments directory.

  • When this is complete, hop onto the Bastion (from the container you should just need to ssh centos@<bastion_ip>) and then move to the okd-orchestrator directory that will have been created and run ./ --okd

If you have your own bastion you might want to use the OKD Orchestrator in just plan mode so that you can render the OKD inventory file based on your my_machines definition without resorting to configuring the Bastion. If so you will need to copy the generated inventory.yaml file to the Bastion for subsequent manual deployment of the OK platform. You can run just plan by adding --just-plan to -

./ --cluster --just-plan <deployment-name>

Copy the generated template file (which may be okd/inventories/standard-os-3-11) to your bastion (in a similar location).