kubectl简介

一、kubectl简介

kubectl 是操作 k8s 集群的命令行工具，安装在 k8s 的 master 节点，kubectl 在 $HOME/.kube 目录中查找一个名为 config 的文件, 你可以通过设置 Kubeconfig 环境变量 或设置特定的 kubeconfig，kubectl 也可以使用特定的 kubeconfig 文件操作 k8s 集群。

kubectl 通过与 apiserver 交互可以实现对 k8s 集群中各种资源的增删改查。接下来将会 介绍 kubectl 语法，命令行的操作，并介绍常见的示例。命令的详细信息、参数和子命令 可在 kubectl 参考文档中查看

kubectl --help 可以查看kubectl帮助命令

1.1 kubectl 语法

kubectl 语法格式如下，可在 k8s 集群的 master 节点执行：
kubectl [command] [TYPE] [NAME] [flags]

上述语法解释说明：
command：指定要对一个或多个资源执行的操作，例如 create、get、describe、delete等。
type：指定资源类型，可以是 pod、deployment、statefulset、service 等。资源类型不区分大小写，可以指定单数、复数或缩写形式。例如，以下命令输出相同的结果:
kubectl get pod pod1 例如：kubectl get pod kube-scheduler-master -n kube-system
kubectl get pods pod1
kubectl get po pod1  #  kubectl get po kube-scheduler-master -n kube-system
NAME：指定资源的名称。名称区分大小写。如果省略名称，则显示所有资源的详细信息：
kubectl get pods。
flags: 指定可选的参数。例如，可以使用-o 查看 pod 在哪个机器上

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

1.2 多个资源执行操作

在对多个资源执行操作时，可以按类型、名称、一个或者多个文件指定每个资源：

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

要对所有类型相同的资源进行分组，请执行以下操作：

TYPE1 name1 name2 name<#>

例子：kubectl get pod kube-scheduler-master etcd-master -n kube-system

 

分别指定多个资源类型：

TYPE1/name1 TYPE1/name2 TYPE2/name3 TYPE<#>/name<#>。

例：kubectl get pod/example-pod1 pod/example-pod2 deployment/example-rc1

　　kubectl get pod/cephfs-pod-1 pod/cephfs-pod-2

二、kubectl 操作命令演示

参考：Kubernetes kubectl annotate 命令详解 _ Kubernetes(K8S)中文文档_Kubernetes中文社区

下面讲解和 kubectl 操作相关的命令和语法： kubectl apply -f kubectl-pod.yaml

1.annotate 
描述：添加或更新一个或多个资源的注释。
Annotations 由 key/value 组成。
Annotations 的目的是存储辅助数据，特别是通过工具和系统扩展操作的数据
如果--overwrite 为 true，现有的 annotations 可以被覆盖，否则试图覆盖
annotations 将会报错。
如果设置了--resource-version，则更新将使用此 resource version，否则将使用原有的 resource version。

语法：
kubectl annotate (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 … 
KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]

示例：
更新“kubectl-pod”这个 pod，设置 annotation “description”的 value 为 “my kubectl-pod”，如果同一个 annotation 多次设置，则只使用最后设置的 value 值。
kubectl annotate pods kubectl-pod description='my kubectl-pod'

更新“kubectl-pod”这个 pod，设置 annotation “description”的 value 为 “my tomcat”，覆盖现有的值
kubectl annotate --overwrite pods kubectl-pod description='my tomcat'

2.api-versions
语法： 
kubectl api-versions [flags]
描述：
列出可用的 api 版本

各种 apiVersion 的含义：
alpha： 
内测版，包含很多错误，使用可能会有 bug，如果这个版本废弃，不会通知客户
beta： 
公测版，该版本经过大量的测试已经可以被正常使用，可能某些细节会有变化，但是不会废弃这个版本
stable： 
稳定版：此版本很稳定，可以放心使用，之后的版本会一直包含这个稳定版，命名方式如 v1

kubectl api-versions 显示的结果如下:
admissionregistration.k8s.io/v1 #准入控制相关的 api
v1 # Kubernetes API 的稳定版本，包含很多核心对象：pod、service 等
apps/v1 #包含一些通用的应用层的 api 组合，如：Deployments, Statefulset, and Daemonset 等

