kubectl常用命令

kubectl简介

Kubectl is a command line interface for running commands against Kubernetes clusters.

没错，kubectl是一个命令行工具，用来控制K8S集群。kubectl该怎么读？可以参考HowToPronounce-kubectl，郝同学喜欢读作kubecontrol。

kubectl命令格式为：

kubectl [command] [TYPE] [NAME] [flags]

更多内容，参考：

• Overview of kubectl
• kubectl Cheat Sheet
• The Kubectl Book
• Kubernetes kubectl 命令表

《K8S入门篇》一文中，已经学习了kubectl的安装方法，并且使用了一些简单命令。本文整理一下kubectl的常用命令，方便记忆和复习。

环境准备

指定配置文件

# 指定默认配置文件
export KUBECONFIG=~/.kube/config

# 查看kubectl配置
kubectl config view

# 指定配置文件和context
kubectl config --kubeconfig=/root/vk-kube-config use-context voidking@kubenertes

# 指定单次运行配置文件
kubectl get deployments --kubeconfig=/root/.kube/config
kubectl get deployments --kubeconfig /root/.kube/config

# 指定默认namespace
kubectl config set-context --current --namespace=voidking
kubectl config set-context $(kubectl config current-context) --namespace=voidking

# 多个配置整合成一个配置
KUBECONFIG=~/.kube/config:~/Downloads/new-config kubectl config view --merge --flatten > ~/.kube/newconfig
export KUBECONFIG=~/.kube/newconfig

# 同时使用多个配置
export KUBECONFIG=~/.kube/config:~/Download/new-config

# 查看使用配置
kubectl config get-contexts
kubectl config use-context voidking@kubenertes

命令自动补全

1、linux下配置

yum install -y bash-completion
source <(kubectl completion bash)
echo "source <(kubectl completion bash)" >> ~/.bash_profile

2、mac下配置

brew install bash-completion
source <(kubectl completion zsh)
echo "source <(kubectl completion zsh)" >> ~/.bash_profile

使用别名缩写

# kubectl缩写为k
# alias k=kubectl
alias k="/usr/local/bin/kubectl"
complete -F __start_kubectl k

# 可选alias
alias kg="kubectl get"
alisa kd="kubectl describe"

建议把配置写入 .bash_profile ，登录后别名自动生效。

查看集群信息

# 查看集群信息
kubectl cluster-info
kubectl cluster-info dump

# 查看集群状态
kubectl get cs

# 查看node资源使用
kubectl top node

# 查看集群事件
kubectl get ev

查看帮助

查看资源缩写

kubectl describe
kubectl api-resources

建议记住常用资源的SHORTNAMES，可以提升输入效率。
此外，记住常用资源的APIGROUP，可以提高编写yaml文件时的效率。

查看可用api版本

kubectl api-versions

yaml帮助

yaml文件分成四部分，apiVersion、kind、metadata和spec。
apiVersion和kind是关联的，参考kubectl api-resources。
metadata必填name、namespace、labels。
pod.spec主要填containers的name和image；deployment.spec主要填replicas、template和selector；service.spec主要填selector、ports和type。

编写yaml文件的过程中，如果忘记了某些结构和字段，可以使用kubectl explain命令来获取帮助。

1、查看资源包含哪些字段
以查看deployment的yaml包含哪些字段为例：

kubectl explain deployment
kubectl explain deployment --api-version=apps/v1

2、查看子字段
以查看节点亲和性字段为例：

kubectl explain deployment.spec.template.spec.affinity
kubectl explain deployment.spec.template.spec.affinity.nodeAffinity
...
kubectl explain deployment.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

资源相关

查看资源

1、查看集群的所有资源

kubectl get all
kubectl get all -o wide

# 根据label筛选所有资源
kubectl get all -l 'env=dev'

2、查看deployment

# 查看deployment
kubectl get deploy
kubectl get deploy -n voidking -o wide
kubectl get deploy -l 'env=dev'
kubectl get deploy --selector='env=dev'
kubectl get deploy --all-namespaces
kubectl get deploy --show-labels

# 查看deployment实时变化
kubectl get deploy --watch

# 查看指定deployment
kubectl get deploy/deployment-name
kubectl get deploy deployment-name

# 指定namespace
kubectl get deploy -n voidking

# 根据label选择deployment
kubectl get deploy --selector="name=nginx,type=frontend"

# 查看deployment详细信息
kubectl describe deploy

pod、service、node的查看方法和deployment相同。

创建资源

kubectl create -f deploy.yaml
kubectl apply -f deploy.yaml

更新资源

# 编辑集群中的资源
kubectl edit deployment deployment-name

# 比较manifest与集群中当前资源的不同
kubectl diff -f deploy.yaml

# 应用最新定义
kubectl replace -f deploy.yaml
kubectl apply -f deploy.yaml

# 添加label
kubectl label deployment deployment-name new-label=awesome

