Kubectl 常用命令大全

官方文档

https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands

基础命令

create,delete,get,run,expose,set,explain,edit

create

根据文件或者输入来创建资源

1# 创建Deployment和Service资源
2kubectl create -f demo-deployment.yaml
3kubectl create -f demo-service.yaml

delete

1# 根据yaml文件删除对应的资源,但是yaml文件并不会被删除,这样更加高效
2kubectl delete -f demo-deployment.yaml 
3kubectl delete -f demo-service.yaml
4
5# 也可以通过具体的资源名称来进行删除,使用这个删除资源,同时删除deployment和service资源
6kubectl delete 具体的资源名称
7kubectl delete deploy whomai

get

 1# 查看所有的资源信息
 2kubectl get all
 3kubectl get --all-namespaces
 4
 5# 查看pod列表
 6kubectl get pod
 7
 8# 显示pod节点的标签信息
 9kubectl get pod --show-labels
10
11# 根据指定标签匹配到具体的pod
12kubectl get pods -l app=example
13
14# 查看node节点列表
15kubectl get node 
16
17# 显示node节点的标签信息
18kubectl get node --show-labels
19
20# 查看pod详细信息,也就是可以查看pod具体运行在哪个节点上(ip地址信息)
21kubectl get pod -o wide
22
23# 查看服务的详细信息,显示了服务名称,类型,集群ip,端口,时间等信息
24kubectl get svc
25kubectl get svc -n kube-system
26
27# 查看命名空间
28kubectl get ns
29kubectl get namespaces
30
31# 查看所有pod所属的命名空间
32kubectl get pod --all-namespaces
33
34# 查看所有pod所属的命名空间并且查看都在哪些节点上运行
35kubectl get pod --all-namespaces  -o wide
36
37# 查看目前所有的replica set,显示了所有的pod的副本数,以及他们的可用数量以及状态等信息
38kubectl get rs
39
40# 查看已经部署了的所有应用,可以看到容器,以及容器所用的镜像,标签等信息
41kubectl get deploy -o wide
42kubectl get deployments -o wide

run

在集群中创建并运行一个或多个容器镜像。

1# 示例,运行一个名称为nginx,副本数为3,标签为app=example,镜像为nginx:1.10,端口为80的容器实例
2
3kubectl run nginx --replicas=3 --labels="app=example" --image=nginx:1.10 --port=80
4
5# 示例,运行一个名称为nginx,副本数为3,标签为app=example,镜像为nginx:1.10,端口为80的容器实例,并绑定到k8s-node1上
6kubectl run nginx --image=nginx:1.10 --replicas=3 --labels="app=example" --port=80 --overrides='{"apiVersion":"apps/v1","spec":{"template":{"spec":{"nodeSelector":{"kubernetes.io/hostname":"k8s-node1"}}}}}'

expose

创建一个service服务,并且暴露端口让外部可以访问

1# 创建一个nginx服务并且暴露端口让外界可以访问
2kubectl expose deployment nginx --port=88 --type=NodePort --target-port=80 --name=nginx-service

set

配置应用的一些特定资源,也可以修改应用已有的资源

使用 kubectl set –help查看,它的子命令,env,image,resources,selector,serviceaccount,subject。

 1# 将deployment中的nginx容器镜像设置为“nginx:1.9.1”
 2kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1
 3
 4# 所有deployment和rc的nginx容器镜像更新为“nginx:1.9.1”
 5kubectl set image deployments,rc nginx=nginx:1.9.1 --all
 6
 7# 将daemonset abc的所有容器镜像更新为“nginx:1.9.1”
 8kubectl set image daemonset abc *=nginx:1.9.1
 9
10# 从本地文件中更新nginx容器镜像
11kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
12
13# 将deployment的nginx容器cpu限制为“200m”,将内存设置为“512Mi”
14kubectl set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi
15
16# 设置所有nginx容器中 Requests和Limits
17kubectl set resources deployment nginx --limits=cpu=200m,memory=512Mi --requests=cpu=100m,memory=256Mi
18
19# 删除nginx中容器的计算资源值
20kubectl set resources deployment nginx --limits=cpu=0,memory=0 --requests=cpu=0,memory=0

explain

用于显示资源文档信息

1kubectl explain rs

edit

用于编辑资源信息

1# 编辑Deployment nginx的一些信息
2kubectl edit deployment nginx
3
4# 编辑service类型的nginx的一些信息
5kubectl edit service/nginx

设置命令

label,annotate,completion

