kubectl
概要
kubectl 控制 Kubernetes 集群管理器。
在命令行工具 (kubectl
) 中查找更多信息。
kubectl [flags]
选项
--add-dir-header | |
如果为 true,则将文件目录添加到日志消息的头部 | |
--alsologtostderr | |
同时记录到标准错误和文件 | |
--as string | |
用于操作的模拟用户名 | |
--as-group stringArray | |
用于操作的模拟用户组,此标志可以重复以指定多个组。 | |
--azure-container-registry-config string | |
包含 Azure 容器注册表配置信息的文件的路径。 | |
--cache-dir string 默认值: "$HOME/.kube/cache" | |
默认缓存目录 | |
--certificate-authority string | |
证书颁发机构证书文件的路径 | |
--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 防火墙中为 L7 LB 流量代理和健康检查开放的 CIDR | |
--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 防火墙中为 L4 LB 流量代理和健康检查开放的 CIDR | |
--cluster string | |
要使用的 kubeconfig 集群名称 | |
--context string | |
要使用的 kubeconfig 上下文名称 | |
--default-not-ready-toleration-seconds int 默认值: 300 | |
表示默认添加到每个尚未具有此类容忍度的 Pod 的 notReady:NoExecute 容忍度的 tolerationSeconds。 | |
--default-unreachable-toleration-seconds int 默认值: 300 | |
表示默认添加到每个尚未具有此类容忍度的 Pod 的 unreachable:NoExecute 容忍度的 tolerationSeconds。 | |
-h, --help | |
kubectl 帮助 | |
--insecure-skip-tls-verify | |
如果为 true,则不检查服务器证书的有效性。这将使你的 HTTPS 连接不安全 | |
--kubeconfig string | |
用于 CLI 请求的 kubeconfig 文件路径。 | |
--log-backtrace-at traceLocation 默认值: :0 | |
当日志命中文件:N 行时,输出堆栈跟踪 | |
--log-dir string | |
如果非空,将日志文件写入此目录 | |
--log-file string | |
如果非空,使用此日志文件 | |
--log-file-max-size uint 默认值: 1800 | |
定义日志文件可以增长到的最大大小。单位是兆字节。如果值为 0,则最大文件大小不受限制。 | |
--log-flush-frequency duration 默认值: 5s | |
日志刷新之间的最大秒数 | |
--logtostderr 默认值: true | |
记录到标准错误而不是文件 | |
--match-server-version | |
要求服务器版本与客户端版本匹配 | |
-n, --namespace string | |
如果存在,此 CLI 请求的命名空间范围 | |
--one-output | |
如果为 true,则只将日志写入其原生严重级别(而不是也写入每个较低严重级别) | |
--password string | |
用于向 API 服务器进行基本身份验证的密码 | |
--profile string 默认值: "none" | |
要捕获的 profile 名称。可选值包括 (none|cpu|heap|goroutine|threadcreate|block|mutex) | |
--profile-output string 默认值: "profile.pprof" | |
写入 profile 的文件名 | |
--request-timeout string 默认值: "0" | |
在放弃单个服务器请求之前等待的时间长度。非零值应包含相应的时间单位(例如 1s, 2m, 3h)。零值表示请求不超时。 | |
-s, --server string | |
Kubernetes API 服务器的地址和端口 | |
--skip-headers | |
如果为 true,避免在日志消息中使用头部前缀 | |
--skip-log-headers | |
如果为 true,打开日志文件时避免使用头部 | |
--stderrthreshold severity 默认值: 2 | |
日志级别等于或高于此阈值的日志将输出到标准错误 | |
--tls-server-name string | |
用于服务器证书验证的服务器名称。如果未提供,则使用用于联系服务器的主机名 | |
--token string | |
用于向 API 服务器进行身份验证的 Bearer token | |
--user string | |
要使用的 kubeconfig 用户名 | |
--username string | |
用于向 API 服务器进行基本身份验证的用户名 | |
-v, --v Level | |
日志级别详细程度的数字 | |
--version version[=true] | |
打印版本信息并退出 | |
--vmodule moduleSpec | |
逗号分隔的 pattern=N 设置列表,用于文件过滤的日志记录 | |
--warnings-as-errors | |
将从服务器收到的警告视为错误并以非零退出码退出 |
环境变量
KUBECONFIG | |
kubectl 配置 ("kubeconfig") 文件路径。默认值: "$HOME/.kube/config" | |
KUBECTL_COMMAND_HEADERS | |
设置为 false 时,关闭显示已调用 kubectl 命令细节的额外 HTTP 头部(Kubernetes v1.22 或更高版本) | |
KUBECTL_EXPLAIN_OPENAPIV3 | |
切换 `kubectl explain` 调用是否使用新的 OpenAPIv3 数据源。自 Kubernetes 1.24 起,OpenAPIV3 默认启用。 | |
KUBECTL_ENABLE_CMD_SHADOW | |
设置为 true 时,如果内建命令的子命令不存在,外部插件可以用作内建命令的子命令。在 alpha 阶段,此特性仅可用于 create 命令(例如 kubectl create networkpolicy)。 | |
KUBECTL_PORT_FORWARD_WEBSOCKETS | |
设置为 true 时,kubectl port-forward 命令将尝试使用 websockets 协议进行流传输。如果升级到 websockets 失败,该命令将回退到使用当前的 SPDY 协议。 | |
KUBECTL_REMOTE_COMMAND_WEBSOCKETS | |
设置为 true 时,kubectl exec, cp 和 attach 命令将尝试使用 websockets 协议进行流传输。如果升级到 websockets 失败,这些命令将回退到使用当前的 SPDY 协议。 | |
KUBECTL_KUBERC | |
设置为 true 时,kuberc 文件会被考虑以定义用户特定的偏好设置。 |
参阅
- kubectl annotate - 更新资源的注解
- kubectl api-resources - 打印服务器上支持的 API 资源
- kubectl api-versions - 打印服务器上支持的 API 版本,格式为 "group/version"
- kubectl apply - 通过文件名或 stdin 对资源应用配置
- 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 - 从文件或 stdin 创建资源。
- kubectl debug - 为调试工作负载和节点创建调试会话
- kubectl delete - 通过文件名、stdin、资源和名称或通过资源和标签选择器删除资源
- kubectl describe - 显示特定资源或资源组的详细信息
- kubectl diff - 比较实时版本与将要应用的版本的差异
- kubectl drain - 为维护准备排空节点
- kubectl edit - 编辑服务器上的资源
- kubectl events - 列出事件
- kubectl exec - 在容器中执行命令
- kubectl explain - 资源的文档说明
- kubectl expose - 将 replication controller、service、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 - 通过文件名或 stdin 替换资源
- kubectl rollout - 管理资源的上线
- kubectl run - 在集群上运行特定的镜像
- kubectl scale - 设置 Deployment、ReplicaSet 或 Replication Controller 的新大小
- kubectl set - 在对象上设置特定功能
- kubectl taint - 更新一个或多个节点的污点
- kubectl top - 显示资源(CPU/内存/存储)使用情况。
- kubectl uncordon - 标记节点为可调度
- kubectl version - 打印客户端和服务器版本信息
- kubectl wait - 实验性:等待一个或多个资源达到特定条件。
上次修改于 2025 年 2 月 12 日太平洋标准时间 9:16 AM: 添加 KUBECTL_KUBERC 环境变量描述 (a9f3315985)