Skip to content

Provision

Follow the instructions below if you wish to provision a managed upstream Kubernetes cluster using the prepackaged OVA image in your vSphere environment.


Step 1: Create Cluster

In this step, you will configure and create a cluster object in the Controller. This step will provide you with newly generated cluster activation secrets for this cluster. You will use this (optionally inject into the Cloud Init template) to bring up a VM on vSphere.

As an Org Admin or Infrastructure Admin for a Project

  • Login into the Web Console and go to Infrastructure > Clusters.
  • Click on “New Cluster”.
  • Select "Create a New Cluster" option
  • Click "Continue" to go to the next configuration page

New OVA Cluster

  • Select "Data center/Edge" for Environment.
  • Then select "OVA/OVF" option for Package type
  • Provide a name for your cluster (the use of underscore is not allowed in the name)
  • And provide an optional description for the cluster
  • Click "Continue" to go to the next configuration page

New OVA Cluster

  • In General settings, select a location from the "Location" drop down
  • Select the cluster blueprint from the "Blueprint" drop down
  • Select the Kubernetes version from the "K8s Version" drop down
  • Select “Ubuntu 18.04” for the "Operating System" drop down

New OVA Cluster

  • In the "Advanced" settings, (optionally) change the "Storage Path" for the local storage
  • (Optionally) enable “GlusterFS” for StorageClass (if this option is selected, make sure to attach a raw unformatted volume to your VM)
  • Select the Default Storage Class in the drop down.
  • Select to enable “Approve nodes automatically” option if necessary
  • Select to enable "Install GPU driver" option if your have GPU enabled in all your nodes
  • Select to enable "High Availability (Multi Master)" if you like to provision a multi-master cluster
  • Select to enable "Dedicated Master" if you like the have a dedicate master model for the cluster
  • Click "Continue" to create the cluster

New OVA Cluster

NOTE: Selecting node auto approval will help avoid a manual approval step in the provisioning process. It is highly recommended for controlled, factory type assembly environments.

Note

Selecting node auto approval will help avoid a manual approval step in the provisioning process. It is highly recommended for controlled environments where automation is critical.


Overrides

A default, the latest k8s version is pre-packaged in the provided OVA image. If another version of Kubernetes is selected during provisioning, it will be automatically downloaded from the Controller and used for provisioning. However, this will require additional time for provisioning and will require the download of software over the Internet.


Step 2: Download Activation Secrets

Download the installer and activation secrets (i.e credentials and passphrase files) from the node installation instructions. You will have two files that are ”unique” to this cluster.

  • "clustername"-credentials.pem
  • "clustername"-passphrase.txt

New OVA Cluster

Important

The activation secrets are unique to this cluster and cannot be reused with other clusters.


Step 3: Launch VM

Use the vSphere Console to launch the VM. An illustrative screenshots shown below

Launch VM for Node

Launch VM for Node

Launch VM for Node

Make sure to disable the "Power on automatically" option so you can change the VM Settings before powering on the VM.

Launch VM for Node

Launch VM for Node

Launch VM for Node

Change the VM Settings to the required CPU and Memory as indicated here

Change VM Settings

And (optionally) add additional volumes for your application storage.

Change VM Settings

Power on the VM and configure networking (IP address and gateway, ...) for the VM if not using DHCP.

Please refer to instruction here on how to access to the VM from vSphere console.

By default, the VM launched via OVA image does not allow ssh access. Please refer to instruction here if you would like to enable ssh access to the VM.

Once the VM has been launched successfully, copy the files downloaded from Step 2 above to the VM.

Then, run the installation pre-flight check using the command from the Step 3 of the Web Console node installation instructions to make sure there is no error (you can ignore the errors indicated the previous installed docker and Kubernetes versions)

An illustrative screenshot shown below:

Run Conjurer

After that, run the installation script using the command from the Step 4 of the Console node installation instructions.

An illustrative screenshot shown below:

Run Conjurer

Once the installation script is run successfully with the activation secrets, the node will automatically attempt to connect and register with the Controller.

An illustrative screenshot shown below:

Node Checkin


Step 4: Configure Cluster

In the Web Console, in a few seconds, you will see that the node has been discovered and approved. Click on “Configure” and follow the wizard

Master Role

Enable Master role. This will configure the node to act as a Kubernetes master.

Storage

The Controller auto-detects and displays the available volumes. Select the correct volume from the dropdown (currently “/dev/sdb” with a capacity of 50GB)

Interface

The controller auto-detects and displays the available interfaces. Select the correct interface from the dropdown

Configure Node

Ingress IP

In this step, we will configure the IP of the cluster node where you expect to receive incoming traffic. Applications (workloads) deployed on the managed cluster can be accessed on this IP.

  • Look up the IP addresses assigned to the VM and copy/paste this here. This information is also available directly in the interface dropdown.

Configure IP


Step 5: Provision Cluster

Once configured, Click on “Provision” to provision the cluster and wait for the process to complete.

Important

If you selected a multi master, HA cluster configuration, you will have to configure at least three nodes before you will be allowed to provision the cluster.

Depending on the resources provided to the VM, the provisioning process can take ~5 minutes to complete. Progress and status updates will be displayed to the user during this process as the software components are configured in the VM.

An illustrative screenshot shown below.

Provision Cluster


Step 6: Validate Provisioning

Once the cluster is provisioned, verify the following:

Control Plane

This should show as Green and report status as HEALTHY. This means that the k8s cluster operating in vSphere is in a healthy state.

Reachability Check

This should report status as SUCCESS. In addition, the “Last Check in Time” should be within a minute. This means that a heartbeat has been established between the Kubernetes cluster on vSphere and the Controller. An illustrative screenshot of a “successfully” provisioned cluster in the Web Console is shown below.

Successful Provisioning