kubectl 备忘单

本页列举了常用的 “kubectl” 命令和标志

Kubectl 自动补全

BASH

  1. source <(kubectl completion bash) # 在 bash 中设置当前 shell 的自动补全,要先安装 bash-completion 包。
  2. echo "source <(kubectl completion bash)" >> ~/.bashrc # 在您的 bash shell 中永久的添加自动补全

您还可以为 kubectl 使用一个速记别名,该别名也可以与 completion 一起使用:

  1. alias k=kubectl
  2. complete -F __start_kubectl k

ZSH

  1. source <(kubectl completion zsh) # 在 zsh 中设置当前 shell 的自动补全
  2. echo "[[ $commands[kubectl] ]] && source <(kubectl completion zsh)" >> ~/.zshrc # 在您的 zsh shell 中永久的添加自动补全

Kubectl 上下文和配置

设置 kubectl 与哪个 Kubernetes 集群进行通信并修改配置信息。 查看使用 kubeconfig 跨集群授权访问 文档获取配置文件详细信息。

  1. kubectl config view # 显示合并的 kubeconfig 配置。
  2. # 同时使用多个 kubeconfig 文件并查看合并的配置
  3. KUBECONFIG=~/.kube/config:~/.kube/kubconfig2 kubectl config view
  4. # 获取 e2e 用户的密码
  5. kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
  6. kubectl config view -o jsonpath='{.users[].name}' # 显示第一个用户
  7. kubectl config view -o jsonpath='{.users[*].name}' # 获取用户列表
  8. kubectl config get-contexts # 显示上下文列表
  9. kubectl config current-context # 展示当前所处的上下文
  10. kubectl config use-context my-cluster-name # 设置默认的上下文为 my-cluster-name
  11. # 添加新的用户配置到 kubeconf 中,使用 basic auth 进行身份认证
  12. kubectl config set-credentials kubeuser/foo.kubernetes.com --username=kubeuser --password=kubepassword
  13. # 在指定上下文中持久性地保存名字空间,供所有后续 kubectl 命令使用
  14. kubectl config set-context --current --namespace=ggckad-s2
  15. # 使用特定的用户名和名字空间设置上下文
  16. kubectl config set-context gce --user=cluster-admin --namespace=foo \
  17. && kubectl config use-context gce
  18. kubectl config unset users.foo # 删除用户 foo

Kubectl apply

apply 通过定义 Kubernetes 资源的文件来管理应用。 它通过运行 kubectl apply 在集群中创建和更新资源。 这是在生产中管理 Kubernetes 应用的推荐方法。 参见 Kubectl 文档

创建对象

Kubernetes 配置可以用 YAML 或 JSON 定义。可以使用的文件扩展名有 .yaml.yml.json

  1. kubectl apply -f ./my-manifest.yaml # 创建资源
  2. kubectl apply -f ./my1.yaml -f ./my2.yaml # 使用多个文件创建
  3. kubectl apply -f ./dir # 基于目录下的所有清单文件创建资源
  4. kubectl apply -f https://git.io/vPieo # 从 URL 中创建资源
  5. kubectl create deployment nginx --image=nginx # 启动单实例 nginx
  6. # 创建一个打印 “Hello World” 的 Job
  7. kubectl create job hello --image=busybox -- echo "Hello World"
  8. # 创建一个打印 “Hello World” 间隔1分钟的 CronJob
  9. kubectl create cronjob hello --image=busybox --schedule="*/1 * * * *" -- echo "Hello World"
  10. kubectl explain pods # 获取 pod 清单的文档说明
  11. # 从标准输入创建多个 YAML 对象
  12. cat <<EOF | kubectl apply -f -
  13. apiVersion: v1
  14. kind: Pod
  15. metadata:
  16. name: busybox-sleep
  17. spec:
  18. containers:
  19. - name: busybox
  20. image: busybox
  21. args:
  22. - sleep
  23. - "1000000"
  24. ---
  25. apiVersion: v1
  26. kind: Pod
  27. metadata:
  28. name: busybox-sleep-less
  29. spec:
  30. containers:
  31. - name: busybox
  32. image: busybox
  33. args:
  34. - sleep
  35. - "1000"
  36. EOF
  37. # 创建有多个 key 的 Secret
  38. cat <<EOF | kubectl apply -f -
  39. apiVersion: v1
  40. kind: Secret
  41. metadata:
  42. name: mysecret
  43. type: Opaque
  44. data:
  45. password: $(echo -n "s33msi4" | base64 -w0)
  46. username: $(echo -n "jane" | base64 -w0)
  47. EOF

