Install kubectl

Kubernetes provides a command-line interface (CLI) called kubectl to deploy, troubleshoot, and manage applications. Before you can use kubectl, you must ensure you can authenticate with the cluster’s API server. Your credentials are distributed in a file called a kubeconfig, which is read by kubectl.

You must first download the kubeconfig that can be used by kubectl.

Make kubeconfig discoverable by kubectl

kubectl reads the KubeConfig file that is stored in your Home directory file ~/.kube/config, by default.

Platform9 recommends you to place your kubeconfig under~/.kube/config. Otherwise, you can pass kubectl the option --kubeconfig

Download kubectl

kubectl is an executable binary built specifically for combinations of OS and CPU architectures.

Before you can download kubectl, you must identify the version of kubectl to download. The kubectl version must match the Kubernetes version of your cluster.

Follow the steps given below to identify the Kubernetes version of your cluster.

  1. Navigate to Infrastructure > Clusters on the Platform9 Clarity UI. check Kubernetes version
  2. Check the value in the Kubernetes version column for your cluster.

If you are using Linux, you can download kubectl, make it executable, and move it to /usr/local/bin by using the following commands. curl -Lo kubectl chmod +x kubectl && sudo mv kubectl /usr/local/bin/

To install kubectl on other operating systems, refer to Kubernetes documentation.

Make kubeconfig discoverable by kubectl

kubectl will by default read the file ~/.kube/config We recommend placing your kubeconfig there. Otherwise, you can pass kubectl the option --kubeconfig <path to config />

Using kubectl

To see the nodes in your cluster:

kubectl get nodes

Let’s make a Deployment with one nginx Pod:

kubectl run nginx-example --image=nginx --port=80

And watch the Pods as they are created (Ctrl-C to stop):

kubectl get pods --watch

Finally, delete the Deployment. The Pod will be deleted automatically.

kubectl delete deployment nginx-example

For more details, see the Kubectl Overview.