website/content/zh/docs/reference/kubectl/kubectl.md

title, notitle

title	notitle
kubectl	true

kubectl

kubectl 用来控制 Kubernetes 集群管理器

摘要

kubectl 用来控制 Kubernetes 集群管理器。

更多信息参见 /docs/reference/kubectl/overview/

kubectl [flags]

Options

      --alsologtostderr                  log to standard error as well as files
      --as string                        Username to impersonate for the operation
      --as-group stringArray             Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
      --cache-dir string                 Default HTTP cache directory (default "/home/username/.kube/http-cache")
      --certificate-authority string     Path to a cert file for the certificate authority
      --client-certificate string        Path to a client certificate file for TLS
      --client-key string                Path to a client key file for TLS
      --cluster string                   The name of the kubeconfig cluster to use
      --context string                   The name of the kubeconfig context to use
  -h, --help                             help for kubectl
      --insecure-skip-tls-verify         If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
      --kubeconfig string                Path to the kubeconfig file to use for CLI requests.
      --log-backtrace-at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
      --log-dir string                   If non-empty, write log files in this directory
      --logtostderr                      log to standard error instead of files
      --match-server-version             Require server version to match client version
  -n, --namespace string                 If present, the namespace scope for this CLI request
      --request-timeout string           The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
  -s, --server string                    The address and port of the Kubernetes API server
      --stderrthreshold severity         logs at or above this threshold go to stderr (default 2)
      --token string                     Bearer token for authentication to the API server
      --user string                      The name of the kubeconfig user to use
  -v, --v Level                          log level for V logs
      --vmodule moduleSpec               comma-separated list of pattern=N settings for file-filtered logging

-->

选项

      --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，使用逗号分隔

接下来看

• kubectl alpha - alpha环境上命令属性
• kubectl annotate - 更新资源上注释
• kubectl api-resources - 在服务器上打印支持的 API 资源
• kubectl api-versions - 以 "group/version" 的形式在服务器上打印支持的 API 版本
• kubectl apply - 通过文件名或标准输入将配置添加给资源
• kubectl attach - 附加到正在运行的容器
• kubectl auth - 检查授权
• kubectl autoscale - 自动扩展 Deployment, ReplicaSet 或 ReplicationController
• kubectl certificate - 修改证书资源。
• kubectl cluster-info - 展示集群信息
• kubectl completion - 为给定的 shell 输出完成代码（ bash 或 zsh）
• kubectl config - 修改 kubeconfig 配置文件
• kubectl convert - 在不同的 API 版本之间转换配置文件
• kubectl cordon - 将 node 节点标记为不可调度
• kubectl cp - 从容器复制文件和目录，也可将文件和目录复制到容器。
• kubectl create - 通过文件名或标准输入创建资源。
• kubectl delete - 通过文件名，标准输入，资源和名称或资源和标签选择器删除资源
• kubectl describe - 显示特定资源或资源组的详细信息
• kubectl drain - 为便于维护，需要提前驱逐node节点
• kubectl edit - 在服务器编辑资源
• kubectl exec - 容器内退出命令
• kubectl explain - 资源文档
• kubectl expose - 获取 replication controller, service, deployment 或 pod 资源，并作为新的 Kubernetes 服务暴露
• kubectl get - 展示一个或多个资源
• kubectl label - 升级资源标签
• kubectl logs - 为 pod 中的容器打印日志
• kubectl options - 打印所有命令继承的标识列表
• kubectl patch - 使用战略性合并补丁更新资源字段
• kubectl plugin - 运行命令行插件
• kubectl port-forward - 给 pod 开放一个或多个本地端口
• kubectl proxy - 为 Kubernetes API server 运行代理
• kubectl replace - 通过文件或标准输入替换资源
• kubectl rollout - 管理资源展示
• kubectl run - 在集群上运行指定镜像
• kubectl scale - 给 Deployment, ReplicaSet, Replication Controller 或 Job 设置新副本规模
• kubectl set - 给对象设置特定功能
• kubectl taint - 更新一个或多个 node 节点的污点信息
• kubectl top - 展示资源 (CPU/Memory/Storage) 使用信息。
• kubectl uncordon - 标记 node 节点为可调度
• kubectl version - 打印客户端和服务端版本信息
• kubectl wait - 试验: 在一个或多个资源上等待条件完成

######2018年6月16日，通过spf13/cobra自动生成

• kubectl alpha - kubectl alpha 功能

• 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 convert - 在不同的 API 版本之间转换配置文件

• kubectl cordon - 标记节点为不可调度的

• kubectl cp - 将文件和路径拷入/拷出容器。

• kubectl create - 通过文件或标准输入来创建资源

• kubectl delete - 通过文件名、标准输入、资源和名字删除资源，或者通过资源和标签选择器来删除资源

• kubectl describe - 显示某个资源或某组资源的详细信息

• kubectl drain - 腾空节点，准备维护

• kubectl edit - 修改服务器上的某资源

• kubectl exec - 在容器中执行命令

• kubectl explain - 显示资源说明

• kubectl expose - 给定副本控制器、服务、Deployment 或 Pod，将其暴露为新的 kubernetes Service

• kubectl get - 显示一个或者多个资源信息

• kubectl label - 更新资源的标签

• kubectl logs - 输出 pod 中某容器的日志

• kubectl options - 打印所有命令都支持的共有参数列表

• kubectl patch - 基于策略性合并修补（Stategic Merge Patch）规则更新某资源中的字段

• kubectl plugin - 运行命令行插件

• kubectl port-forward - 将一个或者多个本地端口转发到 pod

• kubectl proxy - 运行一个 kubernetes API 服务器代理

• kubectl replace - 基于文件名或标准输入替换资源

• kubectl rollout - 管理资源的上线

• kubectl run - 在集群中使用指定镜像启动容器

• kubectl scale - 为一个 Deployment、ReplicaSet、ReplicationController 或 Job 设置一个新的规模尺寸值

• kubectl set - 在资源对象设置特定的功能

• kubectl taint - 在一个或者多个节点上更新污点配置

• kubectl top - 显示资源（CPU /内存/存储）使用率

• kubectl uncordon - 标记节点为可调度的

• kubectl version - 打印客户端和服务器的版本信息

• kubectl wait - 实验性：等待一个或多个资源达到某种状态