查看和查找资源

  1. # get 命令的基本输出
  2. kubectl get services # 列出当前命名空间下的所有 services
  3. kubectl get pods --all-namespaces # 列出所有命名空间下的全部的 Pods
  4. kubectl get pods -o wide # 列出当前命名空间下的全部 Pods,并显示更详细的信息
  5. kubectl get deployment my-dep # 列出某个特定的 Deployment
  6. kubectl get pods # 列出当前命名空间下的全部 Pods
  7. kubectl get pod my-pod -o yaml # 获取一个 pod 的 YAML
  8. # describe 命令的详细输出
  9. kubectl describe nodes my-node
  10. kubectl describe pods my-pod
  11. # 列出当前名字空间下所有 Services,按名称排序
  12. kubectl get services --sort-by=.metadata.name
  13. # 列出 Pods,按重启次数排序
  14. kubectl get pods --sort-by='.status.containerStatuses[0].restartCount'
  15. # 列举所有 PV 持久卷,按容量排序
  16. kubectl get pv --sort-by=.spec.capacity.storage
  17. # 获取包含 app=cassandra 标签的所有 Pods 的 version 标签
  18. kubectl get pods --selector=app=cassandra -o \
  19. jsonpath='{.items[*].metadata.labels.version}'
  20. # 检索带有 “.” 键值,例: 'ca.crt'
  21. kubectl get configmap myconfig \
  22. -o jsonpath='{.data.ca\.crt}'
  23. # 获取所有工作节点(使用选择器以排除标签名称为 'node-role.kubernetes.io/master' 的结果)
  24. kubectl get node --selector='!node-role.kubernetes.io/master'
  25. # 获取当前命名空间中正在运行的 Pods
  26. kubectl get pods --field-selector=status.phase=Running
  27. # 获取全部节点的 ExternalIP 地址
  28. kubectl get nodes -o jsonpath='{.items[*].status.addresses[?(@.type=="ExternalIP")].address}'
  29. # 列出属于某个特定 RC 的 Pods 的名称
  30. # 在转换对于 jsonpath 过于复杂的场合,"jq" 命令很有用;可以在 https://stedolan.github.io/jq/ 找到它。
  31. sel=${$(kubectl get rc my-rc --output=json | jq -j '.spec.selector | to_entries | .[] | "\(.key)=\(.value),"')%?}
  32. echo $(kubectl get pods --selector=$sel --output=jsonpath={.items..metadata.name})
  33. # 显示所有 Pods 的标签(或任何其他支持标签的 Kubernetes 对象)
  34. kubectl get pods --show-labels
  35. # 检查哪些节点处于就绪状态
  36. JSONPATH='{range .items[*]}{@.metadata.name}:{range @.status.conditions[*]}{@.type}={@.status};{end}{end}' \
  37. && kubectl get nodes -o jsonpath="$JSONPATH" | grep "Ready=True"
  38. # 不使用外部工具来输出解码后的 Secret
  39. kubectl get secret my-secret -o go-template='{{range $k,$v := .data}}{{"### "}}{{$k}}{{"\n"}}{{$v|base64decode}}{{"\n\n"}}{{end}}'
  40. # 列出被一个 Pod 使用的全部 Secret
  41. kubectl get pods -o json | jq '.items[].spec.containers[].env[]?.valueFrom.secretKeyRef.name' | grep -v null | sort | uniq
  42. # 列举所有 Pods 中初始化容器的容器 ID(containerID)
  43. # 可用于在清理已停止的容器时避免删除初始化容器
  44. kubectl get pods --all-namespaces -o jsonpath='{range .items[*].status.initContainerStatuses[*]}{.containerID}{"\n"}{end}' | cut -d/ -f3
  45. # 列出事件(Events),按时间戳排序
  46. kubectl get events --sort-by=.metadata.creationTimestamp
  47. # 比较当前的集群状态和假定某清单被应用之后的集群状态
  48. kubectl diff -f ./my-manifest.yaml
  49. # 生成一个句点分隔的树,其中包含为节点返回的所有键
  50. # 在复杂的嵌套JSON结构中定位键时非常有用
  51. kubectl get nodes -o json | jq -c 'path(..)|[.[]|tostring]|join(".")'
  52. # 生成一个句点分隔的树,其中包含为pod等返回的所有键
  53. kubectl get pods -o json | jq -c 'path(..)|[.[]|tostring]|join(".")'
  54. # 假设你的 Pods 有默认的容器和默认的名字空间,并且支持 'env' 命令,可以使用以下脚本为所有 Pods 生成 ENV 变量。
  55. # 该脚本也可用于在所有的 Pods 里运行任何受支持的命令,而不仅仅是 'env'。
  56. for pod in $(kubectl get po --output=jsonpath={.items..metadata.name}); do echo $pod && kubectl exec -it $pod -- env; done