3.apply
语法： 
kubectl apply -f FILENAME [flags]
从文件对资源的应用配置进行更改。声明式的更新配置文件。

4.autoscale 
自动扩缩容由副本控制器管理的一组 pod。

语法： 
kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]

5.cluster-info
1）语法： 
kubectl cluster-info [flags]
显示有关集群中的主服务器和服务的端点信息。

6.config
语法： 
kubectl config SUBCOMMAND [flags]
修改 kubeconfig 文件

7.create-一般不用，用 apply 替代这个 
语法： 
kubectl create -f FILENAME [flags]
从文件或标准输入创建一个或多个资源。

8.delete
语法：
kubectl delete (-f FILENAME | TYPE [NAME | /NAME | -l label | --all]) [flags] 
从文件、标准输入或指定标签选择器、名称、资源选择器或资源中删除资源。

9.describe
语法： 
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | /NAME | -l label]) [flags]
显示一个或多个资源的详细状态。

10.edit
语法：
kubectl edit (-f FILENAME | TYPE NAME | TYPE/NAME) [flags] 
使用默认编辑器编辑和更新服务器上一个或多个资源的定义。

11.exec---常用
语法： 
kubectl exec POD-name [-c CONTAINER-name] [-i] [-t] [flags] [-- COMMAND [args...]]
对 pod 中的容器执行命令。

12.explain---常用
语法： 
kubectl explain [--recursive=false] [flags]
获取多种资源的文档。例如 pod, node, service 等，相当于帮助命令，可以告诉我们怎么创建资源

13.expose
语法：
kubectl expose (-f FILENAME | TYPE NAME | TYPE/NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--externalip=external-ip-of-service] [--type=type] [flags]
将副本控制器、服务或 pod 作为新的 Kubernetes 服务进行暴露。

14.get
语法： 
kubectl get (-f FILENAME | TYPE [NAME | /NAME | -l label]) [--watch] [--sortby=FIELD] [[-o | --output]=OUTPUT_FORMAT] [flags]
列出一个或多个资源。

15.label
语法： 
kubectl label (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 … KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]
添加或更新一个或多个资源的标签。

16.logs
语法：
kubectl logs POD [-c CONTAINER] [--follow] [flags] 
在 pod 中打印容器的日志。

17.patch
patch 
1）语法：
kubectl patch (-f FILENAME | TYPE NAME | TYPE/NAME) --patch PATCH [flags] 
更新资源的一个或多个字段

18.port-forward
语法： 
kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT 
[...[LOCAL_PORT_N:]REMOTE_PORT_N] [flags]
将一个或多个本地端口转发到 Pod。

19.proxy
语法： 
kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--apiprefix=prefix] [flags]
运行 Kubernetes API 服务器的代理。

20.replace
语法：
kubectl replace -f FILENAM 
从文件或标准输入中替换资源。

21.run---测试镜像偶尔使用
语法： 
kubectl run NAME --image=image [--env=“key=value”] [--port=port] [--dryrun=server | client | none] [--overrides=inline-json] [flags]
在集群上运行指定的镜像

22.scale
语法： 
kubectl scale (-f FILENAME | TYPE NAME | TYPE/NAME) --replicas=COUNT [--resource-version=version] [--current-replicas=count] [flags]
更新指定副本控制器的大小。

23.version
语法： 
kubectl version [--client] [flags] 
显示运行在客户端和服务器上的 Kubernetes 版本

有关 kubectl 更详细的操作命令，可参考

https://kubernetes.io/docs/reference/kubectl/kubectl/

http://docs.kubernetes.org.cn/486.html

三、资源类型

下表列出所有受支持的资源类型及其缩写别名: 以下输出可以通过 kubectl api-resources 获取

 

 

 

 四、kubectl 输出选项

4.1 格式输出

kubectl 命令的默认输出格式是人类可读的明文格式，若要以特定格式向终端窗口输出详 细信息，可以将-o 或—out 参数添加到受支持的 kubectl 命令中。

4.2 语法

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

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

 

 **示例：在此示例中，以下命令将单个 pod 的详细信息输出为 YAML 格式的对象： kubectl get pod web-pod-13je7 -o yaml

注：有关每个命令支持哪种输出格式的详细信息，可参考：

https://kubernetes.io/docs/user-guide/kubectl/

4.3 自定义列

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

示例：

1）内联

