玩转k8s：kubectl命令行工具用法详解_kubectl apply -f

Kubectl 是管理kubernetes的命令行工具，kubectl在$HOME/.kube目录下查找config配置文件。可以通过设置KUBECONFIG环境变量或设置--kubeconfig参数指定其他kubeconfig文件。

本文介绍kubectl语法和命令操作描述，并提供常见示例。包括支持的参数和子命令。

一、语法

kubectl使用以下语法，在终端运行命令：

kubectl [command] [TYPE] [NAME] [flags]

其中：

• command：指定要对一个或多个资源执行的操作，比如create、get、describe、delete、run。
• TYPE：指定资源类型。资源类型不区分大小写，可以指定单数、复数或缩写形式。

例如：以下三个命令输出结果相同

kubectl get pod nginx-1635820653-568f555cfd-fmvr2
kubectl get pods nginx-1635820653-568f555cfd-fmvr2
kubectl get po nginx-1635820653-568f555cfd-fmvr2

• NAME: 指定资源的名称。名称区分大小写。如果省略名称，则显示所有资源的详细信息

kubectl get pods

1）要按类型和名称指定资源

a) 要对所有类型相同的资源进行分区，执行以下操作： TYPE1 name1 name2 name<#>，例如： 

kubectl get pod nfs-client-provisioner-6fd5756874-qkwwq sentinel-0

b) 分别指定多个资源类型： TYPE1/name TYPE1/name2 TYPE2/name1 TYPE<#>/name<#>，例如：

kubectl get pod/nfs-client-provisioner-6fd5756874-qkwwq service/nginx-1635820653

2）用一个或多个文件指定资源： -f file1 -f file2 -f file<#>

a) 使用YAML而不是JSON，因为YAML更容易使用，特别是用于配置文件。例如：

kubectl get -f ./pod.yaml

• flags:  指定可选的参数。例如，可以使用 -s 或 --server 参数指定 Kubernetes API 服务器的地址和端口。

• -n 后跟 namespace, 查看指定的命名空间
• -o

注意：从命令行指定的参数会覆盖默认值和任何相应的环境变量。 

如果需要帮助，可以使用kubectl的help命令

kubectl -h

二、操作

基础命令

集群部署命令

集群管理命令

故障和调试命令

高级命令

设置命令

其他命令

下表包含所有kubectl操作的描述和语法

更多有关命令操作的信息，请参阅kubectl参考文档。

三、资源类型

下表列出所有支持的资源类型及其缩写名：

提示：以下输出可以通过kubectl api-resources获取

四、输出选项

介绍如何格式化或排序某些命令的输出信息。

1）格式化输出

kubectl命令的默认输出格式是可读的纯文本格式。要以特定格式向终端窗口输出详细信息，可以将-o或--output参数添加到kubectl命令中。

语法：

kubectl [command] [TYPE] [NAME] -o=<output_format>

 根据kubectl操作，支持以下输出格式：

示例

在此示例中，将单个pod的详细信息输出为YAML格式的对象：

kubectl get pods web-59ff48c4b4-p7d4l -o yaml

2）自定义列

可以自定义列并仅将所需的详细信息输出到表中，可以使用该custom-columns选项。可以使用内联定义自定义列或使用模板文件： -o=custom-columns=<spec> 或 -o=custom-columns-file=<filename>

示例：

内联

kubectl get pods <pod-name> -o custom-columns=NAME:.metadata.name,RSRC:.metadata.resourceVersion

模板文件：

kubectl get pods <pod-name> -o custom-columns-file=template.txt

其中，template.txt文件包含：

 
NAME          RSRC
metadata.name metadata.resourceVersion

运行命令，结果如下：

NAME                   RSRC
web-59ff48c4b4-p7d4l   73277318

3）Server-side列

kubectl支持从服务器接收关于对象的特定列信息。对于任何给定的资源，服务器将返回与该资源相关的列和行，以便客户端打印。通过让服务器封装打印的细节，允许在针对统一集群使用的客户端之间提供一直的可读输出。

此功能默认启用。要禁用它，将参数--server-print=false参数添加到kubectl get 命令中

例子：

要打印有关pod状态的信息，请使用如下命令：

kubectl get pods <pod-name> --server-print=false

输出类似于

NAME       AGE
pod-name   1m

4）排序列表对象

要将对象排序后输出到终端窗口，可以将--sort-by参数添加到支持的kubectl命令。通过使用--sort-by参数指定任何数字或字符串来对对象进行排序。要指定字段，请使用jsonpath表达式。

语法：

kubectl [command] [TYPE] [NAME] --sort-by=<jsonpath_exp>

示例：

要打印按名称排序的pod列表，请运行：

kubectl get pods --sort-by=.metadata.name

五、示例：常用操作

使用以下示例来帮助你熟悉运行常用kubectl操作

