kubectl概述

概述

kubectl 是一个命令行接口,用于对Kubernetes 集群进行命令操作管理。
kubectl$HOME/.kube 目录中寻找一个名为 config 的文件。可以通过设置环境变量 KUBECONFIG 或设置 --kubeconfig 参数指定其它 kubeconfig 文件。


安装

在 Linux 上安装 kubectl

二进制

  1. 使用以下命令下载最新版本

    1
    curl -LO "https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl"

    需要下载特定版本请替换 $(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt) 即可。

  2. 使kubectl 二进制可执行文件

    1
    chmod +x ./kubectl
  3. 将二进制文件移到PATH 中

    1
    sudo mv ./kubectl /usr/local/bin/kubectl
  4. 测试安装是否为最新版本

    1
    kubectl version --client

软件包

1
2
3
4
5
sudo apt-get update && sudo apt-get install -y apt-transport-https gnupg2 curl
curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -
echo "deb https://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee -a /etc/apt/sources.list.d/kubernetes.list
sudo apt-get update
sudo apt-get install -y kubectl

在 MacOS 上安装 kubectl

二进制

在MacOS 上安装kubectl 与在Linux 上一致。

Homebrew

  1. 运行安装命令

    1
    brew install kubectl 
  2. 测试安装是否为最新版本

    1
    kubectl version --client

在 Windows 上安装 kubectl

exe 可执行文件

  1. 下载版本

    1
    curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.19.0/bin/windows/amd64/kubectl.exe
  2. 将文件目录添加到PATH 中

  3. 测试安装是否为最新版本

    1
    kubectl version --client

命令

从命令行指定的参数会覆盖默认值和任何相应的环境变量。

如果需要帮助,只需从终端窗口运行 kubectl help 即可。

语法

kubectl 使用以下语法 kubectl 从终端窗口运行命令:

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

这其中command、TYPE、NAME、flags 分别是:

  • command: 指定要对一个或多个资源执行的操作,例如get、create、run、delete。
  • TYPE: 指定资源类型。资源类型区分大小写,可以指定单数、复数或缩写形式。例如,以下命令的输出结果完全一致:
    1
    2
    3
    kubectl get pod pod1
    kubectl get pods pod1
    kubectl get po pod1
  • NAME: 指定资源的名称。名称区分大小写。如果默认省略,这显示所有资源的详细信息。
    在对多个资源执行操作时,可以按照类型和名称指定每个资源,或指定一个或多个文件。
    1
    2
    TYPE1 name1 name2
    -f file1 -f file2
  • flags: 指定可选的参数。例如,可以使用 -s-server 参数指定Kubernetes API 服务器的地址和端口。

操作

annotate

添加或更新一个或多个资源的注解。

1
kubectl annotate (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]

api-versions

列出可用的 API 版本。

1
kubectl api-versions [flags]

apply

从文件或 stdin 对资源应用配置更改。

1
kubectl apply -f FILENAME [flags]

attach

附加到正在运行的容器,查看输出流与容器(stdin)交互。

1
kubectl attach POD -c CONTAINER [-i] [-t] [flags]

autoscale

自动伸缩由副本控制器管理的一组pod。

1
kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-precent=CPU] [flags]

cluster-info

显示有关集群中主服务器和服务的端口信息。

1
kubectl cluster-info [flags]

config

修改 kubeconfig 文件。

1
kubectl config SUBCOMMAND [flags]

create

从文件或stdin 创建一个或多个资源。

1
kubectl create -f FILENAME [flags]

delete

从文件、标准输入或指定标签选择器、名称、资源选择器或资源中删除资源。

1
kubectl delete (-f FILENAME | TYPE [NAME_PREFIX | /NAME | -l label | --all]) [flags]

describe

显示一个或多个资源的详细状态。

1
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | /NAME | -l label]) [flags] 

drain

驱逐节点上的Pod ,并转移到其他的节点上。

1
kubectl drain [NodeName] [--force] [--ignore-daemonsets] [--delete-local-data]

–force: 强制转义一些Pod,例如kube-proxy。
–ignore-daemonsets: 无视DaemonSet 管理下的Pod。
–delete-local-data: 如果有mount local volume 的Pod ,会强制杀掉Pod 并把数据清除。

diff

将live 配置和文件或标准输入做对比(BETA)。

