目录

• 用法概述
• 子命令详解
• 参数列表
• 输出格式
• 操作示例

原文: http://106.13.73.98/__/183/

@

用法概述

kubectl 命令行的语法如下：

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

1. command：子命令，用于操作 Kubernetes 集群资源对象的命令，例如 create、delete、describe、get、apply 等。
2. TYPE：资源对象类型，区分大小写，能以单数、复数形式或者简写形式表达。
3. NAME：资源对象的名称，区分大小写。如果不指定名称，则系统将返回属于 TYPE 的全部对象的列表，例如：$ kubectl get pods 将返回所有 Pod 的列表。
4. 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]
  显示一个或多个资源对象的概要信息
• get
  $ kubectl get [(-o|--output=)json|yaml|wide|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE [name | -l label] | TYPE/NAME ...) [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>

根据不同子命令的输出结果，可选的输出格式如下表：
| 输出格式 | 说明 |
|:-:|:-:|
| -o=custom-columns= | 根据自定义列名进行输出，以逗号分隔 |
| -o=custom-columns-file= | 从文件中获取自定义列名进行输出 |
| -o=json | 以 JSON 格式显示结果 |
| -o=jsonpath= | 输出 jsonpath 表达式定义的字段信息 |
| -o=jsonpath-file= | 输出 jsonpath 表达式定义的字段信息，来源于文件 |
| -o=name | 仅输出资源对象的名称 |
| -o=wide | 输出额外信息。对于 Pod ，将输出 Pod 所在的 Node 名 |
| -o=yaml | 以 yaml 格式显示结果 |

常用的输出格式如下

1.显示 Pod 的更多信息：

$ kubectl get pod <pod-name> -o wide

2.以 yaml 格式显示 Pod 的详细信息：

$ kubectl get pod <pod-name> -o wide

3.以自定义列名显示 Pod 信息：

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

4.基于文件的自定义列名输出：

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


template.txt文件的内容为：
NAME                RSRC
metadata.name       metadata.resourceVersion

输出结果为：
NAME            RSRC
pod-name        52305

5.还可以将输出结果按某个字段排序，通过 --sort-by 参数以 jsonpath 表达式进行指定，$ kubectl [command] [TYPE] [NAME] --sort-by= ，例如按照名字进行排序：

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

操作示例

1. 创建资源对象

根据 yaml 配置文件一次性创建 service 和 rc ：

$ kubectl create -f my-service.yaml -f my-rc.yaml

根据 <directory> 目录下所有 .yaml 、.yml 、 .json 文件的定义进行创建操作：

$ kubectl create -f <directory

2. 查看资源对象

查看所有 Pod 列表：

$ kubectl get pods

查看 rc 和 service 列表：

$ kubectl get rc,service
# 注意：逗号后不可跟空格

查看多个 Pod 列表：

$ kubectl get pods pod01 pod02

查看多种对象信息：

$ kubectl get pod/pod01 rc/rc01

3. 描述资源对象

显示 Node 的详细信息：

$ kubectl describe nodes <node-name>

显示 Pod 的详细信息：

$ kubectl describe pods/<pod-name>

显示由 RC 管理的 Pod 的信息：

$ kubectl describe pods <rc-name>

4. 删除资源对象

基于 pod.yaml 定义的名称删除 Pod ：

$ kubectl delete -f pod.yaml

删除所有包含某个 label 的 Pod 和 service ：

$ kubectl delete pods,services -l name=<label-name>

删除所有 Pod ：

$ kubectl delete pods -all

5. 执行容器的命令

执行 Pod 的 date 命令，默认使用 Pod 种的第 1 个容器执行：

$ kubectl exec <pod-name> date

指定 Pod 中某个容器执行 date 命令：

$ kubectl exec <pod-name> -c <container-name> date

通过 bash 获得 Pod 中某个容器的 TTY ，相当于登陆容器：

$ kubectl exec -ti <pod-name> -c <container-name> /bin/bash

6. 查看容器的日志

查看容器输出到 stdout 的日志：

$ kubectl logs <pod-name>

跟踪查看容器的日志，相当于 $ tail -f 命令的结果：

$ kubectl logs -f <pod-name> -c <container-name>

7. 项目摘

获取 CPU 或 Memory 最大可使用量：

kubectl get deployment <deploy-name> -n <namespace> -o go-template --template='{{range .spec.template.spec.containers}} {{printf .name}} {{printf .resources.limits.[cpy|memory]}} {{end}}'

获取 CPU 或 Memory 最小可使用量：

kubectl get deployment <deploy-name> -n <namespace> -o go-template --template='{{range .spec.template.spec.containers}} {{printf .resources.requests.[cpy|memory]}} {{end}}'

获取预期的副本数量：

kubectl get deployment <deploy-name> -n <namespace> -o go-template --template='{{.spec.replicas}}'

获取当前副本副本数量和预期的副本数量：

kubectl get deployments <deploy-name> -n <namespace> -o  go-template --template='{{.status.readyReplicas}} {{.status.replicas}}'

获取某个 Deploy 的副本前缀：

kubectl describe deploy <deploy-name> -n <namespace> | grep 'NewReplicaSet:' | awk '{print $2}'

获取以某个前缀开头的所有 Pod ：

kubectl get pod -n sock-shop -o wide | grep <pod-prefix>

设置某个 Deploy 的副本数量为 4 ：

kubectl patch deployment <deploy-name> -n sock-shop -p '{"spec": {"replicas": 4}}'

调整某个 Deploy 的 CPU ：

updateCmdCPU = """kubectl patch deployment %s -n %s -p '{"spec":{"template":{"spec":{"containers":[{"name":"%s","resources":{"limits": {"%s":"%s"}}}]}}}}'""" % (self.name, self.namespace, conName, "cpu", str(cpu)+"m")

调整某个 Deploy 的 Memory ：

updateCmdMem = """kubectl patch deployment %s -n %s -p '{"spec":{"template":{"spec":{"containers":[{"name":"%s","resources":{"limits": {"%s":"%s"}}, "env": [{"name":"JAVA_OPTS", "value": "-Xms%dm -Xmx%dm -XX:PermSize=%dm -XX:MaxPermSize=%dm -XX:+UseG1GC -Djava.security.egd=file:/dev/urandom"}]}]}}}}'""" % (self.name, self.namespace, conName, "memory", str(mem)+"Mi", mem, mem2, memhalf, mem)

原文: http://106.13.73.98/__/183/