Information in this document may be out of date
This document has an older update date than the original, so the information it contains may be out of date. If you're able to read English, see the English version for the most up-to-date information: kubectl
kubectl
简介
kubectl 管理控制 Kubernetes 集群。
更多信息请查阅命令行工具(kubectl
)。
kubectl [flags]
选项
--add-dir-header | |
设置为 true 表示添加文件目录到日志信息头中 | |
--alsologtostderr | |
表示将日志输出到文件的同时输出到 stderr | |
--as string | |
以指定用户的身份执行操作 | |
--as-group stringArray | |
模拟指定的组来执行操作,可以使用这个标志来指定多个组。 | |
--azure-container-registry-config string | |
包含 Azure 容器仓库配置信息的文件的路径。 | |
--cache-dir string 默认值:"$HOME/.kube/cache" | |
默认缓存目录 | |
--certificate-authority string | |
指向证书机构的 cert 文件路径 | |
--client-certificate string | |
TLS 使用的客户端证书路径 | |
--client-key string | |
TLS 使用的客户端密钥文件路径 | |
--cloud-provider-gce-l7lb-src-cidrs cidrs 默认值:130.211.0.0/22,35.191.0.0/16 | |
在 GCE 防火墙中开放的 CIDR,用来进行 L7 LB 流量代理和健康检查。 | |
--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,用来进行 L4 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 请求将使用此命名空间 | |
--one-output | |
如果为 true,则只将日志写入初始严重级别(而不是同时写入所有较低的严重级别)。 | |
--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 设置列表,用于过滤文件的日志记录 |
环境变量
KUBECONFIG | |
kubectl 的配置 ("kubeconfig") 文件的路径。默认值:"$HOME/.kube/config" | |
KUBECTL_COMMAND_HEADERS | |
设置为 false 时,将关闭额外的 HTTP 标头,不再详细说明被调用的 kubectl 命令(此变量适用于 Kubernetes v1.22 或更高版本) | |
KUBECTL_EXPLAIN_OPENAPIV3 | |
切换对 `kubectl explain` 的调用是否使用可用的新 OpenAPIv3 数据源。OpenAPIV3 自 Kubernetes 1.24 起默认被启用。 | |
KUBECTL_ENABLE_CMD_SHADOW | |
当设置为 true 时,如果子命令不存在,外部插件可以用作内置命令的子命令。 此功能处于 alpha 阶段,只能用于 create 命令(例如 kubectl create networkpolicy)。 | |
KUBECTL_REMOTE_COMMAND_WEBSOCKETS | |
当设置为 true 时,kubectl exec、cp 和 attach 命令将尝试使用 WebSocket 协议进行流式传输。 如果升级到 WebSocket 失败,这些命令将回退为使用当前的 SPDY 协议。 |
另请参见
- kubectl annotate - 更新资源所关联的注解
- kubectl api-resources - 打印服务器上所支持的 API 资源
- kubectl api-versions - 以“组/版本”的格式输出服务端所支持的 API 版本
- kubectl apply - 基于文件名或标准输入,将新的配置应用到资源上
- kubectl attach - 挂接到一个正在运行的容器
- kubectl auth - 检查授权信息
- kubectl autoscale - 对一个资源对象 (Deployment、ReplicaSet 或 ReplicationController)进行自动扩缩
- kubectl certificate - 修改证书资源
- kubectl cluster-info - 显示集群信息
- kubectl completion - 根据已经给出的 Shell(bash 或 zsh), 输出 Shell 补全后的代码
- kubectl config - 修改 kubeconfig 配置文件
- kubectl cordon - 标记节点为不可调度的
- kubectl cp - 将文件和目录拷入/拷出容器
- kubectl create - 通过文件或标准输入来创建资源
- kubectl debug - 创建用于排查工作负载和节点故障的调试会话
- kubectl delete - 通过文件名、标准输入、资源和名字删除资源, 或者通过资源和标签选择算符来删除资源
- kubectl describe - 显示某个资源或某组资源的详细信息
- kubectl diff - 显示目前版本与将要应用的版本之间的差异
- kubectl drain - 腾空节点,准备维护
- kubectl edit - 修改服务器上的某资源
- kubectl events - 列举事件
- kubectl exec - 在容器中执行相关命令
- kubectl explain - 显示资源文档说明
- kubectl expose - 给定副本控制器、服务、Deployment 或 Pod, 将其暴露为新的 kubernetes Service
- kubectl get - 显示一个或者多个资源信息
- kubectl kustomize - 从目录或远程 URL 中构建 kustomization
- kubectl label - 更新资源的标签
- kubectl logs - 输出 Pod 中某容器的日志
- kubectl options - 打印所有命令都支持的共有参数列表
- kubectl patch - 更新某资源中的字段
- kubectl plugin - 运行命令行插件
- kubectl port-forward - 将一个或者多个本地端口转发到 Pod
- kubectl proxy - 运行一个 kubernetes API 服务器代理
- kubectl replace - 基于文件名或标准输入替换资源
- kubectl rollout - 管理资源的上线
- kubectl run - 在集群中使用指定镜像启动容器
- kubectl scale - 为一个 Deployment、ReplicaSet 或 ReplicationController 设置一个新的规模值
- kubectl set - 为对象设置功能特性
- kubectl taint - 在一个或者多个节点上更新污点配置
- kubectl top - 显示资源(CPU/内存/存储)使用率
- kubectl uncordon - 标记节点为可调度的
- kubectl version - 打印客户端和服务器的版本信息
- kubectl wait - 实验级特性:等待一个或多个资源达到某种状态
最后修改 February 23, 2024 at 10:24 AM PST: [zh] Sync /kubectl/kubectl.md (354260f1e4)