更新资源

  1. kubectl set image deployment/frontend www=image:v2 # 滚动更新 "frontend" Deployment 的 "www" 容器镜像
  2. kubectl rollout history deployment/frontend # 检查 Deployment 的历史记录,包括版本
  3. kubectl rollout undo deployment/frontend # 回滚到上次部署版本
  4. kubectl rollout undo deployment/frontend --to-revision=2 # 回滚到特定部署版本
  5. kubectl rollout status -w deployment/frontend # 监视 "frontend" Deployment 的滚动升级状态直到完成
  6. kubectl rollout restart deployment/frontend # 轮替重启 "frontend" Deployment
  7. cat pod.json | kubectl replace -f - # 通过传入到标准输入的 JSON 来替换 Pod
  8. # 强制替换,删除后重建资源。会导致服务不可用。
  9. kubectl replace --force -f ./pod.json
  10. # 为多副本的 nginx 创建服务,使用 80 端口提供服务,连接到容器的 8000 端口。
  11. kubectl expose rc nginx --port=80 --target-port=8000
  12. # 将某单容器 Pod 的镜像版本(标签)更新到 v4
  13. kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
  14. kubectl label pods my-pod new-label=awesome # 添加标签
  15. kubectl annotate pods my-pod icon-url=http://goo.gl/XXBTWq # 添加注解
  16. kubectl autoscale deployment foo --min=2 --max=10 # 对 "foo" Deployment 自动伸缩容

部分更新资源

  1. # 部分更新某节点
  2. kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
  3. # 更新容器的镜像;spec.containers[*].name 是必须的。因为它是一个合并性质的主键。
  4. kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
  5. # 使用带位置数组的 JSON patch 更新容器的镜像
  6. kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
  7. # 使用带位置数组的 JSON patch 禁用某 Deployment 的 livenessProbe
  8. kubectl patch deployment valid-deployment --type json -p='[{"op": "remove", "path": "/spec/template/spec/containers/0/livenessProbe"}]'
  9. # 在带位置数组中添加元素
  10. kubectl patch sa default --type='json' -p='[{"op": "add", "path": "/secrets/1", "value": {"name": "whatever" } }]'

编辑资源

使用你偏爱的编辑器编辑 API 资源。

  1. kubectl edit svc/docker-registry # 编辑名为 docker-registry 的服务
  2. KUBE_EDITOR="nano" kubectl edit svc/docker-registry # 使用其他编辑器

对资源进行伸缩

  1. kubectl scale --replicas=3 rs/foo # 将名为 'foo' 的副本集伸缩到 3 副本
  2. kubectl scale --replicas=3 -f foo.yaml # 将在 "foo.yaml" 中的特定资源伸缩到 3 个副本
  3. kubectl scale --current-replicas=2 --replicas=3 deployment/mysql # 如果名为 mysql 的 Deployment 的副本当前是 2,那么将它伸缩到 3
  4. kubectl scale --replicas=5 rc/foo rc/bar rc/baz # 伸缩多个副本控制器

