Skip to content

Steps

On public clouds such as GCP, the controller can automatically provision and configure the required infrastructure.


Step 1: Create Cloud Credentials

With the Auto Provisioning process, the controller programmatically provisions and configures required the infrastructure on public clouds. In order to do this, the controller needs to be configured with service account credentials that will allow it to create, configure and decomission infrastructure on GCP.

The creation of "cloud credentials" is a "One Time" task. This can then be used multiple times to create clusters when required. The provider profile can be deleted anytime by clicking on the "ellipsis" on the on the far right and clicking on "Remove".

The credentials in the provider profile are stored encrypted using the organization's key. They are treated in a manner similar to Private Keys.

Please review GCP Credentials for additional instructions on how to configure and download the service account credentials for GCP.


Step 2: Cluster Configuration

In this step, you will configure and create a cluster object in the Controller for auto provisioning an upstream K8s cluster in your Google Cloud account using the GCP Credential created in Step 1 above.

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 GCP Cluster

  • Select "Public Cloud" for Environment.
  • Select "GCP" option for Cloud provider
  • And select "Upstream Kubernetes" option for Kubernetes Distribution
  • 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 GCP Cluster

  • In General settings, select the cluster blueprint from the "Blueprint" drop down
  • Select the Kubernetes version from the "K8s Version" drop down
  • Then select the GCP Credential Name created in Step 1 above from the "Cloud Credentials" drop down
  • Select the GCP region from the "Region" drop down
  • And select the instance type from the "Instance Type" drop down
  • In the "Advanced" settings, select to enable "High Availability (Multi Master)" if you would like to provision a multi-master cluster.
  • Click "Continue" to create the cluster

New GCP Cluster

NOTE: For auto-provisioned clusters, the controller automatically programs the cluster with the "region" metadata based on information from the selected region.


Step 3: Cluster Provisioning

At this point, the controller has everything it needs to provision the cluster, test it and make it available for workloads.

Note that manual intervention is NOT REQUIRED unless there is an error or an issue to deal with. The end-to-end process before the cluster is ready for workloads can take ~15 minutes.

New GCP Cluster

Click "Provision" button to start cluster creation in your Google Cloud account. The end-to-end process comprises two distinct steps.

Infra Creation

In this step, the controller uses the cloud credentials to programmatically create the infrastructure in the selected GCP region with the provided specifications.

Depending on the region selected, the creation and configuration of infrastructure can take ~5 mins.

Behind the scenes, the controller automatically creates and configures required VPC, IPs, SSH keys, instances, volumes etc. If the process encounters issues during the infrastructure creation step, everything is undone and a suitable error message is presented to the user.

New GCP Cluster

Software Provisioning

Once the necessary infrastructure is successfully created and configured, the workflow automatically transitions to the next step i.e. software provisioning.

Required software components are automatically downloaded, deployed and tested on the individual cluster nodes.

New GCP Cluster

Once this step is complete, the automated cluster provisioning is performed and the cluster automatically transitions to a "READY" state and can accept workloads.

Healthy Cluster on GCP

To view a provisioned cluster's config

  • Click on the cluster name
  • Click on Configuration

GCP Cluster Config


Resource Quotas

GCP enforces "quotas" for resources. The Auto Provisioning process can encounter errors if these quota limits are breached in the customer's GCP project. Customers can submit requests to Google for quota changes. More information here.


Step 4: Cluster De-Provisioning

If you wish to deprovision the auto provisioned cluster in your Google Cloud account, follow the steps below to delete the cluster:

  • Click on the Options icon (i.e. gear) on the far right of the selected cluster.
  • Select Delete to remove the cluster object from the Rafay Controller.

The controller will automatically delete all resources created by the controller during the provisioning in your Google Cloud account.

Delete Cluster in Controller