From 2db6b9a08733abe37b84309658f936f52c7c8bf9 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Wed, 30 Sep 2020 14:49:38 +0800 Subject: [PATCH 01/31] [zh] Add style guide for Chinese localization Most of the contents are summarized from previous practices. This PR is an attempt to document these practices as guidelines. --- content/zh/docs/contribute/localization.md | 2 +- content/zh/docs/contribute/localization_zh.md | 465 ++++++++++++++++++ 2 files changed, 466 insertions(+), 1 deletion(-) create mode 100644 content/zh/docs/contribute/localization_zh.md diff --git a/content/zh/docs/contribute/localization.md b/content/zh/docs/contribute/localization.md index 3f6788a806..5ad2b88a87 100644 --- a/content/zh/docs/contribute/localization.md +++ b/content/zh/docs/contribute/localization.md @@ -455,7 +455,7 @@ Some language teams have their own language-specific style guide and glossary. F ### 特定语言的样式指南和词汇表 一些语言团队有自己的特定语言样式指南和词汇表。 -例如，请参见[韩语本地化指南](/ko/docs/contribute/localization_ko/)。 +例如，请参见[中文本地化指南](/zh/docs/contribute/localization_zh/)。 + +本节详述文档中文本地化过程中须注意的事项。 +这里列举的内容包含了*中文本地化小组*早期给出的指导性建议和后续实践过程中 +积累的经验。 +在阅读、贡献、评阅中文本地化文档的过程中，如果对本文的指南有任何改进建议， +都请直接提出 PR。我们欢迎任何形式的补充和更正！ + + + +## 一般规定 + +本节列举一些译文中常见问题和约定。 + +### 英文原文的保留 + +为便于译文审查和变更追踪，所有中文本地化 Markdown 文件中都应使用 HTML 注释 +`` 将英文原文逐段注释起来，后跟对应中文译文。例如： + +``` + +中文译文对应 ... +``` + +不建议采用下面的方式注释英文段落，除非英文段落非常非常短： + +``` + +中文译文对应 ... + +``` + +无论英文原文或者中文译文中，都不要保留过多的、不必要的空白行。 + +#### 段落划分 + +请避免大段大段地注释和翻译。一般而言，每段翻译可对应两三个自然段。 +段落过长会导致译文很难评阅。但也不必每个段落都单独翻译。例如： + +``` + +## 概述 {#overview} + +### 概念 {#concept} + +第一段落，不太长。 +``` + +以下风格是不必要的： + +``` + +## 概述 {#overview} + + +### 概念 {#concept} + + +第一段落，不太长。 +``` + +#### 编号列表的处理 + +编号列表需要编号的连续性，处理不好的话可能导致输出结果错误。 +由于有些列表可能很长，一次性等将整个列表注释掉再翻译也不现实。 +推荐采用下面的方式。 + +假定英文为： + +``` +1. Prepare something +1. Followed by a long step with code snippets and notes ... + this is a really long item +1. Another long item ... + .. continues here +1. Almost done ... +``` + +本地化处理： + +``` + +1. 准备工作，... + 这里每行缩进 3 个空格 + + +2. 这里是第二个编号，但需要显式给出数字，不能沿用英文编号。 + 缩进内容同上，3 个空格。 + 即使有三个反引号的代码段或者短代码，都按 3 个空格缩进。 + + +3. 继续列表。 + + 如果条目有多个段落，也要 + 保持缩进对齐以确保排版正确。 + +4. 列表终于结束 +``` + +#### Frontmatter 的处理 + +页面中的 Frontmatter 指的是文件头的两个 `---` 中间的部分。 +对这一部分，解析器有特殊处理，因此不能将英文部分放在前面，中文跟在后面。 +需要将二者顺序颠倒。如下所示： + +``` +--- +title: 译文标题 +type: concept +weight: 30 +--- + + +``` + +这里要注意的是： + +- `title`、`description` 的内容要翻译，其他字段一般不必（甚至不可）翻译。 +- `reviewers` 部分要删除，不然中文译文会转给英文作者来审阅。 + + +#### 短代码（shortcode）处理 + +通过 HTML 注释的短代码仍会被运行，因此需要额外小心。建议处理方式： + +``` + +{{}} +中文译文 +{{}} +``` + +评阅人应该不难理解中英文段落的对应关系。但是如果采用下面的方式，则会出现 +两个 `note`，因此需要避免。这是因为被注释起来的短代码仍会起作用！ + +``` + +{{}} +中文译文 +{{}} +``` + +### 译与不译 + +#### 资源名称或字段不译 + +根据英文原文写作风格约定【也在持续修订改进】，对 Kubernetes 中的 API +资源均按其规范中所给的大小写形式书写，例如：英文中会使用 Deployment 而不是 +deployment 来表示名为 "Deployment" 的 API 资源类型和对象实例。 + +对这类词语，一般不应翻译。 + +{{< note >}} +英文原文在这方面并不严谨，译者或中文译文的评阅者要非常留心。 +比如 Secret 资源，很多时候被误写为 secret。这时在本地化版本中一定 +不能译为“秘密”，以免与原文的语义不符。 +{{< /note >}} + +#### 代码中的注释 + +一般而言，代码中的注释需要翻译，包括存放在 `content/zh/examples/` 目录下 +的清单文件中的注释。 + + +#### 出站链接 + +如果超级链接的目标是 Kubernetes 网站之外的纯英文网页，链接中的内容*可以*不翻译。 +例如： + +``` + +请参阅 [installation caveats](https://acme.com/docs/v1/caveats) ... +``` + +注意，这里的 `installation` 与 `参阅` 之间留白，因为解析后属于中英文混排的情况。 + +### 标点符号 + +译文中标点符号要使用全角字符，除非以下两种情况： + +- 标点符号是英文命令的一部分； +- 标点符号是 Markdown 语法的一部分。 + +英文排比句式中采用的逗号，在译文中要使用顿号代替，复合中文书写习惯。 + +## 关于链接 + +### 链接锚点 + +英文 Markdown 中的各级标题会自动生成锚点，以便从其他页面中链接。 +在译为中文后，相应的链接必然会失效。为防止这类问题，建议在翻译 +各级标题时，使用英文方式显式给出链接锚点。例如： + +``` + +### 创建 Pod {#create-a-pod} +``` + +此类问题对于概念部分的页面最为突出，需要格外注意。 + + +### 中文链接目标 + +由于大部分页面已经完成中文本地化，这意味着很多链接可以使用中文版本作为目标。 +例如： + +``` + +更多的信息可参考[卷](/zh/docs/concepts/storage/)页面。 +``` + +如果对应目标页面尚未本地化，建议登记一个 Issue。 + +{{< note >}} +Website 的仓库中 `scripts/linkchecker.py` 是一个工具，可用来检查页面中的链接。 +例如，下面的命令检查中文本地化目录 `/content/zh/docs/concepts/containers/` +中所有 Markdown 文件中的链接合法性： + +``` +./scripts/linkchecker.py -l zh -f /docs/concepts/containers/**/*.md +``` +{{< /note >}} + +## 排版格式 + +以下为译文 Markdown 排版格式要求： + +- 中英文之间留一个空格 + * 这里的“英文”包括以英文呈现的超级链接 + * 这里的中文、英文都不包括标点符号 +- 译文 Markdown 中不要使用长行，应适当断行。 + * 可根据需要在 80-120 列断行 + * 最好结合句子的边界断行，即一句话在一行，不必留几个字转到下一行 + * 超级链接文字一般较长，可独立成行 + +{{< warning >}} +我们注意到有些贡献者可能使用了某种自动化工具，在 Markdown 英文原文中自动 +添加空格。虽然这些工具可一定程度提高效率，仍然需要提请作者注意，某些工具 +所作的转换可能是不对的，例如将 `foo=bar` 转换为 `foo = bar`、将 +`），另一些文字` 转换为 `） ，另一些文字` 等等，甚至将超级链接中的半角 +井号（`#`）转换为全角，导致链接失效。 +{{< /warning >}} + +英文中 "you" 翻译成 "你" 不必是 “您" +文章内的链接用英文例如 (#deploying )，在对应的标题上后面加上 {#deploying} + + +## 术语 + +### 术语拼写 + +按中文译文习惯，尽量不要在中文译文中使用首字母小写的拼写。例如： + +``` +列举所有 pods，查看其创建时间 ... [No] +列举所有 Pod，查看其创建时间 ... [Yes] +``` + +*第一次*使用首字母缩写时，应标注其全称和中文译文。例如： + +``` +你可以创建一个 Pod 干扰预算（Pod Disruption Budget，PDB）来解决这一问题。 +所谓 PDB 实际上是 ... +``` + +对于某些特定于 Kubernetes 语境的术语，也应在*第一次*出现在页面中时给出其英文原文， +以便读者对照阅读。例如： + +``` +镜像策略（Image Policy）用来控制集群可拉取的镜像仓库（Image Registry）源。 +``` + +### 术语对照 + +本节列举常见术语的统一译法。除极个别情况，对于专业术语应使用本节所列举的译法： + +- API Server，API 服务器 +- GA (general availability)，正式发布 +- addons，插件 +- admission controller，准入控制器 +- affinity，亲和性 +- annotation，注解 +- anti-affinity，反亲和性 +- attach，挂接 +- autoscale，自动扩缩容 +- bearer token，持有者令牌 +- capabilities权能字 + * 当泛指某主体执行某操作的能力时，可直译为“能力” + * 当特指 Linux 操作系统上的[权限控制](http://man7.org/linux/man-pages/man7/capabilities.7.html)机制时，译为“权能字” +- certificate authority，证书机构 +- certificate，证书 +- claim，申领 +- cloud provider + * 当用来指代下层云服务的提供厂商时，译为“云服务供应商” + * 当特指 Kubernetes 中对不同云平台的支持时，可酌情译为“云驱动” +- cluster，集群 +- condition + * 大多数上下文中，可译为“条件” + * 在讨论 Kubernetes 资源的 condition 时，应译为“状况” +- control loop，控制回路 +- control plane，控制平面，或控制面 +- controller，控制器 +- controller manager，控制器管理器 +- credential，登录凭据，凭据 +- custom，定制，或自定义 +- daemon，守护进程 +- dashboard，仪表板 +- dependent，附属或附属者 +- deprecated，已弃用的 +- deprecation，弃用 +- desired，预期的 +- desired state，预期状态 +- detach，解除挂接 +- distribution，发行版本 +- disruption，干扰（请勿译为“中断”） +- drain，腾空 +- endpoint，端点 +- egress，出站 +- evict，驱逐 +- eviction，驱逐 +- feature gate，特性门控 +- federation，联邦 +- flags，命令行参数，参数 +- grace period，宽限期限 +- graceful termination，体面终止 +- hairpin，发夹 +- hash，哈希 +- headless service，无头服务 +- healthcheck，健康检查 +- hook，回调 +- host，主机，宿主机 +- hosting，托管 +- idempotent，幂等的 +- image，镜像 +- image registry，镜像仓库 +- ingress，入站 +- init container，Init 容器 +- key + * 在加密解密、安全认证上下文中，译为密钥 + * 在配置文件、数据结构上下文中，译为主键，或键 +- label，标签 +- label selector，标签选择算符 +- lifecycle，生命周期 +- limit，限制，限值 +- liveness probe，存活态探针 +- load balance，负载均衡 +- load balancer，负载均衡器 +- log flush，清刷日志数据 +- loopback，本地回路 +- manifest，清单，清单文件 +- master node，主控节点 +- metric + * 用来指代被测量的数据源时，译为指标 + * 用来指代测量观测结果时，译为度量值 +- mount，挂载 +- namespace，名字空间，命名空间 +- orphans，孤立或孤立的 +- override，覆写 +- owner，所有者，属主 +- pending，悬决的 +- persistent volume，持久卷 +- persistent volume claim，持久卷申领 +- pipeline，流水线 +- prerequisites，依赖，前提条件（根据上下文判断） +- priority class，优先级类 +- probe，探针 +- provision，供应 +- pull，拉取 +- push，推送 +- quota，配额 +- readiness probe，就绪态探针 +- replica，副本 +- repo，仓库 +- repository，仓库 +- revision，修订版本 +- role，角色 +- role binding，角色绑定 +- rolling update，滚动更新 +- rollout，上线 +- rotate，轮换 +- round robin，轮转 +- runtime，运行时 +- scale in/out，横向缩容/扩容 +- scale up/down，纵向扩容/缩容 +- scale + * 做动词用时，译为“扩缩”，或者“改变...的规模” + * 做名词用时，译为“规模” +- scheduler，调度器 +- service，服务 +- service account，服务账号 +- service account token，服务账号令牌 +- service discovery，服务发现 +- service mesh，服务网格 +- session，会话 +- sidecar，挂斗 +- skew，偏移 +- spec，规约 +- specification，规约 +- startup probe，启动探针 +- stateless，无状态的 +- static pod，静态 Pod +- stderr，标准错误输出 +- stdin，标准输入 +- stdout，标准输出 +- storage class，存储类 +- taint，污点 +- threshold，阈值 +- toleration，容忍度 +- topology，拓扑 +- topology spread constraint，拓扑分布约束 +- traffic，流量 + * 在某些上下文中，可以根据情况译为“服务请求”，“服务响应” +- unmount，卸载 +- use case，用例，使用场景 +- volume，卷 +- worker node，工作节点 +- workload，工作负载 From dccbc5f3cd17175a231013a0b6ff0c52cc9232f1 Mon Sep 17 00:00:00 2001 From: Max Belsky Date: Thu, 22 Oct 2020 16:42:36 +0300 Subject: [PATCH 02/31] Reduce steps count to list the env vars --- .../define-environment-variable-container.md | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/content/en/docs/tasks/inject-data-application/define-environment-variable-container.md b/content/en/docs/tasks/inject-data-application/define-environment-variable-container.md index cbc3c45260..e31b711ad7 100644 --- a/content/en/docs/tasks/inject-data-application/define-environment-variable-container.md +++ b/content/en/docs/tasks/inject-data-application/define-environment-variable-container.md @@ -47,17 +47,10 @@ Pod: envar-demo 1/1 Running 0 9s ``` -1. Get a shell to the container running in your Pod: +1. List the pod's container environment variables: ```shell - kubectl exec -it envar-demo -- /bin/bash - ``` - -1. In your shell, run the `printenv` command to list the environment variables. - - ```shell - # Run this in the shell inside the container - printenv + kubectl exec envar-demo -- printenv ``` The output is similar to this: @@ -71,8 +64,6 @@ Pod: DEMO_FAREWELL=Such a sweet sorrow ``` -1. To exit the shell, enter `exit`. - {{< note >}} The environment variables set using the `env` or `envFrom` field override any environment variables specified in the container image. From 6ed67daf6e1414c199524b3cb827a0de250ef6c9 Mon Sep 17 00:00:00 2001 From: guiadco Date: Thu, 22 Oct 2020 19:32:08 +0200 Subject: [PATCH 03/31] fix-24683 --- .../zh/docs/tasks/administer-cluster/dns-custom-nameservers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/tasks/administer-cluster/dns-custom-nameservers.md b/content/zh/docs/tasks/administer-cluster/dns-custom-nameservers.md index 3697aa9657..330416050c 100644 --- a/content/zh/docs/tasks/administer-cluster/dns-custom-nameservers.md +++ b/content/zh/docs/tasks/administer-cluster/dns-custom-nameservers.md @@ -250,7 +250,7 @@ To explicitly force all non-cluster DNS lookups to go through a specific nameser 指向该域名服务器，而不是 `/etc/resolv.conf`。 ``` -proxy . 172.16.0.1 +forward . 172.16.0.1 ``` + + + +本教程建立在 +[使用 Redis 部署 PHP Guestbook](/zh/docs/tutorials/stateless-application/guestbook) 教程之上。 +*Beats*，是 Elastic 出品的开源的轻量级日志、指标和网络数据采集器， +将和 Guestbook 一同部署在 Kubernetes 集群中。 +Beats 收集、分析、索引数据到 Elasticsearch，使你可以用 Kibana 查看并分析得到的运营信息。 +本示例由以下内容组成： + +* Elasticsearch 和 Kibana +* Filebeat +* Metricbeat +* Packetbeat + +## {{% heading "objectives" %}} + + +* 启动用 Redis 部署的 PHP Guestbook。 +* 安装 kube-state-metrics。 +* 创建 Kubernetes secret。 +* 部署 Beats。 +* 用仪表板查看日志和指标。 + +## {{% heading "prerequisites" %}} + + +{{< include "task-tutorial-prereqs.md" >}} +{{< version-check >}} + + +此外，你还需要: + +* 依照教程[使用 Redis 的 PHP Guestbook](/zh/docs/tutorials/stateless-application/guestbook)得到的一套运行中的部署环境。 +* 一套运行中的 Elasticsearch 和 Kibana 部署环境。你可以使用 [Elastic 云中的Elasticsearch 服务](https://cloud.elastic.co)、在工作站或者服务器上运行此[下载文件](https://www.elastic.co/guide/en/elastic-stack-get-started/current/get-started-elastic-stack.html)、或运行 [Elastic Helm Charts](https://github.com/elastic/helm-charts)。 + + + + +## 启动用 Redis 部署的 PHP Guestbook {#start-up-the-php-guestbook-with-redis} + +本教程建立在 +[使用 Redis 部署 PHP Guestbook](/zh/docs/tutorials/stateless-application/guestbook) 之上。 +如果你已经有一个运行的 Guestbook 应用程序，那就监控它。 +如果还没有，那就按照说明先部署 Guestbook ，但不要执行**清理**的步骤。 +当 Guestbook 运行起来后，再返回本页。 + + +## 添加一个集群角色绑定 {#add-a-cluster-role-binding} + +创建一个[集群范围的角色绑定](/zh/docs/reference/access-authn-authz/rbac/#rolebinding-和-clusterrolebinding)， +以便你可以在集群范围（在 kube-system 中）部署 kube-state-metrics 和 Beats。 + +```shell +kubectl create clusterrolebinding cluster-admin-binding \ + --clusterrole=cluster-admin --user= +``` + + +### 安装 kube-state-metrics {#install-kube-state-metrics} + +Kubernetes [*kube-state-metrics*](https://github.com/kubernetes/kube-state-metrics) +是一个简单的服务，它侦听 Kubernetes API 服务器并生成对象状态的指标。 +Metricbeat 报告这些指标。 +添加 kube-state-metrics 到运行 Guestbook 的 Kubernetes 集群。 + +```shell +git clone https://github.com/kubernetes/kube-state-metrics.git kube-state-metrics +kubectl apply -f kube-state-metrics/examples/standard +``` + + +### 检查 kube-state-metrics 是否正在运行 {#check-to-see-if-kube-state-metrics-is-running} + +```shell +kubectl get pods --namespace=kube-system -l app.kubernetes.io/name=kube-state-metrics +``` + + +输出： + +``` +NAME READY STATUS RESTARTS AGE +kube-state-metrics-89d656bf8-vdthm 1/1 Running 0 21s +``` + + +## 从 GitHub 克隆 Elastic examples 库 {#clone-the-elastic-examples-github-repo} + +```shell +git clone https://github.com/elastic/examples.git +``` + + +后续命令将引用目录 `examples/beats-k8s-send-anywhere` 中的文件， +所以把目录切换过去。 + +```shell +cd examples/beats-k8s-send-anywhere +``` + + +## 创建 Kubernetes Secret {#create-a-kubernetes-secret} + +Kubernetes {{< glossary_tooltip text="Secret" term_id="secret" >}} +是包含少量敏感数据（类似密码、令牌、秘钥等）的对象。 +这类信息也可以放在 Pod 规格定义或者镜像中； +但放在 Secret 对象中，能更好的控制它的使用方式，也能减少意外泄露的风险。 + +{{< note >}} +这里有两套步骤，一套用于*自管理*的 Elasticsearch 和 Kibana（运行在你的服务器上或使用 Helm Charts）， +另一套用于在 Elastic 云服务中 *Managed service* 的 Elasticsearch 服务。 +在本教程中，只需要为 Elasticsearch 和 Kibana 系统创建 secret。 +{{< /note >}} + +{{< tabs name="tab_with_md" >}} +{{% tab name="自管理" %}} + + +### 自管理系统 {#self-managed} + +如果你使用 Elastic 云中的 Elasticsearch 服务，切换到 **Managed service** 标签页。 + +### 设置凭据 {#set-the-credentials} + +当你使用自管理的 Elasticsearch 和 Kibana （对比托管于 Elastic 云中的 Elasticsearch 服务，自管理更有效率）， +创建 k8s secret 需要准备四个文件。这些文件是： + +1. `ELASTICSEARCH_HOSTS` +1. `ELASTICSEARCH_PASSWORD` +1. `ELASTICSEARCH_USERNAME` +1. `KIBANA_HOST` + + +为你的 Elasticsearch 集群和 Kibana 主机设置这些信息。这里是一些例子 +（另见[*此配置*](https://stackoverflow.com/questions/59892896/how-to-connect-from-minikube-to-elasticsearch-installed-on-host-local-developme/59892897#59892897)） + +#### `ELASTICSEARCH_HOSTS` {#elasticsearch-hosts} + + +1. 来自于 Elastic Elasticsearch Helm Chart 的节点组： + + ``` + ["http://elasticsearch-master.default.svc.cluster.local:9200"] + ``` + + +1. Mac 上的单节点的 Elasticsearch，Beats 运行在 Mac 的容器中： + + ``` + ["http://host.docker.internal:9200"] + ``` + + +1. 运行在虚拟机或物理机上的两个 Elasticsearch 节点 + + ``` + ["http://host1.example.com:9200", "http://host2.example.com:9200"] + ``` + + +编辑 `ELASTICSEARCH_HOSTS` +```shell +vi ELASTICSEARCH_HOSTS +``` + +#### `ELASTICSEARCH_PASSWORD` {#elasticsearch-password} + + +只有密码；没有空格、引号、< 和 >： + +``` + +``` + + +编辑 `ELASTICSEARCH_PASSWORD`： + +```shell +vi ELASTICSEARCH_PASSWORD +``` + +#### `ELASTICSEARCH_USERNAME` {#elasticsearch-username} + + +只有用名；没有空格、引号、< 和 >： + + +``` +<为 Elasticsearch 注入的用户名> +``` + + +编辑 `ELASTICSEARCH_USERNAME`： + +```shell +vi ELASTICSEARCH_USERNAME +``` + +#### `KIBANA_HOST` {#kibana-host} + + +1. 从 Elastic Kibana Helm Chart 安装的 Kibana 实例。子域 `default` 指默认的命名空间。如果你把 Helm Chart 指定部署到不同的命名空间，那子域会不同： + + ``` + "kibana-kibana.default.svc.cluster.local:5601" + ``` + + +1. Mac 上的 Kibana 实例，Beats 运行于 Mac 的容器： + + ``` + "host.docker.internal:5601" + ``` + + +1. 运行于虚拟机或物理机上的两个 Elasticsearch 节点： + + ``` + "host1.example.com:5601" + ``` + + +编辑 `KIBANA_HOST`： + +```shell +vi KIBANA_HOST +``` + + +### 创建 Kubernetes secret {#create-a-kubernetes-secret} + +在上面编辑完的文件的基础上，本命令在 Kubernetes 系统范围的命名空间（kube-system）创建一个 secret。 + +``` + kubectl create secret generic dynamic-logging \ + --from-file=./ELASTICSEARCH_HOSTS \ + --from-file=./ELASTICSEARCH_PASSWORD \ + --from-file=./ELASTICSEARCH_USERNAME \ + --from-file=./KIBANA_HOST \ + --namespace=kube-system +``` + +{{% /tab %}} +{{% tab name="Managed service" %}} + + +## Managed service {#managed-service} + +本标签页只用于 Elastic 云 的 Elasticsearch 服务，如果你已经为自管理的 Elasticsearch 和 Kibana 创建了secret，请继续[部署 Beats](#deploy-the-beats)并继续。 + +### 设置凭据 {#set-the-credentials} + +在 Elastic 云中的托管 Elasticsearch 服务中，为了创建 k8s secret，你需要先编辑两个文件。它们是： + +1. `ELASTIC_CLOUD_AUTH` +1. `ELASTIC_CLOUD_ID` + + +当你完成部署的时候，Elasticsearch 服务控制台会提供给你一些信息，用这些信息完成设置。 +这里是一些示例： + +#### ELASTIC_CLOUD_ID {#elastic-cloud-id} + +``` +devk8s:ABC123def456ghi789jkl123mno456pqr789stu123vwx456yza789bcd012efg345hijj678klm901nop345zEwOTJjMTc5YWQ0YzQ5OThlN2U5MjAwYTg4NTIzZQ== +``` + +#### ELASTIC_CLOUD_AUTH {#elastic-cloud-auth} + + +只要用户名；没有空格、引号、< 和 >： + +``` +elastic:VFxJJf9Tjwer90wnfTghsn8w +``` + + +### 编辑要求的文件 {#edit-the-required-files} +```shell +vi ELASTIC_CLOUD_ID +vi ELASTIC_CLOUD_AUTH +``` + + +### 创建 Kubernetes secret {#create-a-kubernetes-secret} + +基于上面刚编辑过的文件，在 Kubernetes 系统范围命名空间（kube-system）中，用下面命令创建一个的secret： + + kubectl create secret generic dynamic-logging \ + --from-file=./ELASTIC_CLOUD_ID \ + --from-file=./ELASTIC_CLOUD_AUTH \ + --namespace=kube-system + + {{% /tab %}} +{{< /tabs >}} + + +## 部署 Beats {#deploy-the-beats} + +为每一个 Beat 提供 清单文件。清单文件使用已创建的 secret 接入 Elasticsearch 和 Kibana 服务器。 + +### 关于 Filebeat {#about-filebeat} + +Filebeat 收集日志，日志来源于 Kubernetes 节点以及这些节点上每一个 Pod 中的容器。Filebeat 部署为 +{{< glossary_tooltip text="DaemonSet" term_id="daemonset" >}}。 +Filebeat 支持自动发现 Kubernetes 集群中的应用。 +在启动时，Filebeat 扫描存量的容器，并为它们提供适当的配置， +然后开始监听新的启动/中止信号。 + +下面是一个自动发现的配置，它支持 Filebeat 定位并分析来自于 Guestbook 应用部署的 Redis 容器的日志文件。 +下面的配置片段来自文件 `filebeat-kubernetes.yaml`： + +```yaml +- condition.contains: + kubernetes.labels.app: redis + config: + - module: redis + log: + input: + type: docker + containers.ids: + - ${data.kubernetes.container.id} + slowlog: + enabled: true + var.hosts: ["${data.host}:${data.port}"] +``` + + + +这样配置 Filebeat，当探测到容器拥有 `app` 标签，且值为 `redis`，那就启用 Filebeat 的 `redis` 模块。 +`redis` 模块可以根据 docker 的输入类型（在 Kubernetes 节点上读取和 Redis 容器的标准输出流关联的文件） ，从容器收集 `log` 流。 +另外，此模块还可以使用容器元数据中提供的配置信息，连到 Pod 适当的主机和端口，收集 Redis 的 `slowlog` 。 + +### 部署 Filebeat {#deploy-filebeat} + +```shell +kubectl create -f filebeat-kubernetes.yaml +``` + + +#### 验证 {#verify} + +```shell +kubectl get pods -n kube-system -l k8s-app=filebeat-dynamic +``` + + +### 关于 Metricbeat {#about-metricbeat} + +Metricbeat 自动发现的配置方式与 Filebeat 完全相同。 +这里是针对 Redis 容器的 Metricbeat 自动发现配置。 +此配置片段来自于文件 `metricbeat-kubernetes.yaml`： + +```yaml +- condition.equals: + kubernetes.labels.tier: backend + config: + - module: redis + metricsets: ["info", "keyspace"] + period: 10s + + # Redis hosts + hosts: ["${data.host}:${data.port}"] +``` + +配置 Metricbeat，在探测到标签 `tier` 的值等于 `backend` 时，应用 Metricbeat 模块 `redis`。 +`redis` 模块可以获取容器元数据，连接到 Pod 适当的主机和端口，从 Pod 中收集指标 `info` 和 `keyspace`。 + +### 部署 Metricbeat {#deploy-metricbeat} + +```shell +kubectl create -f metricbeat-kubernetes.yaml +``` + + +#### 验证 {#verify2} + +```shell +kubectl get pods -n kube-system -l k8s-app=metricbeat +``` + + +### 关于 Packetbeat {#about-packetbeat} + +Packetbeat 的配置方式不同于 Filebeat 和 Metricbeat。 +相比于匹配容器标签的模式，它的配置基于相关协议和端口号。 +下面展示的是端口号的一个子集： + +{{< note >}} +如果你的服务运行在非标准的端口上，那就打开文件 `filebeat.yaml`，把这个端口号添加到合适的类型中，然后删除/启动 Packetbeat 的守护进程。 +{{< /note >}} + +```yaml +packetbeat.interfaces.device: any + +packetbeat.protocols: +- type: dns + ports: [53] + include_authorities: true + include_additionals: true + +- type: http + ports: [80, 8000, 8080, 9200] + +- type: mysql + ports: [3306] + +- type: redis + ports: [6379] + +packetbeat.flows: + timeout: 30s + period: 10s +``` + + +### 部署 Packetbeat {#deploy-packetbeat} + +```shell +kubectl create -f packetbeat-kubernetes.yaml +``` + + +#### 验证 {#verify3} + +```shell +kubectl get pods -n kube-system -l k8s-app=packetbeat-dynamic +``` + + +## 在 kibana 中浏览 {#view-in-kibana} + +在浏览器中打开 kibana，再打开 **Dashboard**。 +在搜索栏中键入 Kubernetes，再点击 Metricbeat 的 Kubernetes Dashboard。 +此 Dashboard 展示节点状态、应用部署等。 + +在 Dashboard 页面，搜索 Packetbeat，并浏览 Packetbeat 概览信息。 + +同样地，浏览 Apache 和 Redis 的 Dashboard。 +可以看到日志和指标各自独立 Dashboard。 +Apache Metricbeat Dashboard 是空的。 +找到 Apache Filebeat Dashboard，拉到最下面，查看 Apache 的错误日志。 +日志会揭示出没有 Apache 指标的原因。 + +要让 metricbeat 得到 Apache 的指标，需要添加一个包含模块状态配置文件的 ConfigMap，并重新部署 Guestbook。 + +## 缩放部署规模，查看新 Pod 已被监控 {#scale-your-deployments-and-see-new-pods-being-monitored} + +列出现有的 deployments： + +```shell +kubectl get deployments +``` + + +输出： + +``` +NAME READY UP-TO-DATE AVAILABLE AGE +frontend 3/3 3 3 3h27m +redis-master 1/1 1 1 3h27m +redis-slave 2/2 2 2 3h27m +``` + + +缩放前端到两个 Pod： + +```shell +kubectl scale --replicas=2 deployment/frontend +``` + + +输出： + +``` +deployment.extensions/frontend scaled +``` + + +将前端应用缩放回三个 Pod： + +```shell +kubectl scale --replicas=3 deployment/frontend +``` + + +## 在 Kibana 中查看变化 {#view-the-chagnes-in-kibana} + +参见屏幕截图，添加指定的过滤器，然后将列添加到视图。 +你可以看到，ScalingReplicaSet 被做了标记，从标记的点开始，到消息列表的顶部，展示了拉取的镜像、挂载的卷、启动的 Pod 等。 +![Kibana 发现](https://raw.githubusercontent.com/elastic/examples/master/beats-k8s-send-anywhere/scaling-up.png) + +## {{% heading "cleanup" %}} + + +删除 Deployments 和 Services， 删除运行的 Pod。 +用标签功能在一个命令中删除多个资源。 + +1. 执行下列命令，删除所有的 Pod、Deployment 和 Services。 + + ```shell + kubectl delete deployment -l app=redis + kubectl delete service -l app=redis + kubectl delete deployment -l app=guestbook + kubectl delete service -l app=guestbook + kubectl delete -f filebeat-kubernetes.yaml + kubectl delete -f metricbeat-kubernetes.yaml + kubectl delete -f packetbeat-kubernetes.yaml + kubectl delete secret dynamic-logging -n kube-system + ``` + +2. 查询 Pod，以核实没有 Pod 还在运行： + + ```shell + kubectl get pods + ``` + + + 响应应该是这样： + + ``` + No resources found. + ``` + + +## {{% heading "whatsnext" %}} + + +* 了解[监控资源的工具](/zh/docs/tasks/debug-application-cluster/resource-usage-monitoring/) +* 进一步阅读[日志体系架构](/zh/docs/concepts/cluster-administration/logging/) +* 进一步阅读[应用内省和调试](/zh/docs/tasks/debug-application-cluster/) +* 进一步阅读[应用程序的故障排除](/zh/docs/tasks/debug-application-cluster/resource-usage-monitoring/) \ No newline at end of file From d71c21442657d73b0c7c7f58fad5b0a9e7ba4098 Mon Sep 17 00:00:00 2001 From: rob Date: Fri, 23 Oct 2020 12:10:38 -1000 Subject: [PATCH 08/31] fix KubeSchedulerConfiguration syntax --- .../pods/pod-topology-spread-constraints.md | 14 +++++++------- .../pods/pod-topology-spread-constraints.md | 14 +++++++------- .../pods/pod-topology-spread-constraints.md | 14 +++++++------- .../pods/pod-topology-spread-constraints.md | 14 +++++++------- 4 files changed, 28 insertions(+), 28 deletions(-) diff --git a/content/en/docs/concepts/workloads/pods/pod-topology-spread-constraints.md b/content/en/docs/concepts/workloads/pods/pod-topology-spread-constraints.md index 09a02d6afc..622d6a6149 100644 --- a/content/en/docs/concepts/workloads/pods/pod-topology-spread-constraints.md +++ b/content/en/docs/concepts/workloads/pods/pod-topology-spread-constraints.md @@ -295,13 +295,13 @@ apiVersion: kubescheduler.config.k8s.io/v1beta1 kind: KubeSchedulerConfiguration profiles: - pluginConfig: - - name: PodTopologySpread - args: - defaultConstraints: - - maxSkew: 1 - topologyKey: topology.kubernetes.io/zone - whenUnsatisfiable: ScheduleAnyway + - pluginConfig: + - name: PodTopologySpread + args: + defaultConstraints: + - maxSkew: 1 + topologyKey: topology.kubernetes.io/zone + whenUnsatisfiable: ScheduleAnyway ``` {{< note >}} diff --git a/content/fr/docs/concepts/workloads/pods/pod-topology-spread-constraints.md b/content/fr/docs/concepts/workloads/pods/pod-topology-spread-constraints.md index 4e0fddc40b..d1cd1f41e1 100644 --- a/content/fr/docs/concepts/workloads/pods/pod-topology-spread-constraints.md +++ b/content/fr/docs/concepts/workloads/pods/pod-topology-spread-constraints.md @@ -205,13 +205,13 @@ apiVersion: kubescheduler.config.k8s.io/v1alpha2 kind: KubeSchedulerConfiguration profiles: - pluginConfig: - - name: PodTopologySpread - args: - defaultConstraints: - - maxSkew: 1 - topologyKey: failure-domain.beta.kubernetes.io/zone - whenUnsatisfiable: ScheduleAnyway + - pluginConfig: + - name: PodTopologySpread + args: + defaultConstraints: + - maxSkew: 1 + topologyKey: topology.kubernetes.io/zone + whenUnsatisfiable: ScheduleAnyway ``` {{< note >}} diff --git a/content/id/docs/concepts/workloads/pods/pod-topology-spread-constraints.md b/content/id/docs/concepts/workloads/pods/pod-topology-spread-constraints.md index f1d970a473..8c5bb1a227 100644 --- a/content/id/docs/concepts/workloads/pods/pod-topology-spread-constraints.md +++ b/content/id/docs/concepts/workloads/pods/pod-topology-spread-constraints.md @@ -249,13 +249,13 @@ apiVersion: kubescheduler.config.k8s.io/v1alpha2 kind: KubeSchedulerConfiguration profiles: - pluginConfig: - - name: PodTopologySpread - args: - defaultConstraints: - - maxSkew: 1 - topologyKey: failure-domain.beta.kubernetes.io/zone - whenUnsatisfiable: ScheduleAnyway + - pluginConfig: + - name: PodTopologySpread + args: + defaultConstraints: + - maxSkew: 1 + topologyKey: topology.kubernetes.io/zone + whenUnsatisfiable: ScheduleAnyway ``` {{< note >}} diff --git a/content/ko/docs/concepts/workloads/pods/pod-topology-spread-constraints.md b/content/ko/docs/concepts/workloads/pods/pod-topology-spread-constraints.md index 31587a99e6..d5d4490608 100644 --- a/content/ko/docs/concepts/workloads/pods/pod-topology-spread-constraints.md +++ b/content/ko/docs/concepts/workloads/pods/pod-topology-spread-constraints.md @@ -295,13 +295,13 @@ apiVersion: kubescheduler.config.k8s.io/v1beta1 kind: KubeSchedulerConfiguration profiles: - pluginConfig: - - name: PodTopologySpread - args: - defaultConstraints: - - maxSkew: 1 - topologyKey: topology.kubernetes.io/zone - whenUnsatisfiable: ScheduleAnyway + - pluginConfig: + - name: PodTopologySpread + args: + defaultConstraints: + - maxSkew: 1 + topologyKey: topology.kubernetes.io/zone + whenUnsatisfiable: ScheduleAnyway ``` {{< note >}} From d80a20ea6a8c878800cae88081e41fd1abf0f031 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Sat, 24 Oct 2020 09:29:13 +0800 Subject: [PATCH 09/31] Improve the lsync script This PR improves the lsync script so that it can handle directories (recursively). For example, you can run the following command to find the detailed changes that are out of sync: ``` ./scripts/lsync content/zh/docs/concepts/_index.md ``` and you can run the following command to identify how many files are out of sync under a given directory: ``` > ./scripts/lsync content/zh/docs/concepts/ content/en/docs/concepts/architecture/control-plane-node-communication.md | 2 +- content/en/docs/concepts/architecture/controller.md | 10 ++++++++++ content/en/docs/concepts/cluster-administration/logging.md | 4 ++-- content/en/docs/concepts/cluster-administration/system-metrics.md | 2 +- content/en/docs/concepts/configuration/pod-priority-preemption.md | 2 +- content/en/docs/concepts/containers/runtime-class.md | 2 +- content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md | 2 +- content/en/docs/concepts/extend-kubernetes/operator.md | 2 +- content/en/docs/concepts/extend-kubernetes/service-catalog.md | 2 +- content/en/docs/concepts/overview/kubernetes-api.md | 2 +- content/en/docs/concepts/overview/what-is-kubernetes.md | 3 +-- content/en/docs/concepts/overview/working-with-objects/labels.md | 2 +- content/en/docs/concepts/scheduling-eviction/kube-scheduler.md | 4 ++-- content/en/docs/concepts/services-networking/dual-stack.md | 2 +- content/en/docs/concepts/storage/ephemeral-volumes.md | 11 +++++------ content/en/docs/concepts/storage/persistent-volumes.md | 2 +- content/en/docs/concepts/storage/storage-classes.md | 2 +- content/en/docs/concepts/storage/volumes.md | 5 ++--- content/en/docs/concepts/workloads/_index.md | 2 +- content/en/docs/concepts/workloads/controllers/replicaset.md | 4 ++-- content/en/docs/concepts/workloads/pods/_index.md | 4 ++-- content/en/docs/concepts/workloads/pods/pod-lifecycle.md | 3 ++- ``` --- scripts/lsync.sh | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/scripts/lsync.sh b/scripts/lsync.sh index a1378bf154..9b4bfe1bb9 100755 --- a/scripts/lsync.sh +++ b/scripts/lsync.sh @@ -3,27 +3,37 @@ # This script checks if the English version of a page has changed since a localized # page has been committed. -if [ "$#" -ne 1 ] || ! [ -f "$1" ]; then - echo -e "\nThis script checks if the English version of a page has changed since a " - echo -e "localized page has been committed.\n" +if [ "$#" -ne 1 ] ; then + echo -e "\nThis script checks if the English version of a page has changed since a " >&2 + echo -e "localized page has been committed.\n" >&2 echo -e "Usage:\n\t$0 \n" >&2 echo -e "Example:\n\t$0 content/zh/docs/concepts/_index.md\n" >&2 exit 1 fi +# Check if path exists, and whether it is a directory or a file +if [ ! -e "$1" ] ; then + echo "Path not found: '$1'" >&2 + exit 2 +elif [ -d "$1" ] ; then + IS_DIR=1 + EXTRA_FLAGS="--stat" +else + IS_DIR=0 +fi LOCALIZED="$1" # Try get the English version EN_VERSION=`echo $LOCALIZED | sed "s/content\/..\//content\/en\//g"` -if ! [ -f $EN_VERSION ]; then +if [ $IS_DIR -eq 1 -a ! -e $EN_VERSION ]; then echo "$EN_VERSION has been removed." - exit 2 + exit 3 fi -# Last commit for the localized file +# Last commit for the localized path LASTCOMMIT=`git log -n 1 --pretty=format:%h -- $LOCALIZED` -git diff --exit-code $LASTCOMMIT...HEAD $EN_VERSION +git diff --exit-code $EXTRA_FLAGS $LASTCOMMIT...HEAD $EN_VERSION if [ "$?" -eq 0 ]; then echo "$LOCALIZED is still in sync" From aadf52491a659e5ce711bc18ae16454f3ebf4eaa Mon Sep 17 00:00:00 2001 From: kangni <2881570+kangni@users.noreply.github.com> Date: Sat, 24 Oct 2020 17:12:51 +0800 Subject: [PATCH 10/31] Update cluster-intro.html fix translate error --- .../kubernetes-basics/create-cluster/cluster-intro.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/zh/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html b/content/zh/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html index 43b0c79331..7147587d51 100644 --- a/content/zh/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html +++ b/content/zh/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html @@ -29,7 +29,7 @@ weight: 10

