目录
- kubectl 的使用方法
- 1、语法
- 2、操作
- 3、资源类型
- 4、输出格式
- 5、示例：常用操作
- 6、示例：创建和使用插件
kubectl__1">kubectl 的使用方法
Kubernetes 提供 kubectl 是使用 Kubernetes API 与 Kubernetes 集群的控制面进行通信的命令行工具。这个工具叫做 kubectl。通过 kubectl 能够对集群本身进行管理，并能够在集群上进行容器化应用的安装部署。可以说，kebectl 是 Kubernets 集群的最重要的工具，是整个集群的大管家。本节学习的内容就是 kubectl 的使用方法，有关安装说明，请参见：Linux 系统中安装 kubectl
1、语法
使用以下语法从终端窗口运行 kubectl 命令：
kubectl [command] [TYPE] [NAME] [flags]
其中 command、TYPE、NAME 和 flags 分别是：
• command：指定要对一个或多个资源执行的操作，例如 create、get、describe、delete。
• TYPE：指定资源类型。资源类型不区分大小写， 可以指定单数、复数或缩写形式。例如，以下命令输出相同的结果：
kubectl get pod pod1
kubectl get pods pod1
kubectl get po pod1
• NAME：指定资源的名称。名称区分大小写。 如果省略名称，则显示所有资源的详细信息。例如：kubectl get pods。
在对多个资源执行操作时，你可以按类型和名称指定每个资源，或指定一个或多个文件：
• 要按类型和名称指定资源：
• 要对所有类型相同的资源进行分组，请执行以下操作：TYPE1 name1 name2 name<#>。
例子：kubectl get pod example-pod1 example-pod2
• 分别指定多个资源类型：TYPE1/name1 TYPE1/name2 TYPE2/name3 TYPE<#>/name<#>。
例子：kubectl get pod/example-pod1 replicationcontroller/example-rc1
• 用一个或多个文件指定资源：-f file1 -f file2 -f file<#>
• 使用 YAML 而不是 JSON， 因为 YAML 对用户更友好, 特别是对于配置文件。
例子：kubectl get -f ./pod.yaml
• flags： 指定可选的参数。例如，可以使用 -s 或 --server 参数指定 Kubernetes API 服务器的地址和端口。
注意： 从命令行指定的参数会覆盖默认值和任何相应的环境变量。
如果你需要帮助，在终端窗口中运行 kubectl help。
2、操作
| 操作 | 语法 | 描述 |
|---|---|---|
| alpha | kubectl alpha SUBCOMMAND [flags] | 列出与 alpha 特性对应的可用命令，这些特性在 Kubernetes 集群中默认情况下是不启用的。 |
| annotate | kubectl annotate (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 … KEY_N=VAL_N [–overwrite] [–all] [–resource-version=version] [flags] | 添加或更新一个或多个资源的注解。 |
| api-resources | kubectl api-resources [flags] | 列出可用的 API 资源。 |
| api-versions | kubectl api-versions [flags] | 列出可用的 API 版本。 |
| apply | kubectl apply -f FILENAME [flags] | 从文件或 stdin 对资源应用配置更改。 |
| attach | kubectl attach POD -c CONTAINER [-i] [-t] [flags] | 挂接到正在运行的容器，查看输出流或与容器（stdin）交互。 |
| auth | kubectl auth [flags] [options] | 检查授权。 |
| autoscale | kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [–min=MINPODS] --max=MAXPODS [–cpu-percent=CPU] [flags] | 自动扩缩由副本控制器管理的一组 pod。 |
| certificate | kubectl certificate SUBCOMMAND [options] | 修改证书资源。 |
| cluster-info | kubectl cluster-info [flags] | 显示有关集群中主服务器和服务的端口信息。 |
| completion | kubectl completion SHELL [options] | 为指定的 Shell（Bash 或 Zsh）输出 Shell 补齐代码。 |
| config | kubectl config SUBCOMMAND [flags] | 修改 kubeconfig 文件。有关详细信息，请参阅各个子命令。 |
| convert | kubectl convert -f FILENAME [options] | 在不同的 API 版本之间转换配置文件。配置文件可以是 YAML 或 JSON 格式。注意 - 需要安装 kubectl-convert 插件。 |
| cordon | kubectl cordon NODE [options] | 将节点标记为不可调度。 |
| cp | kubectl cp [options] | 从容器复制文件、目录或将文件、目录复制到容器。 |
| create | kubectl create -f FILENAME [flags] | 从文件或 stdin 创建一个或多个资源。 |
| delete | kubectl delete (-f FILENAME | TYPE [NAME | /NAME | -l label | --all]) [flags] | 基于文件、标准输入或通过指定标签选择器、名称、资源选择器或资源本身，删除资源。 |
| describe | kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | /NAME | -l label]) [flags] | 显示一个或多个资源的详细状态。 |
| diff | kubectl diff -f FILENAME [flags] | 在当前起作用的配置和文件或标准输之间作对比 (BETA) |
| drain | kubectl drain NODE [options] | 腾空节点以准备维护。 |
| edit | kubectl edit (-f FILENAME | TYPE NAME | TYPE/NAME) [flags] | 使用默认编辑器编辑和更新服务器上一个或多个资源的定义。 |
| exec | kubectl exec POD [-c CONTAINER] [-i] [-t] [flags] [-- COMMAND [args…]] | 对 Pod 中的容器执行命令。 |
| explain | kubectl explain [–recursive=false] [flags] | 获取多种资源的文档。例如 Pod、Node、Service 等。 |
| expose | kubectl expose (-f FILENAME | TYPE NAME | TYPE/NAME) [–port=port] [–protocol=TCP|UDP] [–target-port=number-or-name] [–name=name] [–external-ip=external-ip-of-service] [–type=type] [flags] | 将副本控制器、服务或 Pod 作为新的 Kubernetes 服务暴露。 |
| get | kubectl get (-f FILENAME | TYPE [NAME | /NAME| -l label]) [–watch] [–sort-by=FIELD] [[-o | --output]=OUTPUT_FORMAT] [flags] | 列出一个或多个资源。 |
| kustomize | kubectl kustomize [flags] [options]` | 列出从 kustomization.yaml 文件中的指令生成的一组 API 资源。参数必须是包含文件的目录的路径，或者是 git 存储库 URL，其路径后缀相对于存储库根目录指定了相同的路径。 |
| label | kubectl label (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 … KEY_N=VAL_N [–overwrite] [–all] [–resource-version=version] [flags] | 添加或更新一个或多个资源的标签。 |
| logs | kubectl logs POD [-c CONTAINER] [–follow] [flags] | 打印 Pod 中容器的日志。 |
| options | kubectl options | 全局命令行选项列表，这些选项适用于所有命令。 |
| patch | kubectl patch (-f FILENAME | TYPE NAME | TYPE/NAME) --patch PATCH [flags] | 使用策略合并流程更新资源的一个或多个字段。 |
| plugin | kubectl plugin [flags] [options] | 提供用于与插件交互的实用程序。 |
| port-forward | kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT […[LOCAL_PORT_N:]REMOTE_PORT_N] [flags] | 将一个或多个本地端口转发到一个 Pod。 |
| proxy | kubectl proxy [–port=PORT] [–www=static-dir] [–www-prefix=prefix] [–api-prefix=prefix] [flags] | 运行访问 Kubernetes API 服务器的代理。 |
| replace | kubectl replace -f FILENAME | 基于文件或标准输入替换资源。 |
| rollout | kubectl rollout SUBCOMMAND [options] | 管理资源的上线。有效的资源类型包括：Deployment、 DaemonSet 和 StatefulSet。 |
| run | kubectl run NAME --image=image [–env=“key=value”] [–port=port] [–dry-run=server | client | none] [–overrides=inline-json] [flags] | 在集群上运行指定的镜像。 |
| scale | kubectl scale (-f FILENAME | TYPE NAME | TYPE/NAME) --replicas=COUNT [–resource-version=version] [–current-replicas=count] [flags] | 更新指定副本控制器的大小。 |
| set | kubectl set SUBCOMMAND [options] | 配置应用资源。 |
| taint | kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 … KEY_N=VAL_N:TAINT_EFFECT_N [options] | 更新一个或多个节点上的污点。 |
| top | kubectl top [flags] [options] | 显示资源（CPU、内存、存储）的使用情况。 |
| uncordon | kubectl uncordon NODE [options] | 将节点标记为可调度。 |
| version | kubectl version [–client] [flags] | 显示运行在客户端和服务器上的 Kubernetes 版本。 |
| wait | kubectl wait ([-f FILENAME] | resource.group/resource.name | resource.group [(-l label | --all)]) [–for=delete|–for condition=available] [options] | 实验特性：等待一种或多种资源的特定状况。 |
3、资源类型
以下输出可以通过 kubectl api-resources 获取
| 资源名 | 缩写名 | API 版本 | 按命名空间 | 资源类型 |
|---|---|---|---|---|
| bindings | v1 | true | Binding | |
| componentstatuses | cs | v1 | false | ComponentStatus |
| configmaps | cm | v1 | true | ConfigMap |
| endpoints | ep | v1 | true | Endpoints |
| events | ev | v1 | true | Event |
| limitranges | limits | v1 | true | LimitRange |
| namespaces | ns | v1 | false | Namespace |
| nodes | no | v1 | false | Node |
| persistentvolumeclaims | pvc | v1 | true | PersistentVolumeClaim |
| persistentvolumes | pv | v1 | false | PersistentVolume |
| pods | po | v1 | true | Pod |
| podtemplates | v1 | true | PodTemplate | |
| replicationcontrollers | rc | v1 | true | ReplicationController |
| resourcequotas | quota | v1 | true | ResourceQuota |
| secrets | v1 | true | Secret | |
| serviceaccounts | sa | v1 | true | ServiceAccount |
| services | svc | v1 | true | Service |
| mutatingwebhookconfigurations | admissionregistration.k8s.io/v1 | false | MutatingWebhookConfiguration | |
| validatingwebhookconfigurations | admissionregistration.k8s.io/v1 | false | ValidatingWebhookConfiguration | |
| customresourcedefinitions | crd,crds | apiextensions.k8s.io/v1 | false | CustomResourceDefinition |
| apiservices | apiregistration.k8s.io/v1 | false | APIService | |
| controllerrevisions | apps/v1 | true | ControllerRevision | |
| daemonsets | ds | apps/v1 | true | DaemonSet |
| deployments | deploy | apps/v1 | true | Deployment |
| replicasets | rs | apps/v1 | true | ReplicaSet |
| statefulsets | sts | apps/v1 | true | StatefulSet |
| tokenreviews | authentication.k8s.io/v1 | false | TokenReview | |
| localsubjectaccessreviews | authorization.k8s.io/v1 | true | LocalSubjectAccessReview | |
| selfsubjectaccessreviews | authorization.k8s.io/v1 | false | SelfSubjectAccessReview | |
| selfsubjectrulesreviews | authorization.k8s.io/v1 | false | SelfSubjectRulesReview | |
| subjectaccessreviews | authorization.k8s.io/v1 | false | SubjectAccessReview | |
| horizontalpodautoscalers | hpa | autoscaling/v2 | true | HorizontalPodAutoscaler |
| cronjobs | cj | batch/v1 | true | CronJob |
| jobs | batch/v1 | true | Job | |
| certificatesigningrequests | csr | certificates.k8s.io/v1 | false | CertificateSigningRequest |
| leases | coordination.k8s.io/v1 | true | Lease | |
| endpointslices | discovery.k8s.io/v1 | true | EndpointSlice | |
| events | ev | events.k8s.io/v1 | true | Event |
| flowschemas | flowcontrol.apiserver.k8s.io/v1beta2 | false | FlowSchema | |
| prioritylevelconfigurations | flowcontrol.apiserver.k8s.io/v1beta2 | false | PriorityLevelConfiguration | |
| ingressclasses | networking.k8s.io/v1 | false | IngressClass | |
| ingresses | ing | networking.k8s.io/v1 | true | Ingress |
| networkpolicies | netpol | networking.k8s.io/v1 | true | NetworkPolicy |
| runtimeclasses | node.k8s.io/v1 | false | RuntimeClass | |
| poddisruptionbudgets | pdb | policy/v1 | true | PodDisruptionBudget |
| podsecuritypolicies | psp | policy/v1beta1 | false | PodSecurityPolicy |
| clusterrolebindings | rbac.authorization.k8s.io/v1 | false | ClusterRoleBinding | |
| clusterroles | rbac.authorization.k8s.io/v1 | false | ClusterRole | |
| rolebindings | rbac.authorization.k8s.io/v1 | true | RoleBinding | |
| roles | rbac.authorization.k8s.io/v1 | true | Role | |
| priorityclasses | pc | scheduling.k8s.io/v1 | false | PriorityClass |
| csidrivers | storage.k8s.io/v1 | false | CSIDriver | |
| csinodes | storage.k8s.io/v1 | false | CSINode | |
| csistoragecapacities | storage.k8s.io/v1 | true | CSIStorageCapacity | |
| storageclasses | sc | storage.k8s.io/v1 | false | StorageClass |
| volumeattachments | storage.k8s.io/v1 | false | VolumeAttachment |
4、输出格式
所有 kubectl 命令的默认输出格式都是人类可读的纯文本格式。要以特定格式在终端窗口输出详细信息， 可以将 -o 或 --output 参数添加到受支持的 kubectl 命令中。
语法：
kubectl [command] [TYPE] [NAME] -o <output_format>
| 输出格式 | 描述 |
|---|---|
| -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 对象。 |
5、示例：常用操作
使用以下示例集来帮助你熟悉运行常用 kubectl 操作：
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>
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 --include-uninitialized# 列出在节点 server01 上运行的所有 Pod
kubectl get pods --field-selector=spec.nodeName=server01
kubectl describe - 显示一个或多个资源的详细状态，默认情况下包括未初始化的资源。
# 显示名为 <pod-name> 的 Pod 的详细信息。
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 的摘要，为节点生成的事件等。
kubectl delete - 基于文件、标准输入或通过指定标签选择器、名称、资源选择器或资源来删除资源。
# 使用 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
kubectl exec - 对 Pod 中的容器执行命令。
# 从 Pod <pod-name> 中获取运行 'date' 的输出。默认情况下，输出来自第一个容器。
kubectl exec <pod-name> -- date# 运行输出 'date' 获取在 Pod <pod-name> 中容器 <container-name> 的输出。
kubectl exec <pod-name> -c <container-name> -- date# 获取一个交互 TTY 并在 Pod <pod-name> 中运行 /bin/bash。默认情况下，输出来自第一个容器。
kubectl exec -ti <pod-name> -- /bin/bash
kubectl logs - 打印 Pod 中容器的日志。
# 返回 Pod <pod-name> 的日志快照。
kubectl logs <pod-name># 从 Pod <pod-name> 开始流式传输日志。这类似于 'tail -f' Linux 命令。
kubectl logs -f <pod-name>
kubectl diff - 查看集群建议更新的差异。
# “pod.json”中包含的差异资源。
kubectl diff -f pod.json# 从标准输入读取的差异文件。
cat service.yaml | kubectl diff -f -
6、示例：创建和使用插件
使用以下示例来帮助你熟悉编写和使用 kubectl 插件：
# 用任何语言创建一个简单的插件，并为生成的可执行文件命名
# 以前缀 "kubectl-" 开始
cat ./kubectl-hello
#!/bin/sh# 这个插件打印单词 "hello world"
echo "hello world"
这个插件写好了，把它变成可执行的：
sudo chmod a+x ./kubectl-hello# 并将其移动到路径中的某个位置
sudo mv ./kubectl-hello /usr/local/bin
sudo chown root:root /usr/local/bin# 你现在已经创建并"安装了"一个 kubectl 插件。
# 你可以开始使用这个插件，从 kubectl 调用它，就像它是一个常规命令一样
kubectl hello
hello world
# 你可以"卸载"一个插件，只需从你的 $PATH 中删除它
sudo rm /usr/local/bin/kubectl-hello
为了查看可用的所有 kubectl 插件，你可以使用 kubectl plugin list 子命令：
kubectl plugin list
输出类似于：
The following kubectl-compatible plugins are available:/usr/local/bin/kubectl-hello
/usr/local/bin/kubectl-foo
/usr/local/bin/kubectl-bar
kubectl plugin list 指令也可以向你告警哪些插件被运行，或是被其它插件覆盖了，例如：
sudo chmod -x /usr/local/bin/kubectl-foo # 删除执行权限
kubectl plugin list
The following kubectl-compatible plugins are available:/usr/local/bin/kubectl-hello
/usr/local/bin/kubectl-foo- warning: /usr/local/bin/kubectl-foo identified as a plugin, but it is not executable
/usr/local/bin/kubectl-barerror: one plugin warning was found
你可以将插件视为在现有 kubectl 命令之上构建更复杂功能的一种方法：
cat ./kubectl-whoami
接下来的几个示例假设你已经将 kubectl-whoami 设置为以下内容：
#!/bin/bash#这个插件利用 `kubectl config` 命令基于当前所选上下文输出当前用户的信息
kubectl config view --template='{{ range .contexts }}{{ if eq .name "'$(kubectl config current-context)'" }}Current user: {{ printf "%s\n" .context.user }}{{ end }}{{ end }}'
运行以上命令将为你提供一个输出，其中包含 KUBECONFIG 文件中当前上下文的用户：
#!/bin/bash
# 使文件成为可执行的
sudo chmod +x ./kubectl-whoami# 然后移动到你的路径中
sudo mv ./kubectl-whoami /usr/local/binkubectl whoami
Current user: plugins-user
本节的内容就到这里，有问题的小伙伴评论区留言。
