用法概述

kubectl 命令行的语法如下：

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

command：子命令，用于操作 Kubernetes 集群资源对象的命令，例如 create、delete、describe、get、apply 等。
TYPE：资源对象类型，区分大小写，能以单数、复数形式或者简写形式表达。
NAME：资源对象的名称，区分大小写。如果不指定名称，则系统将返回属于 TYPE 的全部对象的列表，例如：$ kubectl get pods 将返回所有 Pod 的列表。
flags：kubectl 子命令的可选参数，例如使用 -s 指定 apiserver 的 URL 地址而不用默认值。

kubectl 可操作的资源对象如下表：
| 资源对象名称 | 缩写 |
|:--------:|:-------------:|
| componentstatuses | cs |
| daemonsets | ds |
| deployments | |
| events | ev |
| endpoints | ep |
| horizontalpodautoscalers | hpa |
| ingresses | ing |
| jobs | |
| limitranges | limits |
| nodes | no |
| namespaces | ns |
| pods | po |
| persistentvolumes | pv |
| persistentvolumeclaims | pvc |
| resourcequotas | quota |
| replicationcontrollers | rc |
| secrets | |
| serviceaccounts | |
| services | svc |

在同一个命令行中也可以同时对多个资源对象进行操作，以多个 TYPE 和 NAME 的组合表示，示例如下：

获取多个 Pod 信息：$ kubectl get pods pod01 pod02
获取多种对象的信息：$ kubectl get pod/pod01 rc/rc01
同时应用多个 yaml 文件，以多个 -f file 参数表示：
$ kubectl get pod -f pod01.yaml -f pod02.yaml
$ kubectl create -f pod01.yaml -f rc01.yaml -f service01.yaml

子命令详解

kubectl 的子命令非常丰富，涵盖了对 Kubernetes 集群的主要操作，包括资源对象的创建、删除、查看、修改、配置、运行等。详细的子命令如下：

annotate
$ kubectl annotate [ --overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [ --resource-version=version] [flags]
添加或更新资源对象的 annotation 信息
api-versions
$ kubectl api-versions [flags]
列出当前系统支持的 API 版本列表，格式为 "group/version"
apply
$ kubectl apply -f FILENAME [flag]
从配置文件或 stdin 中对资源对象进行配置更新
attach
$ kubectl attach POD -c CONTAINER [flags]
附加到一个正在运行的容器上
autoscale
$ kubectl autoscale (-f FLENAME | TYPE NAME | TYPE/NAME) [ --min=MINPODS] --max=MAXPODS [ --cpu-percent=CPY] [flags]
对 Deployment 、ReplicaSet 或 ReplicationController 进行水平自动扩容或缩容的设置
cluster-info
$ kubectl cluster-info [flags]
$ kubectl cluster-info [command]
显示集群信息
completion
$ kubectl completion SHELL [flags]
输出 shell 命令的执行结果码（ bash 或 zsh ）
config
$ kubectl config SUBCOMMAND [flags]
$ kubectl config [command]
修改 kubeconfig 文件
convert
$ kubectl convert -f FILENAME [flags]
转换配置文件为不同的 API 版本
cordon
$ kubectl cordon NODE [flags]
将 Node 标记为 unschedulable ，即 “隔离” 出集群调度的范围
create
$ kubectl create -f FILENAME [flags]
$ kubectl create [command]
从配置文件或 stdin 中创建资源对象
delete
$ kubectl delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)]) [flags]
根据配置文件、stdin、资源名称或 label selector 删除资源对象
describe
$ kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | /NAME | -l label]) [flags]
描述一个或多个资源对象的详细信息
drain
$ kubectl drain NODE [flags]
首先将 Node 设置为 unschedulable ，然后删除该 Node 上运行的所有 Pod ，但不会删除不由 apiserver 管理的 Pod

edit
$ kubectl edit (RESOURCE/NAME | -f FILENAME) [flags]

exec
$ kubectl exec POD [-c CONTAINER] --COMMAND [args...] [flags]
执行一个容器中的命令

explain
$ kubectl explain RESOURCE [flags]
对资源对象属性的详细说明

