kubectl expose

概要

将一个资源暴露为一个新的 Kubernetes Service。

通过名称查找 Deployment、Service、Replica Set、Replication Controller 或 Pod,并使用该资源的选择器作为新 Service 在指定端口上的选择器。Deployment 或 Replica Set 仅当其选择器可转换为 Service 支持的选择器时(即选择器仅包含 matchLabels 组件时)才会被暴露为 Service。请注意,如果未通过 --port 指定端口,并且被暴露的资源有多个端口,则新 Service 将重用所有这些端口。此外,如果未指定标签,则新 Service 将重用其所暴露资源的标签。

可能的资源包括(不区分大小写)

pod (po), service (svc), replicationcontroller (rc), deployment (deploy), replicaset (rs)

kubectl expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP|SCTP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type]

示例

  # Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000
  kubectl expose rc nginx --port=80 --target-port=8000
  
  # Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000
  kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000
  
  # Create a service for a pod valid-pod, which serves on port 444 with the name "frontend"
  kubectl expose pod valid-pod --port=444 --name=frontend
  
  # Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https"
  kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https
  
  # Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'.
  kubectl expose rc streamer --port=4100 --protocol=UDP --name=video-stream
  
  # Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000
  kubectl expose rs nginx --port=80 --target-port=8000
  
  # Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000
  kubectl expose deployment nginx --port=80 --target-port=8000

选项

--allow-missing-template-keys     默认值: true

如果为 true,则在模板中字段或 map key 缺失时忽略模板中的任何错误。仅适用于 golang 和 jsonpath 输出格式。

--cluster-ip string

要分配给 Service 的 ClusterIP。留空以自动分配,或设置为 'None' 以创建无头 Service。

--dry-run string[="unchanged"]     默认值: "none"

必须是 "none"、"server" 或 "client"。如果策略是 client,则只打印将要发送的对象,但不实际发送。如果策略是 server,则提交服务器端请求但不持久化资源。

--external-ip string

Service 要接受的额外外部 IP 地址(非 Kubernetes 管理)。如果此 IP 被路由到节点,则除了生成的 Service IP 外,还可以通过此 IP 访问 Service。

--field-manager string     默认值: "kubectl-expose"

用于跟踪字段所有权的管理器的名称。

-f, --filename strings

文件名、目录或 URL,指向标识要暴露 Service 的资源的文件。

-h, --help

expose 命令的帮助信息

-k, --kustomize string

处理 kustomization 目录。此标志不能与 -f 或 -R 一起使用。

-l, --labels string

应用于此调用创建的 Service 的标签。

--load-balancer-ip string

要分配给 LoadBalancer 的 IP。如果为空,将创建并使用一个临时 IP(取决于云提供商)。

--name string

新创建对象的名称。

-o, --output string

输出格式。以下之一: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file)。

--override-type string     默认值: "merge"

用于覆盖生成对象的方法: json, merge, 或 strategic。

--overrides string

生成对象的内联 JSON 覆盖。如果此值不为空,则用于覆盖生成对象。要求对象提供有效的 apiVersion 字段。

--port string

Service 应在其上提供服务的端口。如果未指定,则从被暴露的资源复制。

--protocol string

将要创建的 Service 的网络协议。默认值为 'TCP'。

-R, --recursive

递归处理 -f, --filename 中使用的目录。当你想管理组织在同一目录下的相关 manifest 文件时非常有用。

--save-config

如果为 true,当前对象的配置将保存在其 annotation 中。否则,annotation 将保持不变。当将来想对此对象执行 kubectl apply 时,此标志很有用。

--selector string

用于此 Service 的标签选择器。仅支持基于等价关系的选择器要求。如果为空(默认),则从 replication controller 或 replica set 中推断选择器。)

--session-affinity string

如果不为空,则将此 Service 的会话亲和性设置为此值;合法值: 'None', 'ClientIP'。

--show-managed-fields

如果为 true,则在以 JSON 或 YAML 格式打印对象时保留 managedFields。

--target-port string

Service 应将流量导向的容器上的端口名称或编号。可选。

--template string

当 -o=go-template, -o=go-template-file 时使用的模板字符串或模板文件路径。模板格式为 golang 模板 [https://golang.ac.cn/pkg/text/template/#pkg-overview]。

--type string

此 Service 的类型: ClusterIP, NodePort, LoadBalancer, 或 ExternalName。默认值为 'ClusterIP'。

继承的父选项

--as string

操作时要模拟的用户名。用户可以是普通用户或命名空间中的 ServiceAccount。

--as-group strings

操作时要模拟的组,此标志可以重复以指定多个组。

--as-uid string

操作时要模拟的 UID。

--cache-dir string     默认值: "$HOME/.kube/cache"

默认缓存目录

--certificate-authority string

证书颁发机构的证书文件路径。

--client-certificate string

用于 TLS 的客户端证书文件路径。

--client-key string

用于 TLS 的客户端密钥文件路径。

--cluster string

要使用的 kubeconfig 集群的名称。

--context string

要使用的 kubeconfig context 的名称。

--default-not-ready-toleration-seconds int     默认值: 300

指示默认添加到每个尚不具有此类容忍度的 Pod 的 notReady:NoExecute 容忍度的 tolerationSeconds。

--default-unreachable-toleration-seconds int     默认值: 300

指示默认添加到每个尚不具有此类容忍度的 Pod 的 unreachable:NoExecute 容忍度的 tolerationSeconds。

--disable-compression

如果为 true,则对于发送到服务器的所有请求,不进行响应压缩。

--insecure-skip-tls-verify

如果为 true,则不检查服务器证书的有效性。这将使你的 HTTPS 连接不安全。

--kubeconfig string

用于 CLI 请求的 kubeconfig 文件路径。

--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 服务器的地址和端口。

--storage-driver-buffer-duration duration     默认值: 1m0s

存储驱动程序中的写入将在此持续时间内进行缓冲,并作为单个事务提交给非内存后端。

--storage-driver-db string     默认值: "cadvisor"

数据库名称。

--storage-driver-host string     默认值: "localhost:8086"

数据库主机:端口。

--storage-driver-password string     默认值: "root"

数据库密码。

--storage-driver-secure

使用安全的数据库连接。

--storage-driver-table string     默认值: "stats"

表名。

--storage-driver-user string     默认值: "root"

数据库用户名。

--tls-server-name string

用于服务器证书验证的服务器名称。如果未提供,则使用用于联系服务器的主机名。

--token string

用于向 API 服务器进行认证的 Bearer Token。

--user string

要使用的 kubeconfig 用户的名称。

--username string

用于向 API 服务器进行基本认证的用户名。

--version version[=true]

--version, --version=raw 打印版本信息并退出;--version=vX.Y.Z... 设置报告的版本。

--warnings-as-errors

将从服务器接收到的警告视为错误,并以非零退出码退出。

参阅

  • kubectl - kubectl 控制 Kubernetes 集群管理器

此页面是自动生成的。

如果你打算报告此页面存在的问题,请在问题描述中提及此页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

最后修改于 2024 年 8 月 19 日 下午 5:14 PST: 更新 kubectl 参考文档至 v1.31 (59df28c340)