1）kubectl apply -以文件或标准输入为准应用或更新资源

# 使用 example-service.yaml 中的定义创建服务。
kubectl apply -f example-service.yaml
# 使用 example-controller.yaml 中的定义创建 replication controller。
kubectl apply -f example-controller.yaml
# 使用 <directory> 路径下的任意 .yaml, .yml, 或 .json 文件 创建对象。
kubectl apply -f <directory>

2）kubectl get - 列出一个或多个资源

# 获取所有名称空间的pod
kubectl get pod -A
 
# 以纯文本输出格式列出所有 pod，并包含附加信息(如节点名)。
kubectl get pods -o wide
 
# 以纯文本输出格式列出具有指定名称的副本控制器。提示：你可以使用别名 'rc' 缩短和替换 'replicationcontroller' 资源类型。
kubectl get replicationcontroller <rc-name>
 
# 以纯文本输出格式列出所有副本控制器和服务。
kubectl get rc,services
 
# 以纯文本输出格式列出所有守护程序集，包括未初始化的守护程序集。
kubectl get ds --include-uninitialized
 
# 列出在节点 server01 上运行的所有 pod
kubectl get pods --field-selector=spec.nodeName=server01

3）kubectl describe - 显示一个或多个资源的详细状态，默认情况下包含未初始化的资源

# 显示名称为 <node-name> 的节点的详细信息。
kubectl describe nodes <node-name>
# 显示名为 <pod-name> 的 pod 的详细信息。
kubectl describe pods/<pod-name>
# 显示由名为 <rc-name> 的副本控制器管理的所有 pod 的详细信息。
# 记住：副本控制器创建的任何 pod 都以复制控制器的名称为前缀。
kubectl describe pods <rc-name>
# 描述所有的 pod，不包括未初始化的 pod
kubectl describe pods

说明：

kubectl get 命令通常用于检索同一类型的一个或多个资源。它具有丰富的参数，允许使用-o或--output参数自定义输出格式。可以指定-w或--watch参数以开始观察特定对象的更新。

kubectl describe命令更侧重于描述指定资源的相关方面。可以调用对API服务器的多个API调用来为用户构建视图。例如，kubectl describe node命令不仅检索有关节点的信息，还检索在其上运行的pod的摘要，为节点生成的事件等。

3）kubectl delete - 从文件、stdin或指定的标签选择器、名称、资源选择器或资源中删除资源。

# 使用 pod.yaml 文件中指定的类型和名称删除 pod。
kubectl delete -f pod.yaml
# 删除所有带有 '<label-key>=<label-value>' 标签的 Pod 和服务。
kubectl delete pods,services -l <label-key>=<label-value>
# 删除所有 pod，包括未初始化的 pod。
kubectl delete pods --all

 4）kubectl exec - 对pod中的容器执行命令

# 从 pod <pod-name> 中获取运行 'date' 的输出。默认情况下，输出来自第一个容器。
kubectl exec <pod-name> -- date
# 运行输出 'date' 获取在容器的 <container-name> 中 pod <pod-name> 的输出。
kubectl exec <pod-name> -c <container-name> -- date
# 获取一个交互 TTY 并运行 /bin/bash <pod-name >。默认情况下，输出来自第一个容器。
kubectl exec -it <pod-name> -n dev /bin/bash

5）kubectl logs -打印pod中的日志

kubectl是 Kubernetes 命令行工具，是一个管理 Kubernetes 集群的命令行工具。kubectl logs是其中一个命令，可用于查看 Kubernetes Pod 或容器的日志。

使用kubectl logs命令可以了解Pod或容器内发生的事情，帮助我们找出问题，确定调试信息，进而改善应用程序。

该命令的基本语法如下：

kubectl logs [-f] [-p] POD [-c CONTAINER] [--follow] [--previous] [--timestamps] [-n NAMESPACE] [--tail LINES]

其中，[-f]参数表示将持续输出日志，[-c]参数表示指定容器名，[--timestamps]参数表示显示时间戳，[-n]参数表示指定命名空间，[--tail]参数表示显示最近的几行日志。

实时容器日志

kubectl  logs -f $POD_NAME -n $NAMESPACE

 异常退出的容器日志

kubectl  logs  $POD_NAME -n $NAMESPACE -p

按照时间段日志查询(h/m/s之内)

kubectl  logs  $POD_NAME -n $NAMESPACE --since=1h

 按照时间戳查询日志

kubectl  logs  $POD_NAME -n $NAMESPACE --since-time=2019-09-29T11:00:00

查看指定容器日志

一个 Pod 中可能会有多个实例，使用[-c]参数可以查看指定容器的日志。使用下面的命令行来查看容器名称为my-container的日志： 

kubectl logs $POD_NAME -c my-container

监控日志输出

可以使用[-f]参数以流的方式监控日志输出。这会持续地输出容器的最新日志。