expose
$ kubectl expose (-f FILENAME | TYPE NAME) [ --port=port] [ --protocol=TCP|UDP] [ --target-port=number-or-name] [ --name=name] [ --extermal-ip=external-ip-of-service] [ --type=type] [flags]
显示一个或多个资源对象的概要信息

label
$ kubectl label [ --overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [ --resource-version=version [ flags]
设置或更新资源对象的 labels

logs
$ kubectl logs [-f] [-p] POD [-c CONTAINER] [flags]
屏幕打印一个容器的日志

namespace
$ kubectl namespace [namespace] [flags]
已被 $ kubectl config set-context 替代

patch
$ kubectl patch (-f FILENAME | TYPE NAME) -p PATCH [flags]
以 merge 形式对资源对象的部分字段的值进行修改

port-forward
$ kubectl port-forward POD [LOBAL_POCAL_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]
将本机的某个端口号映射到 apiserver

replace
$ kubectl replace -f FILENAME [flags]
从配置文件或 stdin 替换资源对象

roling-update
$ kubectl rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC) [flags]
对 RC 进行滚动升级

rollout
$ kubectl rollout SUBCOMMAND [flags]
对 Deployment 进行管理，可用操作包括：history、pause、resume、undo、status

run
$ kubectl run NAME --image=image [ --env="key=value"] [ --port=port] [ --replicas=replicas] [ --dry-run=bool] [ --overrides=inline-json] [ --command] -- [COMMAND] [args...] [flags]
基于一个镜在 Kubernetes 集群上启动一个 Deployment

scale
$ kubectl scale [ --resource-version=version] [ --current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME) [flags]
扩容或缩容一个 Deployment、ReplicaSet、RC或Job中的Pod的数量

set
$ kubectl set SUBCOMMAND [flags]
$ kubectl set [command]
设置资源对象的某个e特定信息，目前仅支持修改容器的镜像

taint
$ kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TANT_EFFECT_N [flags]
设置 Node 的 taint 信息，用于将特定的 Pod 调度到特定的 Node 的操作，为 Alpha 版本对功能

uncordon
$ kubectl uncordon NODE [flags]
将 Node 设置为 schedulable

version
$ kubectl version [flags]
打印信息的版本信息

参数列表

参数名称和取值示例	说明
--alsologtostder[=false]	设置为 true 表示将日志输出到文件的同时输出到 stderr
--as=""	设置本次操作的用户名
--certificate-authority=""	用于 CA 授权的 cert 文件路径
--client-certificate=""	用于 TLS 的客户端证书文件路径
--client-key=""	用于 TLS 的客户端 key 文件路径
--cluster=""	设置要使用的 kubeconfig 中的 cluster 名
--context=""	设置要使用的 kubeconfig 中的 context 名
--insecure-skip-tls-verify[=flase]	设置为 true 表示跳过 TLS 安全验证模式，将使得 HTTPS 连接不安全
--kubeconfig=""	kubeconfig 配置文件路径，在配置文件中包括 Master 地址信息及必要的认证信息
--log-backtrace-at=:0	纪录日志每到 "file:行号" 时，打印一次 stack trace
--log-dir=""	日志文件路径
--log-flush-frequency=5s	设置 flush 日志文件的时间间隔
--logtostderr[=true]	设置为 true 表示将日志输出到 stderr ，不输出到日志文件
--match-server-version[=false]	设置为 true 表示客户端版本号需要与服务端一致
-n, --namespace=""	设置本次操作所在的 namespace
--password=""	设置 apiserver 的 basic authentication 的密码
-s, --server=""	设置 apiserver 的 URL 地址，默认为 localhost:8080
--stderrthrechold=2	在该 threshold 级别之上的日志将输出到 stderr
--token=""	设置访问 apiserver 的安全 token
--user=""	指定 kubeconfig 用户名
--username=""	设置 apiserver 的 basic authentication 的用户名
-v=0	glog 日志级别
--vmodule=""	glog 模块的详细日志级别

输出格式

kubectl 命令可以用多种格式对结果进行显示，输出的格式通过 -o 参数指定：

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

【Kubernetes】kubectl命令详解

用法概述

子命令详解

参数列表

输出格式

操作示例