1
kubectl diff -f FILENAME [flags]

edit

使用默认编辑器编辑和更新服务器上一个或多个资源的定义。

1
kubectl edit (-f FILENAME | TYPE NAME | TYPE/NAME) [flags]

exec

对pod 中的容器执行命令。

1
kubectl exec POD [-c CONTAINER] [-i] [-t] [flags] [-- COMMAND [args...]]

explain

获取多种资源的文档。

1
kubectl explain [--recursive=false] [flags]

expose

将副本控制器、服务或pod 作为新的Kubernetes 服务暴露。

1
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

列出一个或多个资源。

1
kubectl get (-f FILENAME | TYPE [NAME | /NAME | -l label]) [--watch] [--sort-by=FIELD] [[-o | --output]=OUTPUT_FORMAT] [flags] 

label

添加或更新一个或多个资源的标签。

1
kubectl label (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]

logs

在pod 中打印容器的日志。

1
kubectl logs POD [-c CONTAINER] [--follow] [flags]

patch

使用策略合并patch 程序更新资源的一个或多个字段。

1
kubectl patch (-f FILENAME | TYPE NAME | TYPE/NAME) --patch PATCH [flags]

port-forward

将一个或多个本地端口转发到一个pod。

1
kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N] [flags] 

proxy

运行Kubernetes API 服务器的代理。

1
kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix] [flags]

replace

从文件或标准输入中替换资源。

1
kubectl replace -f FILENAME

rolling-update

通过逐步替换指定的副本控制器及其pod 来执行滚动更新。

