HyperShift

Guest clustering for OpenShift.

Prerequisites

• Admin access to an OpenShift cluster (version 4.7).
• The OpenShift oc CLI tool.
• Kustomize

Installation

Install HyperShift into the management cluster:

$ make install

Remove HyperShift from the management cluster:

$ make uninstall

Create a cluster

First, create the following files containing secrets used by the example cluster:

• config/example-cluster/pull-secret a valid pull secret for image pulls.
• config/example-cluster/ssh-key an SSH public key for guest node access.
• config/example-cluster/aws-creds an aws credentials file.

Install the example cluster:

$ make install-example-cluster

If you want to see but not apply the example cluster resource (i.e. dry run), try:

$ make example-cluster

When the cluster is available, get the guest kubeconfig using:

$ oc get secret --namespace hypershift example-kubeconfig --template={{.data.value}} | base64 -D

To create additional node pools, create a resource like:

apiVersion: hypershift.openshift.io/v1alpha1
kind: NodePool
metadata:
  namespace: hypershift
  name: example-extended
spec:
  clusterName: example
  autoScaling:
    max: 0
    min: 0
  nodeCount: 1
  platform:
    aws:
      instanceType: m5.large

And delete the cluster using:

$ oc delete --namespace hypershift openshiftclusters/example