kubectl命令行工具
1.kubectl 简介
kubectl 是操作 k8s 集群的命令行工具,安装在 k8s 的 master 节点,kubectl 在 $HOME/.kube 目录中查找一个名为 config 的文件, 你可以通过设置 Kubeconfig 环境变量或设置特定的 kubeconfig,kubectl 也可以使用特定的 kubeconfig 文件操作 k8s 集群。
kubectl 通过与 apiserver 交互可以实现对 k8s 集群中各种资源的增删改查。接下来将会介绍 kubectl 语法,命令行的操作,并介绍常见的示例。命令的详细信息、参数和子命令可在 kubectl 参考文档中查看。
2.kubectl 语法
kubectl [command] [TYPE] [NAME] [flags]
- command:指定要对一个或多个资源执行的操作,例如 create、get、describe、delete等。
- type:指定资源类型,可以是 pod、deployment、statefulset、service 等。资源类型不区分大小写,可以指定单数、复数或缩写形式。例如,以下命令输出相同的结果:
- kubectl get pod pod1
- kubectl get pods pod1
- kubectl get po pod1
- NAME:指定资源的名称。名称区分大小写。如果省略名称,则显示所有资源的详细信息:
- kubectl get pods。
- flags: 指定可选的参数。例如,可以使用-o 查看 pod 在哪个机器上
注意事项说明:
从命令行指定的参数会覆盖默认值和任何相应的环境变量。
在对多个资源执行操作时,可以按类型、名称、一个或者多个文件指定每个资源:
- 按类型和名称指定资源
TYPE1 name1 name2 name<#>。
例子:kubectl get pod example-pod1 example-pod2
- 分别指定多个资源类型:
TYPE1/name1 TYPE1/name2 TYPE2/name3 TYPE<#>/name<#>。
例:kubectl get pod/example-pod1 pod/example-pod2 deployment/example-rc1
3.kubectl 操作命令演示
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'
api-versions: 列出可用的 api 版本
kubectl api-versions [flags]
各种 apiVersion 的含义:
- alpha: 内测版,包含很多错误,使用可能会有 bug,如果这个版本废弃,不会通知客户
- beta: 公测版,该版本经过大量的测试已经可以被正常使用,可能某些细节会有变化,但是不会废弃这个版本
- stable: 稳定版:此版本很稳定,可以放心使用,之后的版本会一直包含这个稳定版,命名方式如 v1
admissionregistration.k8s.io/v1: 准入控制相关的 api
v1: Kubernetes API 的稳定版本,包含很多核心对象:pod、service 等
apps/v1: 包含一些通用的应用层的 api 组合,如:Deployments, Statefulset, and Daemonset 等
apply: 从文件对资源的应用配置进行更改。声明式的更新配置文件。
kubectl apply -f FILENAME [flags]
autoscale: 自动扩缩容由副本控制器管理的一组 pod。
kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]
cluster-info: 显示有关集群中的主服务器和服务的端点信息。
kubectl cluster-info [flags]
config: 修改 kubeconfig 文件
kubectl config SUBCOMMAND [flags]
create: 从文件或标准输入创建一个或多个资源。一般不用,用 apply 替代这个
kubectl create -f FILENAME [flags]
delete:从文件、标准输入或指定标签选择器、名称、资源选择器或资源中删除资源。
kubectl delete (-f FILENAME | TYPE [NAME | /NAME | -l label | --all]) [flags]
describe: 显示一个或多个资源的详细状态。
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | /NAME | -l label]) [flags]
edit:使用默认编辑器编辑和更新服务器上一个或多个资源的定义。
kubectl edit (-f FILENAME | TYPE NAME | TYPE/NAME) [flags]
exec: 对 pod 中的容器执行命令。
kubectl exec POD-name [-c CONTAINER-name] [-i] [-t] [flags] [-- COMMAND [args...]]
kubectl exec calico-node-cblk2 -n kube-system -i -t -- /bin/sh
explain: 获取多种资源的文档。例如 pod, node, service 等,相当于帮助命令,可以告诉我们怎么创建资源
kubectl explain [--recursive=false] [flags]
expose: 将副本控制器、服务或 pod 作为新的 Kubernetes 服务进行暴露。
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]
get: 列出一个或多个资源。
kubectl get (-f FILENAME | TYPE [NAME | /NAME | -l label]) [--watch] [--sortby=FIELD] [[-o | --output]=OUTPUT_FORMAT] [flags]
label: 添加或更新一个或多个资源的标签。
kubectl label (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 … KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]
logs:在 pod 中打印容器的日志。
kubectl logs POD [-c CONTAINER] [--follow] [flags]
patch:更新资源的一个或多个字段
kubectl patch (-f FILENAME | TYPE NAME | TYPE/NAME) --patch PATCH [flags]
port-forward: 将一个或多个本地端口转发到 Pod。
kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N] [flags]
proxy: 运行 Kubernetes API 服务器的代理。
kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--apiprefix=prefix] [flags]
replace:从文件或标准输入中替换资源。
kubectl replace -f FILENAM
run: 在集群上运行指定的镜像
kubectl run NAME --image=image [--env=“key=value”] [--port=port] [--dryrun=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]
version: 显示运行在客户端和服务器上的 Kubernetes 版本
kubectl version [--client] [flags]
4.kubectl 输出选项
格式化输出
kubectl 命令的默认输出格式是人类可读的明文格式,若要以特定格式向终端窗口输出详细信息,可以将-o 或—out 参数添加到受支持的 kubectl 命令中
kubectl [command] [TYPE] [NAME] -o=<output_format>
示例:在此示例中,以下命令将单个 pod 的详细信息输出为 YAML 格式的对象:
kubectl get pod web-pod-13je7 -o yaml
自定义列
要定义自定义列并仅将所需的详细信息输出到表中,可以使用 custom-columns 选项。你可以选择内联定义自定义列或使用模板文件:-o=custom-columns=
示例:
1)内联:
kubectl get pods-o custom-columns=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
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
排序列表对象
要将对象排序后输出到终端窗口,可以将--sort-by 参数添加到支持的 kubectl 命令。通过使用--sort-by 参数指定任何数字或字符串字段来对对象进行排序。要指定字段,请使用 jsonpath 表达式。
kubectl [command] [TYPE] [NAME] --sort-by=<jsonpath_exp>
示例
要打印按名称排序的 pod 列表,请运行:
kubectl get pods -n kube-system --sort-by=.metadata.name
NAME READY STATUS RESTARTS AGE
calico-node-cblk2 1/1 Running 40 7d8h
calico-node-q84kx 1/1 Running 31 7d8h
coredns-66bff467f8-f2nrb 1/1 Running 3 5d21h
coredns-66bff467f8-x24ff 1/1 Running 4 5d21h
etcd-master1 1/1 Running 7 7d8h
kube-apiserver-master1 1/1 Running 22 7d8h
kube-controller-manager-master1 1/1 Running 81 7d8h
kube-proxy-4xlzz 1/1 Running 4 7d8h
kube-proxy-pxjlx 1/1 Running 5 7d8h
kube-scheduler-master1 1/1 Running 72 7d8h
metrics-server-8459f8db8c-lvx9x 2/2 Running 2 5d21h
traefik-ingress-controller-c8dm6 1/1 Running 4 7d8h
traefik-ingress-controller-nr4n6 1/1 Running 6 7d8h