附录5、Kubectl 命令行界面
本文是《Docker必知必会系列》第十三篇，原文发布于个人博客：悟尘记。
一、概述¶
Kubectl 是一个命令行接口，用于对 Kubernetes 集群运行命令。kubectl 在 $HOME/.kube 目录中寻找一个名为 config 的文件。您可以通过设置环境变量 KUBECONFIG 或设置[--kubeconfig参数指定其它配置文件。
二、语法¶
使用以下语法 kubectl 从终端窗口运行命令：
kubectl [command] [TYPE] [NAME] [flags]
其中 command、TYPE、NAME 和 flags 分别是：
command：指定要对一个或多个资源执行的操作，例如create、get、describe、delete。-
TYPE：指定资源类型。资源类型不区分大小写，可以指定单数、复数或缩写形式。 -
NAME：指定资源的名称。名称区分大小写。如果省略名称，则显示所有资源的详细信息kubectl get pods。 -
flags: 指定可选的参数。例如，可以使用-s或-server参数指定 Kubernetes API 服务器的地址和端口。
从命令行指定的参数会覆盖默认值和任何相应的环境变量。
如果需要帮助，只需从终端窗口运行
kubectl help即可。
三、kubectl 命令列表¶
下表包含所有 kubectl 操作的简短描述和普通语法：
| 操作 | 描述 |
|---|---|
annotate |
添加或更新一个或多个资源的注解。 |
api-versions |
列出可用的 API 版本。 |
apply |
从文件或 stdin 对资源应用配置更改。 |
attach |
附加到正在运行的容器，查看输出流或与容器（stdin）交互。 |
autoscale |
自动伸缩由副本控制器管理的一组 pod。 |
cluster-info |
显示有关集群中主服务器和服务的端口信息。 |
config |
修改 kubeconfig 文件。有关详细信息，请参阅各个子命令。 |
create |
从文件或 stdin 创建一个或多个资源。 |
delete |
从文件、标准输入或指定标签选择器、名称、资源选择器或资源中删除资源。 |
describe |
显示一个或多个资源的详细状态。 |
diff |
将 live 配置和文件或标准输入做对比 (BETA) |
edit |
使用默认编辑器编辑和更新服务器上一个或多个资源的定义。 |
exec |
对 pod 中的容器执行命令。 |
explain |
获取多种资源的文档。例如 pod, node, service 等。 |
expose |
将副本控制器、服务或 pod 作为新的 Kubernetes 服务暴露。 |
get |
列出一个或多个资源。 |
label |
添加或更新一个或多个资源的标签。 |
logs |
在 pod 中打印容器的日志。 |
patch |
使用策略合并 patch 程序更新资源的一个或多个字段。 |
port-forward |
将一个或多个本地端口转发到一个 pod。 |
proxy |
运行 Kubernetes API 服务器的代理。 |
replace |
从文件或标准输入中替换资源。 |
rolling-update |
通过逐步替换指定的副本控制器及其 pod 来执行滚动更新。 |
run |
在集群上运行指定的镜像。 |
scale |
更新指定副本控制器的大小。 |
stop |
不推荐：相反，请参阅 kubectl delete。 |
version |
显示运行在客户端和服务器上的 Kubernetes 版本。 |
有关命令操作的更多信息，请参阅 kubectl 参考文档。
四、资源类型¶
列出全部支持的资源类型和它们的简称，无论它们是否是 namespaced, Kind。
kubectl api-resources
用于探索 API 资源的其他操作：
kubectl api-resources --namespaced=true # 所有在命名空间中的资源
kubectl api-resources --namespaced=false # 所有不在命名空间中的资源
kubectl api-resources -o name # 输出简单的所有资源（只是资源名称）
kubectl api-resources -o wide # 具有扩展（又称 "wide"）输出的所有资源
kubectl api-resources --verbs=list,get # 支持 "list" 和 "get" 请求动词的所有资源
kubectl api-resources --api-group=extensions # "extensions" API 组中的所有资源
五、上下文和配置¶
设置 kubectl 与哪个 Kubernetes 集群进行通信并修改配置信息。
kubectl config view # 显示合并的 kubeconfig 配置。
# 同时使用多个 kubeconfig 文件并查看合并的配置
KUBECONFIG=~/.kube/config:~/.kube/kubconfig2 kubectl config view
# 获取 e2e 用户的密码
kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
kubectl config current-context # 展示当前所处的上下文
kubectl config use-context my-cluster-name # 设置默认的上下文为 my-cluster-name
# 添加新的集群配置到 kubeconf 中，使用 basic auth 进行鉴权
kubectl config set-credentials kubeuser/foo.kubernetes.com --username=kubeuser --password=kubepassword
# 使用特定的用户名和命名空间设置上下文。
kubectl config set-context gce --user=cluster-admin --namespace=foo \
&& kubectl config use-context gce
六、常用命令备忘¶
Apply¶
通过定义 Kubernetes 资源的文件管理应用程序。它通过运行 kubectl apply 在集群中创建和更新资源。这是在生产中管理 Kubernetes 应用程序的推荐方法。详情请查阅 Kubectl 文档。
创建对象¶
Kubernetes 配置可以用 json 或 yaml 定义。可以使用的文件扩展名有 .yaml，.yml 和 .json。
kubectl apply -f ./my-manifest.yaml # 创建资源
kubectl apply -f ./my1.yaml -f ./my2.yaml # 使用多个文件创建
kubectl apply -f ./dir # 从目录下的全部配置文件创建资源
kubectl apply -f https://git.io/vPieo # 从 url 中创建资源
kubectl create deployment nginx --image=nginx # 启动单实例 nginx
kubectl explain pods,svc # 获取 pod，svc 配置的文档说明
# 从标准输入中的多个 YAML 对象中创建
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Pod
metadata:
name: busybox-sleep
spec:
containers:
- name: busybox
image: busybox
args:
- sleep
- "1000000"
---
apiVersion: v1
kind: Pod
metadata:
name: busybox-sleep-less
spec:
containers:
- name: busybox
image: busybox
args:
- sleep
- "1000"
EOF
# 创建有多个 key 的 Secret
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
name: mysecret
type: Opaque
data:
password: $(echo -n "s33msi4" | base64 -w0)
username: $(echo -n "jane" | base64 -w0)
EOF
获取和查找资源¶
# 使用 get 命令获取基本输出
kubectl get services # 列出当前命名空间下的所有 services
kubectl get pods --all-namespaces # 列出所有命名空间下的全部的 pods
kubectl get pods -o wide # 列出当前命名空间下的全部 pods，有更多的详细信息
kubectl get deployment my-dep # 列出某个特定的 deployment
kubectl get pods --include-uninitialized # 列出当前命名空间下的全部 pods，包含未初始化的
kubectl get pod my-pod -o yaml # 获取一个 pod 的 YAML
kubectl get pod my-pod -o yaml --export # 获取一个没有集群特定信息的 YAML
# 使用 describe 命令获取详细输出
kubectl describe nodes my-node
kubectl describe pods my-pod
kubectl get services --sort-by=.metadata.name # 列出当前命名空间下所有 services，按照名称排序
# 列出 pods 按照重启次数进行排序
kubectl get pods --sort-by='.status.containerStatuses[0].restartCount'
# 列出测试命名空间中的 Pod，按容量排序
kubectl get pods -n test --sort-by=.spec.capacity.storage
# 获取包含 app=cassandra 标签全部 pods 的 version 标签
kubectl get pods --selector=app=cassandra -o \
jsonpath='{.items[*].metadata.labels.version}'
# 获取所有工作节点(使用选择器以排除标签名称为 'node-role.kubernetes.io/master' 的结果)
kubectl get node --selector='!node-role.kubernetes.io/master'
# 获取当前命名空间中正在运行的 pods
kubectl get pods --field-selector=status.phase=Running
# 获取全部 node 的 ExternalIP 地址
kubectl get nodes -o jsonpath='{.items[*].status.addresses[?(@.type=="ExternalIP")].address}'
# 列出属于某个特定 RC 的 pods 的名称
# "jq" 命令对于 jsonpath 过于复杂的转换非常有用，可以在 https://stedolan.github.io/jq/ 找到它。
sel=${$(kubectl get rc my-rc --output=json | jq -j '.spec.selector | to_entries | .[] | "\(.key)=\(.value),"')%?}
echo $(kubectl get pods --selector=$sel --output=jsonpath={.items..metadata.name})
# 显示所有 Pod 的标签(或任何其他支持标签的 Kubernetes 对象)
# 也可以使用 "jq"
for item in $( kubectl get pod --output=name); do printf "Labels for %s\n" "$item" | grep --color -E '[^/]+$' && kubectl get "$item" --output=json | jq -r -S '.metadata.labels | to_entries | .[] | " \(.key)=\(.value)"' 2>/dev/null; printf "\n"; done
# 或也可以使用此命令来获取与容器关联的所有标签
kubectl get pods --show-labels
# 检查哪些节点处于 ready
JSONPATH='{range .items[*]}{@.metadata.name}:{range @.status.conditions[*]}{@.type}={@.status};{end}{end}' \
&& kubectl get nodes -o jsonpath="$JSONPATH" | grep "Ready=True"
# 列出被一个 pod 使用的全部 secret
kubectl get pods -o json | jq '.items[].spec.containers[].env[]?.valueFrom.secretKeyRef.name' | grep -v null | sort | uniq
# 列出 events，按照创建时间排序
kubectl get events --sort-by=.metadata.creationTimestamp
更新资源¶
从版本 1.11 开始，rolling-update 已被弃用，使用 rollout 代替。
kubectl set image deployment/frontend www=image:v2 # 滚动更新 "frontend" deployment 的 "www" 容器镜像
kubectl rollout history deployment/frontend # 检查部署的历史记录，包括版本
kubectl rollout undo deployment/frontend # 回滚到上次部署版本
kubectl rollout undo deployment/frontend --to-revision=2 # 回滚到特定部署版本
kubectl rollout status -w deployment/frontend # Watch "frontend" deployment 的滚动升级状态直到完成
# 从 1.11 版本开始弃用
kubectl rolling-update frontend-v1 -f frontend-v2.json # (弃用) 滚动升级 frontend-v1 的 pods
kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2 # (弃用) 修改资源的名称并更新镜像
kubectl rolling-update frontend --image=image:v2 # (弃用) 更新 frontend 的 pods 的镜像
kubectl rolling-update frontend-v1 frontend-v2 --rollback # (弃用) 终止已经进行中的 rollout
cat pod.json | kubectl replace -f - # 通过传入到标准输入的 JSON 来替换 pod
# 强制进行替换，会删除然后再创建资源，会导致服务不可用。
kubectl replace --force -f ./pod.json
# 为多副本的 nginx 创建服务，使用 80 端口提供服务，连接到容器的 8000 端口。
kubectl expose rc nginx --port=80 --target-port=8000
# 更新单容器 pod 的镜像标签到 v4
kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
kubectl label pods my-pod new-label=awesome # 添加标签
kubectl annotate pods my-pod icon-url=http://goo.gl/XXBTWq # 添加注解
kubectl autoscale deployment foo --min=2 --max=10 # 使 "foo" deployment 自动伸缩容
局部更新资源¶
kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}' # 部分更新 node
#更新容器的镜像；spec.containers[*].name 是必须的。因为它是一个合并 key。
kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
# 使用带位置数组的 json patch 更新容器的镜像
kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
# 使用带位置数组的 json patch 禁用 deployment 的 livenessProbe
kubectl patch deployment valid-deployment --type json -p='[{"op": "remove", "path": "/spec/template/spec/containers/0/livenessProbe"}]'
# 在带位置数组中添加元素
kubectl patch sa default --type='json' -p='[{"op": "add", "path": "/secrets/1", "value": {"name": "whatever" } }]'
编辑资源¶
在编辑器中编辑任何 API 资源
kubectl edit svc/docker-registry # 编辑名为 docker-registry 的 service
KUBE_EDITOR="nano" kubectl edit svc/docker-registry # 使用其他编辑器
对资源进行伸缩¶
kubectl scale --replicas=3 rs/foo # 将名为 'foo' 的副本集伸缩到 3 副本
kubectl scale --replicas=3 -f foo.yaml # 将在 "foo.yaml" 中的特定资源伸缩到 3 个副本
kubectl scale --current-replicas=2 --replicas=3 deployment/mysql # 如果名为 mysql 的 deployment 的副本当前是 2，那么将它伸缩到 3
kubectl scale --replicas=5 rc/foo rc/bar rc/baz # 伸缩多个 replication controllers
删除资源¶
kubectl delete -f ./pod.json # 删除在 pod.json 中指定的类型和名称的 pod
kubectl delete pod,service baz foo # 删除名称为 "baz" 和 "foo" 的 pod 和 service
kubectl delete pods,services -l name=myLabel # 删除包含 name=myLabel 标签的 pods 和 services
kubectl delete pods,services -l name=myLabel --include-uninitialized # 删除包含 label name=myLabel 标签的 pods 和 services，包括未初始化的
kubectl -n my-ns delete po,svc --all # 删除在 my-ns 命名空间中全部的 pods 和 services ，包括未初始化的
# 删除所有与 pattern1 或 pattern2 匹配的 pod
kubectl get pods -n mynamespace --no-headers=true | awk '/pattern1|pattern2/{print $1}' | xargs kubectl delete -n mynamespace pod
与运行中的 Pods 进行交互¶
kubectl logs my-pod # 获取 pod 日志(标准输出)
kubectl logs -l name=myLabel # 获取 pod label name=myLabel 日志(标准输出)
kubectl logs my-pod --previous # 获取上个容器实例的 pod 日志(标准输出)
kubectl logs my-pod -c my-container # 获取 pod 的容器日志 (标准输出, 多容器的场景)
kubectl logs -l name=myLabel -c my-container # 获取 label name=myLabel pod 的容器日志 (标准输出, 多容器的场景)
kubectl logs my-pod -c my-container --previous # 获取 pod 的上个容器实例日志 (标准输出, 多容器的场景)
kubectl logs -f my-pod # 流式输出 pod 的日志 (标准输出)
kubectl logs -f my-pod -c my-container # 流式输出 pod 容器的日志 (标准输出, 多容器的场景)
kubectl logs -f -l name=myLabel --all-containers # 流式输出 label name=myLabel pod 的日志 (标准输出)
kubectl run -i --tty busybox --image=busybox -- sh # 以交互式 shell 运行 pod
kubectl attach my-pod -i # 进入到一个运行中的容器中
kubectl port-forward my-pod 5000:6000 # 在本地计算机上侦听端口 5000 并转发到 my-pod 上的端口 6000
kubectl exec my-pod -- ls / # 在已有的 pod 中运行命令(单容器的场景)
kubectl exec my-pod -c my-container -- ls / # 在已有的 pod 中运行命令(多容器的场景)
kubectl top pod POD_NAME --containers # 显示给定 pod 和容器的监控数据
与节点和集群进行交互¶
kubectl cordon my-node # 设置 my-node 节点为不可调度
kubectl drain my-node # 对 my-node 节点进行驱逐操作，为节点维护做准备
kubectl uncordon my-node # 设置 my-node 节点为可以调度
kubectl top node my-node # 显示给定 node 的指标
kubectl cluster-info # 显示 master 和 services 的地址
kubectl cluster-info dump # 将当前集群状态输出到标准输出
kubectl cluster-info dump --output-directory=/path/to/cluster-state # 将当前集群状态输出到 /path/to/cluster-state
# 如果已存在具有该键和效果的污点，则其值将按指定替换
kubectl taint nodes foo dedicated=special-user:NoSchedule
七、适用于 Docker 用户的 kubectl¶
您可以使用 Kubernetes 命令行工具 kubectl 与 API 服务器进行交互。如果您熟悉 Docker 命令行工具，则使用 kubectl 非常简单。但是，docker 命令和 kubectl 命令之间有一些区别。以下显示了 docker 子命令，并描述了等效的 kubectl 命令。
运行 nginx 部署并将其暴露¶
使用 docker 命令：
docker run -d --restart=always -e DOMAIN=cluster --name nginx-app -p 80:80 nginx
使用 kubectl 命令：
# 启动运行 nginx 的 Pod
kubectl run --image=nginx nginx-app --port=80 --env="DOMAIN=cluster"
# 通过服务公开端口
kubectl expose deployment nginx-app --port=80 --name=nginx-http
列出哪些正在运行¶
使用 docker 命令：
docker ps -a
使用 kubectl 命令：
kubectl get po # pod/pods 均可
连接到已经运行在容器中的进程¶
使用 docker 命令：
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
55c103fa1296 nginx "nginx -g 'daemon of…" 5 minutes ago Up 5 minutes 0.0.0.0:80->80/tcp nginx-app
$ docker attach 55c103fa1296
...
kubectl:
$ kubectl get pods
NAME READY STATUS RESTARTS AGE
nginx-app-5jyvm 1/1 Running 0 10m
$ kubectl attach -it nginx-app-5jyvm
...
要从容器中分离，可以输入 Ctrl + P，然后按 Ctrl + Q。
在容器中执行命令¶
使用 docker 命令：
docker exec -ti 55c103fa1296 /bin/sh
kubectl:
kubectl exec -ti nginx-app-5jyvm -- /bin/sh
查看运行中进程的日志¶
使用 docker 命令：
docker logs -f nginx
使用 kubectl 命令：
kubectl logs -f nginx-app-zibvs
在 docker 中，进程的每个调用的输出都是被连接起来的，但是对于 kubernetes，每个调用都是分开的。要查看以前在 kubernetes 中执行的输出，请执行以下操作：
kubectl logs --previous nginx-app-zibvs
停止和删除运行中的进程¶
使用 docker 命令：
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
a9ec34d98787 nginx "nginx -g 'daemon of" 22 hours ago Up 22 hours 0.0.0.0:80->80/tcp, 443/tcp nginx-app
$ docker stop a9ec34d98787
a9ec34d98787
$ docker rm a9ec34d98787
a9ec34d98787
使用 kubectl 命令：
$ kubectl get deployment nginx-app
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
nginx-app 1 1 1 1 2m
$ kubectl get po -l run=nginx-app
NAME READY STATUS RESTARTS AGE
nginx-app-2883164633-aklf7 1/1 Running 0 2m
$ kubectl delete deployment nginx-app
deployment "nginx-app" deleted
$ kubectl get po -l run=nginx-app
# Return nothing
注意： 使用 kubectl 命令，不直接删除 Pod。要删除拥有该 pod 的 Deployment。如果直接删除 pod，Deployment 将会重新创建该 pod。
查看客户端和服务端的版本¶
使用 docker 命令：
docker version
使用 kubectl 命令：
kubectl version
获取有关环境和配置的各种信息¶
使用 docker 命令：
docker info
使用 kubectl 命令：
kubectl cluster-info
八、格式化输出¶
要以特定格式将详细信息输出到终端窗口，可以将 -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 对象 |
九、Kubectl 日志输出控制¶
Kubectl 日志输出详细程度是通过 -v 或者 --v 来控制的，参数后跟了一个数字表示日志的级别。
| 详细程度 | 描述 |
|---|---|
--v=0 |
通常对此有用，始终对运维人员可见。 |
--v=1 |
如果您不想要详细程度，则为合理的默认日志级别。 |
--v=2 |
有关服务的有用稳定状态信息以及可能与系统中的重大更改相关的重要日志消息。这是大多数系统的建议默认日志级别。 |
--v=3 |
有关更改的扩展信息。 |
--v=4 |
Debug 级别。 |
--v=6 |
显示请求的资源。 |
--v=7 |
显示 HTTP 请求头。 |
--v=8 |
显示 HTTP 请求内容。 |
--v=9 |
显示 HTTP 请求内容而不截断内容。 |
参考¶
相关文章¶
- 上一篇：Docker必知必会系列（附录4）：Docker-compose 配置文件编写
- 下一篇：没有了
写在最后¶
至此，本系列文章已经阅读完成。
获取最新内容，请访问我的个人博客：悟尘记。