参考书籍: kubernetes全栈架构师
kubectl 命令自动补全
要在 bash 中设置当前 shell 的自动补全,首先需要安装
bash-completion
包1
yum install -y bash-completion
配置 kubectl 命令自动补全
1
echo "source <(kubectl completion bash)" >> ~/.bashrc
刷新配置文件
1
source ~/.bashrc
kubectl 常用命令
查看所有 Pod 列表。
-n
后面跟 namespace 查看指定的命令空间内的 Pod1
2
3
4kubectl get pod # 查看默认的 default 命名空间中的 Pod
kubectl get pod -n kube-system # 查看指定命名空间 kube-system 中的 Pod
kubectl get pod -o wide # 查看更详细地信息,比如 pod 所在的节点
kubectl get pod --show-labels # 获取 pod 并查看 pod 的标签查看 RC 和 Service 列表,
-o wide
查看详细信息1
2
3kubectl get rc,svc
kubectl get pod,svc -o wide
kubectl get pod <pod_name> -o yaml查看 Node 的详细信息
1
kubectl describe node k8s-master-01
查看 Pod 的详细信息,特别是 Pod 无法创建的时候查看详细的日志
1
2
3
4kubectl describe pod <pod_name>
example:
kubectl describe pod nginx根据 yaml 文件创建资源,
apply
可以重复执行,create
不行.1
2kubectl create -f pod.yaml
kubectl apply -f pod.yaml基于 pod.yaml 定义的名称删除指定资源
1
kubectl delete -f pod.yaml
删除所有包含某个 label 的 Pod 和 Service
1
kubectl delete pod,svc -l name=<label-name>
删除默认命名空间下的所有 Pod
1
kubectl delete pod --all
执行 Pod 命令
1
2
3kubectl exec <pod-name> -- date
kubectl exec <pod-name> -- bash
kubectl exec <pod-name> -- ping 10.24.51.9通过 bash 获得 Pod 中某个容器的 TTY,相当于登陆容器
1
2
3
4kubectl exec -it <pod-name> -c <container-name> --bash
example:
kubectl exec -it nginx -- bash查看容器的日志
1
2
3
4kubectl logs <pod-name>
kubectl logs -f <pod-name> # 实时查看日志
kubectl log <pod-name> -c <container-name> # 若 pod 只有一个 容器,可以不加 -c
kubectl logs -l app=frontend # 返回所有标记为 app=frontend 的 pod 的合并日志查看节点 labels
1
kubectl get node --show-labels
重启 pod
1
kubectl get pod <POD_NAME> -n <POD_NAMESPACE> -o yaml | kubectl replace --force -f -
kubectl 创建动作相关命令
使用单个 yaml 文件创建资源
1
kubectl apply -f ./my-manifest.yaml
使用多个文件创建
1
kubectl apply -f ./my1.yaml -f ./my2.yaml
基于目录下的所有清单文件创建资源
1
kubectl apply -f ./dir
从 URL 中创建资源
1
kubectl apply -f https://git.io/vPieo
启动单实例 nginx
1
kubectl create deployment nginx --image=nginx
获取 pod 清单的文档说明
1
kubectl explain pods,svc
从标准输入创建多个 YAML 对象
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25cat <<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
1
2
3
4
5
6
7
8
9
10cat <<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
kubectl 查看和查找资源相关命令
get 命令的基本输出
列出当前命名空间下的所有 services
1
kubectl get services
列出所有命名空间下的全部的 Pods
1
kubectl get pods --all-namespaces
列出当前命名空间下的全部的 Pods,并显示更详细的信息
1
kubectl get pods -o wide
列出某个特定的 Deployment
1
kubectl get deployment my-dep
列出当前命名空间下的全部 Pods
1
kubectl get pods
获取一个 pod 的 YAML
1
kubectl get pod my-pod -o yaml
查看当前命名空间下的所有 Services,按名称排序
1
kubectl get services --sort-by=.metadata.name
列出 Pods,按重启次数排序
1
kubectl get pods --sort-by='.status.containerStatuses[0].restartCount'
列出所有的 PV 持久卷,按容量排序
1
kubectl get pv --sort-by=.spec.capacity.storage
获取包含 app=cassandra 标签的所有 Pods 的 version 标签
1
2kubectl get pods --selector=app=cassandra -o \
jsonpath='{.items[*].metadata.labels.version}'获取所有工作节点(使用选择器以排除标签名称为 ‘node-role.kubernetes.io/master’ 的结果)
1
kubectl get node --selector='!node-role.kubernetes.io/master'
获取当前命名空间中正在运行的 Pods
1
kubectl get pods --field-selector=status.phase=Running
获取全部节点的 ExternalIP 地址
1
kubectl get nodes -o jsonpath='{.items[*].status.addresses[?(@.type=="ExternalIP")].address}'
列出属于某个特定 RC 的 Pods 的名称,在转换对于 jsonpath 过于复杂的场合,
jq
命令很有用1
2sel=${$(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})显示所有 Pods 的标签(或任何其他支持标签的 Kubernetes 对象)
1
kubectl get pods --show-labels
检查哪些节点处于就绪状态
1
2
3JSONPATH='{range .items[*]}{@.metadata.name}:{range @.status.conditions[*]}{@.type}={@.status};{end}{end}'
kubectl get nodes -o jsonpath="$JSONPATH" | grep "Ready=True"列出被一个 pod 使用的全部 Secret
1
kubectl get pods -o json |jq '.items[].spec.containers[].env[]?.valueFrom.secretKeyRef.name' |grep -v null |sort |uniq
列举所有 Pods 中初始化容器的容器 ID(containerID)
1
kubectl get pods --all-namespaces -o jsonpath='{range .items[*].status.initContainerStatuses[*]}{.containerID}{"\n"}{end}' | cut -d / -f3
列出事件 (Events),按时间戳排序
1
kubectl get events --sort-by=.metadata.creationTimestamp
比较当前的集群状态和假定某清单被应用之后的集群状态
1
kubectl diff -f ./my-manifest.yaml
describe 命令的详细输出
查看节点的详细信息
1
kubectl describe nodes my-node
查看 Pod 的详细信息
1
kubectl describe pods my-pod
kubectl 更新资源相关命令
滚动更新 “frontend” Deployment 的 “www” 容器镜像
1
kubectl set image deployment/frontend www=image:v2
检查 Deployment 的历史记录,包括版本
1
kubectl rollout history deployment/frontend
回滚到上次部署版本
1
kubectl rollout undo deployment/frontend
回滚到特定部署版本
1
kubectl rollout undo deployment/frontend --to-revision=2
监视 “frontend” Deployment 的滚动升级状态,直到完成
1
kubectl rollout status -w deployment/frontend
轮替重启 “frontend” Deployment
1
kubectl rollout restart deployment/frontend
通过传入标准的 JSON 输入来替换 Pod
1
cat pod.json |kubectl replace -f -
强制替换,删除后重建资源。会导致服务不可用
1
kubectl replace --force -f ./pod.json
为多副本的 Nginx 创建服务,使用 80 端口提供服务,连接到容器的 8000 端口
1
kubectl expose rc nginx --port=80 --target-port=8000
将某个单容器 pod 的镜像版本(标签)更新到 v4
1
kubectl get pod mypod -o yaml |sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
添加标签
1
kubectl label pods my-pod new-label=awesome
添加注解
1
kubectl annotate pods my-pod icon-url=http://goo.gl/XXBTWq
对 “foo” Deployment 自动伸缩容
1
kubectl autoscale deployment foo --min=2 --max=10
kubectl 更新部分资源
部分更新某节点
1
kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
更新容器的镜像,
spec.containers[*].name
是必须的。因为它是一个合并性质的主键1
kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
使用带位置数组的 JSON patch 更新容器的镜像
1
kubectl patch pod valid-pod --type='json' -p='[{"op":"replace","path":"/spec/containers/0/image","value":"new image"}]'
使用带位置数组的 JSON patch 禁用某 Deployment 的 livenessProbe
1
kubectl patch deployment valid-deployment --type json -p='[{"op":"remove", "path": "/spec/template/spec/containers/0/livenessProbe"}]'
在带位置数组中添加元素
1
kubectl patch sa default --type='json' -p='[{"op": "add", "path": "/secrets/1", "value": {"name": "whatever"}}]'
kubectl 删除资源
删除在
pod.json
中指定的类型和名称的 Pod1
kubectl delete -f ./pod.json
删除名称为
baz
和 foo 的Pod
服务1
kubectl delete pods,services baz foo
删除包含 name=myLabel 标签的 pods 和服务
1
kubectl delete pods,services -l name=myLabel
删除包含 label name=myLabel 标签的 Pods 和服务
1
kubectl delete pods,services -l name=myLabel --include-uninitialized
删除在 my-ns 命名空间中全部的 pods 和服务
1
kubectl -n my-ns delete po,svc --all
删除所有与 pattern1 或 pattern2 awk 模式匹配的 Pods
1
kubectl get pods -n my-namespace --no-headers=true |awk '/pattern1|pattern2/{print $1}' |xargs kubectl delete -n my-namespace pod
kubectl 对 Pod 的常用操作
获取 Pod 的日志(标准输出)
1
kubectl logs my-pod
获取含 name=myLabel 标签的 pod 的日志(标准输出)
1
kubectl logs -l name=myLabel
获取上个容器实例的 Pod 日志(标准输出)
1
kubectl logs my-pod --previous
获取 Pod 容器的日志(标准输出,多容器场景)
1
kubectl logs my-pod -c my-container
获取含 name=myLabel 标签的 Pod 容器日志(标准输出,多容器场景)
1
kubectl logs -l name=myLabel -c my-container
获取 Pod 中某个容器的上个实例的日志(标准输出,多容器场景)
1
kubectl logs my-pod -c my-container --previous
流式输出 Pod 的日志(标准输出)
1
kubectl logs -f my-pod
流式输出 Pod 容器的日志(标准输出,多容器场景)
1
kubectl logs -f my-pod -c my-container
流式输出含 name=myLabel 标签的 Pod 的所有日志(标准输出)
1
kubectl logs -f -l name=myLabel --all-containers
以交互式 shell 运行 Pod
1
kubectl run -i --tty busybox --image=busybox -- sh
指定命名空间中运行 Nginx pod
1
kubectl run nginx --image=nginx -n my-namespace
运行 nginx pod 并将其规约写入名为 nginx.yaml 的文件
1
kubectl run nginx --image=nginx --dry-run=client -o yaml > nginx.yaml
进入到一个运行的容器中
1
kubectl attach my-pod -i
在本地计算机上侦听端口 5000 并转发到 my-pod 上的端口 6000
1
kubectl port-forward my-pod 5000:6000
在已有的 Pod 中运行命令(单容器场景)
1
kubectl exec my-pod -- ls /
在已有的 Pod 中运行命令(多容器场景)
1
kubectl exec my-pod -c my-container -- ls /
显示给定 Pod 和其中容器的监控数据
1
kubectl top pod POD_NAME --containers
kubectl 对节点的操作
标记 my-node 节点为不可调度
1
kubectl cordon my-node
对 my-node 节点进行清空操作,为节点维护做准备
1
kubectl drain my-node
标记 my-node 节点为可以调度
1
kubectl uncordon my-node
显示给定节点的度量值
1
kubectl top node my-node
显示主控节点和服务的地址
1
kubectl cluster-info
将当前集群状态转储到标准输出
1
kubectl cluster-info dump
将当前集群状态输出到 /path/to/cluster-state
1
kubectl cluster-info dump --output-directory=/path/to/cluster-state
如果已存在具有指定键和效果的污点,则替换其值为指定值
1 | kubectl taint nodes foo dedicated=special-user:NoSchedule |
格式化输出
要以特定格式将详细信息输出到终端窗口,可以将 -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
kubectl get pods -A -o=custom-columns='DATA:sepc.containers[*].image'
除 “coredns/coredns:1.7.0” 之外的所有镜像
1
kubectl get pods -A -o=custom-columns='DATA:spec.containers[?(@.image!="coredns/coredns:1.7.0")].image'
输出 metadata 下面的所有字段,无论 Pod 名字为何
1
kubectl get pods -A -o=custom-columns='DATA:metadata.*'
查看某个 namespace 下所有 Pod 的 名称
1
kubectl get pods -n rook-ceph -o custom-columns=NAME:.metadata.name --no-headers
删除符合指定条件的 Pod
1
kubectl delete pods -n rook-ceph $(kubectl get pods -n rook-ceph -o custom-columns=NAME:.metadata.name --no-headers | grep 'mon')
调试 Pod
注意: 如果调试容器一直卡在
Defaulting debug container name to debugger-xxx
,请确保 kubelet 服务开启了 –feature-gates=EphemeralContainers=true 功能,该参数可以手动配置在/etc/systemd/system/kubelet.service.d/10-kubelet.conf
中的 KUBELET_CONFIG_ARGS 参数上
使用临时容器调试 Pod
1
kubectl debug -it -n kubesphere-monitoring-system grafana-6844f774f-km4rs --image=10.1.40.69/publics/alpine-curl:latest --target=grafana
通过 Pod 副本调试
1
2
3
4kubectl debug -it -n kubesphere-monitoring-system grafana-6844f774f-km4rs --image=10.1.40.69/publics/alpine-curl:latest --share-processes --copy-to=myapp-debug
# 清理调试 Pod
kubectl delete pod -n kubesphere-monitoring-system myapp-debug有时更改容器的命令很有用,例如添加调试标志或因为应用崩溃。在创建 Pod 副本时改变 Pod 命令
1
kubectl debug -it -n kubesphere-monitoring-system grafana-6844f774f-km4rs --copy-to=myapp-debug --container=grafana -- sh
批量更新服务
批量更新某个命名空间的所有服务
1
2
3
4
5
6
7
8
9
10# 获取服务镜像
kubectl get deploy -n maya-pet-shop-sit -owide |awk '{print $1,$7}' > images.txt
# 同步镜像到其他仓库
while read line;do ./image_rsync.sh maya-pet-shop $line;done < images.txt
# 更新服务
while read line;do
kubectl set image deploy -n maya-pet-shop-uat -l app=${line%%' '*} ${line%%' '*}=${line##*' '} --record;
done < images.txt
kubectl Patch 命令
更新 Deployment 资源中指定容器的 env 配置
1
kubectl patch deployment -n maya-pet-dev easy-retry -p '{"spec":{"template":{"spec":{"containers":[{"name":"easy-retry","env":[{"name":"SW_AGENT_NAME","value":"maya-pet-dev::easy-retry"}]}]}}}}'