删除资源

  1. kubectl delete -f ./pod.json # 删除在 pod.json 中指定的类型和名称的 Pod
  2. kubectl delete pod,service baz foo # 删除名称为 "baz" 和 "foo" 的 Pod 和服务
  3. kubectl delete pods,services -l name=myLabel # 删除包含 name=myLabel 标签的 pods 和服务
  4. kubectl -n my-ns delete pod,svc --all # 删除在 my-ns 名字空间中全部的 Pods 和服务
  5. # 删除所有与 pattern1 或 pattern2 awk 模式匹配的 Pods
  6. kubectl get pods -n mynamespace --no-headers=true | awk '/pattern1|pattern2/{print $1}' | xargs kubectl delete -n mynamespace pod

与运行中的 Pods 进行交互

  1. kubectl logs my-pod # 获取 pod 日志(标准输出)
  2. kubectl logs -l name=myLabel # 获取含 name=myLabel 标签的 Pods 的日志(标准输出)
  3. kubectl logs my-pod --previous # 获取上个容器实例的 pod 日志(标准输出)
  4. kubectl logs my-pod -c my-container # 获取 Pod 容器的日志(标准输出, 多容器场景)
  5. kubectl logs -l name=myLabel -c my-container # 获取含 name=myLabel 标签的 Pod 容器日志(标准输出, 多容器场景)
  6. kubectl logs my-pod -c my-container --previous # 获取 Pod 中某容器的上个实例的日志(标准输出, 多容器场景)
  7. kubectl logs -f my-pod # 流式输出 Pod 的日志(标准输出)
  8. kubectl logs -f my-pod -c my-container # 流式输出 Pod 容器的日志(标准输出, 多容器场景)
  9. kubectl logs -f -l name=myLabel --all-containers # 流式输出含 name=myLabel 标签的 Pod 的所有日志(标准输出)
  10. kubectl run -i --tty busybox --image=busybox -- sh # 以交互式 Shell 运行 Pod
  11. kubectl run nginx --image=nginx -n mynamespace # 在指定名字空间中运行 nginx Pod
  12. kubectl run nginx --image=nginx # 运行 ngins Pod 并将其规约写入到名为 pod.yaml 的文件
  13. --dry-run=client -o yaml > pod.yaml
  14. kubectl attach my-pod -i # 挂接到一个运行的容器中
  15. kubectl port-forward my-pod 5000:6000 # 在本地计算机上侦听端口 5000 并转发到 my-pod 上的端口 6000
  16. kubectl exec my-pod -- ls / # 在已有的 Pod 中运行命令(单容器场景)
  17. kubectl exec --stdin --tty my-pod -- /bin/sh # 使用交互 shell 访问正在运行的 Pod (一个容器场景)
  18. kubectl exec my-pod -c my-container -- ls / # 在已有的 Pod 中运行命令(多容器场景)
  19. kubectl top pod POD_NAME --containers # 显示给定 Pod 和其中容器的监控数据
  20. kubectl top pod POD_NAME --sort-by=cpu # 显示给定 Pod 的指标并且按照 'cpu' 或者 'memory' 排序

与 Deployments 和 Services 进行交互

  1. kubectl logs deploy/my-deployment # 获取一个 Deployment 的 Pod 的日志(单容器例子)
  2. kubectl logs deploy/my-deployment -c my-container # 获取一个 Deployment 的 Pod 的日志(多容器例子)
  3. kubectl port-forward svc/my-service 5000 # 侦听本地端口 5000 并转发到 Service 后端端口 5000
  4. kubectl port-forward svc/my-service 5000:my-service-port # 侦听本地端口 5000 并转发到名字为 <my-service-port> 的 Service 目标端口
  5. kubectl port-forward deploy/my-deployment 5000:6000 # 侦听本地端口 5000 并转发到 <my-deployment> 创建的 Pod 里的端口 6000
  6. kubectl exec deploy/my-deployment -- ls # 在 Deployment 里的第一个 Pod 的第一个容器里运行命令(单容器和多容器例子)