例如，要查看容器my-container的实时日志：

kubectl logs $POD_NAME -c my-container -f

指定命名空间

使用[-n]参数可以查看指定命名空间内的容器日志。

例如，要查看特定命名空间内的容器日志：

kubectl logs $POD_NAME -n my-namespace -c my-container

显示最近日志

需要显示容器的最近的几行日志时，可以使用[--tail]参数。

例如，要查看查询容器的最后5行日志：

kubectl logs $POD_NAME -c my-container --tail 5

6）kubectl scale - 扩缩容

# 变更副本数量为5个
[root@k8s-master01 ~]# kubectl scale deploy pc-deployment --replicas=5  -n dev
deployment.apps/pc-deployment scaled
​
# 查看deployment
[root@k8s-master01 ~]# kubectl get deploy pc-deployment -n dev
NAME            READY   UP-TO-DATE   AVAILABLE   AGE
pc-deployment   5/5     5            5           2m
​
# 查看pod
[root@k8s-master01 ~]#  kubectl get pods -n dev
NAME                             READY   STATUS    RESTARTS   AGE
pc-deployment-6696798b78-d2c8n   1/1     Running   0          4m19s
pc-deployment-6696798b78-jxmdq   1/1     Running   0          94s
pc-deployment-6696798b78-mktqv   1/1     Running   0          93s
pc-deployment-6696798b78-smpvp   1/1     Running   0          4m19s
pc-deployment-6696798b78-wvjd8   1/1     Running   0          4m19s
​
# 编辑deployment的副本数量，修改spec:replicas: 4即可
[root@k8s-master01 ~]# kubectl edit deploy pc-deployment -n dev
deployment.apps/pc-deployment edited
​
# 查看pod
[root@k8s-master01 ~]# kubectl get pods -n dev
NAME                             READY   STATUS    RESTARTS   AGE
pc-deployment-6696798b78-d2c8n   1/1     Running   0          5m23s
pc-deployment-6696798b78-jxmdq   1/1     Running   0          2m38s
pc-deployment-6696798b78-smpvp   1/1     Running   0          5m23s
pc-deployment-6696798b78-wvjd8   1/1     Running   0          5m23s

7）版本回退

deployment支持版本升级过程中的暂停、继续功能以及版本回退等诸多功能，下面具体来看.

kubectl rollout： 版本升级相关功能，支持下面的选项：

• status 显示当前升级状态
• history 显示 升级历史记录
• pause 暂停版本升级过程
• resume 继续已经暂停的版本升级过程
• restart 重启版本升级过程
• undo 回滚到上一级版本（可以使用--to-revision回滚到指定版本）

 
# 查看当前升级版本的状态
[root@k8s-master01 ~]# kubectl rollout status deploy pc-deployment -n dev
deployment "pc-deployment" successfully rolled out
​
# 查看升级历史记录
[root@k8s-master01 ~]# kubectl rollout history deploy pc-deployment -n dev
deployment.apps/pc-deployment
REVISION  CHANGE-CAUSE
1         kubectl create --filename=pc-deployment.yaml --record=true
2         kubectl create --filename=pc-deployment.yaml --record=true
3         kubectl create --filename=pc-deployment.yaml --record=true
# 可以发现有三次版本记录，说明完成过两次升级
​
# 版本回滚
# 这里直接使用--to-revision=1回滚到了1版本， 如果省略这个选项，就是回退到上个版本，就是2版本
[root@k8s-master01 ~]# kubectl rollout undo deployment pc-deployment --to-revision=1 -n dev
deployment.apps/pc-deployment rolled back
​
# 查看发现，通过nginx镜像版本可以发现到了第一版
[root@k8s-master01 ~]# kubectl get deploy -n dev -o wide
NAME            READY   UP-TO-DATE   AVAILABLE   AGE   CONTAINERS   IMAGES         
pc-deployment   4/4     4            4           74m   nginx        nginx:1.17.1   
​
# 查看rs，发现第一个rs中有4个pod运行，后面两个版本的rs中pod为运行
# 其实deployment之所以可是实现版本的回滚，就是通过记录下历史rs来实现的，
# 一旦想回滚到哪个版本，只需要将当前版本pod数量降为0，然后将回滚版本的pod提升为目标数量就可以了
[root@k8s-master01 ~]# kubectl get rs -n dev
NAME                       DESIRED   CURRENT   READY   AGE
pc-deployment-6696798b78   4         4         4       78m
pc-deployment-966bf7f44    0         0         0       37m

8） kubectl label - 标签：

# 为pod资源打标签
[root@master ~]# kubectl label pod nginx-pod version=1.0 -n dev
pod/nginx-pod labeled
 
# 为pod资源更新标签
[root@master ~]# kubectl label pod nginx-pod version=2.0 -n dev --overwrite
pod/nginx-pod labeled
 