# 添加annotation
kubectl annotate deployment deployment-name icon-url=http://goo.gl/XXBTWq 

# 部分修改deployment
kubectl patch deployment deployment-name --type json -p='[{"op": "remove", "path": "/spec/template/spec/containers/0/livenessProbe"}]'

删除资源

kubectl delete deployment deployment-name

扩缩容

方法一：通过扩缩容命令。

kubectl scale --replicas=2 deployment deployment-name

方法二：通过更新yaml文件。

暴露服务

# 为deployment创建clusterip，暴露clusterip的80端口
kubectl expose deployment deployment-name --port=80 --name svc-name
# 为deployment创建clusterip，暴露clusterip的6789端口
kubectl expose deployment deployment-name --target-port=80 --port=6789
kubectl expose -f vk-deploy.yaml --target-port=80 --port=6789
# 创建nodeport，暴露clusterip的80端口，暴露node的随机端口
kubectl expose deployment deployment-name --port=80 --type=NodePort --name svc-name

# 创建clusterip，暴露clusterip的80端口
kubectl create service clusterip svc-name --tcp=80:80
# 创建nodeport，暴露clusterip的80端口，暴露node的30080端口
kubectl create service nodeport svc-name --tcp=80:80 --node-port=30080

版本回退

# 查看发布历史
kubectl rollout history deployment deployment-name
# 查看发布状态
kubectl rollout status deployment deployment-name
# 回退到上一个版本
kubectl rollout undo deployment deployment-name

cm和secret

1、创建configmap

kubectl create configmap special-config --from-literal=special.how=very --from-literal=special.type=charm
kubectl create configmap game-config-3 --from-file=<my-key-name>=<path-to-file>

2、创建secret

# 在命令中指定key和value
kubectl create secret generic db-user-pass --from-literal=username=voidking --from-literal=password='vkpassword'
kubectl get secret db-user-pass -o yaml

# 在文件中指定value
echo -n 'voidking' > ./username.txt
echo -n 'vkpassword' > ./password.txt
kubectl create secret generic db-user-pass --from-file=./username.txt --from-file=./password.txt
kubectl create secret generic db-user-pass --from-file=username=./username.txt --from-file=password=./password.txt
kubectl get secret db-user-pass -o yaml

在yaml文件中看到的username和password，都是经过base64加密的字符串。

# 加密
echo -n 'voidking' | base64
# 解密
echo 'dm9pZGtpbmc=' | base64 --decode

创建多个资源

如果要创建ns，然后在ns中创建configmap，最后创建deployment（依赖configmap），该怎么操作？
方法一：挨个apply

kubectl apply -f ns.yaml
kubectl apply -f cm.yaml
kubectl apply -f deploy.yaml

方法二：按顺序合并，然后apply

cat ns.yaml <(echo "---") cm.yaml <(echo "---") deploy.yaml > ns-cm-deploy.yaml
kubecl apply -f ns-cm-deploy.yaml

方法三：多次apply

kubectl apply -f .
kubectl apply -f .

方法四：添加编号

mv ns.yaml 00-ns.yaml
mv cm.yaml 01-cm.yaml
mv deploy.yaml 02-deploy.yaml
kubectl apply -f .

资源拼接

参考 Kustomize。

yaml相关

导出yaml或json文件

# 导出deployment的yaml文件
kubectl get deploy -o yaml > deploy.yaml

# 导出deployment的json文件
kubectl get deploy -o json > deploy.json

# 导出指定deployment的yaml文件
kubectl get deploy/deployment-name -o yaml > deploy-name.yaml

# 导出指定deployment的json文件
kubectl get deploy/deployment-name -o json > deploy-name.json

pod、service、node的yaml/json文件的导出方法和deployment相同。

pod yaml

生成pod的yaml文件模板：

kubectl run vkpod --image=nginx --restart=Never --dry-run=client -oyaml
kubectl run vk-pod --image=nginx --generator=run-pod/v1 -l 'name=vk-pod,env=dev' --dry-run -o yaml
kubectl run vk-pod --image=nginx --generator=run-pod/v1 --labels='name=vk-pod,env=dev' --dry-run -o yaml
kubectl run vk-pod --image=busybox --generator=run-pod/v1 --dry-run -o yaml --command -- sleep 1000

更多内容，参考Kubernetes kubectl run 命令详解和kubectl 的用法约定。

deployment yaml

1、生成deployment的yaml文件模板（历史方法）：

kubectl run vk-deploy --image=nginx --dry-run -o yaml

会出现提示：
kubectl run –generator=deployment/apps.v1 is DEPRECATED and will be removed in a future version. Use kubectl run –generator=run-pod/v1 or kubectl create instead.
因为官方不推荐使用 run-pod/v1 以外的其他生成器，其他生成器不久后就会弃用。更多内容参考kubectl run。