与节点和集群进行交互

  1. kubectl cordon my-node # 标记 my-node 节点为不可调度
  2. kubectl drain my-node # 对 my-node 节点进行清空操作,为节点维护做准备
  3. kubectl uncordon my-node # 标记 my-node 节点为可以调度
  4. kubectl top node my-node # 显示给定节点的度量值
  5. kubectl cluster-info # 显示主控节点和服务的地址
  6. kubectl cluster-info dump # 将当前集群状态转储到标准输出
  7. kubectl cluster-info dump --output-directory=/path/to/cluster-state # 将当前集群状态输出到 /path/to/cluster-state
  8. # 如果已存在具有指定键和效果的污点,则替换其值为指定值。
  9. kubectl taint nodes foo dedicated=special-user:NoSchedule

资源类型

列出所支持的全部资源类型和它们的简称、API 组, 是否是名字空间作用域Kind

  1. kubectl api-resources

用于探索 API 资源的其他操作:

  1. kubectl api-resources --namespaced=true # 所有命名空间作用域的资源
  2. kubectl api-resources --namespaced=false # 所有非命名空间作用域的资源
  3. kubectl api-resources -o name # 用简单格式列举所有资源(仅显示资源名称)
  4. kubectl api-resources -o wide # 用扩展格式列举所有资源(又称 "wide" 格式)
  5. kubectl api-resources --verbs=list,get # 支持 "list" 和 "get" 请求动词的所有资源
  6. kubectl api-resources --api-group=extensions # "extensions" API 组中的所有资源

格式化输出

要以特定格式将详细信息输出到终端窗口,将 -o(或者 --output)参数添加到支持的 kubectl 命令中。

输出格式描述
-o=custom-columns=<spec>使用逗号分隔的自定义列来打印表格
-o=custom-columns-file=<filename>使用 <filename> 文件中的自定义列模板打印表格
-o=json输出 JSON 格式的 API 对象
-o=jsonpath=<template>打印 jsonpath 表达式中定义的字段
-o=jsonpath-file=<filename>打印在 <filename> 文件中定义的 jsonpath 表达式所指定的字段。
-o=name仅打印资源名称而不打印其他内容
-o=wide以纯文本格式输出额外信息,对于 Pod 来说,输出中包含了节点名称
-o=yaml输出 YAML 格式的 API 对象

使用 -o=custom-columns 的示例:

  1. # 集群中运行着的所有镜像
  2. kubectl get pods -A -o=custom-columns='DATA:spec.containers[*].image'
  3. # 列举 default 名字空间中运行的所有镜像,按 Pod 分组
  4. kubectl get pods --namespace default --output=custom-columns="NAME:.metadata.name,IMAGE:.spec.containers[*].image"
  5. # 除 "k8s.gcr.io/coredns:1.6.2" 之外的所有镜像
  6. kubectl get pods -A -o=custom-columns='DATA:spec.containers[?(@.image!="k8s.gcr.io/coredns:1.6.2")].image'
  7. # 输出 metadata 下面的所有字段,无论 Pod 名字为何
  8. kubectl get pods -A -o=custom-columns='DATA:metadata.*'

有关更多示例,请参看 kubectl 参考文档

Kubectl 日志输出详细程度和调试

Kubectl 日志输出详细程度是通过 -v 或者 --v 来控制的,参数后跟一个数字表示日志的级别。 Kubernetes 通用的日志习惯和相关的日志级别在 这里 有相应的描述。

详细程度描述
—v=0用于那些应该 始终 对运维人员可见的信息,因为这些信息一般很有用。
—v=1如果您不想要看到冗余信息,此值是一个合理的默认日志级别。
—v=2输出有关服务的稳定状态的信息以及重要的日志消息,这些信息可能与系统中的重大变化有关。这是建议大多数系统设置的默认日志级别。
—v=3包含有关系统状态变化的扩展信息。
—v=4包含调试级别的冗余信息。
—v=5跟踪级别的详细程度。
—v=6显示所请求的资源。
—v=7显示 HTTP 请求头。
—v=8显示 HTTP 请求内容。
—v=9显示 HTTP 请求内容而且不截断内容。

What’s next

最后修改 November 20, 2021 at 2:26 AM PST: [zh] update pod mapping to avoid deprecation notice (2b40286fd)