# 查看标签
[root@master ~]# kubectl get pod nginx-pod  -n dev --show-labels
NAME        READY   STATUS    RESTARTS   AGE   LABELS
nginx-pod   1/1     Running   0          10m   version=2.0
 
# 筛选标签
[root@master ~]# kubectl get pod -n dev -l version=2.0  --show-labels
NAME        READY   STATUS    RESTARTS   AGE   LABELS
nginx-pod   1/1     Running   0          17m   version=2.0
[root@master ~]# kubectl get pod -n dev -l version!=2.0 --show-labels
No resources found in dev namespace.
 
#删除标签
[root@master ~]# kubectl label pod nginx-pod version- -n dev
pod/nginx-pod labeled

9） kubectl Annotation - 注解： 

Annotation注解和标签很类似，其同样是一个键值对。但目的是将非标识性的元数据附加到K8s资源对象上，以便客户端程序（例如工具和库）能够获取这些元数据信息。故在注解中不存在所谓的注解选择器

添加注解

可以在创建资源的Yaml文件中指定注解信息

apiVersion: v1
# 资源类型
kind: Pod
metadata:
  # Pod 名称
  name: my-bootcamp-pod-2-annotation
  # Pod的注解信息
  annotations:
    my.Author: "Aaron Zhu"
    my.Age: "18"
spec:
  # 容器信息
  containers:
  # 一个名为my-bootcamp-2-annotation的容器
  - name: my-bootcamp-2-annotation
    # 镜像信息
    image: jocatalin/kubernetes-bootcamp:v1
    # 仅用于展示容器所使用的端口
    ports:
      - containerPort: 8080
        protocol: TCP

效果如下

也可以直接对现有Pod添加注解

# 给指定Pod添加注解
kubectl annotate pod <Pod名称> <注解的键>=<注解的值>
 
# 给名为my-bootcamp-pod-2的Pod添加名为name、值为hello的注解
kubectl annotate pod my-bootcamp-pod-2 name=hello

效果如下所示

修改注解

修改现有Pod的注解信息，类似于添加注解的命令。只需添加--overwrite选项即可

# 将指定Pod的注解值修改为指定值
kubectl annotate pod <Pod名称> <注解的键>=<注解的新值> --overwrite
 
# 将名为my-bootcamp-pod-2的Pod的名为name的注解值修改为hi
kubectl annotate pod my-bootcamp-pod-2 name=hi --overwrite

效果如下所示

删除注解

删除现有Pod的注解信息，只需指定欲删除注解的名称，并在后面添加一个减号即可

# 对指定Pod，删除指定的注解
kubectl annotate pod <Pod名称> <注解的键>-
 
# 对名为my-bootcamp-pod-2的Pod, 删除名为name的注解
kubectl annotate pod my-bootcamp-pod-2 name-

效果如下所示

查看注解

可借助于kubectl describe命令查看注解信息

kubectl describe <Pod名称>

 而如果使用kubectl get命令查看Json形式的Pod信息，我们会发现注解信息位于.metadata.annotations项中。故我们还可以使用-o jsonpath选项指定注解的路径来直接查看

# 查看指定Pod的注解信息
kubectl get pod <Pod名称> -o jsonpath='{.metadata.annotations}'

效果如下所示

10） kubectl cluster-info - 显示集群信息：  

使用标签kubernetes.io/cluster-service=true显示控制平面和服务地址。要进一步调试和诊断集群问题，可以使用“kubectl cluster-info dump”。

kubectl cluster-info
kubectl cluster-info dump

dump适合调试和诊断集群问题的集群信息。默认情况下，将所有内容转储到标准输出。可以选择使用--output-directory指定目录。如果指定一个目录，Kubernetes将在该目录中构建一组文件。默认情况下，只dump当前名称空间和' kube-system '名称空间中的内容，但可以使用--output-directory标志切换到不同的名称空间，或指定--all-namespaces转储所有名称空间。

该命令还转储集群中所有pod的日志;这些日志根据命名空间和pod名称转储到不同的目录中。

将当前集群状态转储到标准输出

kubectl cluster-info dump

将当前集群状态转储到/path/to/cluster-state

kubectl cluster-info dump --output-directory=/path/to/cluster-state

 将所有名称空间转储到标准输出

kubectl cluster-info dump --all-namespaces

 将一组名称空间转储到/path/to/cluster-state

kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state

11）kubectl cordon, drain, uncordon：

将$NODE_NAME节点标记为不可调度

kubectl cordon $NODE_NAME

安全驱逐$NODE_NAME节点上面所有的 pod

kubectl drain $NODE_NAME

 将节点$NODE_NAME标记为可调度的状态

kubectl uncordon $NODE_NAME

 参考地址：

命令行工具 (kubectl) | Kubernetes