1
kubectl rolling-update OLD_CONTAINER_NAME ([NEW_CONTAINER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC) [flags]

run

在集群上运行指定镜像。

1
kubectl run NAME --image=image [--env="key=value"] [--port=port] [--dry-run=server | client | none] [--overrides=inline-json] [flags]

scale

更新指定副本控制器的大小。

1
kubectl scale (-f FILENAME | TYPE NAME | TYPE/NAME) --replicas=COUNT [--resource-version=version] [--current-replicas=count] [flags]

stop

不推荐使用,可以参考 kubectl delete

1
kubectl stop

version

显示运行在客户端和服务器上的Kubernetes 的版本。

1
kubectl version [--client] [flags]

输出

格式化输出

所有 kubectl 命令的默认输出格式都是人类可读的纯文本格式。如果希望以特定的格式向终端输出详细信息,可以使用 -o--output 参数来格式化输出。

语法

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

输出格式

  1. custom-columns=
    使用逗号风格的自定义列列表打印表。

    1
    -o custom-columns=<spec>
  2. custom-columns-file
    使用 <filename> 文件中的自定义列模板打印表。

    1
    -o custom-columns-file=<filename>
  3. json
    输出JSON 格式的API 对象。

    1
    -o json
  4. jsonpath
    打印jsonpath 表达式定义的字段。

    1
    -o jsonpath=<template>
  5. jsonpath-file
    打印 <filename> 文件中的jsonpath 表达式定义的字段。

    1
    -o jsonpath-file=<filename>
  6. name
    仅打印资源名称而不打印任何其他内容。

    1
    -o name
  7. wide
    以纯文本格式输出,包含任何附加信息。对于pod 包含节点名。

    1
    -o wide
  8. yaml
    输出YAML 格式的API 对象。

    1
    -o yaml

示例

在这个示例中,将会以文本的形式打印出myweb-2jkue5 这个pod 的所有详细。

1
kubectl get pod myweb-2jkue5 -o wide

自定义列

要定义自定义列仅将所需的详细信息输出到表中,可以使用该 custom-columns 或者 custom-columns-file 参数。

  1. custom-columns :

    1
    kubectl get pods <pod-name> -o custom-columns=NAME:.metadata.name,RSRC:.metadata.resourceVersion
  2. custom-columns-file :

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

    其中 template.txt 文件内容:

    1
    2
    NAME          RSRC
    metadata.name metadata.resourceVersion

Server-side 列

kubectl 支持从服务器接收关于对象的特定列的信息。
这就意味着对于任何给定的资源,服务器将返回与该资源相关的列和行,以便客户端打印。通过让服务器封装打印的细节,这允许在针对同一集群使用的客户端之间提供一致的可读性输出。

示例:

1
kubectl get pods <pod-name> --server-print=false

输出:

1
2
NAME       READY     STATUS              RESTARTS   AGE
pod-name 1/1 Running 0 1m

排序列表对象

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

语法

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

示例

按照名称打印排序后的pod 列表:

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

选项

语法

1
kubectl [flags]

选项

选项


备忘录

Kubectl 上下文和配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
kubectl config view # 显示合并的 kubeconfig 配置。

# 同时使用多个 kubeconfig 文件并查看合并的配置
KUBECONFIG=~/.kube/config:~/.kube/kubconfig2 kubectl config view

# 获取 e2e 用户的密码
kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'

kubectl config view -o jsonpath='{.users[].name}' # 显示第一个用户
kubectl config view -o jsonpath='{.users[*].name}' # 获取用户列表
kubectl config get-contexts # 显示上下文列表
kubectl config current-context # 展示当前所处的上下文
kubectl config use-context my-cluster-name # 设置默认的上下文为 my-cluster-name

# 添加新的用户配置到 kubeconf 中,使用 basic auth 进行身份认证
kubectl config set-credentials kubeuser/foo.kubernetes.com --username=kubeuser --password=kubepassword

# 在指定上下文中持久性地保存名字空间,供所有后续 kubectl 命令使用
kubectl config set-context --current --namespace=ggckad-s2

# 使用特定的用户名和名字空间设置上下文
kubectl config set-context gce --user=cluster-admin --namespace=foo && kubectl config use-context gce

kubectl config unset users.foo # 删除用户 foo

创建对象

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
kubectl apply -f ./my-manifest.yaml           # 创建资源
kubectl apply -f ./my1.yaml -f ./my2.yaml # 使用多个文件创建
kubectl apply -f ./dir # 基于目录下的所有清单文件创建资源
kubectl apply -f https://git.io/vPieo # 从 URL 中创建资源
kubectl create deployment nginx --image=nginx # 启动单实例 nginx

# 创建一个打印 “Hello World” 的 Job
kubectl create job hello --image=busybox -- echo "Hello World"

# 创建一个打印 “Hello World” 间隔1分钟的 CronJob
kubectl create cronjob hello --image=busybox --schedule="*/1 * * * *" -- echo "Hello World"

kubectl explain pods # 获取 pod 清单的文档说明

# 从标准输入创建多个 YAML 对象
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Pod
metadata:
name: busybox-sleep
spec:
containers:
- name: busybox
image: busybox
args:
- sleep
- "1000000"
---
apiVersion: v1
kind: Pod
metadata:
name: busybox-sleep-less
spec:
containers:
- name: busybox
image: busybox
args:
- sleep
- "1000"
EOF

# 创建有多个 key 的 Secret
cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
name: mysecret
type: Opaque
data:
password: $(echo -n "s33msi4" | base64 -w0)
username: $(echo -n "jane" | base64 -w0)
EOF

查看和查找资源

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# get 命令的基本输出
kubectl get services # 列出当前命名空间下的所有 services
kubectl get pods --all-namespaces # 列出所有命名空间下的全部的 Pods
kubectl get pods -o wide # 列出当前命名空间下的全部 Pods,并显示更详细的信息
kubectl get deployment my-dep # 列出某个特定的 Deployment
kubectl get pods # 列出当前命名空间下的全部 Pods
kubectl get pod my-pod -o yaml # 获取一个 pod 的 YAML

# describe 命令的详细输出
kubectl describe nodes my-node
kubectl describe pods my-pod

# 列出当前名字空间下所有 Services,按名称排序
kubectl get services --sort-by=.metadata.name

# 列出 Pods,按重启次数排序
kubectl get pods --sort-by='.status.containerStatuses[0].restartCount'

# 列举所有 PV 持久卷,按容量排序
kubectl get pv --sort-by=.spec.capacity.storage

# 获取包含 app=cassandra 标签的所有 Pods 的 version 标签
kubectl get pods --selector=app=cassandra -o jsonpath='{.items[*].metadata.labels.version}'

# 检索带有 “.” 键值,例: 'ca.crt'
kubectl get configmap myconfig -o jsonpath='{.data.ca\.crt}'

# 获取所有工作节点(使用选择器以排除标签名称为 'node-role.kubernetes.io/master' 的结果)
kubectl get node --selector='!node-role.kubernetes.io/master'

# 获取当前命名空间中正在运行的 Pods
kubectl get pods --field-selector=status.phase=Running

# 获取全部节点的 ExternalIP 地址
kubectl get nodes -o jsonpath='{.items[*].status.addresses[?(@.type=="ExternalIP")].address}'

# 列出属于某个特定 RC 的 Pods 的名称
# 在转换对于 jsonpath 过于复杂的场合,"jq" 命令很有用;可以在 https://stedolan.github.io/jq/ 找到它。
sel=${$(kubectl get rc my-rc --output=json | jq -j '.spec.selector | to_entries | .[] | "\(.key)=\(.value),"')%?}
echo $(kubectl get pods --selector=$sel --output=jsonpath={.items..metadata.name})

# 显示所有 Pods 的标签(或任何其他支持标签的 Kubernetes 对象)
kubectl get pods --show-labels

# 检查哪些节点处于就绪状态
JSONPATH='{range .items[*]}{@.metadata.name}:{range @.status.conditions[*]}{@.type}={@.status};{end}{end}' \
&& kubectl get nodes -o jsonpath="$JSONPATH" | grep "Ready=True"

# 列出被一个 Pod 使用的全部 Secret
kubectl get pods -o json | jq '.items[].spec.containers[].env[]?.valueFrom.secretKeyRef.name' | grep -v null | sort | uniq

# 列举所有 Pods 中初始化容器的容器 ID(containerID)
# Helpful when cleaning up stopped containers, while avoiding removal of initContainers.
kubectl get pods --all-namespaces -o jsonpath='{range .items[*].status.initContainerStatuses[*]}{.containerID}{"\n"}{end}' | cut -d/ -f3

# 列出事件(Events),按时间戳排序
kubectl get events --sort-by=.metadata.creationTimestamp

# 比较当前的集群状态和假定某清单被应用之后的集群状态
kubectl diff -f ./my-manifest.yaml

# 生成一个句点分隔的树,其中包含为节点返回的所有键
# 在复杂的嵌套JSON结构中定位键时非常有用
kubectl get nodes -o json | jq -c 'path(..)|[.[]|tostring]|join(".")'

# 生成一个句点分隔的树,其中包含为pod等返回的所有键
kubectl get pods -o json | jq -c 'path(..)|[.[]|tostring]|join(".")'

更新资源

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
kubectl set image deployment/frontend www=image:v2               # 滚动更新 "frontend" Deployment 的 "www" 容器镜像
kubectl rollout history deployment/frontend # 检查 Deployment 的历史记录,包括版本
kubectl rollout undo deployment/frontend # 回滚到上次部署版本
kubectl rollout undo deployment/frontend --to-revision=2 # 回滚到特定部署版本
kubectl rollout status -w deployment/frontend # 监视 "frontend" Deployment 的滚动升级状态直到完成
kubectl rollout restart deployment/frontend # 轮替重启 "frontend" Deployment

cat pod.json | kubectl replace -f - # 通过传入到标准输入的 JSON 来替换 Pod

# 强制替换,删除后重建资源。会导致服务不可用。
kubectl replace --force -f ./pod.json

# 为多副本的 nginx 创建服务,使用 80 端口提供服务,连接到容器的 8000 端口。
kubectl expose rc nginx --port=80 --target-port=8000

# 将某单容器 Pod 的镜像版本(标签)更新到 v4
kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -

kubectl label pods my-pod new-label=awesome # 添加标签
kubectl annotate pods my-pod icon-url=http://goo.gl/XXBTWq # 添加注解
kubectl autoscale deployment foo --min=2 --max=10 # 对 "foo" Deployment 自动伸缩容

部分更新资源

1
2
3
4
5
6
7
8
9
10
11
12
13
14
# 部分更新某节点
kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'

# 更新容器的镜像;spec.containers[*].name 是必须的。因为它是一个合并性质的主键。
kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'

# 使用带位置数组的 JSON patch 更新容器的镜像
kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'

# 使用带位置数组的 JSON patch 禁用某 Deployment 的 livenessProbe
kubectl patch deployment valid-deployment --type json -p='[{"op": "remove", "path": "/spec/template/spec/containers/0/livenessProbe"}]'

# 在带位置数组中添加元素
kubectl patch sa default --type='json' -p='[{"op": "add", "path": "/secrets/1", "value": {"name": "whatever" } }]'

编辑资源

1
2
kubectl edit svc/docker-registry                      # 编辑名为 docker-registry 的服务
KUBE_EDITOR="nano" kubectl edit svc/docker-registry # 使用其他编辑器

对资源进行伸缩

1
2
3
4
kubectl scale --replicas=3 rs/foo                                 # 将名为 'foo' 的副本集伸缩到 3 副本
kubectl scale --replicas=3 -f foo.yaml # 将在 "foo.yaml" 中的特定资源伸缩到 3 个副本
kubectl scale --current-replicas=2 --replicas=3 deployment/mysql # 如果名为 mysql 的 Deployment 的副本当前是 2,那么将它伸缩到 3
kubectl scale --replicas=5 rc/foo rc/bar rc/baz # 伸缩多个副本控制器

删除资源

1
2
3
4
5
6
kubectl delete -f ./pod.json                                              # 删除在 pod.json 中指定的类型和名称的 Pod
kubectl delete pod,service baz foo # 删除名称为 "baz" 和 "foo" 的 Pod 和服务
kubectl delete pods,services -l name=myLabel # 删除包含 name=myLabel 标签的 pods 和服务
kubectl -n my-ns delete pod,svc --all # 删除在 my-ns 名字空间中全部的 Pods 和服务
# 删除所有与 pattern1 或 pattern2 awk 模式匹配的 Pods
kubectl get pods -n mynamespace --no-headers=true | awk '/pattern1|pattern2/{print $1}' | xargs kubectl delete -n mynamespace pod

与运行中的 Pods 进行交互

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
kubectl logs my-pod                                 # 获取 pod 日志(标准输出)
kubectl logs -l name=myLabel # 获取含 name=myLabel 标签的 Pods 的日志(标准输出)
kubectl logs my-pod --previous # 获取上个容器实例的 pod 日志(标准输出)
kubectl logs my-pod -c my-container # 获取 Pod 容器的日志(标准输出, 多容器场景)
kubectl logs -l name=myLabel -c my-container # 获取含 name=myLabel 标签的 Pod 容器日志(标准输出, 多容器场景)
kubectl logs my-pod -c my-container --previous # 获取 Pod 中某容器的上个实例的日志(标准输出, 多容器场景)
kubectl logs -f my-pod # 流式输出 Pod 的日志(标准输出)
kubectl logs -f my-pod -c my-container # 流式输出 Pod 容器的日志(标准输出, 多容器场景)
kubectl logs -f -l name=myLabel --all-containers # 流式输出含 name=myLabel 标签的 Pod 的所有日志(标准输出)
kubectl run -i --tty busybox --image=busybox -- sh # 以交互式 Shell 运行 Pod
kubectl run nginx --image=nginx -n mynamespace # 在指定名字空间中运行 nginx Pod

# 运行 nginx Pod 并将其规约写入到名为 pod.yaml 的文件
kubectl run nginx --image=nginx --dry-run=client -o yaml > pod.yaml

kubectl attach my-pod -i # 挂接到一个运行的容器中
kubectl port-forward my-pod 5000:6000 # 在本地计算机上侦听端口 5000 并转发到 my-pod 上的端口 6000
kubectl exec my-pod -- ls / # 在已有的 Pod 中运行命令(单容器场景)
kubectl exec my-pod -c my-container -- ls / # 在已有的 Pod 中运行命令(多容器场景)
kubectl top pod POD_NAME --containers # 显示给定 Pod 和其中容器的监控数据

与节点和集群进行交互

1
2
3
4
5
6
7
8
9
10
kubectl cordon my-node                                                # 标记 my-node 节点为不可调度
kubectl drain my-node # 对 my-node 节点进行清空操作,为节点维护做准备
kubectl uncordon my-node # 标记 my-node 节点为可以调度
kubectl top node my-node # 显示给定节点的度量值
kubectl cluster-info # 显示主控节点和服务的地址
kubectl cluster-info dump # 将当前集群状态转储到标准输出
kubectl cluster-info dump --output-directory=/path/to/cluster-state # 将当前集群状态输出到 /path/to/cluster-state

# 如果已存在具有指定键和效果的污点,则替换其值为指定值
kubectl taint nodes foo dedicated=special-user:NoSchedule


个人备注

此博客内容均为作者学习所做笔记,侵删!
若转作其他用途,请注明来源!