label

用于更新(增加、修改或删除)资源上的 label(标签)

  • label 必须以字母或数字开头,可以使用字母、数字、连字符、点和下划线,最长63个字符。
  • 如果 --overwritetrue,则可以覆盖已有的label,否则尝试覆盖label将会报错。
  • 如果指定了--resource-version,则更新将使用此资源版本,否则将使用现有的资源版本。
 1# 给名为foo的Pod添加label unhealthy=true
 2kubectl label pods foo unhealthy=true
 3
 4# 给名为foo的Pod修改label 为 'status' / value 'unhealthy',且覆盖现有的value
 5kubectl label --overwrite pods foo status=unhealthy
 6
 7# 给 namespace 中的所有 pod 添加 label
 8kubectl label  pods --all status=unhealthy
 9
10# 仅当resource-version=1时才更新 名为foo的Pod上的label
11kubectl label pods foo status=unhealthy --resource-version=1
12
13# 删除名为“bar”的label 。(使用“ - ”减号相连)
14kubectl label pods foo bar-

annotate

更新一个或多个资源的Annotations信息。也就是注解信息,可以方便的查看做了哪些操作。

  • Annotations由key/value组成。
  • Annotations的目的是存储辅助数据,特别是通过工具和系统扩展操作的数据。
  • 如果–overwrite为true,现有的annotations可以被覆盖,否则试图覆盖annotations将会报错。
  • 如果设置了–resource-version,则更新将使用此resource version,否则将使用原有的resource version。
 1# 更新Pod“foo”,设置annotation “description”的value “my frontend”,如果同一个annotation多次设置,则只使用最后设置的value值
 2kubectl annotate pods foo description='my frontend'
 3
 4# 根据“pod.json”中的type和name更新pod的annotation
 5kubectl annotate -f pod.json description='my frontend'
 6
 7# 更新Pod"foo",设置annotation“description”的value“my frontend running nginx”,覆盖现有的值
 8kubectl annotate --overwrite pods foo description='my frontend running nginx'
 9
10# 更新 namespace中的所有pod
11kubectl annotate pods --all description='my frontend running nginx'
12
13# 只有当resource-version为1时,才更新pod 'foo'
14kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
15
16# 通过删除名为“description”的annotations来更新pod 'foo'。
17# 不需要 -overwrite flag。
18kubectl annotate pods foo description-

completion

用于设置 kubectl 命令自动补全,见 mac下kubectl命令自动补齐

部署命令

rollout, rolling-update,scale,autoscale

rollout

用于对资源进行管理,可用资源包括:deploymentsdaemonsets

子命令:

  • history(查看历史版本)
  • pause(暂停资源)
  • resume(恢复暂停资源)
  • status(查看资源状态)
  • undo(回滚版本)
1# 语法
2kubectl rollout SUBCOMMAND
3
4# 回滚到之前的deployment
5kubectl rollout undo deployment/abc
6
7# 查看daemonet的状态
8kubectl rollout status daemonset/foo

rolling-update

执行指定ReplicationController的滚动更新。

该命令创建了一个新的RC, 然后一次更新一个pod方式逐步使用新的PodTemplate,最终实现Pod滚动更新,new-controller.json需要与之前RC在相同的namespace下

 1# 使用frontend-v2.json中的新RC数据更新frontend-v1的pod
 2kubectl rolling-update frontend-v1 -f frontend-v2.json
 3
 4# 使用JSON数据更新frontend-v1的pod
 5cat frontend-v2.json | kubectl rolling-update frontend-v1 -f -
 6
 7# 其他的一些滚动更新
 8kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2
 9
10kubectl rolling-update frontend --image=image:v2
11
12kubectl rolling-update frontend-v1 frontend-v2 --rollback

scale

扩容或缩容 DeploymentReplicaSetReplication ControllerJob 中Pod数量

scale也可以指定多个前提条件,如:当前副本数量或 –resource-version ,进行伸缩比例设置前,系统会先验证前提条件是否成立。这个就是弹性伸缩策略。

 1# 将名为foo中的pod副本数设置为3。
 2kubectl scale --replicas=3 rs/foo
 3kubectl scale deploy/nginx --replicas=30
 4
 5# 将由“foo.yaml”配置文件中指定的资源对象和名称标识的Pod资源副本设为3
 6kubectl scale --replicas=3 -f foo.yaml
 7
 8# 如果当前副本数为2,则将其扩展至3。
 9kubectl scale --current-replicas=2 --replicas=3 deployment/mysql
