Common Kubectl Commands

1
kubectl create -f FILENAME

1
# Create a Pod from pod.yml
2
kubectl create -f ./pod.yml
3

4
# Create a Pod from YAML via stdin
5
cat pod.yml | kubectl create -f -
6

7
# Grant the cluster-admin role to gitlab-runner in the namespace
8
kubectl create rolebinding deploy-runner --clusterrole=cluster-admin --serviceaccount=deploy:default --namespace=hsh-pre-service

1
kubectl expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type]

1
# Create a Service for nginx rc and forward Service port 80 to container port 8000
2
kubectl expose rc nginx --port=80 --target-port=8000
3

4
# Create a Service for the rc identified by type and name in "nginx-controller.yml",
5
# forwarding Service port 80 to container port 8000
6
kubectl expose -f nginx-controller.yml --port=80 --target-port=8000

1
kubectl get RESOURCE_NAME

1
# View master status
2
kubectl get componentstatuses
3

4
# List all namespaces
5
kubectl get namespaces
6

7
# List all Pods
8
kubectl get pods
9

10
# Show more information about Pods (e.g., Pod IP and Node)
11
kubectl get pods -o wide
12

13
# List the rc named web
14
kubectl get replicationcontroller web
15

16
# Get information about Pod web-pod-13cd8 and output it in JSON format
17
kubectl get -o json pod web-pod-13cd8
18

19
# Find Pods defined in pod.yaml and output them in JSON format
20
kubectl get -f pod.yaml -o json
21

22
# Get the status of a Pod
23
kubectl get -o template pod/kube-dns-795f5f6f9c-ldxxs --template {{.status.phase}}
24

25
# List all rc and services
26
kubectl get rc,services
27

28
# Get all rc, svc, and Pod resources that match the criteria
29
kubectl get rc/web service/frontend pods/web-pod-13cd8
30

31
# Get all resources
32
kubectl get all

1
kubectl edit (RESOURCE/NAME | -f FILENAME)

1
# Edit the Service named "docker-registry"
2
kubectl edit svc/docker-registry
3

4
# Use an alternative editor
5
KUBE_EDITOR="nano" kubectl edit svc/docker-registry
6

7
# Edit deployment "mydeployment" in YAML format and save the changed config into annotations
8
kubectl edit deployment/mydeployment -o yaml --save-config

1
kubectl delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)])

1
# Delete the Pod specified by type and name in pod.yml
2
kubectl delete -f ./pod.yml
3

4
# Delete the Pod specified by type and name in the YAML from stdin
5
cat pod.json | kubectl delete -f -
6

7
# Delete Pods and Services named "foo" and "bar"
8
kubectl delete pod,service foo bar
9

10
# Delete Pods and Services whose label name=myLabel
11
kubectl delete pods,services -l name=myLabel
12

13
# Force delete Pods on a dead node
14
kubectl delete pod foo --grace-period=0 --force
15

16
# Delete all Pods
17
kubectl delete pods --all

1
kubectl rollout SUBCOMMAND

1
# Show the rollout history of a deployment
2
kubectl rollout history deployment/abc
3

4
# Show details of daemonset revision=3
5
kubectl rollout history daemonset/abc --revision=3
6

7
# Mark a deployment as paused. While paused, updates to the deployment have no effect.
8
kubectl rollout pause deployment/nginx
9

10
# Resume a paused deployment
11
kubectl rollout resume deployment/nginx
12

13
# Show the rollout status of a deployment
14
kubectl rollout status deployment/nginx
15

16
# Roll back a deployment to the previous revision
17
kubectl rollout undo deployment/abc
18
kubectl rollout undo --dry-run=true deployment/abc
19

20
# Roll back a daemonset to revision 3
21
kubectl rollout undo daemonset/abc --to-revision=3
22

23
# Set the number of replicas in the ReplicaSet named foo to 3
24
kubectl scale --replicas=3 rs/foo
25

26
# Set the number of Pod replicas defined in foo.yaml to 3
27
kubectl scale --replicas=3 -f foo.yaml
28

29
# If mysql currently has 2 replicas, scale it to 3
30
kubectl scale --current-replicas=2 --replicas=3 deployment/mysql
31

32
# Set the number of Pod replicas in multiple RCs
33
kubectl scale --replicas=5 rc/foo rc/bar

1
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)

1
# Describe a node
2
kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal
3

4
# Describe a Pod
5
kubectl describe pods/nginx
6

7
# Describe the Pod specified by type and name in pod.yml
8
kubectl describe -f pod.yml
9

10
# Describe all Pods
11
kubectl describe pods
12

13
# Describe all Pods with label name=myLabel
14
kubectl describe po -l name=myLabel
15

16
# Describe all Pods managed by the replication controller "frontend"
17
# (Pods created by an rc use the rc name as prefix)
18
kubectl describe pods frontend

1
kubectl logs [-f] [-p] POD [-c CONTAINER]

1
# Return a snapshot of logs from Pod nginx (with a single container)
2
kubectl logs nginx
3

4
# Return a snapshot of logs from the previously terminated container web-1 in Pod ruby
5
kubectl logs -p -c ruby web-1
6

7
# Stream logs from container web-1 in Pod ruby
8
kubectl logs -f -c ruby web-1
9

10
# Show only the last 20 log lines from Pod nginx
11
kubectl logs --tail=20 nginx
12

13
# Show all logs generated in the last hour from Pod nginx
14
kubectl logs --since=1h nginx

1
kubectl exec POD [-c CONTAINER] -- COMMAND [args...]

1
# Run "date" in the first container of Pod 123456-abcd and print the output
2
kubectl exec 123456-abcd date
3

4
# Run "date" in container ruby-container of Pod 123456-abcd and print the output
5
kubectl exec 123456-abcd -c ruby-container date
6

7
# Start an interactive shell by sending console input to the "bash" command
8
# in ruby-container of Pod 123456-abcd and forwarding stdout/stderr back
9
kubectl exec 123456-abcd -c ruby-container -i -t -- bash -il

1
kubectl apply -f FILENAME

1
# Create a Pod from pod.yml
2
kubectl apply -f ./pod.yml
3

4
# Create a Pod from YAML via stdin
5
cat pod.yml | kubectl apply -f -

1
kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

1
# Add label unhealthy=true to Pod foo
2
kubectl label pods foo unhealthy=true
3

4
# Overwrite label 'status' on Pod foo with value 'unhealthy'
5
kubectl label --overwrite pods foo status=unhealthy
6

7
# Add a label to all Pods in the namespace
8
kubectl label pods --all status=unhealthy
9

10
# Update the label on Pod foo only if resource-version=1
11
kubectl label pods foo status=unhealthy --resource-version=1
12

13
# Delete label "bar" from Pod foo (use a trailing minus sign)
14
kubectl label pods foo bar-