Kubernetes 集群

- Kubernetes 协调一个高可用计算机集群，每个计算机作为独立单元互相连接工作。 Kubernetes 中的抽象允许您将容器化的应用部署到群集，而无需将它们绑定到某个特定的独立计算机。为了使用这种新的部署模型，应用需要以将应用与单个主机分离的方式打包：它们需要被容器化。与过去的那种应用直接以包的方式深度与主机集成的部署模型相比，容器化应用更灵活、更可用。 Kubernetes 以更高效的方式跨群集自动分发和调度应用容器。 Kubernetes 是一个开源平台，并且可应用于生产环境。 + Kubernetes 协调一个高可用计算机集群，每个计算机作为独立单元互相连接工作。 Kubernetes 中的抽象允许您将容器化的应用部署到集群，而无需将它们绑定到某个特定的独立计算机。为了使用这种新的部署模型，应用需要以将应用与单个主机分离的方式打包：它们需要被容器化。与过去的那种应用直接以包的方式深度与主机集成的部署模型相比，容器化应用更灵活、更可用。 Kubernetes 以更高效的方式跨集群自动分发和调度应用容器。 Kubernetes 是一个开源平台，并且可应用于生产环境。

一个 Kubernetes 集群包含两种类型的资源:

    @@ -84,9 +84,9 @@ weight: 10
    -

    在 Kubernetes 上部署应用时，您告诉 Master 启动应用容器。 Master 就编排容器在群集的 Node 上运行。 Node 使用 Master 暴露的 Kubernetes API 与 Master 通信。终端用户也可以使用 Kubernetes API 与集群交互。

    +

    在 Kubernetes 上部署应用时，您告诉 Master 启动应用容器。 Master 就编排容器在集群的 Node 上运行。 Node 使用 Master 暴露的 Kubernetes API 与 Master 通信。终端用户也可以使用 Kubernetes API 与集群交互。

    -

    Kubernetes 既可以部署在物理机上也可以部署在虚拟机上。您可以使用 Minikube 开始部署 Kubernetes 集群。 Minikube 是一种轻量级的 Kubernetes 实现，可在本地计算机上创建 VM 并部署仅包含一个节点的简单集群。 Minikube 可用于 Linux ， macOS 和 Windows 系统。Minikube CLI 提供了用于引导群集工作的多种操作，包括启动、停止、查看状态和删除。在本教程里，您可以使用预装有 Minikube 的在线终端进行体验。

    +

    Kubernetes 既可以部署在物理机上也可以部署在虚拟机上。您可以使用 Minikube 开始部署 Kubernetes 集群。 Minikube 是一种轻量级的 Kubernetes 实现，可在本地计算机上创建 VM 并部署仅包含一个节点的简单集群。 Minikube 可用于 Linux ， macOS 和 Windows 系统。Minikube CLI 提供了用于引导集群工作的多种操作，包括启动、停止、查看状态和删除。在本教程里，您可以使用预装有 Minikube 的在线终端进行体验。

    既然您已经知道 Kubernetes 是什么，让我们转到在线教程并启动我们的第一个 Kubernetes 集群！

    From 59510913abf635bac4e9176ed0b781927af3bd20 Mon Sep 17 00:00:00 2001 From: zacharysarah Date: Sun, 25 Oct 2020 14:42:05 -0700 Subject: [PATCH 11/31] Add temporary banner for KCCNC NA 2020 virtual --- config.toml | 2 +- i18n/en.toml | 4 ++-- static/images/kccnc-na-virtual-2020-white.svg | 1 + 3 files changed, 4 insertions(+), 3 deletions(-) create mode 100644 static/images/kccnc-na-virtual-2020-white.svg diff --git a/config.toml b/config.toml index a59fcbd678..b2fd7c3a5c 100644 --- a/config.toml +++ b/config.toml @@ -157,7 +157,7 @@ github_repo = "https://github.com/kubernetes/website" # param for displaying an announcement block on every page. # See /i18n/en.toml for message text and title. announcement = true -announcement_bg = "#000000" #choose a dark color – text is white +announcement_bg = "#3f0374" # choose a dark color – text is white #Searching k8s_search = true diff --git a/i18n/en.toml b/i18n/en.toml index 899ffdd4bf..6b437fe56c 100644 --- a/i18n/en.toml +++ b/i18n/en.toml @@ -1,10 +1,10 @@ # i18n strings for the English (main) site. # NOTE: Please keep the entries in alphabetical order when editing [announcement_title] -other = "Black lives matter." +other = "KubeCon + CloudNativeCon NA 2020 virtual." [announcement_message] -other = "We stand in solidarity with the Black community.
    Racism is unacceptable.
    It conflicts with the [core values of the Kubernetes project](https://git.k8s.io/community/values.md) and our community does not tolerate it." +other = "4 days of incredible opportunities to collaborate, learn, and share with the entire community!
    November 17 – 20 2020." [caution] other = "Caution:" diff --git a/static/images/kccnc-na-virtual-2020-white.svg b/static/images/kccnc-na-virtual-2020-white.svg new file mode 100644 index 0000000000..70521bcbd3 --- /dev/null +++ b/static/images/kccnc-na-virtual-2020-white.svg @@ -0,0 +1 @@ + \ No newline at end of file From fbe9a593a06c0c4928da1ababe8761cd7d121b35 Mon Sep 17 00:00:00 2001 From: Zach Corleissen Date: Sun, 25 Oct 2020 14:55:56 -0700 Subject: [PATCH 12/31] Update en.toml --- i18n/en.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/i18n/en.toml b/i18n/en.toml index 6b437fe56c..bc25eaf2a1 100644 --- a/i18n/en.toml +++ b/i18n/en.toml @@ -4,7 +4,7 @@ other = "KubeCon + CloudNativeCon NA 2020 virtual." [announcement_message] -other = "4 days of incredible opportunities to collaborate, learn, and share with the entire community!
    November 17 – 20 2020." +other = "4 days of incredible opportunities to collaborate, learn, and share with the entire community!
    November 17 – 20 2020" [caution] other = "Caution:" From eebd0d7cb808d3fa1ed9268197019abd9f2c4a10 Mon Sep 17 00:00:00 2001 From: yuanhao Date: Mon, 26 Oct 2020 10:59:11 +0800 Subject: [PATCH 13/31] [zh] translate docs/setup/production-environment/turnkey/gce.md --- .../production-environment/turnkey/gce.md | 398 ++++++++++++++++++ 1 file changed, 398 insertions(+) create mode 100644 content/zh/docs/setup/production-environment/turnkey/gce.md diff --git a/content/zh/docs/setup/production-environment/turnkey/gce.md b/content/zh/docs/setup/production-environment/turnkey/gce.md new file mode 100644 index 0000000000..63ed0c916b --- /dev/null +++ b/content/zh/docs/setup/production-environment/turnkey/gce.md @@ -0,0 +1,398 @@ +--- +title: 在谷歌计算引擎上运行 Kubernetes +content_type: task +--- + + + + + + +下面的示例创建了一个 Kubernetes 集群，其中包含 3 个工作节点虚拟机和 1 个主虚拟机（即集群中有 4 个虚拟机）。 +这个集群是在你的工作站（或你认为方便的任何地方）设置和控制的。 + + +## {{% heading "prerequisites" %}} + + +如果你想要一个简化的入门体验和 GUI 来管理集群， +请考虑尝试[谷歌 Kubernetes 引擎](https://cloud.google.com/kubernetes-engine/)来安装和管理托管集群。 + + +有一个简单的方式可以使用 Kubernetes 开发环境进行实验， +就是点击下面的按钮，打开 Google Cloud Shell，其中包含了 Kubernetes 源仓库自动克隆的副本。 + + +[![在 Cloud Shell 中打卡](https://gstatic.com/cloudssh/images/open-btn.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/kubernetes/kubernetes&page=editor&open_in_editor=README.md) + + +如果你想要使用定制的二进制或者纯开源的 Kubernetes，请继续阅读下面的指导。 + + +### 前提条件 {#prerequisites} + + +1. 你需要一个启用了计费的谷歌云平台账号。 + 更多细节请访问[谷歌开发者控制台](https://console.cloud.google.com)。 +1. 根据需要安装 `gcloud`。 + `gcloud` 可作为[谷歌云 SDK](https://cloud.google.com/sdk/) 的一部分安装。 +1. 在[谷歌云开发者控制台](https://console.developers.google.com/apis/library) + 启用[计算引擎实例组管理器 API](https://console.developers.google.com/apis/api/replicapool.googleapis.com/overview) +1. 确保将 gcloud 设置成使用你想要的谷歌云平台项目。 + 你可以使用 `gcloud config list project` 检查当前项目， + 并通过 `gcloud config set project ` 修改它。 +1. 通过运行 `gcloud auth login`，确保你拥有 GCloud 的凭据。 +1. （可选）如果需要调用 GCE 的 API，你也必须运行 `gcloud auth application-default login`。 +1. 确保你能通过命令行启动 GCE 虚拟机。 + 至少确保你可以完成 GCE 快速入门的[创建实例](https://cloud.google.com/compute/docs/instances/#startinstancegcloud)部分。 +1. 确保你在没有交互式提示的情况下 SSH 到虚拟机。 + 查看 GCE 快速入门的[登录实例](https://cloud.google.com/compute/docs/instances/#sshing)部分。 + + + + + +## 启动集群 + + +你可以安装一个客户端，并使用这些命令的其中之一来启动集群（我们列出的两种情况，因为你的机器可能只安装了二者之一）： + +```shell +curl -sS https://get.k8s.io | bash +``` + +或 + +```shell +wget -q -O - https://get.k8s.io | bash +``` + + +这条命令结完成后，你将会有 1 个主虚拟机和 4 个工作虚拟机，它们一起作为 Kubernetes 集群运行。 + + +默认情况下，有一些容器已经在你的集群上运行。 +像 `fluentd` 这样的容器提供[日志记录](/zh/docs/concepts/cluster-administration/logging/)， +而 `heapster` 提供[监控](https://releases.k8s.io/master/cluster/addons/cluster-monitoring/README.md)服务。 + + +由上述命令运行的脚本创建了一个名称/前缀为“kubernetes”的集群。 +它定义了一个特定的集群配置，所以此脚本只能运行一次。 + + +或者，你可以通过[这个页面](https://github.com/kubernetes/kubernetes/releases)下载和安装最新版本的 Kubernetes， +然后运行 `/cluster/kube-up.sh` 脚本启动集群： + +```shell +cd kubernetes +cluster/kube-up.sh +``` + + +如果你希望在项目中运行多个集群，希望使用一个不同名称，或者不同数量工作节点的集群， +请查看 `/cluster/gce/config-default.sh` 文件，以便在启动集群之前进行更细粒度的配置。 + + + +如果你遇到了问题，请参阅[错误排查](#troubleshooting)一节， +发布到 [Kubernetes 论坛](https://discuss.kubernetes.io)，或者来 `#gke` Slack 频道中提问。 + + +接下来的几个步骤会告诉你: + + +1. 如何在你的工作站设置命令行客户端来管理集群 +2. 如何使用集群的示例 +3. 如何删除集群 +4. 如果以非默认选项启动集群（如规模较大的集群） + + +## 在你的工作站安装 Kubernetes 命令行工具 + + +集群启动脚本将在你的工作站上留下一个正在运行的集群和一个 `kubernetes` 目录。 + + +[kubectl](/zh/docs/reference/kubectl/kubectl/) 工具控制 Kubernetes 集群管理器。 +它允许你检查集群资源，创建、删除和更新组件等等。 +你将使用它来查看新集群并启动示例应用程序。 + + +你可以使用 `gcloud` 在工作站上安装 `kubectl` 命令行工具: + +```shell +gcloud components install kubectl +``` + +{{< note >}} + +与 `gcloud` 绑定的 kubectl 版本可能比 get.k8s.io 安装脚本所下载的更老。。 +查看[安装 kubectl](/zh/docs/tasks/tools/install-kubectl/) 文档，了解如何在工作站上设置最新的 `kubectl`。 +{{< /note >}} + + +## 开始使用你的集群 + + +### 检查你的集群 + + +一旦 `kubectl` 存在于你的路径中，你就可以使用它来查看集群，例如，运行： + +``` +kubectl get --all-namespaces services +``` + + +应该显示 [services](/zh/docs/concepts/services-networking/service/) 集合，看起来像这样： + +``` +NAMESPACE NAME TYPE CLUSTER_IP EXTERNAL_IP PORT(S) AGE +default kubernetes ClusterIP 10.0.0.1 443/TCP 1d +kube-system kube-dns ClusterIP 10.0.0.2 53/TCP,53/UDP 1d +kube-system kube-ui ClusterIP 10.0.0.3 80/TCP 1d +... +``` + + +类似的，你可以查看在集群启动时创建的 [pods](/zh/docs/concepts/workloads/pods/) 的集合。 +你可以通过命令： + +``` +kubectl get --all-namespaces pods +``` + + +你将会看到 Pod 的列表，看起来像这样（名称和细节会有所不同）： + +``` +NAMESPACE NAME READY STATUS RESTARTS AGE +kube-system coredns-5f4fbb68df-mc8z8 1/1 Running 0 15m +kube-system fluentd-cloud-logging-kubernetes-minion-63uo 1/1 Running 0 14m +kube-system fluentd-cloud-logging-kubernetes-minion-c1n9 1/1 Running 0 14m +kube-system fluentd-cloud-logging-kubernetes-minion-c4og 1/1 Running 0 14m +kube-system fluentd-cloud-logging-kubernetes-minion-ngua 1/1 Running 0 14m +kube-system kube-ui-v1-curt1 1/1 Running 0 15m +kube-system monitoring-heapster-v5-ex4u3 1/1 Running 1 15m +kube-system monitoring-influx-grafana-v1-piled 2/2 Running 0 15m +``` + + +一些 Pod 启动可能需要几秒钟（在此期间它们会显示 `Pending`）， +但是在短时间后请检查它们是否都显示为 `Running`。 + + +### 运行示例 + + +那么，看[一个简单的 nginx 示例](/zh/docs/tasks/run-application/run-stateless-application-deployment/)来试试你的新集群。 + + +要获得完整的应用，请查看 [examples 目录](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/)。 +[guestbook 示例](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/guestbook/) +是一个很好的“入门”演练。 + + +## 拆除集群 + + +要移除/删除/拆除集群，请使用 `kube-down.sh` 脚本。 + +```shell +cd kubernetes +cluster/kube-down.sh +``` + + +同样地，同一目录下的 `kube-up.sh` 脚本会让集群重新运行起来。 +你不需要再次运行 `curl` 或 `wget` 命令：现在 Kubernetes 集群所需的一切都在你的工作站上。 + + +## 定制 + + +上面的脚本依赖于谷歌存储来保存 Kubernetes 发行版本。 +该脚本然后（默认情况下）会启动 1 个主虚拟机和 3 个工作虚拟机。 +你可以通过编辑 `kubernetes/cluster/gce/config-default.sh` 来调整这些参数。 +你可以在[这里](https://gist.github.com/satnam6502/fc689d1b46db9772adea)查看成功创建集群的记录。 + + +## 故障排除 {#troubleshooting} + + +### 项目设置 + + +你需要启用 Google Cloud Storage API 和 Google Cloud Storage JSON API。 +默认情况下，对新项目都是激活的。 +如果未激活，可以在谷歌云控制台设置。 +更多细节，请查看[谷歌云存储 JSON API 概览](https://cloud.google.com/storage/docs/json_api/)。 + + +也要确保——正如在[前提条件](#prerequisites)中列出的那样—— +你已经启用了 `Compute Engine Instance Group Manager API`， +并且可以像 [GCE 快速入门](https://cloud.google.com/compute/docs/quickstart)指导那样从命令行启动 GCE 虚拟机。 + + +### 集群初始化过程停滞 + + +如果 Kubernetes 启动脚本停滞，等待 API 可达， +你可以 SSH 登录到主虚拟机和工作虚拟机， +通过查看 `/var/log/startupscript.log` 日志来排除故障。 + + +**一旦解决了这个问题，你应该在部分集群创建之后运行 `kube-down.sh` 来进行清理**，然后再运行 `kube-up.sh` 重试。 + +### SSH + + +如果在 SSH 登录实例时遇到困难，确保 GCE 防火墙没有阻塞你虚拟机的 22 端口。 +默认情况下应该可用，但是如果你编辑了防火墙规则或者创建了一个新的非默认网络， +你需要公开它：`gcloud compute firewall-rules create default-ssh --network= --description "SSH allowed from anywhere" --allow tcp:22` + + +此外，你的 GCE SSH 密钥不能有密码，否则你需要使用 `ssh-agent`。 + + +### 网络 + + +虚拟机实例必须能够使用它们的私有 IP 彼此连接。 +该脚本使用 "default" 网络，此网络应该有一个名为 "default-allow-internal" 的防火墙规则， +此规则允许通过私有 IP 上的任何端口进行通信。 +如果默认网络中缺少此规则，或者更改了 `cluster/config-default.sh` 中使用的网络， +用以下字段值创建一个新规则: + + +* 源范围：`10.0.0.0/8` +* 允许的协议和端口：`tcp:1-65535;udp:1-65535;icmp` + + +## 支持等级 + + +IaaS 提供商 | 配置管理 | 操作系统 | 网络 | 文档 | 符合率 | 支持等级 +---------- | --------- | ------ | ---- | --------------------------------------------------------- | ----- | ------- +GCE | Saltstack | Debian | GCE | [docs](/zh/docs/setup/production-environment/turnkey/gce/) | | Project From 1f40f941c843ea071af916c09cd551cb0ed6cb18 Mon Sep 17 00:00:00 2001 From: WangXiangUSTC Date: Mon, 26 Oct 2020 11:33:42 +0800 Subject: [PATCH 14/31] Update pod-security-policy.md --- content/zh/docs/concepts/policy/pod-security-policy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/concepts/policy/pod-security-policy.md b/content/zh/docs/concepts/policy/pod-security-policy.md index be7c5a88b5..5d87012e66 100644 --- a/content/zh/docs/concepts/policy/pod-security-policy.md +++ b/content/zh/docs/concepts/policy/pod-security-policy.md @@ -862,7 +862,7 @@ to effectively limit access to the specified `pathPrefix`. {{< warning >}} 容器如果对宿主文件系统拥有不受限制的访问权限，就可以有很多种方式提升自己的特权， -包括读取其他容器中的数据、滥用系统服务（如 `kubelet`）`的凭据信息等。 +包括读取其他容器中的数据、滥用系统服务（如 `kubelet`）的凭据信息等。 由可写入的目录所构造的 `hostPath` 卷能够允许容器写入数据到宿主文件系统， 并且在写入时避开 `pathPrefix` 所设置的目录限制。 From 79e2df20b010d9247a679b61c6bcc4e99a8e05f9 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Mon, 26 Oct 2020 16:50:29 +0800 Subject: [PATCH 15/31] Fix smoke test doc --- content/en/docs/test.md | 52 ++++++++++++++++----------------------- static/images/pencil.png | Bin 700 -> 1405 bytes 2 files changed, 21 insertions(+), 31 deletions(-) diff --git a/content/en/docs/test.md b/content/en/docs/test.md index 071a873b37..c052cb5f9c 100644 --- a/content/en/docs/test.md +++ b/content/en/docs/test.md @@ -61,9 +61,7 @@ Markdown doesn't have strict rules about how to process lists. When we moved from Jekyll to Hugo, we broke some lists. To fix them, keep the following in mind: -- Make sure you indent sub-list items **4 spaces** rather than the 2 that you - may be used to. Counter-intuitively, you need to indent block-level content - within a list item an extra 4 spaces too. +- Make sure you indent sub-list items **2 spaces**. - To end a list and start another, you need a HTML comment block on a new line between the lists, flush with the left-hand border. The first list won't end @@ -74,10 +72,9 @@ mind: - This is a list item * This is another list item in the same list - You can mix `-` and `*` - - To make a sub-item, indent two tabstops (4 spaces). **This is different - from Jekyll and Kramdown.** - - This is a sub-sub-item. Indent two more tabstops (4 more spaces). - - Another sub-item. + - To make a sub-item, indent two spaces. + - This is a sub-sub-item. Indent two more spaces. + - Another sub-item. @@ -85,15 +82,15 @@ mind: consecutive lists. **The HTML comment needs to be at the left margin.** - Bullet lists can have paragraphs or block elements within them. - Indent the content to be one tab stop beyond the text of the bullet - point. **This paragraph and the code block line up with the second `l` in - `Bullet` above.** + Indent the content to be the same as the first line of the bullet point. + **This paragraph and the code block line up with the first `B` in `Bullet` + above.** - ```bash - ls -l - ``` + ```bash + ls -l + ``` - - And a sub-list after some block-level content + - And a sub-list after some block-level content - A bullet list item can contain a numbered list. 1. Numbered sub-list item 1 @@ -116,13 +113,13 @@ mind: two consecutive lists. **The HTML comment needs to be at the left margin.** 2. Numbered lists can have paragraphs or block elements within them. - Just indent the content to be one tab stop beyond the text of the bullet - point. **This paragraph and the code block line up with the `m` in - `Numbered` above.** + Just indent the content to be the same as the first line of the bullet + point. **This paragraph and the code block line up with the `N` in + `Numbered` above.** - ```bash - ls -l - ``` + ```bash + ls -l + ``` - And a sub-list after some block-level content. This is at the same "level" as the paragraph and code block above, despite being indented @@ -178,13 +175,6 @@ back-ticks (code fences) for code blocks.** This allows you to specify the language of the enclosed code, which enables syntax highlighting. It is also more predictable than using indentation. -{{< warning >}} -There is one situation where you need to use indentation for code blocks: when -the contents of the code block contain lines starting with `-` or `*` characters. -This is due to -[blackfriday issue #239](https://github.com/russross/blackfriday/issues/239). -{{< /warning >}} - ``` this is a code block created by back-ticks ``` @@ -241,7 +231,7 @@ character. The square brackets contain the image's alt text. Try to always use alt text so that people using screen readers can get some benefit from the image. -![pencil icon](/static/images/pencil.png) +![pencil icon](/images/pencil.png) To specify extended attributes, such as width, title, caption, etc, use the figure shortcode, @@ -249,17 +239,17 @@ which is preferred to using a HTML `` tag. Also, if you need the image to also be a hyperlink, use the `link` attribute, rather than wrapping the whole figure in Markdown link syntax as shown below. -{{< figure src="/static/images/pencil.png" title="Pencil icon" caption="Image used to illustrate the figure shortcode" width="200px" >}} +{{< figure src="/images/pencil.png" title="Pencil icon" caption="Image used to illustrate the figure shortcode" width="200px" >}} Even if you choose not to use the figure shortcode, an image can also be a link. This time the pencil icon links to the Kubernetes website. Outer square brackets enclose the entire image tag, and the link target is in the parentheses at the end. -[![pencil icon](/static/images/pencil.png)](https://kubernetes.io) +[![pencil icon](/images/pencil.png)](https://kubernetes.io) You can also use HTML for images, but it is not preferred. -pencil icon +pencil icon ## Tables diff --git a/static/images/pencil.png b/static/images/pencil.png index 300600da05e637df0b8bcf0743e941eb6e6c27a8..4f0000f639f6772550c2b39e563a3dddcc8a917b 100644 GIT binary patch literal 1405 zcmeAS@N?(olHy`uVBq!ia0vp^Mj*_=1|;R|J2nC-#^NA%Cx&(BWL^R}0jUw5X}-P; zT0k}j0~4bV12aeo5Hhr9GO&Qz3=C>Ont_3N0V6_o0TW!-XaO^V4N{mc*0>dDNMvS6 zL`j6Nk5zJhu3lnFep0GlMQ#B|0fSA26_A;mT9T+xk(-lOY*k^a1Xf`MWP^nDl@!2A zO0sR0B76fBob!uP6-@O^^bC~jxD*r=Y>HCStb$zJpxS{vTcwPWk^(Dz{qpj1y>er{ z{GxPyLrY6beFGzXBO_g)3f4M^0=zbG>mXfw!sJ3||=N)$1u zJvRCv%aI%d@hMmo=v6x|8+~}N*>U+CQjY}2NtvgMV@L+;+i9LY!hsSE)|dUVziXyy zcDM*=Mmst-ol@E~#iONLU06ui*(t@+_{t2=**;T-e0K#gTE- zFn0;7cC_Nstv=H~`ucE8C|F<|te?*}`Fh&D|Nq|q{{KDALZ-rz`2vFp1Fr*u`pwoP zr1k05(pLti!rp~5IUYIlEL|35-LT+AWo1Y}=iPk^i*;|-{}xEk=GtZY>AnN!G^aa$ z*VkNs`>kI`I_Kd}=7d_x=KW{ONSz4^hhdv)l<7{)Rl*T9%HhnmIN zdCu-T^h21%f6bZykG@V&$XAJ+C@|0R_Kj*r2i4-AdnR06`O|22;>kza9FJZfsXZ4Q zB%t^E+4G+VZ(i#-^Fxef&6~pNUCX3)>3=@F#3|{Z+1B$jtmVERmkVs{wS8PBuy@(J zjmw-R3wdALPtV$umv65o@}wyz!#Thur}>2N>aB{)pJ2Un+!77=l~jdo5rEylunB*fL}VD+Nx%g?Svvhm6a-YoRL);n#rgdX3NmJ`{_ zqkmoIIDPC#S+h_7%oQFBmTg*a{`Dt|=OxMc{Bt{N^M0qUeSGqW1uNq>7rom8Q$*x^ zjhzhQpM9+2(I{0x0*Gq&z1j*Gyb+<4@)z z8EN-7-?-k$U0%h}q~P^xhrkKf@JFZ5AM>%f5F4_jO_`x-qxrXYE#H5=HTF2ObdAjh z{WTn(e3MnuB^?5nU+Vd~dghI6L$m+iC0!c2{U^$O-|_F>@1O|}>OJTA8XB0PrgtE3 bL*4`ZiyC&$nJNmPB9y_?)z4*}Q$iB}B!?={ literal 700 zcmeAS@N?(olHy`uVBq!ia0vp^Mj*_=3?wxlRx~p(FzN*Ogt!8^|3?9FA>be8r~(YH zVvt^+k3*kbJp&!CHa4PuIOQyt5=^ue^rDLf;RC$M~PE@+>WTWG?mC z>vzUCU7j~93#xueFU$R6A@pvA_xJ2d*RM9$rv;>G-#_p7ms9CxN=flX-WxA2|J$SE ze729Rrhf9)9Cn~}cRXDjLnI{M9(--Z6ez;>KwoXH&%$NRPFHTYq?IgFaama8v2;q( z-T$^Ftn<>}-v9R7Dexcj@l#q)GW?>79owFL6R3=R@Oka)55lYmwr$+$YSpC391~?B zq}r8x{NPlMw{PC5e%It%*Bo+diF08I&$=_6|4pjZbfjaR@7yy}SHzob$Ek;1p5l)- zajm-*`gd1harCBxODmPjLj=xN7yOiqdiyN-VinW$-#ahATD`6T;hYJh0-H Date: Wed, 23 Sep 2020 14:18:59 -0400 Subject: [PATCH 16/31] testing styling of resources, plugins, drivers --- content/en/docs/concepts/storage/volumes.md | 911 ++++++++++---------- 1 file changed, 440 insertions(+), 471 deletions(-) diff --git a/content/en/docs/concepts/storage/volumes.md b/content/en/docs/concepts/storage/volumes.md index e4f38e7d2b..7645b7e5fa 100644 --- a/content/en/docs/concepts/storage/volumes.md +++ b/content/en/docs/concepts/storage/volumes.md @@ -11,119 +11,80 @@ weight: 10 -On-disk files in a Container are ephemeral, which presents some problems for -non-trivial applications when running in Containers. First, when a Container -crashes, kubelet will restart it, but the files will be lost - the -Container starts with a clean state. Second, when running Containers together -in a `Pod` it is often necessary to share files between those Containers. The -Kubernetes `Volume` abstraction solves both of these problems. - +On-disk files in a container are ephemeral, which presents some problems for +non-trivial applications when running in containers. One problem +is the loss of files when a container crashes. The kubelet restarts the container +but with a clean state. A second problem occurs when sharing files +between containers running together in a `Pod`. +The Kubernetes {{< glossary_tooltip text="volume" term_id="volume" >}} abstraction +solves both of these problems. Familiarity with [Pods](/docs/concepts/workloads/pods/) is suggested. ## Background -Docker also has a concept of +Docker has a concept of [volumes](https://docs.docker.com/storage/), though it is -somewhat looser and less managed. In Docker, a volume is simply a directory on -disk or in another Container. Lifetimes are not managed and until very -recently there were only local-disk-backed volumes. Docker now provides volume -drivers, but the functionality is very limited for now (e.g. as of Docker 1.7 -only one volume driver is allowed per Container and there is no way to pass -parameters to volumes). +somewhat looser and less managed. A Docker volume is a directory on +disk or in another container. Docker provides volume +drivers, but the functionality is somewhat limited. -A Kubernetes volume, on the other hand, has an explicit lifetime - the same as -the Pod that encloses it. Consequently, a volume outlives any Containers that run -within the Pod, and data is preserved across Container restarts. Of course, when a -Pod ceases to exist, the volume will cease to exist, too. Perhaps more -importantly than this, Kubernetes supports many types of volumes, and a Pod can -use any number of them simultaneously. +Kubernetes supports many types of volumes. A {{< glossary_tooltip term_id="pod" text="Pod" >}} +can use any number of volume types simultaneously. +Ephemeral volume types have a lifetime of a pod, but persistent volumes exist beyond +the lifetime of a pod. Consequently, a volume outlives any containers +that run within the pod, and data is preserved across container restarts. When a +pod ceases to exist, the volume is destroyed. At its core, a volume is just a directory, possibly with some data in it, which -is accessible to the Containers in a Pod. How that directory comes to be, the +is accessible to the containers in a pod. How that directory comes to be, the medium that backs it, and the contents of it are determined by the particular volume type used. -To use a volume, a Pod specifies what volumes to provide for the Pod (the -`.spec.volumes` -field) and where to mount those into Containers (the -`.spec.containers[*].volumeMounts` -field). - +To use a volume, specify the volumes to provide for the Pod in `.spec.volumes` +and declare where to mount those volumes into containers in `.spec.containers[*].volumeMounts`. A process in a container sees a filesystem view composed from their Docker -image and volumes. The [Docker image](https://docs.docker.com/userguide/dockerimages/) is at the root of the -filesystem hierarchy, and any volumes are mounted at the specified paths within -the image. Volumes can not mount onto other volumes or have hard links to -other volumes. Each Container in the Pod must independently specify where to +image and volumes. The [Docker image](https://docs.docker.com/userguide/dockerimages/) +is at the root of the filesystem hierarchy. Volumes mount at the specified paths within +the image. Volumes can not mount onto other volumes or have hard links to +other volumes. Each Container in the Pod's configuration must independently specify where to mount each volume. -## Types of Volumes +## Types of Volumes {#volume-types} -Kubernetes supports several types of Volumes: - - * [awsElasticBlockStore](#awselasticblockstore) - * [azureDisk](#azuredisk) - * [azureFile](#azurefile) - * [cephfs](#cephfs) - * [cinder](#cinder) - * [configMap](#configmap) - * [csi](#csi) - * [downwardAPI](#downwardapi) - * [emptyDir](#emptydir) - * [fc (fibre channel)](#fc) - * [flexVolume](#flexVolume) - * [flocker](#flocker) - * [gcePersistentDisk](#gcepersistentdisk) - * [gitRepo (deprecated)](#gitrepo) - * [glusterfs](#glusterfs) - * [hostPath](#hostpath) - * [iscsi](#iscsi) - * [local](#local) - * [nfs](#nfs) - * [persistentVolumeClaim](#persistentvolumeclaim) - * [projected](#projected) - * [portworxVolume](#portworxvolume) - * [quobyte](#quobyte) - * [rbd](#rbd) - * [scaleIO](#scaleio) - * [secret](#secret) - * [storageos](#storageos) - * [vsphereVolume](#vspherevolume) - -We welcome additional contributions. +Kubernetes supports several types of volumes. ### awsElasticBlockStore {#awselasticblockstore} -An `awsElasticBlockStore` volume mounts an Amazon Web Services (AWS) [EBS -Volume](https://aws.amazon.com/ebs/) into your Pod. Unlike -`emptyDir`, which is erased when a Pod is removed, the contents of an EBS -volume are preserved and the volume is merely unmounted. This means that an -EBS volume can be pre-populated with data, and that data can be "handed off" -between Pods. +An `awsElasticBlockStore` volume mounts an Amazon Web Services (AWS) +[EBS volume](https://aws.amazon.com/ebs/) into your pod. Unlike +`emptyDir`, which is erased when a pod is removed, the contents of an EBS +volume are persisted and the volume is unmounted. This means that an +EBS volume can be pre-populated with data, and that data can be shared between pods. -{{< caution >}} -You must create an EBS volume using `aws ec2 create-volume` or the AWS API before you can use it. -{{< /caution >}} +{{< note >}} +You must create an EBS volume by using `aws ec2 create-volume` or the AWS API before you can use it. +{{< /note >}} There are some restrictions when using an `awsElasticBlockStore` volume: -* the nodes on which Pods are running must be AWS EC2 instances -* those instances need to be in the same region and availability-zone as the EBS volume +* the nodes on which pods are running must be AWS EC2 instances +* those instances need to be in the same region and availability zone as the EBS volume * EBS only supports a single EC2 instance mounting a volume -#### Creating an EBS volume +#### Creating an AWS EBS volume -Before you can use an EBS volume with a Pod, you need to create it. +Before you can use an EBS volume with a pod, you need to create it. ```shell aws ec2 create-volume --availability-zone=eu-west-1a --size=10 --volume-type=gp2 ``` -Make sure the zone matches the zone you brought up your cluster in. (And also check that the size and EBS volume -type are suitable for your use!) +Make sure the zone matches the zone you brought up your cluster in. Check that the size and EBS volume +type are suitable for your use. -#### AWS EBS Example configuration +#### AWS EBS configuration example ```yaml apiVersion: v1 @@ -141,37 +102,39 @@ spec: - name: test-volume # This AWS EBS volume must already exist. awsElasticBlockStore: - volumeID: + volumeID: "" fsType: ext4 ``` -#### CSI Migration +#### AWS EBS CSI migration {{< feature-state for_k8s_version="v1.17" state="beta" >}} -The CSI Migration feature for awsElasticBlockStore, when enabled, shims all plugin operations -from the existing in-tree plugin to the `ebs.csi.aws.com` Container -Storage Interface (CSI) Driver. In order to use this feature, the [AWS EBS CSI -Driver](https://github.com/kubernetes-sigs/aws-ebs-csi-driver) +The `CSIMigration` feature for `awsElasticBlockStore`, when enabled, redirects +all plugin operations from the existing in-tree plugin to the `ebs.csi.aws.com` Container +Storage Interface (CSI) driver. In order to use this feature, the [AWS EBS CSI +driver](https://github.com/kubernetes-sigs/aws-ebs-csi-driver) must be installed on the cluster and the `CSIMigration` and `CSIMigrationAWS` -Beta features must be enabled. +beta features must be enabled. + +#### AWS EBS CSI migration complete -#### CSI Migration Complete {{< feature-state for_k8s_version="v1.17" state="alpha" >}} -To turn off the awsElasticBlockStore storage plugin from being loaded by controller manager and kubelet, you need to set this feature flag to true. This requires `ebs.csi.aws.com` Container Storage Interface (CSI) driver being installed on all worker nodes. +To disable the `awsElasticBlockStore` storage plugin from being loaded by the controller manager +and the kubelet, set the `CSIMigrationAWSComplete` flag to `true`. This feature requires the `ebs.csi.aws.com` Container Storage Interface (CSI) driver installed on all worker nodes. ### azureDisk {#azuredisk} -A `azureDisk` is used to mount a Microsoft Azure [Data Disk](https://azure.microsoft.com/en-us/documentation/articles/virtual-machines-linux-about-disks-vhds/) into a Pod. +The `azureDisk` volume type mounts a Microsoft Azure [Data Disk](https://docs.microsoft.com/en-us/azure/aks/csi-storage-drivers) into a pod. -More details can be found [here](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/azure_disk/README.md). +For more details, see the [`azureDisk` volume plugin](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/azure_disk/README.md). -#### CSI Migration +#### azureDisk CSI migration {{< feature-state for_k8s_version="v1.19" state="beta" >}} -The CSI Migration feature for azureDisk, when enabled, shims all plugin operations +The `CSIMigration` feature for `azureDisk`, when enabled, redirects all plugin operations from the existing in-tree plugin to the `disk.csi.azure.com` Container Storage Interface (CSI) Driver. In order to use this feature, the [Azure Disk CSI Driver](https://github.com/kubernetes-sigs/azuredisk-csi-driver) @@ -180,46 +143,46 @@ features must be enabled. ### azureFile {#azurefile} -A `azureFile` is used to mount a Microsoft Azure File Volume (SMB 2.1 and 3.0) -into a Pod. +The `azureFile` volume type mounts a Microsoft Azure File volume (SMB 2.1 and 3.0) +into a pod. -More details can be found [here](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/azure_file/README.md). +For more details, see the [`azureFile` volume plugin](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/azure_file/README.md). -#### CSI Migration +#### azureFile CSI migration {{< feature-state for_k8s_version="v1.15" state="alpha" >}} -The CSI Migration feature for azureFile, when enabled, shims all plugin operations +The `CSIMigration` feature for `azureFile`, when enabled, redirects all plugin operations from the existing in-tree plugin to the `file.csi.azure.com` Container Storage Interface (CSI) Driver. In order to use this feature, the [Azure File CSI Driver](https://github.com/kubernetes-sigs/azurefile-csi-driver) must be installed on the cluster and the `CSIMigration` and `CSIMigrationAzureFile` -Alpha features must be enabled. +alpha features must be enabled. -### cephfs {#cephfs} +### cephfs A `cephfs` volume allows an existing CephFS volume to be -mounted into your Pod. Unlike `emptyDir`, which is erased when a Pod is +mounted into your Pod. Unlike `emptyDir`, which is erased when a pod is removed, the contents of a `cephfs` volume are preserved and the volume is merely -unmounted. This means that a CephFS volume can be pre-populated with data, and -that data can be "handed off" between Pods. CephFS can be mounted by multiple +unmounted. This means that a `cephfs` volume can be pre-populated with data, and +that data can be shared between pods. The `cephfs` volume can be mounted by multiple writers simultaneously. -{{< caution >}} +{{< note >}} You must have your own Ceph server running with the share exported before you can use it. -{{< /caution >}} +{{< /note >}} See the [CephFS example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/volumes/cephfs/) for more details. -### cinder {#cinder} +### cinder {{< note >}} -Prerequisite: Kubernetes with OpenStack Cloud Provider configured. +Kubernetes must be configured with the OpenStack cloud provider. {{< /note >}} -`cinder` is used to mount OpenStack Cinder Volume into your Pod. +The `cinder` volume type is used to mount the OpenStack Cinder volume into your pod. -#### Cinder Volume Example configuration +#### Cinder volume configuration example ```yaml apiVersion: v1 @@ -237,33 +200,32 @@ spec: - name: test-volume # This OpenStack volume must already exist. cinder: - volumeID: + volumeID: "" fsType: ext4 ``` -#### CSI Migration +#### OpenStack CSI migration {{< feature-state for_k8s_version="v1.18" state="beta" >}} -The CSI Migration feature for Cinder, when enabled, shims all plugin operations +The `CSIMigration` feature for Cinder, when enabled, redirects all plugin operations from the existing in-tree plugin to the `cinder.csi.openstack.org` Container Storage Interface (CSI) Driver. In order to use this feature, the [Openstack Cinder CSI Driver](https://github.com/kubernetes/cloud-provider-openstack/blob/master/docs/using-cinder-csi-plugin.md) must be installed on the cluster and the `CSIMigration` and `CSIMigrationOpenStack` -Beta features must be enabled. +beta features must be enabled. -### configMap {#configmap} +### configMap -The [`configMap`](/docs/tasks/configure-pod-container/configure-pod-configmap/) resource -provides a way to inject configuration data into Pods. -The data stored in a `ConfigMap` object can be referenced in a volume of type -`configMap` and then consumed by containerized applications running in a Pod. +A [ConfigMap](/docs/tasks/configure-pod-container/configure-pod-configmap/) +provides a way to inject configuration data into pods. +The data stored in a ConfigMap can be referenced in a volume of type +`configMap` and then consumed by containerized applications running in a pod. -When referencing a `configMap` object, you can simply provide its name in the -volume to reference it. You can also customize the path to use for a specific -entry in the ConfigMap. -For example, to mount the `log-config` ConfigMap onto a Pod called `configmap-pod`, -you might use the YAML below: +When referencing a ConfigMap, you provide the name of the ConfigMap in the +volume. You can customize the path to use for a specific +entry in the ConfigMap. The following configuration shows how to mount +the `log-config` ConfigMap onto a Pod called `configmap-pod`: ```yaml apiVersion: v1 @@ -287,65 +249,61 @@ spec: ``` The `log-config` ConfigMap is mounted as a volume, and all contents stored in -its `log_level` entry are mounted into the Pod at path "`/etc/config/log_level`". +its `log_level` entry are mounted into the Pod at path `/etc/config/log_level`. Note that this path is derived from the volume's `mountPath` and the `path` keyed with `log_level`. -{{< caution >}} -You must create a [ConfigMap](/docs/tasks/configure-pod-container/configure-pod-configmap/) before you can use it. -{{< /caution >}} - {{< note >}} -A Container using a ConfigMap as a [subPath](#using-subpath) volume mount will not -receive ConfigMap updates. -{{< /note >}} +* You must create a [ConfigMap](/docs/tasks/configure-pod-container/configure-pod-configmap/) + before you can use it. -{{< note >}} -Text data is exposed as files using the UTF-8 character encoding. To use some other character encoding, use binaryData. -{{< /note >}} +* A container using a ConfigMap as a [`subPath`](#using-subpath) volume mount will not + receive ConfigMap updates. +* Text data is exposed as files using the UTF-8 character encoding. For other character encodings, use `binaryData`. +{{< /note >}} ### downwardAPI {#downwardapi} -A `downwardAPI` volume is used to make downward API data available to applications. +A `downwardAPI` volume makes downward API data available to applications. It mounts a directory and writes the requested data in plain text files. {{< note >}} -A Container using Downward API as a [subPath](#using-subpath) volume mount will not -receive Downward API updates. +A container using the downward API as a [`subPath`](#using-subpath) volume mount will not +receive downward API updates. {{< /note >}} -See the [`downwardAPI` volume example](/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/) for more details. +See the [downward API example](/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/) for more details. ### emptyDir {#emptydir} -An `emptyDir` volume is first created when a Pod is assigned to a Node, and -exists as long as that Pod is running on that node. As the name says, it is -initially empty. Containers in the Pod can all read and write the same +An `emptyDir` volume is first created when a Pod is assigned to a node, and +exists as long as that Pod is running on that node. As the name says, the +`emptyDir` volume is initially empty. All containers in the Pod can read and write the same files in the `emptyDir` volume, though that volume can be mounted at the same -or different paths in each Container. When a Pod is removed from a node for -any reason, the data in the `emptyDir` is deleted forever. +or different paths in each container. When a Pod is removed from a node for +any reason, the data in the `emptyDir` is deleted permanently. {{< note >}} -A Container crashing does *NOT* remove a Pod from a node, so the data in an `emptyDir` volume is safe across Container crashes. +A container crashing does *not* remove a Pod from a node. The data in an `emptyDir` volume +is safe across container crashes. {{< /note >}} Some uses for an `emptyDir` are: * scratch space, such as for a disk-based merge sort * checkpointing a long computation for recovery from crashes -* holding files that a content-manager Container fetches while a webserver - Container serves the data +* holding files that a content-manager container fetches while a webserver + container serves the data -By default, `emptyDir` volumes are stored on whatever medium is backing the -node - that might be disk or SSD or network storage, depending on your -environment. However, you can set the `emptyDir.medium` field to `"Memory"` -to tell Kubernetes to mount a tmpfs (RAM-backed filesystem) for you instead. +Depending on your environment, `emptyDir` volumes are stored on whatever medium that backs the +node such as disk or SSD, or network storage. However, if you set the `emptyDir.medium` field +to `"Memory"`, Kubernetes mounts a tmpfs (RAM-backed filesystem) for you instead. While tmpfs is very fast, be aware that unlike disks, tmpfs is cleared on -node reboot and any files you write will count against your Container's +node reboot and any files you write count against your container's memory limit. -#### Example Pod +#### emptyDir configuration example ```yaml apiVersion: v1 @@ -366,69 +324,72 @@ spec: ### fc (fibre channel) {#fc} -An `fc` volume allows an existing fibre channel volume to be mounted in a Pod. -You can specify single or multiple target World Wide Names using the parameter -`targetWWNs` in your volume configuration. If multiple WWNs are specified, +An `fc` volume type allows an existing fibre channel block storage volume +to mount in a Pod. You can specify single or multiple target world wide names (WWNs) +using the parameter `targetWWNs` in your Volume configuration. If multiple WWNs are specified, targetWWNs expect that those WWNs are from multi-path connections. -{{< caution >}} -You must configure FC SAN Zoning to allocate and mask those LUNs (volumes) to the target WWNs beforehand so that Kubernetes hosts can access them. -{{< /caution >}} +{{< note >}} +You must configure FC SAN Zoning to allocate and mask those LUNs (volumes) to the target WWNs +beforehand so that Kubernetes hosts can access them. +{{< /note >}} -See the [FC example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/fibre_channel) for more details. +See the [fibre channel example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/fibre_channel) for more details. -### flocker {#flocker} +### flocker (deprecated) {#flocker} -[Flocker](https://github.com/ClusterHQ/flocker) is an open-source clustered Container data volume manager. It provides management +[Flocker](https://github.com/ClusterHQ/flocker) is an open-source, clustered +container data volume manager. Flocker provides management and orchestration of data volumes backed by a variety of storage backends. A `flocker` volume allows a Flocker dataset to be mounted into a Pod. If the dataset does not already exist in Flocker, it needs to be first created with the Flocker CLI or by using the Flocker API. If the dataset already exists it will be -reattached by Flocker to the node that the Pod is scheduled. This means data -can be "handed off" between Pods as required. +reattached by Flocker to the node that the pod is scheduled. This means data +can be shared between pods as required. -{{< caution >}} +{{< note >}} You must have your own Flocker installation running before you can use it. -{{< /caution >}} +{{< /note >}} See the [Flocker example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/flocker) for more details. -### gcePersistentDisk {#gcepersistentdisk} +### gcePersistentDisk A `gcePersistentDisk` volume mounts a Google Compute Engine (GCE) -[Persistent Disk](https://cloud.google.com/compute/docs/disks) into your Pod. Unlike -`emptyDir`, which is erased when a Pod is removed, the contents of a PD are -preserved and the volume is merely unmounted. This means that a PD can be -pre-populated with data, and that data can be "handed off" between Pods. +[persistent disk](https://cloud.google.com/compute/docs/disks) (PD) into your Pod. +Unlike `emptyDir`, which is erased when a pod is removed, the contents of a PD are +preserved and the volume is merely unmounted. This means that a PD can be +pre-populated with data, and that data can be shared between pods. -{{< caution >}} +{{< note >}} You must create a PD using `gcloud` or the GCE API or UI before you can use it. -{{< /caution >}} +{{< /note >}} There are some restrictions when using a `gcePersistentDisk`: * the nodes on which Pods are running must be GCE VMs -* those VMs need to be in the same GCE project and zone as the PD +* those VMs need to be in the same GCE project and zone as the persistent disk -A feature of PD is that they can be mounted as read-only by multiple consumers -simultaneously. This means that you can pre-populate a PD with your dataset -and then serve it in parallel from as many Pods as you need. Unfortunately, -PDs can only be mounted by a single consumer in read-write mode - no -simultaneous writers allowed. +One feature of GCE persistent disk is concurrent read-only access to a persistent disk. +A `gcePersistentDisk` volume permits multiple consumers to simultaneously +mount a persistent disk as read-only. This means that you can pre-populate a PD with your dataset +and then serve it in parallel from as many Pods as you need. Unfortunately, +PDs can only be mounted by a single consumer in read-write mode. Simultaneous +writers are not allowed. -Using a PD on a Pod controlled by a ReplicationController will fail unless +Using a GCE persistent disk with a Pod controlled by a ReplicaSet will fail unless the PD is read-only or the replica count is 0 or 1. -#### Creating a PD +#### Creating a GCE persistent disk {#gce-create-persistent-disk} -Before you can use a GCE PD with a Pod, you need to create it. +Before you can use a GCE persistent disk with a Pod, you need to create it. ```shell gcloud compute disks create --size=500GB --zone=us-central1-a my-data-disk ``` -#### Example Pod +#### GCE persistent disk configuration example ```yaml apiVersion: v1 @@ -450,18 +411,26 @@ spec: fsType: ext4 ``` -#### Regional Persistent Disks -The [Regional Persistent Disks](https://cloud.google.com/compute/docs/disks/#repds) feature allows the creation of Persistent Disks that are available in two zones within the same region. In order to use this feature, the volume must be provisioned as a PersistentVolume; referencing the volume directly from a pod is not supported. +#### Regional persistent disks + +The [Regional persistent disks](https://cloud.google.com/compute/docs/disks/#repds) +feature allows the creation of persistent disks that are available in two zones +within the same region. In order to use this feature, the volume must be provisioned +as a PersistentVolume; referencing the volume directly from a pod is not supported. #### Manually provisioning a Regional PD PersistentVolume -Dynamic provisioning is possible using a [StorageClass for GCE PD](/docs/concepts/storage/storage-classes/#gce). -Before creating a PersistentVolume, you must create the PD: + +Dynamic provisioning is possible using a +[StorageClass for GCE PD](/docs/concepts/storage/storage-classes/#gce). +Before creating a PersistentVolume, you must create the persistent disk: + ```shell gcloud compute disks create --size=500GB my-data-disk - --region us-central1 - --replica-zones us-central1-a,us-central1-b + --region us-central1 + --replica-zones us-central1-a,us-central1-b ``` -Example PersistentVolume spec: + +#### Regional persistent disk configuration example ```yaml apiVersion: v1 @@ -487,29 +456,28 @@ spec: - us-central1-b ``` -#### CSI Migration +#### GCE CSI migration {{< feature-state for_k8s_version="v1.17" state="beta" >}} -The CSI Migration feature for GCE PD, when enabled, shims all plugin operations +The `CSIMigration` feature for GCE PD, when enabled, redirects all plugin operations from the existing in-tree plugin to the `pd.csi.storage.gke.io` Container Storage Interface (CSI) Driver. In order to use this feature, the [GCE PD CSI Driver](https://github.com/kubernetes-sigs/gcp-compute-persistent-disk-csi-driver) must be installed on the cluster and the `CSIMigration` and `CSIMigrationGCE` -Beta features must be enabled. +beta features must be enabled. ### gitRepo (deprecated) {#gitrepo} {{< warning >}} -The gitRepo volume type is deprecated. To provision a container with a git repo, mount an [EmptyDir](#emptydir) into an InitContainer that clones the repo using git, then mount the [EmptyDir](#emptydir) into the Pod's container. +The `gitRepo` volume type is deprecated. To provision a container with a git repo, mount an [EmptyDir](#emptydir) into an InitContainer that clones the repo using git, then mount the [EmptyDir](#emptydir) into the Pod's container. {{< /warning >}} -A `gitRepo` volume is an example of what can be done as a volume plugin. It -mounts an empty directory and clones a git repository into it for your Pod to -use. In the future, such volumes may be moved to an even more decoupled model, -rather than extending the Kubernetes API for every such use case. +A `gitRepo` volume is an example of a volume plugin. This plugin +mounts an empty directory and clones a git repository into this directory +for your Pod to use. -Here is an example of gitRepo volume: +Here is an example of a `gitRepo` volume: ```yaml apiVersion: v1 @@ -530,19 +498,19 @@ spec: revision: "22f1d8406d464b0c0874075539c1f2e96c253775" ``` -### glusterfs {#glusterfs} +### glusterfs A `glusterfs` volume allows a [Glusterfs](https://www.gluster.org) (an open -source networked filesystem) volume to be mounted into your Pod. Unlike +source networked filesystem) volume to be mounted into your Pod. Unlike `emptyDir`, which is erased when a Pod is removed, the contents of a -`glusterfs` volume are preserved and the volume is merely unmounted. This +`glusterfs` volume are preserved and the volume is merely unmounted. This means that a glusterfs volume can be pre-populated with data, and that data can -be "handed off" between Pods. GlusterFS can be mounted by multiple writers +be shared between pods. GlusterFS can be mounted by multiple writers simultaneously. -{{< caution >}} +{{< note >}} You must have your own GlusterFS installation running before you can use it. -{{< /caution >}} +{{< /note >}} See the [GlusterFS example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/volumes/glusterfs) for more details. @@ -554,17 +522,16 @@ powerful escape hatch for some applications. For example, some uses for a `hostPath` are: -* running a Container that needs access to Docker internals; use a `hostPath` +* running a container that needs access to Docker internals; use a `hostPath` of `/var/lib/docker` -* running cAdvisor in a Container; use a `hostPath` of `/sys` +* running cAdvisor in a container; use a `hostPath` of `/sys` * allowing a Pod to specify whether a given `hostPath` should exist prior to the Pod running, whether it should be created, and what it should exist as -In addition to the required `path` property, user can optionally specify a `type` for a `hostPath` volume. +In addition to the required `path` property, you can optionally specify a `type` for a `hostPath` volume. The supported values for field `type` are: - | Value | Behavior | |:------|:---------| | | Empty string (default) is for backward compatibility, which means that no checks will be performed before mounting the hostPath volume. | @@ -578,16 +545,14 @@ The supported values for field `type` are: Watch out when using this type of volume, because: -* Pods with identical configuration (such as created from a podTemplate) may +* Pods with identical configuration (such as created from a PodTemplate) may behave differently on different nodes due to different files on the nodes -* when Kubernetes adds resource-aware scheduling, as is planned, it will not be - able to account for resources used by a `hostPath` -* the files or directories created on the underlying hosts are only writable by root. You +* The files or directories created on the underlying hosts are only writable by root. You either need to run your process as root in a [privileged Container](/docs/tasks/configure-pod-container/security-context/) or modify the file permissions on the host to be able to write to a `hostPath` volume -#### Example Pod +#### hostPath configuration example ```yaml apiVersion: v1 @@ -611,10 +576,13 @@ spec: ``` {{< caution >}} -It should be noted that the `FileOrCreate` mode does not create the parent directory of the file. If the parent directory of the mounted file does not exist, the pod fails to start. To ensure that this mode works, you can try to mount directories and files separately, as shown below. +The `FileOrCreate` mode does not create the parent directory of the file. If the parent directory +of the mounted file does not exist, the pod fails to start. To ensure that this mode works, +you can try to mount directories and files separately, as shown in the +[`FileOrCreate`configuration](#hostpath-fileorcreate-example). {{< /caution >}} -#### Example Pod FileOrCreate +#### hostPath FileOrCreate configuration example {#hostpath-fileorcreate-example} ```yaml apiVersion: v1 @@ -642,48 +610,46 @@ spec: type: FileOrCreate ``` -### iscsi {#iscsi} +### iscsi An `iscsi` volume allows an existing iSCSI (SCSI over IP) volume to be mounted -into your Pod. Unlike `emptyDir`, which is erased when a Pod is removed, the +into your Pod. Unlike `emptyDir`, which is erased when a Pod is removed, the contents of an `iscsi` volume are preserved and the volume is merely -unmounted. This means that an iscsi volume can be pre-populated with data, and -that data can be "handed off" between Pods. +unmounted. This means that an iscsi volume can be pre-populated with data, and +that data can be shared between pods. -{{< caution >}} +{{< note >}} You must have your own iSCSI server running with the volume created before you can use it. -{{< /caution >}} +{{< /note >}} A feature of iSCSI is that it can be mounted as read-only by multiple consumers -simultaneously. This means that you can pre-populate a volume with your dataset -and then serve it in parallel from as many Pods as you need. Unfortunately, -iSCSI volumes can only be mounted by a single consumer in read-write mode - no -simultaneous writers allowed. +simultaneously. This means that you can pre-populate a volume with your dataset +and then serve it in parallel from as many Pods as you need. Unfortunately, +iSCSI volumes can only be mounted by a single consumer in read-write mode. +Simultaneous writers are not allowed. See the [iSCSI example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/volumes/iscsi) for more details. -### local {#local} - -{{< feature-state for_k8s_version="v1.14" state="stable" >}} +### local A `local` volume represents a mounted local storage device such as a disk, partition or directory. Local volumes can only be used as a statically created PersistentVolume. Dynamic -provisioning is not supported yet. +provisioning is not supported. -Compared to `hostPath` volumes, local volumes can be used in a durable and -portable manner without manually scheduling Pods to nodes, as the system is aware +Compared to `hostPath` volumes, `local` volumes are used in a durable and +portable manner without manually scheduling pods to nodes. The system is aware of the volume's node constraints by looking at the node affinity on the PersistentVolume. -However, local volumes are still subject to the availability of the underlying +However, `local` volumes are subject to the availability of the underlying node and are not suitable for all applications. If a node becomes unhealthy, -then the local volume will also become inaccessible, and a Pod using it will not -be able to run. Applications using local volumes must be able to tolerate this +then the `local` volume becomes inaccessible by the pod. The pod using this volume +is unable to run. Applications using `local` volumes must be able to tolerate this reduced availability, as well as potential data loss, depending on the durability characteristics of the underlying disk. -The following is an example of PersistentVolume spec using a `local` volume and +The following example shows a PersistentVolume using a `local` volume and `nodeAffinity`: ```yaml @@ -711,19 +677,19 @@ spec: - example-node ``` -PersistentVolume `nodeAffinity` is required when using local volumes. It enables -the Kubernetes scheduler to correctly schedule Pods using local volumes to the -correct node. +You must set a PersistentVolume `nodeAffinity` when using `local` volumes. +The Kubernetes scheduler uses the PersistentVolume `nodeAffinity` to schedule +these Pods to the correct node. PersistentVolume `volumeMode` can be set to "Block" (instead of the default value "Filesystem") to expose the local volume as a raw block device. When using local volumes, it is recommended to create a StorageClass with -`volumeBindingMode` set to `WaitForFirstConsumer`. See the -[example](/docs/concepts/storage/storage-classes/#local). Delaying volume binding ensures -that the PersistentVolumeClaim binding decision will also be evaluated with any -other node constraints the Pod may have, such as node resource requirements, node -selectors, Pod affinity, and Pod anti-affinity. +`volumeBindingMode` set to `WaitForFirstConsumer`. For more details, see the +local [StorageClass](/docs/concepts/storage/storage-classes/#local) example. +Delaying volume binding ensures that the PersistentVolumeClaim binding decision +will also be evaluated with any other node constraints the Pod may have, +such as node resource requirements, node selectors, Pod affinity, and Pod anti-affinity. An external static provisioner can be run separately for improved management of the local volume lifecycle. Note that this provisioner does not support dynamic @@ -737,18 +703,18 @@ user if the external static provisioner is not used to manage the volume lifecycle. {{< /note >}} -### nfs {#nfs} +### nfs An `nfs` volume allows an existing NFS (Network File System) share to be -mounted into your Pod. Unlike `emptyDir`, which is erased when a Pod is +mounted into a Pod. Unlike `emptyDir`, which is erased when a Pod is removed, the contents of an `nfs` volume are preserved and the volume is merely -unmounted. This means that an NFS volume can be pre-populated with data, and -that data can be "handed off" between Pods. NFS can be mounted by multiple +unmounted. This means that an NFS volume can be pre-populated with data, and +that data can be shared between pods. NFS can be mounted by multiple writers simultaneously. -{{< caution >}} +{{< note >}} You must have your own NFS server running with the share exported before you can use it. -{{< /caution >}} +{{< /note >}} See the [NFS example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/nfs) for more details. @@ -759,30 +725,62 @@ A `persistentVolumeClaim` volume is used to mount a are a way for users to "claim" durable storage (such as a GCE PersistentDisk or an iSCSI volume) without knowing the details of the particular cloud environment. -See the [PersistentVolumes example](/docs/concepts/storage/persistent-volumes/) for more +See the information about [PersistentVolumes](/docs/concepts/storage/persistent-volumes/) for more details. -### projected {#projected} +### portworxVolume {#portworxvolume} + +A `portworxVolume` is an elastic block storage layer that runs hyperconverged with +Kubernetes. [Portworx](https://portworx.com/use-case/kubernetes-storage/) fingerprints storage +in a server, tiers based on capabilities, and aggregates capacity across multiple servers. +Portworx runs in-guest in virtual machines or on bare metal Linux nodes. + +A `portworxVolume` can be dynamically created through Kubernetes or it can also +be pre-provisioned and referenced inside a Pod. +Here is an example Pod referencing a pre-provisioned Portworx volume: + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: test-portworx-volume-pod +spec: + containers: + - image: k8s.gcr.io/test-webserver + name: test-container + volumeMounts: + - mountPath: /mnt + name: pxvol + volumes: + - name: pxvol + # This Portworx volume must already exist. + portworxVolume: + volumeID: "pxvol" + fsType: "" +``` + +{{< note >}} +Make sure you have an existing PortworxVolume with name `pxvol` +before using it in the Pod. +{{< /note >}} + +For more details, see the [Portworx volume](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/portworx/README.md) examples. + +### projected A `projected` volume maps several existing volume sources into the same directory. Currently, the following types of volume sources can be projected: -- [`secret`](#secret) -- [`downwardAPI`](#downwardapi) -- [`configMap`](#configmap) -- `serviceAccountToken` +* [`secret`](#secret) +* [`downwardAPI`](#downwardapi) +* [`configMap`](#configmap) +* `serviceAccountToken` All sources are required to be in the same namespace as the Pod. For more details, see the [all-in-one volume design document](https://github.com/kubernetes/community/blob/{{< param "githubbranch" >}}/contributors/design-proposals/node/all-in-one-volume.md). -The projection of service account tokens is a feature introduced in Kubernetes -1.11 and promoted to Beta in 1.12. -To enable this feature on 1.11, you need to explicitly set the `TokenRequestProjection` -[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) to -True. - -#### Example Pod with a secret, a downward API, and a configmap. +#### Example configuration with a secret, a downwardAPI, and a configMap {#example-configuration-secret-downwardapi-configmap} ```yaml apiVersion: v1 @@ -822,7 +820,7 @@ spec: path: my-group/my-config ``` -#### Example Pod with multiple secrets with a non-default permission mode set. +#### Example configuration: secrets with a non-default permission mode set {#example-configuration-secrets-nondefault-permission-mode} ```yaml apiVersion: v1 @@ -865,7 +863,7 @@ parameters are nearly the same with two exceptions: When the `TokenRequestProjection` feature is enabled, you can inject the token for the current [service account](/docs/reference/access-authn-authz/authentication/#service-account-tokens) -into a Pod at a specified path. Below is an example: +into a Pod at a specified path. For example: ```yaml apiVersion: v1 @@ -891,8 +889,8 @@ spec: ``` The example Pod has a projected volume containing the injected service account -token. This token can be used by Pod containers to access the Kubernetes API -server, for example. The `audience` field contains the intended audience of the +token. This token can be used by a Pod's containers to access the Kubernetes API +server. The `audience` field contains the intended audience of the token. A recipient of the token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. This field is optional and it defaults to the identifier of the API server. @@ -904,96 +902,61 @@ option for the API server. The `path` field specifies a relative path to the mou of the projected volume. {{< note >}} -A Container using a projected volume source as a [subPath](#using-subpath) volume mount will not +A container using a projected volume source as a [`subPath`](#using-subpath) volume mount will not receive updates for those volume sources. {{< /note >}} -### portworxVolume {#portworxvolume} - -A `portworxVolume` is an elastic block storage layer that runs hyperconverged with -Kubernetes. [Portworx](https://portworx.com/use-case/kubernetes-storage/) fingerprints storage in a server, tiers based on capabilities, -and aggregates capacity across multiple servers. Portworx runs in-guest in virtual machines or on bare metal Linux nodes. - -A `portworxVolume` can be dynamically created through Kubernetes or it can also -be pre-provisioned and referenced inside a Kubernetes Pod. -Here is an example Pod referencing a pre-provisioned PortworxVolume: - -```yaml -apiVersion: v1 -kind: Pod -metadata: - name: test-portworx-volume-pod -spec: - containers: - - image: k8s.gcr.io/test-webserver - name: test-container - volumeMounts: - - mountPath: /mnt - name: pxvol - volumes: - - name: pxvol - # This Portworx volume must already exist. - portworxVolume: - volumeID: "pxvol" - fsType: "" -``` - -{{< caution >}} -Make sure you have an existing PortworxVolume with name `pxvol` -before using it in the Pod. -{{< /caution >}} - -More details and examples can be found [here](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/portworx/README.md). - -### quobyte {#quobyte} +### quobyte A `quobyte` volume allows an existing [Quobyte](https://www.quobyte.com) volume to be mounted into your Pod. -{{< caution >}} -You must have your own Quobyte setup running with the volumes +{{< note >}} +You must have your own Quobyte setup and running with the volumes created before you can use it. -{{< /caution >}} +{{< /note >}} Quobyte supports the {{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}}. CSI is the recommended plugin to use Quobyte volumes inside Kubernetes. Quobyte's GitHub project has [instructions](https://github.com/quobyte/quobyte-csi#quobyte-csi) for deploying Quobyte using CSI, along with examples. -### rbd {#rbd} +### rbd An `rbd` volume allows a -[Rados Block Device](https://ceph.com/docs/master/rbd/rbd/) volume to be mounted into your -Pod. Unlike `emptyDir`, which is erased when a Pod is removed, the contents of -a `rbd` volume are preserved and the volume is merely unmounted. This +[Rados Block Device](https://ceph.com/docs/master/rbd/rbd/) (RBD) volume to mount into your +Pod. Unlike `emptyDir`, which is erased when a pod is removed, the contents of +an `rbd` volume are preserved and the volume is unmounted. This means that a RBD volume can be pre-populated with data, and that data can -be "handed off" between Pods. +be shared between pods. -{{< caution >}} -You must have your own Ceph installation running before you can use RBD. -{{< /caution >}} +{{< note >}} +You must have a Ceph installation running before you can use RBD. +{{< /note >}} A feature of RBD is that it can be mounted as read-only by multiple consumers -simultaneously. This means that you can pre-populate a volume with your dataset -and then serve it in parallel from as many Pods as you need. Unfortunately, -RBD volumes can only be mounted by a single consumer in read-write mode - no -simultaneous writers allowed. +simultaneously. This means that you can pre-populate a volume with your dataset +and then serve it in parallel from as many pods as you need. Unfortunately, +RBD volumes can only be mounted by a single consumer in read-write mode. +Simultaneous writers are not allowed. -See the [RBD example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/volumes/rbd) for more details. +See the [RBD example](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/volumes/rbd) +for more details. -### scaleIO {#scaleio} +### scaleIO (deprecated) {#scaleio} -ScaleIO is a software-based storage platform that can use existing hardware to +ScaleIO is a software-based storage platform that uses existing hardware to create clusters of scalable shared block networked storage. The `scaleIO` volume -plugin allows deployed Pods to access existing ScaleIO -volumes (or it can dynamically provision new volumes for persistent volume claims, see -[ScaleIO Persistent Volumes](/docs/concepts/storage/persistent-volumes/#scaleio)). +plugin allows deployed pods to access existing ScaleIO +volumes. For information about dynamically provisioning new volumes for +persistent volume claims, see +[ScaleIO persistent volumes](/docs/concepts/storage/persistent-volumes/#scaleio). -{{< caution >}} +{{< note >}} You must have an existing ScaleIO cluster already setup and running with the volumes created before you can use them. -{{< /caution >}} +{{< /note >}} -The following is an example of Pod configuration with ScaleIO: +The following example is a Pod configuration with ScaleIO: ```yaml apiVersion: v1 @@ -1020,49 +983,51 @@ spec: fsType: xfs ``` -For further detail, please see the [ScaleIO examples](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/scaleio). +For further details, see the [ScaleIO](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/volumes/scaleio) examples. -### secret {#secret} +### secret A `secret` volume is used to pass sensitive information, such as passwords, to -Pods. You can store secrets in the Kubernetes API and mount them as files for -use by Pods without coupling to Kubernetes directly. `secret` volumes are +Pods. You can store secrets in the Kubernetes API and mount them as files for +use by pods without coupling to Kubernetes directly. `secret` volumes are backed by tmpfs (a RAM-backed filesystem) so they are never written to non-volatile storage. -{{< caution >}} -You must create a secret in the Kubernetes API before you can use it. -{{< /caution >}} +{{< note >}} +You must create a Secret in the Kubernetes API before you can use it. +{{< /note >}} {{< note >}} -A Container using a Secret as a [subPath](#using-subpath) volume mount will not +A container using a Secret as a [`subPath`](#using-subpath) volume mount will not receive Secret updates. {{< /note >}} -Secrets are described in more detail [here](/docs/concepts/configuration/secret/). +For more details, see [Configuring Secrets](/docs/concepts/configuration/secret/). ### storageOS {#storageos} A `storageos` volume allows an existing [StorageOS](https://www.storageos.com) -volume to be mounted into your Pod. +volume to mount into your Pod. -StorageOS runs as a Container within your Kubernetes environment, making local +StorageOS runs as a container within your Kubernetes environment, making local or attached storage accessible from any node within the Kubernetes cluster. Data can be replicated to protect against node failure. Thin provisioning and compression can improve utilization and reduce cost. -At its core, StorageOS provides block storage to Containers, accessible via a file system. +At its core, StorageOS provides block storage to containers, accessible from a file system. The StorageOS Container requires 64-bit Linux and has no additional dependencies. A free developer license is available. {{< caution >}} -You must run the StorageOS Container on each node that wants to +You must run the StorageOS container on each node that wants to access StorageOS volumes or that will contribute storage capacity to the pool. For installation instructions, consult the [StorageOS documentation](https://docs.storageos.com). {{< /caution >}} +The following example is a Pod configuration with StorageOS: + ```yaml apiVersion: v1 kind: Pod @@ -1091,24 +1056,24 @@ spec: fsType: ext4 ``` -For more information including Dynamic Provisioning and Persistent Volume Claims, please see the +For more information about StorageOS, dynamic provisioning, and PersistentVolumeClaims, see the [StorageOS examples](https://github.com/kubernetes/examples/blob/master/volumes/storageos). ### vsphereVolume {#vspherevolume} {{< note >}} -Prerequisite: Kubernetes with vSphere Cloud Provider configured. For cloudprovider -configuration please refer [vSphere getting started guide](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/). +You must configure the Kubernetes vSphere Cloud Provider. For cloudprovider +configuration, refer to the [vSphere Getting Started guide](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/). {{< /note >}} -A `vsphereVolume` is used to mount a vSphere VMDK Volume into your Pod. The contents +A `vsphereVolume` is used to mount a vSphere VMDK volume into your Pod. The contents of a volume are preserved when it is unmounted. It supports both VMFS and VSAN datastore. -{{< caution >}} -You must create VMDK using one of the following methods before using with Pod. -{{< /caution >}} +{{< note >}} +You must create vSphere VMDK volume using one of the following methods before using with a Pod. +{{< /note >}} -#### Creating a VMDK volume +#### Creating a VMDK volume {#creating-vmdk-volume} Choose one of the following methods to create a VMDK. @@ -1119,6 +1084,7 @@ First ssh into ESX, then use the following command to create a VMDK: ```shell vmkfstools -c 2G /vmfs/volumes/DatastoreName/volumes/myDisk.vmdk ``` + {{% /tab %}} {{% tab name="Create using vmware-vdiskmanager" %}} Use the following command to create a VMDK: @@ -1126,12 +1092,12 @@ Use the following command to create a VMDK: ```shell vmware-vdiskmanager -c -t 0 -s 40GB -a lsilogic myDisk.vmdk ``` + {{% /tab %}} {{< /tabs >}} - -#### vSphere VMDK Example configuration +#### vSphere VMDK configuration example {#vsphere-vmdk-configuration} ```yaml apiVersion: v1 @@ -1153,22 +1119,22 @@ spec: fsType: ext4 ``` -More examples can be found [here](https://github.com/kubernetes/examples/tree/master/staging/volumes/vsphere). +For more information, see the [vSphere volume](https://github.com/kubernetes/examples/tree/master/staging/volumes/vsphere) examples. -#### CSI migration +#### vSphere CSI migration {#vsphere-csi-migration} {{< feature-state for_k8s_version="v1.19" state="beta" >}} -The CSI Migration feature for vsphereVolume, when enabled, shims all plugin operations -from the existing in-tree plugin to the `csi.vsphere.vmware.com` {{< glossary_tooltip text="CSI" term_id="csi" >}} driver. In order to use this feature, the [vSphere CSI -Driver](https://github.com/kubernetes-sigs/vsphere-csi-driver) +The `CSIMigration` feature for `vsphereVolume`, when enabled, redirects all plugin operations +from the existing in-tree plugin to the `csi.vsphere.vmware.com` {{< glossary_tooltip text="CSI" term_id="csi" >}} driver. In order to use this feature, the +[vSphere CSI driver](https://github.com/kubernetes-sigs/vsphere-csi-driver) must be installed on the cluster and the `CSIMigration` and `CSIMigrationvSphere` [feature gates](/docs/reference/command-line-tools-reference/feature-gates/) must be enabled. This also requires minimum vSphere vCenter/ESXi Version to be 7.0u1 and minimum HW Version to be VM version 15. {{< note >}} -The following StorageClass parameters from the built-in vsphereVolume plugin are not supported by the vSphere CSI driver: +The following StorageClass parameters from the built-in `vsphereVolume` plugin are not supported by the vSphere CSI driver: * `diskformat` * `hostfailurestotolerate` @@ -1178,22 +1144,28 @@ The following StorageClass parameters from the built-in vsphereVolume plugin are * `objectspacereservation` * `iopslimit` -Existing volumes created using these parameters will be migrated to the vSphere CSI driver, but new volumes created by the vSphere CSI driver will not be honoring these parameters. +Existing volumes created using these parameters will be migrated to the vSphere CSI driver, +but new volumes created by the vSphere CSI driver will not be honoring these parameters. {{< /note >}} -#### CSI Migration Complete +#### vSphere CSI migration complete {#vsphere-csi-migration-complete} + {{< feature-state for_k8s_version="v1.19" state="beta" >}} -To turn off the vsphereVolume plugin from being loaded by controller manager and kubelet, you need to set this feature flag to true. This requires `csi.vsphere.vmware.com` {{< glossary_tooltip text="CSI" term_id="csi" >}} driver being installed on all worker nodes. +To turn off the `vsphereVolume` plugin from being loaded by the controller manager and the kubelet, you need to set this feature flag to `true`. You must install a `csi.vsphere.vmware.com` {{< glossary_tooltip text="CSI" term_id="csi" >}} driver on all worker nodes. +## Using subPath {#using-subpath} -## Using subPath +Sometimes, it is useful to share one volume for multiple uses in a single pod. +The `volumeMounts.subPath` property specifies a sub-path inside the referenced volume +instead of its root. -Sometimes, it is useful to share one volume for multiple uses in a single Pod. The `volumeMounts.subPath` -property can be used to specify a sub-path inside the referenced volume instead of its root. +The following example shows how to configure a Pod with a LAMP stack (Linux Apache MySQL PHP) +using a single, shared volume. This sample `subPath` configuration is not recommended +for production use. -Here is an example of a Pod with a LAMP stack (Linux Apache Mysql PHP) using a single, shared volume. -The HTML contents are mapped to its `html` folder, and the databases will be stored in its `mysql` folder: +The PHP application's code and assets map to the volume's `html` folder and +the MySQL database is stored in the volume's `mysql` folder. For example: ```yaml apiVersion: v1 @@ -1223,15 +1195,18 @@ spec: claimName: my-lamp-site-data ``` -### Using subPath with expanded environment variables +### Using subPath with expanded environment variables {#using-subpath-expanded-environment} {{< feature-state for_k8s_version="v1.17" state="stable" >}} - -Use the `subPathExpr` field to construct `subPath` directory names from Downward API environment variables. +Use the `subPathExpr` field to construct `subPath` directory names from +downward API environment variables. The `subPath` and `subPathExpr` properties are mutually exclusive. -In this example, a Pod uses `subPathExpr` to create a directory `pod1` within the hostPath volume `/var/log/pods`, using the pod name from the Downward API. The host directory `/var/log/pods/pod1` is mounted at `/logs` in the container. +In this example, a `Pod` uses `subPathExpr` to create a directory `pod1` within +the `hostPath` volume `/var/log/pods`. +The `hostPath` volume takes the `Pod` name from the `downwardAPI`. +The host directory `/var/log/pods/pod1` is mounted at `/logs` in the container. ```yaml apiVersion: v1 @@ -1262,47 +1237,41 @@ spec: ## Resources -The storage media (Disk, SSD, etc.) of an `emptyDir` volume is determined by the +The storage media (such as Disk or SSD) of an `emptyDir` volume is determined by the medium of the filesystem holding the kubelet root dir (typically -`/var/lib/kubelet`). There is no limit on how much space an `emptyDir` or -`hostPath` volume can consume, and no isolation between Containers or between -Pods. +`/var/lib/kubelet`). There is no limit on how much space an `emptyDir` or +`hostPath` volume can consume, and no isolation between containers or between +pods. -In the future, we expect that `emptyDir` and `hostPath` volumes will be able to -request a certain amount of space using a [resource](/docs/concepts/configuration/manage-resources-containers/) -specification, and to select the type of media to use, for clusters that have -several media types. +To learn about requesting space using a resource specification, see +[how to manage resources](/docs/concepts/configuration/manage-resources-containers/). -## Out-of-Tree Volume Plugins +## Out-of-tree volume plugins -The Out-of-tree volume plugins include the Container Storage Interface (CSI) -and FlexVolume. They enable storage vendors to create custom storage plugins -without adding them to the Kubernetes repository. +The out-of-tree volume plugins include +{{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} (CSI) +and FlexVolume. These plugins enable storage vendors to create custom storage plugins +without adding their plugin source code to the Kubernetes repository. -Before the introduction of CSI and FlexVolume, all volume plugins (like -volume types listed above) were "in-tree" meaning they were built, linked, -compiled, and shipped with the core Kubernetes binaries and extend the core -Kubernetes API. This meant that adding a new storage system to Kubernetes (a -volume plugin) required checking code into the core Kubernetes code repository. +Previously, all volume plugins were "in-tree". The "in-tree" plugins were built, linked, compiled, +and shipped with the core Kubernetes binaries. This meant that adding a new storage system to +Kubernetes (a volume plugin) required checking code into the core Kubernetes code repository. Both CSI and FlexVolume allow volume plugins to be developed independent of the Kubernetes code base, and deployed (installed) on Kubernetes clusters as extensions. For storage vendors looking to create an out-of-tree volume plugin, please refer -to [this FAQ](https://github.com/kubernetes/community/blob/master/sig-storage/volume-plugin-faq.md). +to the [volume plugin FAQ](https://github.com/kubernetes/community/blob/master/sig-storage/volume-plugin-faq.md). -### CSI +### csi -[Container Storage Interface](https://github.com/container-storage-interface/spec/blob/master/spec.md) (CSI) -defines a standard interface for container orchestration systems (like +[Container Storage Interface](https://github.com/container-storage-interface/spec/blob/master/spec.md) +(CSI) defines a standard interface for container orchestration systems (like Kubernetes) to expose arbitrary storage systems to their container workloads. Please read the [CSI design proposal](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/storage/container-storage-interface.md) for more information. -CSI support was introduced as alpha in Kubernetes v1.9, moved to beta in -Kubernetes v1.10, and is GA in Kubernetes v1.13. - {{< note >}} Support for CSI spec versions 0.2 and 0.3 are deprecated in Kubernetes v1.13 and will be removed in a future release. @@ -1315,57 +1284,59 @@ deployments steps for each Kubernetes release and a compatibility matrix. {{< /note >}} Once a CSI compatible volume driver is deployed on a Kubernetes cluster, users -may use the `csi` volume type to attach, mount, etc. the volumes exposed by the +may use the `csi` volume type to attach or mount the volumes exposed by the CSI driver. -A `csi` volume can be used in a pod in three different ways: -- through a reference to a [`persistentVolumeClaim`](#persistentvolumeclaim) -- with a [generic ephemeral volume](/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volume) (alpha feature) -- with a [CSI ephemeral volume](/docs/concepts/storage/ephemeral-volumes/#csi-ephemeral-volume) if the driver - supports that (beta feature) +A `csi` volume can be used in a Pod in three different ways: + +* through a reference to a [PersistentVolumeClaim](#persistentvolumeclaim) +* with a [generic ephemeral volume](/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volume) +(alpha feature) +* with a [CSI ephemeral volume](/docs/concepts/storage/ephemeral-volumes/#csi-ephemeral-volume) +if the driver supports that (beta feature) The following fields are available to storage administrators to configure a CSI persistent volume: -- `driver`: A string value that specifies the name of the volume driver to use. +* `driver`: A string value that specifies the name of the volume driver to use. This value must correspond to the value returned in the `GetPluginInfoResponse` by the CSI driver as defined in the [CSI spec](https://github.com/container-storage-interface/spec/blob/master/spec.md#getplugininfo). It is used by Kubernetes to identify which CSI driver to call out to, and by CSI driver components to identify which PV objects belong to the CSI driver. -- `volumeHandle`: A string value that uniquely identifies the volume. This value +* `volumeHandle`: A string value that uniquely identifies the volume. This value must correspond to the value returned in the `volume.id` field of the `CreateVolumeResponse` by the CSI driver as defined in the [CSI spec](https://github.com/container-storage-interface/spec/blob/master/spec.md#createvolume). The value is passed as `volume_id` on all calls to the CSI volume driver when referencing the volume. -- `readOnly`: An optional boolean value indicating whether the volume is to be +* `readOnly`: An optional boolean value indicating whether the volume is to be "ControllerPublished" (attached) as read only. Default is false. This value is passed to the CSI driver via the `readonly` field in the `ControllerPublishVolumeRequest`. -- `fsType`: If the PV's `VolumeMode` is `Filesystem` then this field may be used +* `fsType`: If the PV's `VolumeMode` is `Filesystem` then this field may be used to specify the filesystem that should be used to mount the volume. If the volume has not been formatted and formatting is supported, this value will be used to format the volume. This value is passed to the CSI driver via the `VolumeCapability` field of `ControllerPublishVolumeRequest`, `NodeStageVolumeRequest`, and `NodePublishVolumeRequest`. -- `volumeAttributes`: A map of string to string that specifies static properties +* `volumeAttributes`: A map of string to string that specifies static properties of a volume. This map must correspond to the map returned in the `volume.attributes` field of the `CreateVolumeResponse` by the CSI driver as defined in the [CSI spec](https://github.com/container-storage-interface/spec/blob/master/spec.md#createvolume). The map is passed to the CSI driver via the `volume_context` field in the `ControllerPublishVolumeRequest`, `NodeStageVolumeRequest`, and `NodePublishVolumeRequest`. -- `controllerPublishSecretRef`: A reference to the secret object containing +* `controllerPublishSecretRef`: A reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI `ControllerPublishVolume` and `ControllerUnpublishVolume` calls. This field is - optional, and may be empty if no secret is required. If the secret object + optional, and may be empty if no secret is required. If the Secret contains more than one secret, all secrets are passed. -- `nodeStageSecretRef`: A reference to the secret object containing +* `nodeStageSecretRef`: A reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI `NodeStageVolume` call. This field is optional, and may be empty if no secret - is required. If the secret object contains more than one secret, all secrets + is required. If the Secret contains more than one secret, all secrets are passed. -- `nodePublishSecretRef`: A reference to the secret object containing +* `nodePublishSecretRef`: A reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI `NodePublishVolume` call. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all @@ -1375,11 +1346,11 @@ persistent volume: {{< feature-state for_k8s_version="v1.18" state="stable" >}} -Vendors with external CSI drivers can implement raw block volumes support +Vendors with external CSI drivers can implement raw block volume support in Kubernetes workloads. -You can [setup your PV/PVC with raw block volume support](/docs/concepts/storage/persistent-volumes/#raw-block-volume-support) -as usual, without any CSI specific changes. +You can set up your +[PersistentVolume/PersistentVolumeClaim with raw block volume support](/docs/concepts/storage/persistent-volumes/#raw-block-volume-support) as usual, without any CSI specific changes. #### CSI ephemeral volumes @@ -1387,107 +1358,105 @@ as usual, without any CSI specific changes. You can directly configure CSI volumes within the Pod specification. Volumes specified in this way are ephemeral and do not -persist across Pod restarts. See [Ephemeral +persist across pod restarts. See [Ephemeral Volumes](/docs/concepts/storage/ephemeral-volumes/#csi-ephemeral-volume) for more information. -#### {{% heading "whatsnext" %}} - -For more information on how to develop a CSI driver, refer to the [kubernetes-csi -documentation](https://kubernetes-csi.github.io/docs/) +For more information on how to develop a CSI driver, refer to the +[kubernetes-csi documentation](https://kubernetes-csi.github.io/docs/) #### Migrating to CSI drivers from in-tree plugins -{{< feature-state for_k8s_version="v1.14" state="alpha" >}} +{{< feature-state for_k8s_version="v1.17" state="alpha" >}} -The CSI Migration feature, when enabled, directs operations against existing in-tree +The `CSIMigration` feature, when enabled, directs operations against existing in-tree plugins to corresponding CSI plugins (which are expected to be installed and configured). -The feature implements the necessary translation logic and shims to re-route the -operations in a seamless fashion. As a result, operators do not have to make any -configuration changes to existing Storage Classes, PVs or PVCs (referring to -in-tree plugins) when transitioning to a CSI driver that supersedes an in-tree plugin. +As a result, operators do not have to make any +configuration changes to existing Storage Classes, PersistentVolumes or PersistentVolumeClaims +(referring to in-tree plugins) when transitioning to a CSI driver that supersedes an in-tree plugin. -In the alpha state, the operations and features that are supported include +The operations and features that are supported include: provisioning/delete, attach/detach, mount/unmount and resizing of volumes. -In-tree plugins that support CSI Migration and have a corresponding CSI driver implemented -are listed in the "Types of Volumes" section above. +In-tree plugins that support `CSIMigration` and have a corresponding CSI driver implemented +are listed in [Types of Volumes](#volume-types). -### FlexVolume {#flexVolume} +### flexVolume FlexVolume is an out-of-tree plugin interface that has existed in Kubernetes since version 1.2 (before CSI). It uses an exec-based model to interface with -drivers. FlexVolume driver binaries must be installed in a pre-defined volume -plugin path on each node (and in some cases master). +drivers. The FlexVolume driver binaries must be installed in a pre-defined volume +plugin path on each node and in some cases the control plane nodes as well. -Pods interact with FlexVolume drivers through the `flexvolume` in-tree plugin. -More details can be found [here](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-storage/flexvolume.md). +Pods interact with FlexVolume drivers through the `flexvolume` in-tree volume plugin. +For more details, see the [FlexVolume](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-storage/flexvolume.md) examples. ## Mount propagation -Mount propagation allows for sharing volumes mounted by a Container to -other Containers in the same Pod, or even to other Pods on the same node. +Mount propagation allows for sharing volumes mounted by a container to +other containers in the same pod, or even to other pods on the same node. -Mount propagation of a volume is controlled by `mountPropagation` field in Container.volumeMounts. -Its values are: +Mount propagation of a volume is controlled by the `mountPropagation` field +in `Container.volumeMounts`. Its values are: - * `None` - This volume mount will not receive any subsequent mounts - that are mounted to this volume or any of its subdirectories by the host. - In similar fashion, no mounts created by the Container will be visible on - the host. This is the default mode. +* `None` - This volume mount will not receive any subsequent mounts + that are mounted to this volume or any of its subdirectories by the host. + In similar fashion, no mounts created by the container will be visible on + the host. This is the default mode. - This mode is equal to `private` mount propagation as described in the - [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) + This mode is equal to `private` mount propagation as described in the + [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) - * `HostToContainer` - This volume mount will receive all subsequent mounts - that are mounted to this volume or any of its subdirectories. +* `HostToContainer` - This volume mount will receive all subsequent mounts + that are mounted to this volume or any of its subdirectories. - In other words, if the host mounts anything inside the volume mount, the - Container will see it mounted there. + In other words, if the host mounts anything inside the volume mount, the + container will see it mounted there. - Similarly, if any Pod with `Bidirectional` mount propagation to the same - volume mounts anything there, the Container with `HostToContainer` mount - propagation will see it. + Similarly, if any Pod with `Bidirectional` mount propagation to the same + volume mounts anything there, the container with `HostToContainer` mount + propagation will see it. - This mode is equal to `rslave` mount propagation as described in the - [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) + This mode is equal to `rslave` mount propagation as described in the + [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) - * `Bidirectional` - This volume mount behaves the same the `HostToContainer` mount. - In addition, all volume mounts created by the Container will be propagated - back to the host and to all Containers of all Pods that use the same volume. +* `Bidirectional` - This volume mount behaves the same the `HostToContainer` mount. + In addition, all volume mounts created by the container will be propagated + back to the host and to all containers of all pods that use the same volume. - A typical use case for this mode is a Pod with a FlexVolume or CSI driver or - a Pod that needs to mount something on the host using a `hostPath` volume. + A typical use case for this mode is a Pod with a FlexVolume or CSI driver or + a Pod that needs to mount something on the host using a `hostPath` volume. - This mode is equal to `rshared` mount propagation as described in the - [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) + This mode is equal to `rshared` mount propagation as described in the + [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) -{{< caution >}} -`Bidirectional` mount propagation can be dangerous. It can damage -the host operating system and therefore it is allowed only in privileged -Containers. Familiarity with Linux kernel behavior is strongly recommended. -In addition, any volume mounts created by Containers in Pods must be destroyed -(unmounted) by the Containers on termination. -{{< /caution >}} + {{< warning >}} + `Bidirectional` mount propagation can be dangerous. It can damage + the host operating system and therefore it is allowed only in privileged + containers. Familiarity with Linux kernel behavior is strongly recommended. + In addition, any volume mounts created by containers in pods must be destroyed + (unmounted) by the containers on termination. + {{< /warning >}} ### Configuration + Before mount propagation can work properly on some deployments (CoreOS, RedHat/Centos, Ubuntu) mount share must be configured correctly in Docker as shown below. -Edit your Docker's `systemd` service file. Set `MountFlags` as follows: +Edit your Docker's `systemd` service file. Set `MountFlags` as follows: + ```shell MountFlags=shared ``` -Or, remove `MountFlags=slave` if present. Then restart the Docker daemon: + +Or, remove `MountFlags=slave` if present. Then restart the Docker daemon: + ```shell sudo systemctl daemon-reload sudo systemctl restart docker ``` - - ## {{% heading "whatsnext" %}} -* Follow an example of [deploying WordPress and MySQL with Persistent Volumes](/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/). - +Follow an example of [deploying WordPress and MySQL with Persistent Volumes](/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/). From 9a6b3d3e7dd58a21365cc2e1fccb3e95fdbba97b Mon Sep 17 00:00:00 2001 From: xieyanker Date: Tue, 27 Oct 2020 11:06:22 +0800 Subject: [PATCH 17/31] Update "kubeclt" to "kubectl" --- content/zh/docs/tasks/extend-kubectl/kubectl-plugins.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/zh/docs/tasks/extend-kubectl/kubectl-plugins.md b/content/zh/docs/tasks/extend-kubectl/kubectl-plugins.md index 4b5acb47ea..f568dc600e 100644 --- a/content/zh/docs/tasks/extend-kubectl/kubectl-plugins.md +++ b/content/zh/docs/tasks/extend-kubectl/kubectl-plugins.md @@ -245,7 +245,7 @@ See [using the command line runtime package](#using-the-command-line-runtime-pac Here are some additional cases where users invoke your plugin while providing additional flags and arguments. This builds upon the `kubectl-foo-bar-baz` plugin from the scenario above. --> -kubeclt 插件必须解析并检查传递给它们的所有参数。 +kubectl 插件必须解析并检查传递给它们的所有参数。 参阅[使用命令行运行时包](#using-the-command-line-runtime-package)了解针对 插件开发人员的 Go 库的细节。 @@ -261,7 +261,7 @@ would be `kubectl-foo-bar-baz-arg1`. Upon not finding that plugin, kubectl then Upon having found a plugin with this name, kubectl then invokes that plugin, passing all args and flags after the plugin's name as arguments to the plugin process. --> -如果你运行 `kubectl foo bar baz arg1 --flag=value arg2`，kubeclt 的插件机制将首先尝试找到 +如果你运行 `kubectl foo bar baz arg1 --flag=value arg2`，kubectl 的插件机制将首先尝试找到 最长可能名称的插件，在本例中是 `kubectl-foo-bar-baz-arg1`。 当没有找到这个插件时，kubectl 就会将最后一个以破折号分隔的值视为参数（在本例中为 `arg1`）， 并尝试找到下一个最长的名称 `kubectl-foo-bar-baz`。 From 428fe6f9042c65bdbc8f5fd3bad28eaa3d722ff5 Mon Sep 17 00:00:00 2001 From: GoodGameZoo Date: Mon, 26 Oct 2020 20:20:36 -0700 Subject: [PATCH 18/31] Update link in page install-service-catalog-using-helm.md --- .../service-catalog/install-service-catalog-using-helm.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/zh/docs/tasks/service-catalog/install-service-catalog-using-helm.md b/content/zh/docs/tasks/service-catalog/install-service-catalog-using-helm.md index 5e102f790c..ecc001e62d 100644 --- a/content/zh/docs/tasks/service-catalog/install-service-catalog-using-helm.md +++ b/content/zh/docs/tasks/service-catalog/install-service-catalog-using-helm.md @@ -32,7 +32,7 @@ Use [Helm](https://helm.sh/) to install Service Catalog on your Kubernetes clust * Follow the [Helm install instructions](https://github.com/kubernetes/helm/blob/master/docs/install.md). * If you already have an appropriate version of Helm installed, execute `helm init` to install Tiller, the server-side component of Helm. --> -* 理解[服务目录](/zh/docs/concepts/service-catalog/) 的关键概念。 +* 理解[服务目录](/zh/docs/concepts/extend-kubernetes/service-catalog/) 的关键概念。 * Service Catalog 需要 Kubernetes 集群版本在 1.7 或更高版本。 * 你必须启用 Kubernetes 集群的 DNS 功能。 * 如果使用基于云的 Kubernetes 集群或 {{< glossary_tooltip text="Minikube" term_id="minikube" >}}，则可能已经启用了集群 DNS。 @@ -156,4 +156,3 @@ helm install svc-cat/catalog --name catalog --namespace catalog --> * 查看[示例服务代理](https://github.com/openservicebrokerapi/servicebroker/blob/mastergettingStarted.md#sample-service-brokers)。 * 探索 [kubernetes-incubator/service-catalog](https://github.com/kubernetes-incubator/service-catalog) 项目。 - From 53115dc2635780da9a6e70de6be832dc139281f4 Mon Sep 17 00:00:00 2001 From: GoodGameZoo Date: Mon, 26 Oct 2020 20:59:07 -0700 Subject: [PATCH 19/31] Update links in page content/zh/docs/reference/kubectl/overview.md --- content/zh/docs/reference/kubectl/overview.md | 44 +++++++++---------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/content/zh/docs/reference/kubectl/overview.md b/content/zh/docs/reference/kubectl/overview.md index 422904423c..54785aa806 100644 --- a/content/zh/docs/reference/kubectl/overview.md +++ b/content/zh/docs/reference/kubectl/overview.md @@ -27,12 +27,12 @@ card: -Kubectl 是一个命令行接口，用于对 Kubernetes 集群运行命令。`kubectl` 在 $HOME/.kube 目录中寻找一个名为 config 的文件。您可以通过设置环境变量 KUBECONFIG 或设置 [`--kubeconfig`](/docs/concepts/configuration/organize-cluster-access-kubeconfig/) 参数指定其它 [kubeconfig](/docs/concepts/configuration/organize-cluster-access-kubeconfig/) 文件。 +Kubectl 是一个命令行接口，用于对 Kubernetes 集群运行命令。`kubectl` 在 $HOME/.kube 目录中寻找一个名为 config 的文件。您可以通过设置环境变量 KUBECONFIG 或设置 [`--kubeconfig`](/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/) 参数指定其它 [kubeconfig](/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/) 文件。 -本文概述了 `kubectl` 语法和命令操作描述，并提供了常见的示例。有关每个命令的详细信息，包括所有受支持的参数和子命令，请参阅 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 参考文档。有关安装说明，请参见 [安装 kubectl](/docs/tasks/kubectl/install/) 。 +本文概述了 `kubectl` 语法和命令操作描述，并提供了常见的示例。有关每个命令的详细信息，包括所有受支持的参数和子命令，请参阅 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 参考文档。有关安装说明，请参见 [安装 kubectl](/zh/docs/tasks/tools/install-kubectl/) 。 @@ -79,22 +79,22 @@ where `command`, `TYPE`, `NAME`, and `flags` are: When performing an operation on multiple resources, you can specify each resource by type and name or specify one or more files: --> - -* `NAME`：指定资源的名称。名称区分大小写。如果省略名称，则显示所有资源的详细信息 `kubectl get pods`。 - 在对多个资源执行操作时，您可以按类型和名称指定每个资源，或指定一个或多个文件： +* `NAME`：指定资源的名称。名称区分大小写。如果省略名称，则显示所有资源的详细信息 `kubectl get pods`。 + + 在对多个资源执行操作时，您可以按类型和名称指定每个资源，或指定一个或多个文件： * 要按类型和名称指定资源： - + * 要对所有类型相同的资源进行分组，请执行以下操作：`TYPE1 name1 name2 name<#>`。
    例子：`kubectl get pod example-pod1 example-pod2` - + * 分别指定多个资源类型：`TYPE1/name1 TYPE1/name2 TYPE2/name3 TYPE<#>/name<#>`。
    例子：`kubectl get pod/example-pod1 replicationcontroller/example-rc1` - + * 用一个或多个文件指定资源：`-f file1 -f file2 -f file<#>` - - * [使用 YAML 而不是 JSON](/docs/concepts/configuration/overview/#general-config-tips) 因为 YAML 更容易使用，特别是用于配置文件时。
    + + * [使用 YAML 而不是 JSON](/zh/docs/concepts/configuration/overview/#general-config-tips) 因为 YAML 更容易使用，特别是用于配置文件时。
    例子：`kubectl get pod -f ./pod.yaml` * `flags`: 指定可选的参数。例如，可以使用 `-s` 或 `-server` 参数指定 Kubernetes API 服务器的地址和端口。
    @@ -206,7 +206,7 @@ Operation | Syntax | Description -记住：有关命令操作的更多信息，请参阅 [kubectl](/docs/user-guide/kubectl/) 参考文档。 +记住：有关命令操作的更多信息，请参阅 [kubectl](/zh/docs/reference/kubectl/kubectl/) 参考文档。 -有关如何格式化或排序某些命令的输出的信息，请使用以下部分。有关哪些命令支持各种输出选项的详细信息，请参阅[kubectl](/docs/user-guide/kubectl/) 参考文档。 +有关如何格式化或排序某些命令的输出的信息，请使用以下部分。有关哪些命令支持各种输出选项的详细信息，请参阅[kubectl](/zh/docs/reference/kubectl/kubectl/) 参考文档。 -请记住：有关每个命令支持哪种输出格式的详细信息，请参阅 [kubectl](/docs/user-guide/kubectl/) 参考文档。 +请记住：有关每个命令支持哪种输出格式的详细信息，请参阅 [kubectl](/zh/docs/reference/kubectl/kubectl/) 参考文档。 -要将对象排序后输出到终端窗口，可以将 `--sort-by` 参数添加到支持的 `kubectl` 命令。通过使用 `--sort-by` 参数指定任何数字或字符串字段来对对象进行排序。要指定字段，请使用 [jsonpath](/docs/reference/kubectl/jsonpath/) 表达式。 +要将对象排序后输出到终端窗口，可以将 `--sort-by` 参数添加到支持的 `kubectl` 命令。通过使用 `--sort-by` 参数指定任何数字或字符串字段来对对象进行排序。要指定字段，请使用 [jsonpath](/zh/docs/reference/kubectl/jsonpath/) 表达式。 开始使用 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 命令。 - - From f5f7393ddbba588d3adf1ea3812da08753447d6f Mon Sep 17 00:00:00 2001 From: xieyanker Date: Tue, 27 Oct 2020 13:09:13 +0800 Subject: [PATCH 20/31] translate "result after merge" --- .../docs/tasks/manage-kubernetes-objects/declarative-config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/tasks/manage-kubernetes-objects/declarative-config.md b/content/zh/docs/tasks/manage-kubernetes-objects/declarative-config.md index 75bc47770e..3ed8d41713 100644 --- a/content/zh/docs/tasks/manage-kubernetes-objects/declarative-config.md +++ b/content/zh/docs/tasks/manage-kubernetes-objects/declarative-config.md @@ -1069,7 +1069,7 @@ Kubernetes 源代码中为每个字段定义了 `patchMergeKey`： - name: nginx-helper-d # 键 nginx-helper-d 会被保留 image: helper:1.3 -# result after merge +# 合并结果 containers: - name: nginx image: nginx:1.16 From 47e8badad891f459e5c81094dc987a57b565b0a1 Mon Sep 17 00:00:00 2001 From: xieyanker Date: Tue, 27 Oct 2020 14:16:51 +0800 Subject: [PATCH 21/31] Fix format error --- .../update-api-object-kubectl-patch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch.md b/content/zh/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch.md index 6b7d13cf14..a06502428f 100644 --- a/content/zh/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch.md +++ b/content/zh/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch.md @@ -538,7 +538,7 @@ The patch you did in the preceding exercise is called a *strategic merge patch w --> ### 关于使用 retainKeys 策略的策略合并 patch 操作的说明 -在前文练习中所执行的称作 *带 retainKeys` 策略的策略合并 patch（Strategic Merge +在前文练习中所执行的称作 *带 retainKeys 策略的策略合并 patch（Strategic Merge Patch with retainKeys Strategy）*。 这种方法引入了一种新的 `$retainKey` 指令，具有如下策略： From 976595da3072b0b1abb1aea377d0d4edcca307da Mon Sep 17 00:00:00 2001 From: xieyanker Date: Tue, 27 Oct 2020 14:23:10 +0800 Subject: [PATCH 22/31] Fix format error --- .../update-api-object-kubectl-patch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch.md b/content/zh/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch.md index 6b7d13cf14..721a3dc8bd 100644 --- a/content/zh/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch.md +++ b/content/zh/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch.md @@ -651,7 +651,7 @@ and 你没有更改最初用于创建 Deployment 对象的配置文件。 用于更新 API 对象的其他命令包括 [`kubectl annotate`](/docs/reference/generated/kubectl/kubectl-commands/#annotate)， -[`kubectl edit](/docs/reference/generated/kubectl/kubectl-commands/#edit)， +[`kubectl edit`](/docs/reference/generated/kubectl/kubectl-commands/#edit)， [`kubectl replace`](/docs/reference/generated/kubectl/kubectl-commands/#replace)， [`kubectl scale`](/docs/reference/generated/kubectl/kubectl-commands/#scale)， 和 From 15c6e38991c224eead3e2c8c4c0d7c91bee4c3c9 Mon Sep 17 00:00:00 2001 From: xieyanker Date: Tue, 27 Oct 2020 14:28:46 +0800 Subject: [PATCH 23/31] Fix format error --- .../debug-application-cluster/get-shell-running-container.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/tasks/debug-application-cluster/get-shell-running-container.md b/content/zh/docs/tasks/debug-application-cluster/get-shell-running-container.md index 591e9ea1a4..f87b7ce205 100644 --- a/content/zh/docs/tasks/debug-application-cluster/get-shell-running-container.md +++ b/content/zh/docs/tasks/debug-application-cluster/get-shell-running-container.md @@ -137,7 +137,7 @@ In your shell, create an `index.html` file in the `/usr/share/nginx/html` directory: --> -在 shell 中，在 `/usr/share/nginx/html` 目录创建一个 `index.html 文件： +在 shell 中，在 `/usr/share/nginx/html` 目录创建一个 `index.html` 文件： ```shell root@shell-demo:/# echo Hello shell demo > /usr/share/nginx/html/index.html From 752f7501feadf8714178a3a489bea15b582d6a6b Mon Sep 17 00:00:00 2001 From: GoodGameZoo Date: Mon, 26 Oct 2020 23:31:49 -0700 Subject: [PATCH 24/31] Update links in page kubectl.md --- content/zh/docs/reference/kubectl/kubectl.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/content/zh/docs/reference/kubectl/kubectl.md b/content/zh/docs/reference/kubectl/kubectl.md index 0315186257..5fcf0780ef 100644 --- a/content/zh/docs/reference/kubectl/kubectl.md +++ b/content/zh/docs/reference/kubectl/kubectl.md @@ -24,7 +24,7 @@ kubectl 管理控制 Kubernetes 集群。 -获取更多信息，请访问 [kubectl 概述](/docs/reference/kubectl/overview/)。 +获取更多信息，请访问 [kubectl 概述](/zh/docs/reference/kubectl/overview/)。 ``` kubectl [flags] @@ -581,6 +581,3 @@ kubectl [flags] * [kubectl uncordon](/docs/reference/generated/kubectl/kubectl-commands#uncordon) - 标记节点为可调度的 * [kubectl version](/docs/reference/generated/kubectl/kubectl-commands#version) - 打印客户端和服务器的版本信息 * [kubectl wait](/docs/reference/generated/kubectl/kubectl-commands#wait) - 实验性：等待一个或多个资源达到某种状态 - - - From e0021447c648b89c2a0472a2146c5a2adcbaf817 Mon Sep 17 00:00:00 2001 From: GoodGameZoo Date: Mon, 26 Oct 2020 23:45:43 -0700 Subject: [PATCH 25/31] Update links in page cheatsheet.md --- .../zh/docs/reference/kubectl/cheatsheet.md | 39 +++++++++---------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/content/zh/docs/reference/kubectl/cheatsheet.md b/content/zh/docs/reference/kubectl/cheatsheet.md index 0ede5fb604..1c351a7eab 100644 --- a/content/zh/docs/reference/kubectl/cheatsheet.md +++ b/content/zh/docs/reference/kubectl/cheatsheet.md @@ -24,7 +24,7 @@ See also: [Kubectl Overview](/docs/reference/kubectl/overview/) and [JsonPath Gu This page is an overview of the `kubectl` command. --> -另见: [Kubectl 概述](/docs/reference/kubectl/overview/) 和 [JsonPath 指南](/docs/reference/kubectl/jsonpath)。 +另见: [Kubectl 概述](/zh/docs/reference/kubectl/overview/) 和 [JsonPath 指南](/zh/docs/reference/kubectl/jsonpath)。 本页面是 `kubectl` 命令的概述。 @@ -85,15 +85,15 @@ detailed config file information. ## Kubectl 上下文和配置 设置 `kubectl` 与哪个 Kubernetes 集群进行通信并修改配置信息。查看 -[使用 kubeconfig 跨集群授权访问](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) +[使用 kubeconfig 跨集群授权访问](/zh/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) 文档获取配置文件详细信息。 - @@ -402,7 +402,7 @@ kubectl diff -f ./my-manifest.yaml ```bash kubectl set image deployment/frontend www=image:v2 # 滚动更新 "frontend" Deployment 的 "www" 容器镜像 -kubectl rollout history deployment/frontend # 检查 Deployment 的历史记录，包括版本 +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 的滚动升级状态直到完成 @@ -465,13 +465,13 @@ kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/ # Disable a deployment livenessProbe using a json patch with positional arrays kubectl patch deployment valid-deployment --type json -p='[{"op": "remove", "path": "/spec/template/spec/containers/0/livenessProbe"}]' -# Add a new element to a positional array +# Add a new element to a positional array kubectl patch sa default --type='json' -p='[{"op": "add", "path": "/secrets/1", "value": {"name": "whatever" } }]' ``` --> ```bash # 部分更新某节点 -kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}' +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"}]}}' @@ -482,7 +482,7 @@ kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/ # 使用带位置数组的 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" } }]' ``` @@ -567,7 +567,7 @@ kubectl logs -f my-pod # stream pod logs (stdout) kubectl logs -f my-pod -c my-container # stream pod container logs (stdout, multi-container case) kubectl logs -f -l name=myLabel --all-containers # stream all pods logs with label name=myLabel (stdout) kubectl run -i --tty busybox --image=busybox -- sh # Run pod as interactive shell -kubectl run nginx --image=nginx -n +kubectl run nginx --image=nginx -n mynamespace # Run pod nginx in a specific namespace kubectl run nginx --image=nginx # Run pod nginx and write its spec into a file called pod.yaml --dry-run=client -o yaml > pod.yaml @@ -641,7 +641,7 @@ kubectl taint nodes foo dedicated=special-user:NoSchedule -列出所支持的全部资源类型和它们的简称、[API 组](/docs/concepts/overview/kubernetes-api/#api-groups), 是否是[名字空间作用域](/docs/concepts/overview/working-with-objects/namespaces) 和 [Kind](/docs/concepts/overview/working-with-objects/kubernetes-objects)。 +列出所支持的全部资源类型和它们的简称、[API 组](/zh/docs/concepts/overview/kubernetes-api/#api-groups), 是否是[名字空间作用域](/zh/docs/concepts/overview/working-with-objects/namespaces) 和 [Kind](/zh/docs/concepts/overview/working-with-objects/kubernetes-objects)。 ```bash kubectl api-resources @@ -697,8 +697,8 @@ utput format | Description `-o=custom-columns=` | 使用逗号分隔的自定义列来打印表格 `-o=custom-columns-file=` | 使用 `` 文件中的自定义列模板打印表格 `-o=json` | 输出 JSON 格式的 API 对象 -`-o=jsonpath=