Skip to content
Install an OpenShift cluster
Branch: master
Clone or download
Latest commit 5f91f75 Apr 25, 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 cmd: add gather bootstrap subcommand for gathering logs on bootstrap … Apr 18, 2019
docs generated Apr 24, 2019
hack Merge pull request #1423 from cgwalters/rhcos-pin-meta Apr 4, 2019
pkg tls: move irreplaceable tls resources to openshift-config Apr 24, 2019
platformtests pkg/types/aws/defaults/platform: Per-region instance-class defaults Feb 19, 2019
scripts/maintenance *: use podman instead of docker Sep 11, 2018
tests BDD Suite: Add BDD framework code Feb 4, 2019
upi Merge pull request #1580 from spangenberg/remove-clusterid-tag Apr 23, 2019
vendor vendor: update openshift/api. Apr 15, 2019
.yamllint .yamllint: Put yamllint config in the usual place Nov 8, 2018 docs: Stronger per-platform isolation Apr 10, 2019 hack: script to generate mocks Dec 20, 2018
DCO DCO: Update Linux Foundation address (to Letterman Drive) Jul 6, 2018
LICENSE feat(*): initial commit Jan 19, 2014
NOTICE NOTICE: Bump copyright year Feb 10, 2017
OWNERS Revert "Add OpenStack team as reviewers" Apr 9, 2019
OWNERS_ALIASES Add reviewers Apr 22, 2019 docs: Stronger per-platform isolation Apr 10, 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 To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/path/to/installer/auth/kubeconfig'
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.

You can’t perform that action at this time.