2、从已有K8S集群中已有资源中导出yaml模板文件（历史方法）：

kubectl get deploy/deployment-name -o yaml --export > deploy-name.yaml

也会出现提示：
Flag –export has been deprecated, This flag is deprecated and will be removed in future.
很尴尬，–export 也要弃用了，且用且珍惜吧。

3、生成deployment的yaml文件模板（推荐方法）：

kubectl create deployment vk-deploy --image=nginx --dry-run -o yaml

更多内容，参考Kubernetes kubectl create deployment 命令详解。

注意，我们并不需要在deployment中指定容器对外暴露的ports，因为该字段只是一个提示作用。

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Cannot be updated.

service yaml

生成service的yaml文件模板（推荐方法）：

kubectl create service clusterip vk-svc --tcp="5678:80" --dry-run -o yaml

更多内容，参考Kubernetes kubectl create service 命令详解和Service。

yaml验证

kubectl create --validate -f deployment.yaml

node相关

taint和tolerations

# 添加taint
kubectl taint nodes node1 key1=value1:NoSchedule
kubectl taint nodes node1 key2=value2:PreferNoSchedule
kubectl taint nodes node1 key3=value3:NoExecute

# 删除taint
kubectl taint nodes node1 value1:NoSchedule-

同时，要在pod yaml的spec下添加tolerations字段：

spec:
  tolerations:
  - key: "key1"
    operator: "Equal"
    value: "value1"
    effect: "NoSchedule"
  - key: "key2"
    operator: "Exists"
    effect: "PreferNoSchedule"
  - key: "key3"
    operator: "Equal"
    value: "value3"
    effect: "NoExecute"

label和affinity

# 添加label
kubectl label nodes node1 key1=value1,key2=value2

# 删除label
kubectl label nodes node1 key1-

同时，要在pod yaml中添加tolerations字段：

nodeSelector:
  disktype: ssd

或者，使用：

spec:
  affinity:
    nodeAffinity:
      requiredDuringSchedulingIgnoredDuringExecution:
        nodeSelectorTerms:
        - matchExpressions:
          - key: key1
            operator: In
            values:
            - value1
            - valuex
      preferredDuringSchedulingIgnoredDuringExecution:
      - weight: 1
        preference:
          matchExpressions:
          - key: key2
            operator: In
            values:
            - value2
            - valuey

node封锁

如果node存在问题，或者node需要升级维护，这时需要对node进行封锁，并且驱除pod。

# 封锁node，不允许分配pod
kubectl cordon nodename

# 从指定node驱除pod
kubectl drain nodename --ignore-daemonsets

# 解除node的封锁，允许分配pod
kubectl uncordon nodename

容器交互

执行命令

1、登录容器

kubectl exec -it pod-name /bin/bash
kubectl exec -it pod-name -c container-name /bin/bash
kubectl exec -it pod-name -c container-name sh

2、直接执行命令

kubectl exec pod-name env
kubectl exec pod-name -- env
kubectl exec pod-name -it -- env
kubectl exec -n default pod-name -it -- env
# 命令带参数时必须加双横线
kubectl exec pod-name -- sh -c 'echo ${LANG}'

拷贝文件

# 拷贝pod内容到宿主机
kubectl cp podname-564949c96c-m986n:/path/filename .

故障排查

故障排查的第一步是先给问题分下类。这个问题是什么？Pods，Replication Controller或者Service？
更多内容参考应用故障排查。

Pods排查

# 查看pod详细信息
kubectl describe pods ${POD_NAME}

# 查看容器日志
kubectl logs ${POD_NAME} ${CONTAINER_NAME}

# 查看crashed容器日志
kubectl logs --previous ${POD_NAME} ${CONTAINER_NAME}

# 查看运行的容器内部日志
kubectl exec ${POD_NAME} -c ${CONTAINER_NAME} -- cat /var/log/cassandra/system.log

# 查看运行的容器内部日志（pod只有一个容器）
kubectl exec ${POD_NAME} -- cat /var/log/cassandra/system.log

RC排查

Replication Controllers排查

# 监控rc相关事件
kubectl describe rc ${CONTROLLER_NAME}

Services排查

# 查看endpoints资源，service选择到了哪些pod和端口
kubectl get endpoints ${SERVICE_NAME}

小技巧

service cidr

怎样查看一个k8s集群的service ip范围？

kubeadm config view | grep Subnet
kubectl get pods -n kube-system kube-apiserver-master -oyaml | grep service-cluster-ip-range

pod cidr

怎样查看一个k8s集群的pod ip范围？

kubeadm config view | grep Subnet
kubectl cluster-info dump | grep -i cidr

如果上面两个方法都找不到，那么还可以通过网络组件的日志来查看，以weave为例。

docker ps | grep weave
docker logs <weave-container-id> | grep ipalloc-range

k8s工具箱

voidking/k8s-tool