Jump to content


From Wikitech

kubectl is the Kubernetes command-line tool to deploy and manage applications on a Kubernetes cluster.

For tasks like doing deployments kubectl should not be used. Instead please refer to helm and helmfile.

On Debian 9 (also known as Debian Stretch) it is included in the package kubernetes-client.

kubectl can be used to view and troubleshoot cluster components and to do certain maintenance tasks. See also the kubectl cheatsheet/.

Run kubectl from the deploy servers


kubectl needs to know how to connect to the cluster and what credentials to use. This information can be stored in the kubeconfig file. By default kubectl uses a variable called KUBECONFIG to find this kubeconfig file. If the variable is not set, it looks in ~/.kube/config.[1]

In order to have kubectl working with your service the KUBECONFIG variable has to be set. This is of the form:


It is easier to use kube_env for this purpose, see below.

Running kubectl Commands

For example to get a list of pods for a service:

KUBECONFIG="/etc/kubernetes/termbox-staging.config" kubectl get pods

Using kube_env

The tool kube_env (present on deploy hosts) simplifies the configuration of kubectl and the access to different clusters and services. Use the following command to setup the KUBECONFIG variable (and many other useful variables like namespace and helm variables):


Then you can use kubectl to access the service:

kubectl get pods

kube_env is aliased to kube-env for consistency with usual CLI tools

kube-environments and kube-services will list for you the available environments and services, which you can also access through the $KUBERNETES_ENV_ENVIRONMENTS and $KUBERNETES_ENV_SERVICES env variables.

Privileged user (for admin access)

The "usual" users have restricted privileges. If more access is needed, root (on deploy hosts) has access to the admin user:

user@deploy1002:~$ sudo -i
root@deploy1002:~# kube-env admin <cluster>

Describe a pod

If there is an issue with a pod not starting and logs don't say anything, use "describe" to get more info. For example:

kubectl describe pod P -n sessionstore

Also see

  1. https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/#set-the-kubeconfig-environment-variable