kubectl 备忘单

    您还可以为 使用一个速记别名，该别名也可以与 completion 一起使用：

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

    Kubectl 上下文和配置

    设置 kubectl 与哪个 Kubernetes 集群进行通信并修改配置信息。 查看 文档获取配置文件详细信息。

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

    Kubectl apply

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

    创建对象

    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
    7. # 创建一个打印 “Hello World” 的 Job
    8. kubectl create job hello --image=busybox -- echo "Hello World" 
    10. # 创建一个打印 “Hello World” 间隔1分钟的 CronJob
    11. kubectl create cronjob hello --image=busybox   --schedule="*/1 * * * *" -- echo "Hello World"    
    14. # 从标准输入创建多个 YAML 对象
    15. cat <<EOF | kubectl apply -f -
    16. apiVersion: v1
    17. kind: Pod
    18. metadata:
    19.   name: busybox-sleep
    20. spec:
    21.   containers:
    22.   - name: busybox
    23.     image: busybox
    24.     args:
    25.     - sleep
    26.     - "1000000"
    28. apiVersion: v1
    29. kind: Pod
    30. metadata:
    31.   name: busybox-sleep-less
    32. spec:
    33.   containers:
    34.   - name: busybox
    35.     image: busybox
    36.     args:
    37.     - sleep
    38.     - "1000"
    39. EOF
    41. # 创建有多个 key 的 Secret
    42. cat <<EOF | kubectl apply -f -
    43. apiVersion: v1
    44. kind: Secret
    45. metadata:
    46.   name: mysecret
    47. type: Opaque
    48. data:
    49.   password: $(echo -n "s33msi4" | base64 -w0)
    50.   username: $(echo -n "jane" | base64 -w0)
    51. EOF

    更新资源

    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
    8. cat pod.json | kubectl replace -f -                              # 通过传入到标准输入的 JSON 来替换 Pod
    10. # 强制替换，删除后重建资源。会导致服务不可用。
    11. kubectl replace --force -f ./pod.json
    13. # 为多副本的 nginx 创建服务，使用 80 端口提供服务，连接到容器的 8000 端口。
    14. kubectl expose rc nginx --port=80 --target-port=8000
    16. # 将某单容器 Pod 的镜像版本（标签）更新到 v4
    17. kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
    19. kubectl label pods my-pod new-label=awesome                      # 添加标签
    20. kubectl annotate pods my-pod icon-url=http://goo.gl/XXBTWq       # 添加注解

    部分更新资源

    1. # 部分更新某节点
    2. kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
    4. # 更新容器的镜像；spec.containers[*].name 是必须的。因为它是一个合并性质的主键。
    5. kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
    7. # 使用带位置数组的 JSON patch 更新容器的镜像
    8. kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
    10. # 使用带位置数组的 JSON patch 禁用某 Deployment 的 livenessProbe
    11. kubectl patch deployment valid-deployment  --type json   -p='[{"op": "remove", "path": "/spec/template/spec/containers/0/livenessProbe"}]'
    13. # 在带位置数组中添加元素
    14. 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 副本
    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                   # 伸缩多个副本控制器

    删除资源

    与运行中的 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
    15. kubectl attach my-pod -i                            # 挂接到一个运行的容器中
    16. kubectl port-forward my-pod 5000:6000               # 在本地计算机上侦听端口 5000 并转发到 my-pod 上的端口 6000
    17. kubectl exec my-pod -- ls /                         # 在已有的 Pod 中运行命令（单容器场景）
    18. kubectl exec --stdin --tty my-pod -- /bin/sh        # 使用交互 shell 访问正在运行的 Pod (一个容器场景)
    19. kubectl exec my-pod -c my-container -- ls /         # 在已有的 Pod 中运行命令（多容器场景）
    20. kubectl top pod POD_NAME --containers               # 显示给定 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
    9. # 如果已存在具有指定键和效果的污点，则替换其值为指定值。
    10. kubectl taint nodes foo dedicated=special-user:NoSchedule

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

    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=custom-columns 的示例：

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

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

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