diff --git a/content/zh/docs/concepts/overview/working-with-objects/common-labels.md b/content/zh/docs/concepts/overview/working-with-objects/common-labels.md new file mode 100644 index 0000000000..f1b3575c45 --- /dev/null +++ b/content/zh/docs/concepts/overview/working-with-objects/common-labels.md @@ -0,0 +1,259 @@ +--- +title: 推荐使用的标签 +content_template: templates/concept +--- + + +{{% capture overview %}} + +除了 kubectl 和 dashboard 之外，您可以其他工具来可视化和管理 Kubernetes 对象。 +一组通用的标签可以让多个工具之间互操作，用所有工具都能理解的通用方式描述对象。 + + +除了支持工具外，推荐的标签还以一种可以查询的方式描述了应用程序。 + +{{% /capture %}} + +{{% capture body %}} + +元数据围绕 _应用（application）_ 的概念进行组织。Kubernetes 不是 +平台即服务（PaaS），没有或强制执行正式的应用程序概念。 +相反，应用程序是非正式的，并使用元数据进行描述。应用程序包含的定义是松散的。 + +{{< note >}} + +这些是推荐的标签。它们使管理应用程序变得更容易但不是任何核心工具所必需的。 +{{< /note >}} + + +共享标签和注解都使用同一个前缀：`app.kubernetes.io`。没有前缀的标签是用户私有的。共享前缀可以确保共享标签不会干扰用户自定义的标签。 + + +## 标签 +为了充分利用这些标签，应该在每个资源对象上都使用它们。 + + +| 键 | 描述 | 示例 | 类型 | +| ----------------------------------- | --------------------- | -------- | ---- | +| `app.kubernetes.io/name` | 应用程序的名称 | `mysql` | 字符串 | +| `app.kubernetes.io/instance` | 用于唯一确定应用实例的名称 | `wordpress-abcxzy` | 字符串 | +| `app.kubernetes.io/version` | 应用程序的当前版本（例如，语义版本，修订版哈希等） | `5.7.21` | 字符串 | +| `app.kubernetes.io/component` | 架构中的组件 | `database` | 字符串 | +| `app.kubernetes.io/part-of` | 此级别的更高级别应用程序的名称 | `wordpress` | 字符串 | +| `app.kubernetes.io/managed-by` | 用于管理应用程序的工具 | `helm` | 字符串 | + +为说明这些标签的实际使用情况，请看下面的 StatefulSet 对象： + +```yaml +apiVersion: apps/v1 +kind: StatefulSet +metadata: + labels: + app.kubernetes.io/name: mysql + app.kubernetes.io/instance: wordpress-abcxzy + app.kubernetes.io/version: "5.7.21" + app.kubernetes.io/component: database + app.kubernetes.io/part-of: wordpress + app.kubernetes.io/managed-by: helm +``` + + +## 应用和应用实例 + +应用可以在 Kubernetes 集群中安装一次或多次。在某些情况下，可以安装在同一命名空间中。例如，可以不止一次地为不同的站点安装不同的 wordpress。 + +应用的名称和实例的名称是分别记录的。例如，某 WordPress 实例的 `app.kubernetes.io/name` 为 `wordpress`，而其实例名称表现为 `app.kubernetes.io/instance` 的属性值 `wordpress-abcxzy`。这使应用程序和应用程序的实例成为可能是可识别的。应用程序的每个实例都必须具有唯一的名称。 + + +## 示例 + + +为了说明使用这些标签的不同方式，以下示例具有不同的复杂性。 + + +### 一个简单的无状态服务 + + +考虑使用 `Deployment` 和 `Service` 对象部署的简单无状态服务的情况。以下两个代码段表示如何以最简单的形式使用标签。 + + +下面的 `Deployment` 用于监督运行应用本身的 pods。 +```yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + labels: + app.kubernetes.io/name: myservice + app.kubernetes.io/instance: myservice-abcxzy +... +``` + + +下面的 `Service` 用于暴露应用。 +```yaml +apiVersion: v1 +kind: Service +metadata: + labels: + app.kubernetes.io/name: myservice + app.kubernetes.io/instance: myservice-abcxzy +... +``` + + +### 带有一个数据库的 Web 应用程序 + + +考虑一个稍微复杂的应用：一个使用 Helm 安装的 Web 应用（WordPress），其中 +使用了数据库（MySQL）。以下代码片段说明用于部署此应用程序的对象的开始。 + +以下 `Deployment` 的开头用于 WordPress： + + +```yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + labels: + app.kubernetes.io/name: wordpress + app.kubernetes.io/instance: wordpress-abcxzy + app.kubernetes.io/version: "4.9.4" + app.kubernetes.io/managed-by: helm + app.kubernetes.io/component: server + app.kubernetes.io/part-of: wordpress +... +``` + + +这个 `Service` 用于暴露 WordPress： + +```yaml +apiVersion: v1 +kind: Service +metadata: + labels: + app.kubernetes.io/name: wordpress + app.kubernetes.io/instance: wordpress-abcxzy + app.kubernetes.io/version: "4.9.4" + app.kubernetes.io/managed-by: helm + app.kubernetes.io/component: server + app.kubernetes.io/part-of: wordpress +... +``` + + +MySQL 作为一个 `StatefulSet` 暴露，包含它和它所属的较大应用程序的元数据： +```yaml +apiVersion: apps/v1 +kind: StatefulSet +metadata: + labels: + app.kubernetes.io/name: mysql + app.kubernetes.io/instance: wordpress-abcxzy + app.kubernetes.io/managed-by: helm + app.kubernetes.io/component: database + app.kubernetes.io/part-of: wordpress + app.kubernetes.io/version: "5.7.21" +... +``` + + +`Service` 用于将 MySQL 作为 WordPress 的一部分暴露： +```yaml +apiVersion: v1 +kind: Service +metadata: + labels: + app.kubernetes.io/name: mysql + app.kubernetes.io/instance: wordpress-abcxzy + app.kubernetes.io/managed-by: helm + app.kubernetes.io/component: database + app.kubernetes.io/part-of: wordpress + app.kubernetes.io/version: "5.7.21" +... +``` + + +使用 MySQL `StatefulSet` 和 `Service`，您会注意到有关 MySQL 和 Wordpress 的信息，包括更广泛的应用程序。 + +{{% /capture %}} diff --git a/content/zh/docs/reference/kubectl/cheatsheet.md b/content/zh/docs/reference/kubectl/cheatsheet.md new file mode 100644 index 0000000000..ab949d4b5e --- /dev/null +++ b/content/zh/docs/reference/kubectl/cheatsheet.md @@ -0,0 +1,663 @@ +--- +title: kubectl Cheat Sheet +reviewers: +- bgrant0607 +- erictune +- krousey +- clove +content_template: templates/concept +--- + +{{% capture overview %}} + + +也可以看下：[Kubectl 概述](/docs/reference/kubectl/overview/) 和 [JsonPath 指南](/docs/reference/kubectl/jsonpath)。 + + +本页面是 `kubectl` 命令的概述。 + +{{% /capture %}} + +{{% capture body %}} + +# kubectl - Cheat Sheet + + +## Kubectl 自动补全 + +### BASH + + +```bash +source <(kubectl completion bash) # 在 bash 中设置当前 shell 的自动补全，要先安装 bash-completion 包。 +echo "source <(kubectl completion bash)" >> ~/.bashrc # 在您的 bash shell 中永久的添加自动补全 +``` + +### ZSH + + +```bash +source <(kubectl completion zsh) # 在 zsh 中设置当前 shell 的自动补全 +echo "if [ $commands[kubectl] ]; then source <(kubectl completion zsh); fi" >> ~/.zshrc # 在您的 zsh shell 中永久的添加自动补全 +``` + + +## Kubectl 上下文和配置 + +设置 `kubectl` 与哪个 Kubernetes 集群进行通信并修改配置信息。查看 [使用 kubeconfig 跨集群授权访问 +](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) 文档获取详情配置文件信息。 + + +```bash +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 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 config set-context gce --user=cluster-admin --namespace=foo \ + && kubectl config use-context gce +``` + + +## 创建对象 + +Kubernetes 配置可以用 json 或 yaml 定义。可以使用的文件扩展名有 `.yaml`， +`.yml` 和 `.json` 。 + + +```bash +kubectl create -f ./my-manifest.yaml # 创建资源 +kubectl create -f ./my1.yaml -f ./my2.yaml # 使用多个文件创建 +kubectl create -f ./dir # 从目录下的全部配置文件创建资源 +kubectl create -f https://git.io/vPieo # 从 url 中创建资源 +kubectl run nginx --image=nginx # 启动单实例 nginx +kubectl explain pods,svc # 获取 pod，svc 配置的文档说明 + +# 从标准输入中的多个 YAML 对象中创建 +cat < +## 获取和查找资源 + + +```bash +# 使用 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 --include-uninitialized # 列出当前命名空间下的全部 pods，包含未初始化的 + +# 使用 describe 命令获取详细输出 +kubectl describe nodes my-node +kubectl describe pods my-pod + +kubectl get services --sort-by=.metadata.name # 列出当前命名空间下所有 services，按照名称排序 + +# 列出 pods 按照重启次数进行排序 +kubectl get pods --sort-by='.status.containerStatuses[0].restartCount' + +# 获取包含 app=cassandra 标签全部 pods 的 version 标签 +kubectl get pods --selector=app=cassandra rc -o \ + jsonpath='{.items[*].metadata.labels.version}' + +# 获取当前命名空间中正在运行的 pods +kubectl get pods --field-selector=status.phase=Running + +# 获取全部 node 的 ExternalIP 地址 +kubectl get nodes -o jsonpath='{.items[*].status.addresses[?(@.type=="ExternalIP")].address}' + +# 列出属于某个特定 RC 的 pods 的名称 +# "jq" 命令对于 jsonpath 过于复杂的转换非常有用，可以在 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}) + +# 检查哪些节点处于 ready +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 + +# 列出 events，按照创建时间排序 +kubectl get events --sort-by=.metadata.creationTimestamp +``` + + +## 更新资源 + +从版本 1.11 开始，`rolling-update` 已被弃用（参见[CHANGELOG-1.11.md]（https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.11.md）），请使用 `rollout` 代替。 + + +```bash +kubectl set image deployment/frontend www=image:v2 # 滚动更新 "frontend" deployment 的 "www" 容器镜像 +kubectl rollout undo deployment/frontend # 回滚到上次部署 +kubectl rollout status -w deployment/frontend # Watch "frontend" deployment 的滚动升级状态直到完成 + +# 从 1.11 版本开始弃用 +kubectl rolling-update frontend-v1 -f frontend-v2.json # (弃用) 滚动升级 frontend-v1 的 pods +kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2 # (弃用) 修改资源的名称并更新镜像 +kubectl rolling-update frontend --image=image:v2 # (弃用) 更新 frontend 的 pods 的镜像 +kubectl rolling-update frontend-v1 frontend-v2 --rollback # (弃用) 终止已经进行中的 rollout + +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 自动伸缩容 +``` + + +## 局部更新资源 + + +```bash +kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}' # 部分更新 node + +# 更新容器的镜像；spec.containers[*].name 是必须的因为它是一个合并 key。 +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" } }]' +``` + + +## 编辑资源 +在编辑器中编辑任何 API 资源 + +```bash +kubectl edit svc/docker-registry # 编辑名为 docker-registry 的 service +KUBE_EDITOR="nano" kubectl edit svc/docker-registry # 使用其他编辑器 +``` + + +## 对资源进行伸缩 + +```bash +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 # 伸缩多个 replication controllers +``` + + +## 删除资源 + +```bash +kubectl delete -f ./pod.json # 删除在 pod.json 中指定的类型和名称的 pod +kubectl delete pod,service baz foo # 删除名称为 "baz" 和 "foo" 的 pod 和 service +kubectl delete pods,services -l name=myLabel # 删除包含 name=myLabel 标签的 pods 和 services +kubectl delete pods,services -l name=myLabel --include-uninitialized # 删除包含 label name=myLabel 标签的 pods 和 services，包括未初始化的 +kubectl -n my-ns delete po,svc --all # 删除在 my-ns 命名空间中全部的 pods 和 services ，包括未初始化的 +``` + + +## 与运行中的 Pods 进行交互 + +```bash +kubectl logs my-pod # 获取 pod 日志(标准输出) +kubectl logs my-pod --previous # 获取上个容器实例的 pod 日志(标准输出) +kubectl logs my-pod -c my-container # 获取 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 run -i --tty busybox --image=busybox -- sh # 以交互式 shell 运行 Pod +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 和容器的监控数据 +``` + + +## 与节点和集群进行交互 + +```bash +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 # 限制 master 和 services 的地址 +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 +``` + + +### 资源类型 + +列出全部支持的资源类型和它们的简称, [API group](/docs/concepts/overview/kubernetes-api/#api-groups), 无论它们是否是 [namespaced](/docs/concepts/overview/working-with-objects/namespaces), [Kind](/docs/concepts/overview/working-with-objects/kubernetes-objects): + +```bash +kubectl api-resources +``` + +用于探索 API 资源的其他操作： + +```bash +kubectl api-resources --namespaced=true # 所有在命名空间中的资源 +kubectl api-resources --namespaced=false # 所有不在命名空间中的资源 +kubectl api-resources -o name # 输出简单的所有资源（只是资源名称） +kubectl api-resources -o wide # 具有扩展（又称 "wide"）输出的所有资源 +kubectl api-resources --verbs=list,get # 支持"list"和"get"请求动词的所有资源 +kubectl api-resources --api-group=extensions # "extensions" API组中的所有资源 +``` + + +### 格式化输出 + +要以特定格式将详细信息输出到终端窗口，可以将 `-o` 或 `--output` 参数添加到支持的 `kubectl` 命令. + +输出格式 | 描述 +--------------| ----------- +`-o=custom-columns=` | 使用逗号分隔的自定义列列表打印表格 +`-o=custom-columns-file=` | 使用 `` 文件中的自定义列模板打印表格 +`-o=json` | 输出 JSON 格式的 API 对象 +`-o=jsonpath=