kubectl get pods -o customcolumns=NAME:.metadata.name,RSRC:.metadata.resourceVersion

2）模板文件

kubectl get pods -o custom-columns-file=template.txt 其中，template.txt 文件内容是：

NAME 　　　　RSRC

metadata.name metadata.resourceVersion

运行任何一个命令的结果是:

NAME 　　　　RSRC

submit-queue 　610995

4.4 server-side列

kubectl 支持从服务器接收关于对象的特定列信息。 这意味着对于任何给定的资源，服务 器将返回与该资源相关的列和行，以便客户端打印。 通过让服务器封装打印的细节，这允 许在针对同一集群使用的客户端之间提供一致的人类可读输出。默认情况下，此功能在 kubectl 1.11 及更高版本中启用。要禁用它，请将该--server-print=false 参数添加 到 kubectl get 命令中。

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

kubectl get pods --server-print=false

输出如下：

NAME AGE

nfs-provisioner-595dcd6b77-527np 5d21h

4.5 排序列表对象

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

语法

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

示例

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

[root@master ceph]# kubectl get pods -n kube-system --sort-by=.metadata.name
NAME                                       READY   STATUS    RESTARTS   AGE
calico-kube-controllers-56c7cdffc6-n2grp   1/1     Running   2          12d
calico-node-h4c57                          1/1     Running   0          53m
calico-node-jp65s                          1/1     Running   0          54m
calico-node-ltnpt                          1/1     Running   0          12d
calico-node-zlfs9                          1/1     Running   11         12d
coredns-7f89b7bc75-2m8n5                   1/1     Running   0          49m
coredns-7f89b7bc75-zdlb6                   1/1     Running   0          47m
etcd-master                                0/1     Running   2          12d
kube-apiserver-master                      0/1     Running   11         17h
kube-controller-manager-master             1/1     Running   2          12d
kube-proxy-8z5fc                           1/1     Running   0          45m
kube-proxy-gjx9g                           1/1     Running   0          12d
kube-proxy-ht224                           1/1     Running   6          12d
kube-proxy-xz4b7                           1/1     Running   2          12d
kube-scheduler-master                      0/1     Running   2          12d

五、kubectl常用命令介绍

1. kubectl apply
用文件或者标准输入来应用或者更新 k8s 的资源
# 使用 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 pods

# 以纯文本输出格式列出所有 pod，并包含附加信息(如节点名)。
kubectl get pods -o wide

# 以纯文本输出格式列出具有指定名称的副本控制器。提示：你可以使用别名 'rc' 缩短和替换 'replicationcontroller' 资源类型。
kubectl get replicationcontroller <rc-name>

# 以纯文本输出格式列出所有副本控制器和服务。
kubectl get rc,services

# 以纯文本输出格式列出所有守护程序集。
kubectl get ds

# 列出在节点 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
kubectl describe pods

注意：

kubectl get 命令通常用于检索同一资源类型的一个或多个资源。 它具有丰 富的参数，允许您使用 -o 或 --output 参数自定义输出格式。您可以指定 - w 或 --watch 参数以开始观察特定对象的更新。 kubectl describe 命令更侧 重于描述指定资源的许多相关方面。它可以调用对 API 服务器 的多个 API 调 用来为用户构建视图。 例如，该 kubectl describe node 命令不仅检索有 关节点的信息，还检索在其上运行的 pod 的摘要，为节点生成的事件等。

4.kubectl delete 
从文件、标注输入或指定标签选择器、名称、资源选择器或资源中删除资源。
# 使用 pod.yaml 文件中指定的类型和名称删除 pod。
kubectl delete -f pod.yaml

# 删除标签名= <label-name> 的所有 pod 和服务。
kubectl delete pods,services -l name=<label-name>

# 删除所有具有标签名称= <label-name> 的 pod 和服务，包括未初始化的那些。
kubectl delete pods,services -l name=<label-name> --include-uninitialized

# 删除所有 pod，包括未初始化的 pod。
kubectl delete pods --all

5.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 -ti <pod-name> -- /bin/bash

6.kubectl logs
打印Pod容器日志
# 从 pod 返回日志快照。
kubectl logs <pod-name>

# 从 pod <pod-name> 开始流式传输日志。这类似于 'tail -f' Linux 命令。
kubectl logs -f <pod-name