OpenShift Hive

API driven OpenShift cluster provisioning and management

Prerequisites

• Install mockgen:
  • $ go get github.com/golang/mock/gomock; go install github.com/golang/mock/mockgen

Deploying In-Cluster

• Ensure that you have access to an OpenShift cluster and have administrator permissions. This could be oc cluster up, minishift, or an actual cluster you can oc login to.
• Build and deploy to Minishift:
  • $ hack/minishift-deploy.sh
• Build and deploy to current kubectl context using local container image:
  • $ make deploy
• Build and deploy to current kubectl context using remote container image:
  • $ make deploy-sd-dev

Running from Source

• Create the ClusterDeployment CRD:
  • $ kubectl apply -f config/crds/hive_v1alpha1_clusterdeployment.yaml
• Run the Hive controllers from source:
  • $ make run

Using Hive

• Create a ClusterDeployment using local container images:
  • Place the OpenShift images pull secret in a known location like $HOME/config.json
  • Assuming AWS credentials set in the standard environment variables, and our usual SSH key.

  export CLUSTER_NAME="${USER}"
  export ADMIN_EMAIL="${USER}@redhat.com"
  export ADMIN_PASSWORD="letmein"
  export SSH_PUB_KEY="$(ssh-keygen -y -f ~/.ssh/libra.pem)"
  export PULL_SECRET="$(cat ${HOME}/config.json)"
  
  oc process -f config/templates/cluster-deployment.yaml \
     CLUSTER_NAME="${CLUSTER_NAME}" \
     ADMIN_EMAIL="${ADMIN_EMAIL}" \
     ADMIN_PASSWORD="${ADMIN_PASSWORD}" \
     SSH_KEY="${SSH_PUB_KEY}" \
     PULL_SECRET="${PULL_SECRET}" \
     AWS_ACCESS_KEY_ID="${AWS_ACCESS_KEY_ID}" \
     AWS_SECRET_ACCESS_KEY="${AWS_SECRET_ACCESS_KEY}" \
     | oc apply -f -

• Create a ClusterDeployment using remote container images:
  • Place the OpenShift images pull secret in a known location like $HOME/config.json
  • Assuming AWS credentials set in the standard environment variables, and our usual SSH key.

  export CLUSTER_NAME="${USER}"
  export ADMIN_EMAIL="${USER}@redhat.com"
  export ADMIN_PASSWORD="letmein"
  export SSH_PUB_KEY="$(ssh-keygen -y -f ~/.ssh/libra.pem)"
  export PULL_SECRET="$(cat ${HOME}/config.json)"
  export HIVE_IMAGE="quay.io/twiest/hive-controller:latest"
  export HIVE_IMAGE_PULL_POLICY="Always"
  export INSTALLER_IMAGE="quay.io/twiest/installer:v0.2.0"
  export INSTALLER_IMAGE_PULL_POLICY="Always"
  
  oc process -f config/templates/cluster-deployment.yaml \
     CLUSTER_NAME="${CLUSTER_NAME}" \
     ADMIN_EMAIL="${ADMIN_EMAIL}" \
     ADMIN_PASSWORD="${ADMIN_PASSWORD}" \
     SSH_KEY="${SSH_PUB_KEY}" \
     PULL_SECRET="${PULL_SECRET}" \
     AWS_ACCESS_KEY_ID="${AWS_ACCESS_KEY_ID}" \
     AWS_SECRET_ACCESS_KEY="${AWS_SECRET_ACCESS_KEY}" \
     HIVE_IMAGE="${HIVE_IMAGE}" \
     HIVE_IMAGE_PULL_POLICY="${HIVE_IMAGE_PULL_POLICY}" \
     INSTALLER_IMAGE="${INSTALLER_IMAGE}" \
     INSTALLER_IMAGE_PULL_POLICY="${INSTALLER_IMAGE_PULL_POLICY}" \
     | oc apply -f -

• Delete your ClusterDeployment:

  $ oc delete clusterdeployment $USER

Tips

Using the Admin Kubeconfig

Once the cluster is provisioned you will see a CLUSTER_NAME-admin-kubeconfig secret. You can use this with:

kubectl get secret ${USER}-admin-kubeconfig -o json | jq ".data.kubeconfig" -r | base64 -d > ${USER}.kubeconfig
export KUBECONFIG=${USER}.kubeconfig
kubectl get nodes