Get started

Beta

Info

A beta feature is available for testing and limited use. To enable a beta feature in your environment, please contact your DoiT Account Manager or open a support request.

To get started with Kubernetes Lens, you first need to enable the Kubernetes core feature, and then onboard Kubernetes clusters.

Enable Kubernetes core

Enabling the Kubernetes core feature on your connected cloud accounts grants DoiT permissions to access relevant information in your environment.

AWS account

You can enable Kubernetes core when linking a new account or editing a linked account.

See Link your AWS account for detailed instructions; see Kubernetes core for information about the required permissions.

Google Cloud organization or project

You can enable Kubernetes core when connecting a Google Cloud organization or project, or when editing the connection.

See Connect Google Cloud resources for detailed instructions; see Kubernetes core for information about the required permissions.

Once permissions are granted:

• DoiT performs a daily scan of the connected AWS accounts and Google Cloud organizations and projects (midnight UTC for AWS, 2 AM UTC for Google Cloud) to uncover Kubernetes clusters in your cloud environment.

• DoiT synchronizes with PerfectScale for clusters that have onboarded the PerfectScale platform.

Onboard clusters

Kubernetes Lens relies on an agent to collect cluster metrics. To onboard a Kubernetes cluster, you need to install the agent on the cluster.

1. In the DoiT console, select Integrate from the top navigation bar, and then select Assets.

2. Select Kubernetes from the left-hand menu. Here you'll find all the clusters uncovered via the daily scan by the DoiT platform.

   

3. (Optional) If you've onboarded clusters with PerfectScale, select Map clusters to specify mappings between PerfectScale clusters and their corresponding DoiT entities. In so doing, you avoid reinstalling the agent. You can also skip this step at the current stage and map the cluster later when installing the agent.

   

4. Navigate back to the Kubernetes assets list, locate the cluster of interest, select the kebab menu (⋮) in the Action column, and then select Install agent.

Depending on whether the DoiT platform identifies clusters that have installed the agent on PerfectScale, there are two options: install the agent via helm chart, or map the cluster to a PerfectScale one.

Install agent via Helm chart

1. Install Helm on your local system if you haven't done so.

2. Make sure the kubectl command-line tool is configured to communicate with your cluster

   There are multiple ways to point kubectl to the correct cluster. The instructions below are for reference purposes.

   Amazon Elastic Kubernetes Service

   1. Associate your IAM user with the AmazonEKSClusterAdminPolicy access policy for the target cluster.

   2. Create a kubeconfig file to connect kubectl to the EKS cluster, using the following command in the AWS CLI:

      aws eks update-kubeconfig --name <eks_cluster_name> --region <region>

   Google Kubernetes Engine

   1. Install the gcloud CLI.

   2. Set your project property by running the gcloud config set project <projectID> command.

   3. Update the kubeconfig file to point kubectl at the GKE cluster, using the following command:

      gcloud container clusters get-credentials <gkeClusterName> --zone <zone> --project <projectID>

3. Copy and run the Helm command shown in the DoiT console to add the PerfectScale Helm chart repo.

   

4. Select Generate secret.

   1. Note down the values of secret.clientIdand secret.clientSecret in the Helm command displayed on the DoiT console.

   2. Copy and run the Helm command to deploy the chart.

5. Select Done when the Helm deployment is completed.

Map cluster

If the DoiT platform identifies clusters that have installed the agent on PerfectScale and you haven't specified the mapping on the Assets page, you can still map the cluster as below:

1. Select a PerfectScale cluster from the drop-down list.

   

2. Select Map.

3. Review the output.

   

4. Select Done if the information is correct, or Edit if you want to map to a different cluster.

Verify agent status

If the installation or mapping is successful, the Agent status of the cluster on the assets list will show Waiting for data. This status may last three minutes. After that, the status changes to Transmitting Data.

To onboard multiple clusters, repeat the steps above for each one.

It can take up to three minutes for the status in the assets table to update, and up to 24 hours before the data is available in the Kubernetes Lens.

Offboard clusters

To offboard a cluster, run the following kubectl command. Deleting the namespace removes the agent from the cluster and stops all data transmission.

kubectl delete namespace perfectscale

You can also find the command in the instructions to Delete agent.