From 67c93b14b4494ade44c8547149a90d64a9aa08e6 Mon Sep 17 00:00:00 2001 From: chentanjun <2799194073@qq.com> Date: Thu, 2 Jan 2020 13:11:39 +0800 Subject: [PATCH] update zh-trans content/zh/docs/reference/kubectl/kubectl.md (#18329) --- content/zh/docs/reference/kubectl/kubectl.md | 833 +++++++++++++------ 1 file changed, 595 insertions(+), 238 deletions(-) diff --git a/content/zh/docs/reference/kubectl/kubectl.md b/content/zh/docs/reference/kubectl/kubectl.md index 9a16532a7a..86f0263b2a 100644 --- a/content/zh/docs/reference/kubectl/kubectl.md +++ b/content/zh/docs/reference/kubectl/kubectl.md @@ -1,263 +1,620 @@ --- title: kubectl -notitle: true +content_template: templates/tool-reference +weight: 28 --- - -## kubectl -kubectl 可以操控 Kubernetes 集群。 + +{{% capture synopsis %}} + -### 简介 +kubectl 管理控制 Kubernetes 集群。 -kubectl 可以操控 Kubernetes 集群。 -获取更多信息，请访问：[kubectl 概述](/docs/reference/kubectl/overview/) + +获取更多信息，请访问 [kubectl 概述](/docs/reference/kubectl/overview/)。 ``` kubectl [flags] ``` - +{{% capture options %}} -### 选项 -``` - --alsologtostderr 同时输出日志到标准错误控制台和文件 - --as string 以指定用户执行操作 - --as-group stringArray 模拟操作的组，可以使用这个标识来指定多个组。 - --cache-dir string 默认 HTTP 缓存目录（默认值 "/home/username/.kube/http-cache" ） - --certificate-authority string 用于进行认证授权的 .cert 文件路径 - --client-certificate string TLS 使用的客户端证书路径 - --client-key string TLS 使用的客户端密钥文件路径 - --cluster string 指定要使用的 kubeconfig 文件中集群名 - --context string 指定要使用的 kubeconfig 文件中上下文 - -h, --help kubectl 帮助 - --insecure-skip-tls-verify 值为 true，则不会检查服务器的证书的有效性。 这将使您的HTTPS连接不安全 - --kubeconfig string CLI 请求使用的 kubeconfig 配置文件路径。 - --log-backtrace-at traceLocation 当日志长度超出规定的行数时，忽略堆栈信息（默认值：0） - --log-dir string 如果不为空，则将日志文件写入此目录 - --logtostderr 日志输出到标准错误控制台而不输出到文件 - --match-server-version 要求客户端版本和服务端版本相匹配 - -n, --namespace string 如果存在，CLI 请求将使用此命名空间 - --request-timeout string 放弃一个简单服务请求前的等待时间，非零值需要包含相应时间单位(例如：1s, 2m, 3h)。零值则认为不做超时请求。 (默认值 "0") - -s, --server string Kubernetes API server 的地址和端口 - --stderrthreshold severity 等于或高于此阈值的日志将输出标准错误控制台（默认值2） - --token string 用于 API server 进行身份认证的承载令牌 - --user string 指定使用的 kubeconfig 配置文件中的用户名 - -v, --v Level 指定输出日志的日志级别 - --vmodule moduleSpec 指定输出日志的模块，格式如下：pattern=N，使用逗号分隔 -``` - -### 接下来看 + + --add-dir-header + + + + + 设置为 true 表示添加文件目录到 header 中 + + -* [kubectl alpha](kubectl_alpha.md) - alpha环境上命令属性 -* [kubectl annotate](kubectl_annotate.md) - 更新资源上注释 -* [kubectl api-resources](kubectl_api-resources.md) - 在服务器上打印支持的 API 资源 -* [kubectl api-versions](kubectl_api-versions.md) - 以 "group/version" 的形式在服务器上打印支持的 API 版本 -* [kubectl apply](kubectl_apply.md) - 通过文件名或标准输入将配置添加给资源 -* [kubectl attach](kubectl_attach.md) - 附加到正在运行的容器 -* [kubectl auth](kubectl_auth.md) - 检查授权 -* [kubectl autoscale](kubectl_autoscale.md) - 自动扩展 Deployment, ReplicaSet 或 ReplicationController -* [kubectl certificate](kubectl_certificate.md) - 修改证书资源。 -* [kubectl cluster-info](kubectl_cluster-info.md) - 展示集群信息 -* [kubectl completion](kubectl_completion.md) - 为给定的 shell 输出完成代码（ bash 或 zsh） -* [kubectl config](kubectl_config.md) - 修改 kubeconfig 配置文件 -* [kubectl convert](kubectl_convert.md) - 在不同的 API 版本之间转换配置文件 -* [kubectl cordon](kubectl_cordon.md) - 将 node 节点标记为不可调度 -* [kubectl cp](kubectl_cp.md) - 从容器复制文件和目录，也可将文件和目录复制到容器。 -* [kubectl create](kubectl_create.md) - 通过文件名或标准输入创建资源。 -* [kubectl delete](kubectl_delete.md) - 通过文件名，标准输入，资源和名称或资源和标签选择器删除资源 -* [kubectl describe](kubectl_describe.md) - 显示特定资源或资源组的详细信息 -* [kubectl drain](kubectl_drain.md) - 为便于维护，需要提前驱逐node节点 -* [kubectl edit](kubectl_edit.md) - 在服务器编辑资源 -* [kubectl exec](kubectl_exec.md) - 容器内退出命令 -* [kubectl explain](kubectl_explain.md) - 资源文档 -* [kubectl expose](kubectl_expose.md) - 获取 replication controller, service, deployment 或 pod 资源，并作为新的 Kubernetes 服务暴露 -* [kubectl get](kubectl_get.md) - 展示一个或多个资源 -* [kubectl label](kubectl_label.md) - 升级资源标签 -* [kubectl logs](kubectl_logs.md) - 为 pod 中的容器打印日志 -* [kubectl options](kubectl_options.md) - 打印所有命令继承的标识列表 -* [kubectl patch](kubectl_patch.md) - 使用战略性合并补丁更新资源字段 -* [kubectl plugin](kubectl_plugin.md) - 运行命令行插件 -* [kubectl port-forward](kubectl_port-forward.md) - 给 pod 开放一个或多个本地端口 -* [kubectl proxy](kubectl_proxy.md) - 为 Kubernetes API server 运行代理 -* [kubectl replace](kubectl_replace.md) - 通过文件或标准输入替换资源 -* [kubectl rollout](kubectl_rollout.md) - 管理资源展示 -* [kubectl run](kubectl_run.md) - 在集群上运行指定镜像 -* [kubectl scale](kubectl_scale.md) - 给 Deployment, ReplicaSet, Replication Controller 或 Job 设置新副本规模 -* [kubectl set](kubectl_set.md) - 给对象设置特定功能 -* [kubectl taint](kubectl_taint.md) - 更新一个或多个 node 节点的污点信息 -* [kubectl top](kubectl_top.md) - 展示资源 (CPU/Memory/Storage) 使用信息。 -* [kubectl uncordon](kubectl_uncordon.md) - 标记 node 节点为可调度 -* [kubectl version](kubectl_version.md) - 打印客户端和服务端版本信息 -* [kubectl wait](kubectl_wait.md) - 试验: 在一个或多个资源上等待条件完成 + + --alsologtostderr + + + + + 表示将日志输出到文件的同时输出到 stderr + + + + + --as string + + + + + 以指定用户的身份执行操作 + + + + + --as-group stringArray + + + + + 模拟指定的组来执行操作，可以使用这个标志来指定多个组。 + + + + + --azure-container-registry-config string + + + + + 包含 Azure 容器仓库配置信息的文件的路径。 + + + + + --cache-dir string     默认值: "~/.kube/http-cache" + + + + + 默认 HTTP 缓存目录 + + + + + --certificate-authority string + + + + + 指向证书机构的 cert 文件路径 + + + + + --client-certificate string + + + + + TLS 使用的客户端证书路径 + + + + + --client-key string + + + + + TLS 使用的客户端密钥文件路径 + + + + + --cloud-provider-gce-lb-src-cidrs cidrs     默认值: 130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16 + + + + + 在 GCE 防火墙中打开 CIDR，以进行 LB 流量代理和运行状况检查。 + + + + + --cluster string + + + + + 要使用的 kubeconfig 集群的名称 + + + + + --context string + + + + + 要使用的 kubeconfig 上下文的名称 + + + + + --default-not-ready-toleration-seconds int     默认值: 300 + + + + + 表示 `notReady` 状态的容忍度秒数：默认情况下，`NoExecute` 被添加到尚未具有此容忍度的每个 Pod 中。 + + + + + --default-unreachable-toleration-seconds int     默认值: 300 + + + + + 表示 `unreachable` 状态的容忍度秒数：默认情况下，`NoExecute` 被添加到尚未具有此容忍度的每个 Pod 中。 + + + + + -h, --help + + + + + kubectl 操作的帮助命令 + + + + + --insecure-skip-tls-verify + + + + + 设置为 true，则表示不会检查服务器证书的有效性。这样会导致您的 HTTPS 连接不安全。 + + + + + --kubeconfig string + + + + + CLI 请求使用的 kubeconfig 配置文件的路径。 + + + + + --log-backtrace-at traceLocation     默认值: 0 + + + + + 当日志机制运行到指定文件的指定行（file:N）时，打印调用堆栈信息 + + + + + --log-dir string + + + + + 如果不为空，则将日志文件写入此目录 + + + + + --log-file string + + + + + 如果不为空，则将使用此日志文件 + + + + + --log-file-max-size uint     默认值: 1800 + + + + + 定义日志文件的最大尺寸。单位为兆字节。如果值设置为 0，则表示日志文件大小不受限制。 + + + + + --log-flush-frequency duration     默认值: 5s + + + + + 两次日志刷新操作之间的最长时间（秒） + + + + + --logtostderr     默认值: true + + + + + 日志输出到 stderr 而不是文件中 + + + + + --match-server-version + + + + + 要求客户端版本和服务端版本相匹配 + + + + + -n, --namespace string + + + + + 如果存在，CLI 请求将使用此命名空间 + + + + + --password string + + + + + API 服务器进行基本身份验证的密码 + + + + + --profile string     默认值: "none" + + + + + 要记录的性能指标的名称。可取 (none|cpu|heap|goroutine|threadcreate|block|mutex) 其中之一。 + + + + + --profile-output string     默认值: "profile.pprof" + + + + + 用于转储所记录的性能信息的文件名 + + + + + --request-timeout string     默认值: "0" + + + + + 放弃单个服务器请求之前的等待时间，非零值需要包含相应时间单位（例如：1s、2m、3h）。零值则表示不做超时要求。 + + + + + -s, --server string + + + + + Kubernetes API 服务器的地址和端口 + + + + + --skip-headers + + + + + 设置为 true 则表示跳过在日志消息中出现 header 前缀信息 + + + + + --skip-log-headers + + + + + 设置为 true 则表示在打开日志文件时跳过 header 信息 + + + + + --stderrthreshold severity     默认值: 2 + + + + + 等于或高于此阈值的日志将输出到标准错误输出（stderr） + + + + + --token string + + + + + 用于对 API 服务器进行身份认证的持有者令牌 + + + + + --user string + + + + + 指定使用 kubeconfig 配置文件中的用户名 + + + + + --username string + + + + + 用于 API 服务器的基本身份验证的用户名 + + + + + -v, --v Level + + + + + 指定输出日志的日志详细级别 + + + + + --version version[=true] + + + + + 打印 kubectl 版本信息并退出 + + + + + --vmodule moduleSpec + + + + + 以逗号分隔的 pattern=N 设置列表，用于过滤文件的日志记录 + + + + + + + + +{{% /capture %}} + +{{% capture seealso %}} -######2018年6月16日，通过spf13/cobra自动生成 +* [kubectl annotate](/docs/reference/generated/kubectl/kubectl-commands#annotate) - 更新资源所关联的注解 +* [kubectl api-resources](/docs/reference/generated/kubectl/kubectl-commands#api-resources) - 打印服务器上所支持的 API 资源 +* [kubectl api-versions](/docs/reference/generated/kubectl/kubectl-commands#api-versions) - 以“组/版本”的格式输出服务端所支持的 API 版本 +* [kubectl apply](/docs/reference/generated/kubectl/kubectl-commands#apply) - 基于文件名或标准输入，将新的配置应用到资源上 +* [kubectl attach](/docs/reference/generated/kubectl/kubectl-commands#attach) - 连接到一个正在运行的容器 + +* [kubectl auth](/docs/reference/generated/kubectl/kubectl-commands#auth) - 检查授权信息 +* [kubectl autoscale](/docs/reference/generated/kubectl/kubectl-commands#autoscale) - 对一个资源对象（Deployment、ReplicaSet 或 ReplicationController ）进行扩缩 +* [kubectl certificate](/docs/reference/generated/kubectl/kubectl-commands#certificate) - 修改证书资源 +* [kubectl cluster-info](/docs/reference/generated/kubectl/kubectl-commands#cluster-info) - 显示集群信息 +* [kubectl completion](/docs/reference/generated/kubectl/kubectl-commands#completion) - 根据已经给出的 Shell（bash 或 zsh），输出 Shell 补全后的代码 +* [kubectl config](/docs/reference/generated/kubectl/kubectl-commands#config) - 修改 kubeconfig 配置文件 + +* [kubectl convert](/docs/reference/generated/kubectl/kubectl-commands#convert) - 在不同的 API 版本之间转换配置文件 +* [kubectl cordon](/docs/reference/generated/kubectl/kubectl-commands#cordon) - 标记节点为不可调度的 +* [kubectl cp](/docs/reference/generated/kubectl/kubectl-commands#cp) - 将文件和目录拷入/拷出容器。 +* [kubectl create](/docs/reference/generated/kubectl/kubectl-commands#create) - 通过文件或标准输入来创建资源 +* [kubectl delete](/docs/reference/generated/kubectl/kubectl-commands#delete) - 通过文件名、标准输入、资源和名字删除资源，或者通过资源和标签选择器来删除资源 + +* [kubectl describe](/docs/reference/generated/kubectl/kubectl-commands#describe) - 显示某个资源或某组资源的详细信息 +* [kubectl diff](/docs/reference/generated/kubectl/kubectl-commands#diff) - 显示目前版本与将要应用的版本之间的差异 +* [kubectl drain](/docs/reference/generated/kubectl/kubectl-commands#drain) - 腾空节点，准备维护 +* [kubectl edit](/docs/reference/generated/kubectl/kubectl-commands#edit) - 修改服务器上的某资源 +* [kubectl exec](/docs/reference/generated/kubectl/kubectl-commands#exec) - 在容器中执行相关命令 +* [kubectl explain](/docs/reference/generated/kubectl/kubectl-commands#explain) - 显示资源文档说明 +* [kubectl expose](/docs/reference/generated/kubectl/kubectl-commands#expose) - 给定副本控制器、服务、Deployment 或 Pod，将其暴露为新的 kubernetes Service + +* [kubectl get](/docs/reference/generated/kubectl/kubectl-commands#get) - 显示一个或者多个资源信息 +* [kubectl kustomize](/docs/reference/generated/kubectl/kubectl-commands#kustomize) - 从目录或远程 URL 中构建 kustomization +* [kubectl label](/docs/reference/generated/kubectl/kubectl-commands#label) - 更新资源的标签 +* [kubectl logs](/docs/reference/generated/kubectl/kubectl-commands#logs) - 输出 pod 中某容器的日志 +* [kubectl options](/docs/reference/generated/kubectl/kubectl-commands#options) - 打印所有命令都支持的共有参数列表 +* [kubectl patch](/docs/reference/generated/kubectl/kubectl-commands#patch) - 基于策略性合并修补（Stategic Merge Patch）规则更新某资源中的字段 + +* [kubectl plugin](/docs/reference/generated/kubectl/kubectl-commands#plugin) - 运行命令行插件 +* [kubectl port-forward](/docs/reference/generated/kubectl/kubectl-commands#port-forward) - 将一个或者多个本地端口转发到 pod +* [kubectl proxy](/docs/reference/generated/kubectl/kubectl-commands#proxy) - 运行一个 kubernetes API 服务器代理 +* [kubectl replace](/docs/reference/generated/kubectl/kubectl-commands#replace) - 基于文件名或标准输入替换资源 +* [kubectl rollout](/docs/reference/generated/kubectl/kubectl-commands#rollout) - 管理资源的上线 +* [kubectl run](/docs/reference/generated/kubectl/kubectl-commands#run) - 在集群中使用指定镜像启动容器 + +* [kubectl scale](/docs/reference/generated/kubectl/kubectl-commands#scale) - 为一个 Deployment、ReplicaSet、ReplicationController 或 Job 设置一个新的规模尺寸值 +* [kubectl set](/docs/reference/generated/kubectl/kubectl-commands#set) - 为对象设置功能特性 +* [kubectl taint](/docs/reference/generated/kubectl/kubectl-commands#taint) - 在一个或者多个节点上更新污点配置 +* [kubectl top](/docs/reference/generated/kubectl/kubectl-commands#top) - 显示资源（CPU /内存/存储）使用率 +* [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) - 实验性：等待一个或多个资源达到某种状态 +{{% /capture %}} - -* [kubectl alpha](kubectl_alpha.md) - kubectl alpha 功能 - -* [kubectl annotate](kubectl_annotate.md) - 更新资源所关联的注解 - -* [kubectl api-resources](kubectl_api-resources.md) - 打印服务器上所支持的 API 资源 - -* [kubectl api-versions](kubectl_api-versions.md) - 以“组/版本”的格式输出服务端支持的 API 版本 - -* [kubectl apply](kubectl_apply.md) - 基于文件名或标准输入，将新的配置应用到资源上 - -* [kubectl attach](kubectl_attach.md) - 连接到一个正在运行的容器 - -* [kubectl auth](kubectl_auth.md) - 检视授权信息 - -* [kubectl autoscale](kubectl_autoscale.md) - 对一个资源对象（ Deployment、ReplicaSet 或 ReplicationController ）进行扩缩 - -* [kubectl certificate](kubectl_certificate.md) - 修改证书资源 - -* [kubectl cluster-info](kubectl_cluster-info.md) - 显示集群信息 - -* [kubectl completion](kubectl_completion.md) - 根据已经给出的 Shell（bash 或 zsh），输出 Shell 补全后的代码 - -* [kubectl config](kubectl_config.md) - 修改 kubeconfig 配置文件 - -* [kubectl convert](kubectl_convert.md) - 在不同的 API 版本之间转换配置文件 - -* [kubectl cordon](kubectl_cordon.md) - 标记节点为不可调度的 - -* [kubectl cp](kubectl_cp.md) - 将文件和路径拷入/拷出容器。 - -* [kubectl create](kubectl_create.md) - 通过文件或标准输入来创建资源 - -* [kubectl delete](kubectl_delete.md) - 通过文件名、标准输入、资源和名字删除资源，或者通过资源和标签选择器来删除资源 - -* [kubectl describe](kubectl_describe.md) - 显示某个资源或某组资源的详细信息 - -* [kubectl drain](kubectl_drain.md) - 腾空节点，准备维护 - -* [kubectl edit](kubectl_edit.md) - 修改服务器上的某资源 - -* [kubectl exec](kubectl_exec.md) - 在容器中执行命令 - -* [kubectl explain](kubectl_explain.md) - 显示资源说明 - -* [kubectl expose](kubectl_expose.md) - 给定副本控制器、服务、Deployment 或 Pod，将其暴露为新的 kubernetes Service - -* [kubectl get](kubectl_get.md) - 显示一个或者多个资源信息 - -* [kubectl label](kubectl_label.md) - 更新资源的标签 - -* [kubectl logs](kubectl_logs.md) - 输出 pod 中某容器的日志 - -* [kubectl options](kubectl_options.md) - 打印所有命令都支持的共有参数列表 - -* [kubectl patch](kubectl_patch.md) - 基于策略性合并修补（Stategic Merge Patch）规则更新某资源中的字段 - -* [kubectl plugin](kubectl_plugin.md) - 运行命令行插件 - -* [kubectl port-forward](kubectl_port-forward.md) - 将一个或者多个本地端口转发到 pod - -* [kubectl proxy](kubectl_proxy.md) - 运行一个 kubernetes API 服务器代理 - -* [kubectl replace](kubectl_replace.md) - 基于文件名或标准输入替换资源 - -* [kubectl rollout](kubectl_rollout.md) - 管理资源的上线 - -* [kubectl run](kubectl_run.md) - 在集群中使用指定镜像启动容器 - -* [kubectl scale](kubectl_scale.md) - 为一个 Deployment、ReplicaSet、ReplicationController 或 Job 设置一个新的规模尺寸值 - -* [kubectl set](kubectl_set.md) - 在资源对象设置特定的功能 - -* [kubectl taint](kubectl_taint.md) - 在一个或者多个节点上更新污点配置 - -* [kubectl top](kubectl_top.md) - 显示资源（CPU /内存/存储）使用率 - -* [kubectl uncordon](kubectl_uncordon.md) - 标记节点为可调度的 - -* [kubectl version](kubectl_version.md) - 打印客户端和服务器的版本信息 - -* [kubectl wait](kubectl_wait.md) - 实验性：等待一个或多个资源达到某种状态