Install an OpenShift cluster
Clone or download
openshift-merge-robot Merge pull request #1101 from crawford/retry-progress-report
data/bootstrap: retry when reporting progress
Latest commit d127242 Jan 19, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github .github: remove libvirt plugin version invocation Dec 18, 2018
cmd/openshift-install Merge pull request #1070 from wking/metadata Jan 19, 2019
data data/bootstrap: retry when reporting progress Jan 18, 2019
docs Merge pull request #1095 from wking/aws-lb-limit-trailing-period Jan 18, 2019
hack *: Make libvirt support completely conditional (behind TAGS=libvirt) Dec 21, 2018
images *: Make libvirt support completely conditional (behind TAGS=libvirt) Dec 21, 2018
pkg Merge pull request #1070 from wking/metadata Jan 19, 2019
scripts/maintenance *: use podman instead of docker Sep 11, 2018
tests */BUILD.bazel: Remove leftover Bazel files Oct 20, 2018
vendor Revendor for getting cluster-api-provider-aws ebs support Jan 17, 2019
.gitignore git: remove log from gitignore Jan 4, 2019
.yamllint .yamllint: Put yamllint config in the usual place Nov 8, 2018 Fix several typo Jan 17, 2019 hack: script to generate mocks Dec 20, 2018
DCO DCO: Update Linux Foundation address (to Letterman Drive) Jul 6, 2018
Gopkg.lock Revendor for getting cluster-api-provider-aws ebs support Jan 17, 2019
Gopkg.toml Merge pull request #943 from ironcladlou/cloudprovider Jan 12, 2019
LICENSE feat(*): initial commit Jan 19, 2014
NOTICE NOTICE: Bump copyright year Feb 10, 2017
OWNERS Add OpenStack team as reviewers Nov 6, 2018
OWNERS_ALIASES OWNERS_ALIASES: Yifan has moved on to other things :( Nov 2, 2018 Merge pull request #1030 from cuppett/cuppett/add-aws-doc Jan 13, 2019 update code of conduct copy Aug 9, 2016

OpenShift Installer

Supported Platforms

Quick Start

First, install all build dependencies.

Clone this repository to src/ in your GOPATH. Then build the openshift-install binary with:


This will create bin/openshift-install. This binary can then be invoked to create an OpenShift cluster, like so:

bin/openshift-install create cluster

The installer will show a series of prompts for user-specific information and use reasonable defaults for everything else. In non-interactive contexts, prompts can be bypassed by providing an install-config.yaml.

If you have trouble, refer to the troubleshooting guide.

Connect to the cluster

Details for connecting to your new cluster are printed by the openshift-install binary upon completion, and are also available in the .openshift_install.log file.

Example output:

INFO Waiting 10m0s for the openshift-console route to be created...
INFO Install complete!
INFO Run 'export KUBECONFIG=/path/to/auth/kubeconfig' to manage the cluster with 'oc', the OpenShift CLI.
INFO The cluster is ready when 'oc login -u kubeadmin -p 5char-5char-5char-5char' succeeds (wait a few minutes).
INFO Access the OpenShift web-console here: https://console-openshift-console.apps.${CLUSTER_NAME}.${BASE_DOMAIN}:6443
INFO Login to the console with user: kubeadmin, password: 5char-5char-5char-5char


Destroy the cluster and release associated resources with:

openshift-install destroy cluster

Note that you almost certainly also want to clean up the installer state files too, including auth/, terraform.tfstate, etc. The best thing to do is always pass the --dir argument to install and destroy. And if you want to reinstall from scratch, rm -rf the asset directory beforehand.