github.com/openshift/installer@v1.4.17/README.md (about)

     1  # OpenShift Installer
     2  
     3  ## Supported Platforms
     4  
     5  * [AWS](docs/user/aws/README.md)
     6  * [AWS (UPI)](docs/user/aws/install_upi.md)
     7  * [Azure](docs/user/azure/README.md)
     8  * [Bare Metal (UPI)](docs/user/metal/install_upi.md)
     9  * [Bare Metal (IPI)](docs/user/metal/install_ipi.md)
    10  * [GCP](docs/user/gcp/README.md)
    11  * [GCP (UPI)](docs/user/gcp/install_upi.md)
    12  * [Libvirt with KVM](docs/dev/libvirt/README.md) (development only)
    13  * [OpenStack](docs/user/openstack/README.md)
    14  * [OpenStack (UPI)](docs/user/openstack/install_upi.md)
    15  * [Power](docs/user/power/install_upi.md)
    16  * [oVirt](docs/user/ovirt/install_ipi.md)
    17  * [oVirt (UPI)](docs/user/ovirt/install_upi.md)
    18  * [vSphere](docs/user/vsphere/README.md)
    19  * [vSphere (UPI)](docs/user/vsphere/install_upi.md)
    20  * [z/VM](docs/user/zvm/install_upi.md)
    21  
    22  ## Quick Start
    23  
    24  First, install all [build dependencies](docs/dev/dependencies.md).
    25  
    26  Clone this repository. Then build the `openshift-install` binary with:
    27  
    28  ```sh
    29  hack/build.sh
    30  ```
    31  
    32  This will create `bin/openshift-install`. This binary can then be invoked to create an OpenShift cluster, like so:
    33  
    34  ```sh
    35  bin/openshift-install create cluster
    36  ```
    37  
    38  The installer will show a series of prompts for user-specific information and use reasonable defaults for everything else.
    39  In non-interactive contexts, prompts can be bypassed by [providing an `install-config.yaml`](docs/user/overview.md#multiple-invocations).
    40  
    41  If you have trouble, refer to [the troubleshooting guide](docs/user/troubleshooting.md).
    42  
    43  ### Connect to the cluster
    44  
    45  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.
    46  
    47  Example output:
    48  
    49  ```sh
    50  INFO Waiting 10m0s for the openshift-console route to be created...
    51  INFO Install complete!
    52  INFO To access the cluster as the system:admin user when using 'oc', run
    53      export KUBECONFIG=/path/to/installer/auth/kubeconfig
    54  INFO Access the OpenShift web-console here: https://console-openshift-console.apps.${CLUSTER_NAME}.${BASE_DOMAIN}:6443
    55  INFO Login to the console with user: kubeadmin, password: 5char-5char-5char-5char
    56  ```
    57  
    58  ### Cleanup
    59  
    60  Destroy the cluster and release associated resources with:
    61  
    62  ```sh
    63  openshift-install destroy cluster
    64  ```
    65  
    66  Note that you almost certainly also want to clean up the installer state files too, including `auth/`, `terraform.tfstate`, etc.
    67  The best thing to do is always pass the `--dir` argument to `create` and `destroy`.
    68  And if you want to reinstall from scratch, `rm -rf` the asset directory beforehand.