10
11# 设置多个RC中Pod副本数量
12kubectl scale --replicas=5 rc/foo rc/bar rc/baz

autoscale

这个比scale更加强大,也是弹性伸缩策略 ,它是根据流量的多少来自动进行扩展或者缩容。

指定DeploymentReplicaSetReplicationController,并创建已经定义好资源的自动伸缩器。使用自动伸缩器可以根据需要自动增加或减少系统中部署的pod数量。

1# 使用 Deployment “foo”设定,使用默认的自动伸缩策略,指定目标CPU使用率,使其Pod数量在2到10之间
2kubectl autoscale deployment foo --min=2 --max=10
3
4# 使用RC“foo”设定,使其Pod的数量介于1和5之间,CPU使用率维持在80%
5kubectl autoscale rc foo --max=5 --cpu-percent=80

集群管理命令

certificate,cluster-info,top,cordon,uncordon,drain,taint

certificate

用于证书资源管理,授权等

1# 例如,当有node节点要向master请求,那么是需要master节点授权的
2kubectl certificate approve node-csr-81F5uBehyEyLWco5qavBsxc1GzFcZk3aFM3XW5rT3mw node-csr-Ed0kbFhc_q7qx14H3QpqLIUs0uKo036O2SnFpIheM18

cluster-info

显示集群信息

1kubectl cluster-info

top

用于查看资源的cpu,内存磁盘等资源的使用率

1# 以前需要heapster,后替换为metrics-server
2kubectl top pod --all-namespaces

cordon命令:用于标记某个节点不可调度

uncordon命令:用于标签节点可以调度

drain命令: 用于在维护期间排除节点。

taint命令:用于给某个Node节点设置污点

集群故障排查和调试命令

describe,logs,exec,attach,port-foward,proxy,cp,auth

describe

显示特定资源的详细信息

1# 查看my-nginx pod的详细状态
2kubectl describe po my-nginx

logs

用于在一个pod中打印一个容器的日志,如果pod中只有一个容器,可以省略容器名

 1# 返回仅包含一个容器的pod nginx的日志快照
 2kubectl logs nginx
 3
 4# 返回pod ruby中已经停止的容器web-1的日志快照
 5kubectl logs -p -c ruby web-1
 6
 7# 持续输出pod ruby中的容器web-1的日志
 8kubectl logs -f -c ruby web-1
 9
10# 仅输出pod nginx中最近的20条日志
11kubectl logs --tail=20 nginx
12
13# 输出pod nginx中最近一小时内产生的所有日志
14kubectl logs --since=1h nginx

参数选项:

1-c, --container="": 容器名。
2-f, --follow[=false]: 指定是否持续输出日志(实时日志)。
3--interactive[=true]: 如果为true,当需要时提示用户进行输入。默认为true。
4--limit-bytes=0: 输出日志的最大字节数。默认无限制。
5-p, --previous[=false]: 如果为true,输出pod中曾经运行过,但目前已终止的容器的日志。
6--since=0: 仅返回相对时间范围,如5s、2m或3h,之内的日志。默认返回所有日志。只能同时使用since和since-time中的一种。
7--since-time="": 仅返回指定时间(RFC3339格式)之后的日志。默认返回所有日志。只能同时使用since和since-time中的一种。
8--tail=-1: 要显示的最新的日志条数。默认为-1,显示所有的日志。
9--timestamps[=false]: 在日志中包含时间戳。

exec

进入容器进行交互,在容器中执行命令 命令选项:

  • -c, –container="": 容器名。如果未指定,使用pod中的一个容器。
  • -p, –pod="": Pod名。
  • -i, –stdin[=false]: 将控制台输入发送到容器。
  • -t, –tty[=false]: 将标准输入控制台作为容器的控制台输入。
1# 进入nginx容器,执行一些命令操作
2kubectl exec -it nginx-deployment-58d6d6ccb8-lc5fp bash

attach

连接到一个正在运行的容器。

1kubectl attach POD -c CONTAINER

参数选项:

  • -c, –container="": 容器名。如果省略,则默认选择第一个 pod。
  • -i, –stdin[=false]: 将控制台输入发送到容器。
  • -t, –tty[=false]: 将标准输入控制台作为容器的控制台输入。
