服务
apiVersion: v1
import "k8s.io/api/core/v1"
服务
Service 是软件服务(例如 mysql)的命名抽象,由代理侦听的本地端口(例如 3306)和确定哪些 Pod 将响应通过代理发送的请求的选择器组成。
apiVersion: v1
kind: Service
metadata (ObjectMeta)
标准对象的元数据。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (ServiceSpec)
Spec 定义了服务的行为。https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
status (ServiceStatus)
最近观察到的服务状态。由系统填充。只读。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
ServiceSpec
ServiceSpec 描述了用户在服务上创建的属性。
selector (map[string]string)
将服务流量路由到具有与此选择器匹配的标签键和值的 Pod。如果为空或不存在,则假定该服务具有一个外部进程来管理其端点,Kubernetes 不会修改这些端点。仅适用于 ClusterIP、NodePort 和 LoadBalancer 类型。如果类型为 ExternalName,则忽略此项。更多信息:https://kubernetes.ac.cn/docs/concepts/services-networking/service/
ports ([]ServicePort)
补丁策略:在键
port
上合并映射:在合并期间,键
port, protocol
上的唯一值将被保留此服务公开的端口列表。更多信息:https://kubernetes.ac.cn/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
ports.port (int32),必需
此服务将公开的端口。
ports.targetPort (IntOrString)
要访问服务目标 Pod 的端口的数字或名称。数字必须在 1 到 65535 范围内。名称必须为 IANA_SVC_NAME。如果这是一个字符串,它将在目标 Pod 的容器端口中查找为命名端口。如果未指定,则使用“port”字段的值(标识映射)。对于 clusterIP=None 的服务,将忽略此字段,应省略或将其设置为等于“port”字段。更多信息:https://kubernetes.ac.cn/docs/concepts/services-networking/service/#defining-a-service
IntOrString 是一种可以保存 int32 或字符串的类型。在 JSON 或 YAML 编组和解组中使用时,它会生成或使用内部类型。这使您可以拥有一个可以接受名称或数字的 JSON 字段。
ports.protocol (string)
此端口的 IP 协议。支持 "TCP"、"UDP" 和 "SCTP"。默认值为 TCP。
ports.name (string)
此端口在服务内的名称。这必须是 DNS_LABEL。ServiceSpec 中的所有端口都必须具有唯一的名称。在考虑服务的端点时,这必须与 EndpointPort 中的“name”字段匹配。如果在此服务上仅定义了一个 ServicePort,则此为可选。
ports.nodePort (int32)
当类型为 NodePort 或 LoadBalancer 时,此服务在每个节点上公开的端口。通常由系统分配。如果指定了一个值,并且该值在范围内且未使用,则将使用它,否则操作将失败。如果未指定,如果此服务需要,则将分配一个端口。如果在创建不需要此字段的服务时指定此字段,则创建将失败。当更新服务不再需要它时(例如,将类型从 NodePort 更改为 ClusterIP),将擦除此字段。更多信息:https://kubernetes.ac.cn/docs/concepts/services-networking/service/#type-nodeport
ports.appProtocol (string)
此端口的应用程序协议。它用作提示,供实现为他们理解的协议提供更丰富的行为。此字段遵循标准的 Kubernetes 标签语法。有效值可以是
无前缀协议名称 - 保留用于 IANA 标准服务名称(根据 RFC-6335 和 https://www.iana.org/assignments/service-names))。
Kubernetes 定义的前缀名称
- 'kubernetes.io/h2c' - HTTP/2 通过明文的预先知识,如 https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- 中所述
- 'kubernetes.io/ws' - 通过明文的 WebSocket,如 https://www.rfc-editor.org/rfc/rfc6455 中所述
- 'kubernetes.io/wss' - 通过 TLS 的 WebSocket,如 https://www.rfc-editor.org/rfc/rfc6455 中所述
其他协议应使用实现定义的前缀名称,例如 mycompany.com/my-custom-protocol。
type (string)
type 确定如何公开 Service。默认为 ClusterIP。有效选项为 ExternalName、ClusterIP、NodePort 和 LoadBalancer。"ClusterIP" 分配一个集群内部 IP 地址,用于负载均衡到端点。端点由选择器确定,如果未指定选择器,则通过手动构造 Endpoints 对象或 EndpointSlice 对象来确定。如果 clusterIP 为“None”,则不会分配虚拟 IP,端点将作为一组端点而不是虚拟 IP 发布。"NodePort" 基于 ClusterIP 构建,并在每个节点上分配一个端口,该端口路由到与 clusterIP 相同的端点。"LoadBalancer" 基于 NodePort 构建,并创建一个外部负载均衡器(如果当前云中支持),该负载均衡器路由到与 clusterIP 相同的端点。"ExternalName" 将此服务别名为指定的 externalName。其他几个字段不适用于 ExternalName 服务。更多信息:https://kubernetes.ac.cn/docs/concepts/services-networking/service/#publishing-services-service-types
ipFamilies ([]string)
原子性:将在合并期间被替换
IPFamilies 是分配给此服务的 IP 系列(例如,IPv4、IPv6)的列表。此字段通常根据集群配置和 ipFamilyPolicy 字段自动分配。如果手动指定此字段,则请求的系列在集群中可用,并且 ipFamilyPolicy 允许它,则将使用它;否则,创建服务将失败。此字段是条件可变的:它允许添加或删除辅助 IP 系列,但不允许更改 Service 的主 IP 系列。有效值为“IPv4”和“IPv6”。此字段仅适用于 ClusterIP、NodePort 和 LoadBalancer 类型的 Service,并且适用于“无头”服务。当将 Service 更新为 ExternalName 类型时,将擦除此字段。
此字段最多可包含两个条目(双栈系列,无论顺序如何)。如果指定,这些系列必须与 clusterIPs 字段的值相对应。clusterIPs 和 ipFamilies 都受 ipFamilyPolicy 字段的约束。
ipFamilyPolicy (string)
IPFamilyPolicy 表示此服务请求或要求的双栈性。如果没有提供值,则此字段将设置为 SingleStack。服务可以是 “SingleStack”(单个 IP 系列)、“PreferDualStack”(在双栈配置的集群上使用两个 IP 系列,或者在单栈集群上使用单个 IP 系列)或 “RequireDualStack”(在双栈配置的集群上使用两个 IP 系列,否则失败)。ipFamilies 和 clusterIPs 字段取决于此字段的值。当将服务更新为 ExternalName 类型时,此字段将被清除。
clusterIP (字符串)
clusterIP 是服务的 IP 地址,通常是随机分配的。如果手动指定了地址,并且该地址在范围内(根据系统配置),并且未使用,则会将其分配给服务;否则,服务创建将失败。除非 type 字段也被更改为 ExternalName(这要求此字段为空),或者 type 字段从 ExternalName 更改,否则此字段不能通过更新进行更改(在这种情况下,可以可选地指定此字段,如上所述)。有效值为 "None"、空字符串 ("") 或有效的 IP 地址。将此设置为 "None" 会创建一个 “无头服务”(没有虚拟 IP),当首选直接端点连接且不需要代理时,这很有用。仅适用于 ClusterIP、NodePort 和 LoadBalancer 类型。如果在创建类型为 ExternalName 的服务时指定了此字段,则创建将失败。当将服务更新为 ExternalName 类型时,此字段将被清除。更多信息:https://kubernetes.ac.cn/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
clusterIPs ([]字符串)
原子性:将在合并期间被替换
ClusterIPs 是分配给此服务的 IP 地址列表,通常是随机分配的。如果手动指定了地址,并且该地址在范围内(根据系统配置),并且未使用,则会将其分配给服务;否则,服务创建将失败。除非 type 字段也被更改为 ExternalName(这要求此字段为空),或者 type 字段从 ExternalName 更改,否则此字段不能通过更新进行更改(在这种情况下,可以可选地指定此字段,如上所述)。有效值为 "None"、空字符串 ("") 或有效的 IP 地址。将此设置为 "None" 会创建一个 “无头服务”(没有虚拟 IP),当首选直接端点连接且不需要代理时,这很有用。仅适用于 ClusterIP、NodePort 和 LoadBalancer 类型。如果在创建类型为 ExternalName 的服务时指定了此字段,则创建将失败。当将服务更新为 ExternalName 类型时,此字段将被清除。如果未指定此字段,它将从 clusterIP 字段初始化。如果指定了此字段,客户端必须确保 clusterIPs[0] 和 clusterIP 具有相同的值。
此字段最多可以包含两个条目(双栈 IP,顺序不限)。这些 IP 必须与 ipFamilies 字段的值相对应。clusterIPs 和 ipFamilies 都受 ipFamilyPolicy 字段的控制。更多信息:https://kubernetes.ac.cn/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
externalIPs ([]字符串)
原子性:将在合并期间被替换
externalIPs 是一个 IP 地址列表,集群中的节点也将接受该服务发送到这些 IP 地址的流量。这些 IP 地址不由 Kubernetes 管理。用户负责确保流量到达具有此 IP 的节点。一个常见的例子是不属于 Kubernetes 系统的外部负载均衡器。
sessionAffinity (字符串)
支持 “ClientIP” 和 “None”。用于维护会话亲和性。启用基于客户端 IP 的会话亲和性。必须为 ClientIP 或 None。默认为 None。更多信息:https://kubernetes.ac.cn/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
loadBalancerIP (字符串)
仅适用于服务类型:LoadBalancer。此功能取决于底层云提供商是否支持在创建负载均衡器时指定 loadBalancerIP。如果云提供商不支持该功能,则将忽略此字段。已弃用:此字段未被充分指定,并且其含义在不同的实现中有所不同。使用它是不可移植的,并且可能不支持双栈。建议用户在可用时使用特定于实现的注解。
loadBalancerSourceRanges ([]字符串)
原子性:将在合并期间被替换
如果指定且平台支持,这将限制通过云提供商负载均衡器的流量,限制为指定的客户端 IP。如果云提供商不支持此功能,则将忽略此字段。” 更多信息:https://kubernetes.ac.cn/docs/tasks/access-application-cluster/create-external-load-balancer/
loadBalancerClass (字符串)
loadBalancerClass 是此服务所属的负载均衡器实现的类。如果指定,此字段的值必须是标签样式的标识符,带有可选的前缀,例如 “internal-vip” 或 “example.com/internal-vip”。不带前缀的名称保留给最终用户使用。只有当服务类型为 “LoadBalancer” 时,才能设置此字段。如果未设置,则使用默认的负载均衡器实现,目前通常是通过云提供商集成完成,但也应适用于任何默认实现。如果设置,则假定负载均衡器实现正在监视具有匹配类的服务。任何默认的负载均衡器实现(例如,云提供商)都应忽略设置此字段的服务。只有在创建或更新服务类型为 “LoadBalancer” 时,才能设置此字段。一旦设置,就无法更改。当将服务更新为非 “LoadBalancer” 类型时,此字段将被清除。
externalName (字符串)
externalName 是发现机制将作为此服务的别名返回的外部引用(例如,DNS CNAME 记录)。不涉及代理。必须是小写的 RFC-1123 主机名 (https://tools.ietf.org/html/rfc1123),并且需要
type
为 “ExternalName”。externalTrafficPolicy (字符串)
externalTrafficPolicy 描述节点如何分配它们在服务的 “面向外部” 地址(NodePorts、ExternalIPs 和 LoadBalancer IPs)上接收到的服务流量。如果设置为 “Local”,则代理将配置服务,使其假定外部负载均衡器将负责在节点之间平衡服务流量,因此每个节点将仅将流量传递到服务的节点本地端点,而不会伪装客户端源 IP。(错误地发送到没有端点的节点的流量将被丢弃。)默认值 “Cluster” 使用标准行为,均匀地路由到所有端点(可能由拓扑和其他功能修改)。请注意,从集群内部发送到外部 IP 或 LoadBalancer IP 的流量将始终获得 “Cluster” 语义,但是从集群内部发送到 NodePort 的客户端在选择节点时可能需要考虑流量策略。
internalTrafficPolicy (字符串)
InternalTrafficPolicy 描述节点如何分配它们在 ClusterIP 上接收到的服务流量。如果设置为 “Local”,则代理将假定 pod 只想与与 pod 位于同一节点上的服务的端点通信,如果不存在本地端点,则丢弃流量。默认值 “Cluster” 使用标准行为,均匀地路由到所有端点(可能由拓扑和其他功能修改)。
healthCheckNodePort (int32)
healthCheckNodePort 指定服务的运行状况检查 nodePort。这仅在类型设置为 LoadBalancer 且 externalTrafficPolicy 设置为 Local 时适用。如果指定了一个值,该值在范围内且未使用,则将使用它。如果未指定,则将自动分配一个值。外部系统(例如负载均衡器)可以使用此端口来确定给定节点是否包含此服务的端点。如果在创建不需要此字段的服务时指定了此字段,则创建将失败。当更新服务使其不再需要此字段(例如,更改类型)时,此字段将被清除。一旦设置,就无法更新此字段。
publishNotReadyAddresses (布尔值)
publishNotReadyAddresses 指示任何处理此服务端点的代理都应忽略任何就绪/未就绪的指示。设置此字段的主要用例是,StatefulSet 的无头服务为其 Pod 传播 SRV DNS 记录,以实现对等发现。为服务生成 Endpoints 和 EndpointSlice 资源的 Kubernetes 控制器将此解释为意味着所有端点都被认为是 “就绪” 的,即使 Pod 本身不是。仅通过 Endpoints 或 EndpointSlice 资源使用 Kubernetes 生成的端点的代理可以安全地假设此行为。
sessionAffinityConfig (SessionAffinityConfig)
sessionAffinityConfig 包含会话亲和性的配置。
allocateLoadBalancerNodePorts (布尔值)
allocateLoadBalancerNodePorts 定义是否为类型为 LoadBalancer 的服务自动分配 NodePorts。默认为 “true”。如果集群负载均衡器不依赖于 NodePorts,则可以将其设置为 “false”。如果调用方请求特定的 NodePorts(通过指定一个值),则将尊重这些请求,而不管此字段如何。此字段只能为类型为 LoadBalancer 的服务设置,如果类型更改为任何其他类型,则此字段将被清除。
trafficDistribution (字符串)
TrafficDistribution 提供了一种表达如何将流量分配给服务端点的偏好的方法。实现可以使用此字段作为提示,但不需要保证严格遵守。如果未设置该字段,则实现将应用其默认路由策略。如果设置为 “PreferClose”,则实现应优先考虑拓扑上接近的端点(例如,同一区域)。这是一个 beta 字段,需要启用 ServiceTrafficDistribution 功能。
ServiceStatus
ServiceStatus 表示服务的当前状态。
conditions ([]Condition)
补丁策略:合并键
type
映射:在合并期间将保留键类型上的唯一值
当前服务状态
Condition 包含此 API 资源的当前状态的某一个方面的详细信息。
conditions.lastTransitionTime (Time), 必需
lastTransitionTime 是条件从一个状态转换到另一个状态的最后时间。这应该是底层条件更改的时间。如果未知,则使用 API 字段更改的时间是可以接受的。
Time 是 time.Time 的包装器,它支持正确地编组为 YAML 和 JSON。为 time 包提供的许多工厂方法提供了包装器。
conditions.message (字符串), 必需
message 是一个人类可读的消息,指示有关转换的详细信息。这可能是一个空字符串。
conditions.reason (字符串), 必需
reason 包含一个程序化的标识符,指示条件上次转换的原因。特定条件类型的生产者可以为该字段定义期望值和含义,以及这些值是否被视为有保障的 API。该值应为 CamelCase 字符串。此字段不能为空。
conditions.status (字符串),必需
条件的状态,为 True、False 或 Unknown 之一。
conditions.type (字符串),必需
条件的类型,采用 CamelCase 格式或 foo.example.com/CamelCase 格式。
conditions.observedGeneration (int64)
observedGeneration 表示设置条件所基于的 .metadata.generation。例如,如果 .metadata.generation 当前为 12,但 .status.conditions[x].observedGeneration 为 9,则该条件相对于实例的当前状态已过时。
loadBalancer (LoadBalancerStatus)
LoadBalancer 包含负载均衡器的当前状态(如果存在)。
LoadBalancerStatus 表示负载均衡器的状态。
loadBalancer.ingress ([]LoadBalancerIngress)
原子性:将在合并期间被替换
Ingress 是包含负载均衡器入口点的列表。发往服务的流量应发送到这些入口点。
LoadBalancerIngress 表示负载均衡器入口点的状态:发往服务的流量应发送到入口点。
loadBalancer.ingress.hostname (字符串)
Hostname 为基于 DNS 的负载均衡器入口点(通常是 AWS 负载均衡器)设置。
loadBalancer.ingress.ip (字符串)
IP 为基于 IP 的负载均衡器入口点(通常是 GCE 或 OpenStack 负载均衡器)设置。
loadBalancer.ingress.ipMode (字符串)
IPMode 指定负载均衡器 IP 的行为方式,并且仅当指定了 ip 字段时才可以指定。将其设置为“VIP”表示流量将传送到目标设置为负载均衡器 IP 和端口的节点。将其设置为“Proxy”表示流量将传送到目标设置为节点 IP 和节点端口或 Pod IP 和端口的节点或 Pod。服务实现可以使用此信息来调整流量路由。
loadBalancer.ingress.ports ([]PortStatus)
原子性:将在合并期间被替换
Ports 是服务端口记录的列表。如果使用,则服务中定义的每个端口都应在其中有一个条目。
loadBalancer.ingress.ports.port (int32),必需
Port 是此处记录状态的服务端口的端口号。
loadBalancer.ingress.ports.protocol (字符串),必需
Protocol 是此处记录状态的服务端口的协议。支持的值为:“TCP”、“UDP”、“SCTP”
loadBalancer.ingress.ports.error (字符串)
Error 用于记录服务端口的问题。错误的格式应符合以下规则: - 内置错误值应在此文件中指定,并且这些值应使用 CamelCase 名称。
- 云提供商特定的错误值必须具有符合 foo.example.com/CamelCase 格式的名称。
ServiceList
ServiceList 保存服务列表。
apiVersion: v1
kind: ServiceList
metadata (ListMeta)
标准列表元数据。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
items ([]Service),必需
服务列表
操作
get
读取指定的 Service
HTTP 请求
GET /api/v1/namespaces/{namespace}/services/{name}
参数
响应
200 (Service): 成功
401: 未授权
get
读取指定 Service 的状态
HTTP 请求
GET /api/v1/namespaces/{namespace}/services/{name}/status
参数
响应
200 (Service): 成功
401: 未授权
list
列出或监视 Service 类型的对象
HTTP 请求
GET /api/v1/namespaces/{namespace}/services
参数
namespace (路径中): 字符串,必需
allowWatchBookmarks (查询中): 布尔值
continue (查询中): 字符串
fieldSelector (查询中): 字符串
labelSelector (查询中): 字符串
limit (查询中): 整数
pretty (查询中): 字符串
resourceVersion (查询中): 字符串
resourceVersionMatch (查询中): 字符串
sendInitialEvents (查询中): 布尔值
timeoutSeconds (查询中): 整数
watch (查询中): 布尔值
响应
200 (ServiceList): 成功
401: 未授权
list
列出或监视 Service 类型的对象
HTTP 请求
GET /api/v1/services
参数
allowWatchBookmarks (查询中): 布尔值
continue (查询中): 字符串
fieldSelector (查询中): 字符串
labelSelector (查询中): 字符串
limit (查询中): 整数
pretty (查询中): 字符串
resourceVersion (查询中): 字符串
resourceVersionMatch (查询中): 字符串
sendInitialEvents (查询中): 布尔值
timeoutSeconds (查询中): 整数
watch (查询中): 布尔值
响应
200 (ServiceList): 成功
401: 未授权
create
创建一个 Service
HTTP 请求
POST /api/v1/namespaces/{namespace}/services
参数
namespace (路径中): 字符串,必需
body: Service,必需
dryRun (查询中): 字符串
fieldManager (查询中): 字符串
fieldValidation (查询中): 字符串
pretty (查询中): 字符串
响应
200 (Service): 成功
201 (Service): 已创建
202 (Service): 已接受
401: 未授权
update
替换指定的 Service
HTTP 请求
PUT /api/v1/namespaces/{namespace}/services/{name}
参数
name (路径中): 字符串,必需
Service 的名称
namespace (路径中): 字符串,必需
body: Service,必需
dryRun (查询中): 字符串
fieldManager (查询中): 字符串
fieldValidation (查询中): 字符串
pretty (查询中): 字符串
响应
200 (Service): 成功
201 (Service): 已创建
401: 未授权
update
替换指定 Service 的状态
HTTP 请求
PUT /api/v1/namespaces/{namespace}/services/{name}/status
参数
name (路径中): 字符串,必需
Service 的名称
namespace (路径中): 字符串,必需
body: Service,必需
dryRun (查询中): 字符串
fieldManager (查询中): 字符串
fieldValidation (查询中): 字符串
pretty (查询中): 字符串
响应
200 (Service): 成功
201 (Service): 已创建
401: 未授权
patch
部分更新指定的 Service
HTTP 请求
PATCH /api/v1/namespaces/{namespace}/services/{name}
参数
name (路径中): 字符串,必需
Service 的名称
namespace (路径中): 字符串,必需
body: Patch,必需
dryRun (查询中): 字符串
fieldManager (查询中): 字符串
fieldValidation (查询中): 字符串
force (查询中): 布尔值
pretty (查询中): 字符串
响应
200 (Service): 成功
201 (Service): 已创建
401: 未授权
patch
部分更新指定 Service 的状态
HTTP 请求
PATCH /api/v1/namespaces/{namespace}/services/{name}/status
参数
name (路径中): 字符串,必需
Service 的名称
namespace (路径中): 字符串,必需
body: Patch,必需
dryRun (查询中): 字符串
fieldManager (查询中): 字符串
fieldValidation (查询中): 字符串
force (查询中): 布尔值
pretty (查询中): 字符串
响应
200 (Service): 成功
201 (Service): 已创建
401: 未授权
delete
删除一个 Service
HTTP 请求
DELETE /api/v1/namespaces/{namespace}/services/{name}
参数
name (路径中): 字符串,必需
Service 的名称
namespace (路径中): 字符串,必需
body: DeleteOptions
dryRun (查询中): 字符串
gracePeriodSeconds (查询中): 整数
pretty (查询中): 字符串
propagationPolicy (查询中): 字符串
响应
200 (Service): 成功
202 (Service): 已接受
401: 未授权
deletecollection
删除 Service 的集合
HTTP 请求
DELETE /api/v1/namespaces/{namespace}/services
参数
namespace (路径中): 字符串,必需
body: DeleteOptions
continue (查询中): 字符串
dryRun (查询中): 字符串
fieldSelector (查询中): 字符串
gracePeriodSeconds (查询中): 整数
labelSelector (查询中): 字符串
limit (查询中): 整数
pretty (查询中): 字符串
propagationPolicy (查询中): 字符串
resourceVersion (查询中): 字符串
resourceVersionMatch (查询中): 字符串
sendInitialEvents (查询中): 布尔值
timeoutSeconds (查询中): 整数
响应
200 (Status): 成功
401: 未授权
此页面是自动生成的。
如果您计划报告此页面的问题,请在您的问题描述中说明该页面是自动生成的。修复可能需要在 Kubernetes 项目中的其他位置进行。