Skip to content

Prerequisites

Generic

  • The HyperShift CLI (hypershift).

    Install it using Go 1.18: 

    1
2
3
4
    git clone https://github.com/openshift/hypershift.git
cd hypershift
make build
sudo install -m 0755 bin/hypershift /usr/local/bin/hypershift

  • Admin access to an OpenShift cluster (version 4.8+) specified by the KUBECONFIG environment variable.

  • The OpenShift CLI (oc) or Kubernetes CLI (kubectl).
  • A valid pull secret file for the quay.io/openshift-release-dev repository.

Authentication

There are two ways to set up authentication

  • Authenticate IBM Cloud Clients by setting the IBMCLOUD_API_KEY environment var to your API Key.
  • Authenticate IBM Cloud Clients by setting the IBMCLOUD_CREDENTIALS environment var pointing to a file containing your API Key.

Base Domain

Need to have existing CIS Domain in IBM Cloud Internet Services which can be used as a BASEDOMAIN while creating the cluster.

Region and Zones

Refer this to get possible region and zone values. Substitute those with REGION ZONE and VPC_REGION while creating the cluster.

Release Image

Use this to get latest multi arch nightly build as release image. Substitute it with RELEASE_IMAGE while creating the cluster.

Custom Endpoints

Use following environment variables to set custom endpoint. 

IBMCLOUD_POWER_API_ENDPOINT    - to setup PowerVS custom endpoint
IBMCLOUD_VPC_API_ENDPOINT      - to setup VPC custom endpoint
IBMCLOUD_PLATFORM_API_ENDPOINT - to setup platform services custom endpoint