1# 获取正在运行中的pod 123456-7890的输出,默认连接到第一个容器
2kubectl attach 123456-7890
3
4# 获取pod 123456-7890中ruby-container的输出
5kubectl attach 123456-7890 -c ruby-container
6
7# 切换到终端模式,将控制台输入发送到pod 123456-7890的ruby-container的“bash”命令,并将其输出到控制台/
8# 错误控制台的信息发送回客户端。
9kubectl attach 123456-7890 -c ruby-container -i -t

cp

拷贝文件或者目录到pod容器,或者从容器拷贝到本机;用于pod和外部的文件交换,类似于docker 的cp,就是将容器中的内容和外部的内容进行交换。

1# 本地到容器
2kubectl cp /tmp/foo_dir <some-pod>:/tmp/bar_dir
3
4# 容器到本地
5kubectl exec -n <some-namespace> <some-pod> -- tar cf - /tmp/foo | tar xf - -C /tmp/bar
6kubectl cp <some-namespace>/<some-pod>:/tmp/foo /tmp/bar

其他命令

api-servions,config,help,plugin,version

api-servions

打印受支持的api版本信息

1# 打印当前集群支持的api版本
2kubectl api-versions

config

用于修改kubeconfig配置文件(用于访问api,例如配置认证信息),设置 kubectl 与哪个 Kubernetes 集群进行通信并修改配置信息。

 1# 显示合并的 kubeconfig 配置
 2kubectl config view
 3
 4# 同时使用多个 kubeconfig 文件并查看合并的配置
 5KUBECONFIG=~/.kube/config:~/.kube/kubconfig2 kubectl config view
 6
 7# 获取 e2e 用户的密码
 8kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
 9
10# 展示当前所处的上下文
11kubectl config current-context
12
13# 设置默认的上下文为 my-cluster-name
14kubectl config use-context my-cluster-name
15
16# 添加新的集群配置到 kubeconf 中,使用 basic auth 进行鉴权
17kubectl config set-credentials kubeuser/foo.kubernetes.com --username=kubeuser --password=kubepassword
18
19# 使用特定的用户名和命名空间设置上下文。
20kubectl config set-context gce --user=cluster-admin --namespace=foo \
21  && kubectl config use-context gce

version

打印客户端和服务端版本信息kubectl version

plugin

运行一个命令行插件

高级命令

apply,patch,replace,convert

apply

通过文件名或控制台输入,对资源进行配置。 如果资源不存在,将会新建一个。可以使用 JSON 或者 YAML 格式。

1# 将pod.json中的配置应用到pod
2kubectl apply -f ./pod.json
3
4# 将控制台输入的JSON配置应用到Pod
5cat pod.json | kubectl apply -f -

参数选项:

  • -f, –filename=[]: 包含配置信息的文件名,目录名或者URL。
  • –include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true]
  • -o, –output="": 输出模式。"-o name"为快捷输出(资源/name).
  • –record[=false]: 在资源注释中记录当前 kubectl 命令。
  • -R, –recursive[=false]: Process the directory used in -f, –filename recursively. Useful when you want to manage related manifests organized within the same directory.
  • –schema-cache-dir="~/.kube/schema": 非空则将API schema缓存为指定文件,默认缓存到’$HOME/.kube/schema'
  • –validate[=true]: 如果为true,在发送到服务端前先使用schema来验证输入。

patch

使用补丁修改,更新资源的字段,也就是修改资源的部分内容

1# Partially update a node using strategic merge patch
2kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
3
4# Update a container's image; spec.containers[*].name is required because it's a merge key
5kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'

replace

通过文件或者标准输入替换原有资源

 1# Replace a pod using the data in pod.json.
 2kubectl replace -f ./pod.json
 3
 4# Replace a pod based on the JSON passed into stdin.
 5cat pod.json | kubectl replace -f -
 6
 7# Update a single-container pod's image version (tag) to v4
 8kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
 9
10# Force replace, delete and then re-create the resource
11kubectl replace --force -f ./pod.json

convert

不同的版本之间转换配置文件

1# Convert 'pod.yaml' to latest version and print to stdout.
2kubectl convert -f pod.yaml
3
4# Convert the live state of the resource specified by 'pod.yaml' to the latest version
5# and print to stdout in json format.
6kubectl convert -f pod.yaml --local -o json
7
8# Convert all files under current directory to latest version and create them all.
9kubectl convert -f . | kubectl create -f -

格式化输出

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

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

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

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

参考: https://kubernetes.io/zh-cn/docs/reference/kubectl/cheatsheet/#kubectl-output-verbosity-and-debugging

发布日期:2023-06-01 19:59 字数:1189 用时 6分钟
tags:k8s kubectl