[zh] resync page ingress-v1

This commit is contained in:
zhenghao.zhu 2023-05-13 15:45:45 +08:00
parent 028d490558
commit 85bfa119cf
1 changed files with 87 additions and 77 deletions

View File

@ -41,7 +41,7 @@ Ingress 可以配置为向服务提供外部可访问的 URL、负载均衡流
- **kind**: Ingress
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
<!--
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
-->
@ -51,7 +51,7 @@ Ingress 可以配置为向服务提供外部可访问的 URL、负载均衡流
- **spec** (<a href="{{< ref "../service-resources/ingress-v1#IngressSpec" >}}">IngressSpec</a>)
<!--
Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
-->
spec 是 Ingress 的预期状态。更多信息:
@ -60,7 +60,7 @@ Ingress 可以配置为向服务提供外部可访问的 URL、负载均衡流
- **status** (<a href="{{< ref "../service-resources/ingress-v1#IngressStatus" >}}">IngressStatus</a>)
<!--
Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
-->
status 是 Ingress 的当前状态。更多信息:
@ -78,7 +78,7 @@ IngressSpec 描述用户希望存在的 Ingress。
- **defaultBackend** (<a href="{{< ref "../service-resources/ingress-v1#IngressBackend" >}}">IngressBackend</a>)
<!--
DefaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller.
defaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller.
-->
defaultBackend 是负责处理与任何规则都不匹配的请求的后端。
@ -88,12 +88,12 @@ IngressSpec 描述用户希望存在的 Ingress。
- **ingressClassName** (string)
<!--
IngressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the `kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present.
ingressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the `kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present.
-->
IngressClassName 是 IngressClass 集群资源的名称。
ingressClassName 是 IngressClass 集群资源的名称。
Ingress 控制器实现使用此字段来了解它们是否应该通过传递连接(控制器 -> IngressClass -> Ingress 资源)为该
Ingress 资源提供服务。尽管 `kubernetes.io/ingress.class` 注解(简单的常量名称)从未正式定义,
但它被 Ingress 控制器广泛支持,以在 Ingress 控制器和 Ingress 资源之间创建直接绑定。
但它被 Ingress 控制器广泛支持,以在 Ingress 控制器和 Ingress 资源之间创建直接绑定。
新创建的 Ingress 资源应该优先选择使用该字段。但是,即使注解已被正式弃用,
出于向后兼容性的原因Ingress 控制器仍应能够处理该注解(如果存在)。
@ -101,13 +101,13 @@ IngressSpec 描述用户希望存在的 Ingress。
<!--
*Atomic: will be replaced during a merge*
A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
rules is a list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
-->
**Atomic: 将在合并期间被替换**
用于配置 Ingress 的主机规则列表。如果未指定或没有规则匹配,则所有流量都将发送到默认后端。
rules 是用于配置 Ingress 的主机规则列表。如果未指定或没有规则匹配,则所有流量都将发送到默认后端。
<!--
<a name="IngressRule"></a>
@ -121,14 +121,14 @@ IngressSpec 描述用户希望存在的 Ingress。
- **rules.host** (string)
<!--
Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
the IP in the Spec of the parent Ingress.
2. The `:` delimiter is not respected because ports are not allowed.
Currently the port of an Ingress is implicitly :80 for http and
:443 for https.
Currently the port of an Ingress is implicitly :80 for http and
:443 for https.
Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.
-->
host 是 RFC 3986 定义的网络主机的完全限定域名。请注意以下与 RFC 3986 中定义的 URI 的 “host” 部分的偏差:
1. 不允许 IP。当前 IngressRuleValue 只能应用于父 Ingress Spec 中的 IP。
@ -142,7 +142,7 @@ IngressSpec 描述用户希望存在的 Ingress。
如果主机未指定Ingress 将根据指定的 IngressRuleValue 规则路由所有流量。
<!--
Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule.
host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If host is precise, the request matches this rule if the http host header is equal to Host. 2. If host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule.
-->
host 可以是 “精确“ 的,设置为一个不含终止句点的网络主机域名(例如 “foo.bar.com”
@ -173,16 +173,16 @@ IngressSpec 描述用户希望存在的 Ingress。
<!--
*Atomic: will be replaced during a merge*
A collection of paths that map requests to backends.
paths is a collection of paths that map requests to backends.
<a name="HTTPIngressPath"></a>
*HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.*
-->
**Atomic: 将在合并期间被替换**
将请求映射到后端的路径集合。
paths 是一个将请求映射到后端的路径集合。
<a name="HTTPIngressPath"></a>
**HTTPIngressPath 将路径与后端关联。与路径匹配的传入 URL 将转发到后端。**
@ -190,7 +190,7 @@ IngressSpec 描述用户希望存在的 Ingress。
<!--
- **rules.http.paths.backend** (<a href="{{< ref "../service-resources/ingress-v1#IngressBackend" >}}">IngressBackend</a>), required
Backend defines the referenced service endpoint to which the traffic will be forwarded to.
backend defines the referenced service endpoint to which the traffic will be forwarded to.
-->
- **rules.http.paths.backend** (<a href="{{< ref "../service-resources/ingress-v1#IngressBackend" >}}">IngressBackend</a>),必需
@ -204,7 +204,7 @@ IngressSpec 描述用户希望存在的 Ingress。
- **rules.http.paths.pathType** (string),必需
<!--
PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is
pathType determines the interpretation of the path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is
done on a path element by element basis. A path element refers is the
list of labels in the path split by the '/' separator. A request is a
match for path p if every p is an element-wise prefix of p of the
@ -234,7 +234,7 @@ IngressSpec 描述用户希望存在的 Ingress。
- **rules.http.paths.path** (string)
<!--
Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value "Exact" or "Prefix".
path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value "Exact" or "Prefix".
-->
path 要与传入请求的路径进行匹配。
@ -245,42 +245,40 @@ IngressSpec 描述用户希望存在的 Ingress。
<!--
*Atomic: will be replaced during a merge*
TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
tls represents the TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
-->
**Atomic: 将在合并期间被替换**
TLS 配置。目前Ingress 仅支持一个 TLS 端口 443。
tls 表示 TLS 配置。目前Ingress 仅支持一个 TLS 端口 443。
如果此列表的多个成员指定了不同的主机,如果实现 Ingress 的 Ingress 控制器支持 SNI
则它们将根据通过 SNI TLS 扩展指定的主机名在同一端口上多路复用。
<!--
<a name="IngressTLS"></a>
*IngressTLS describes the transport layer security associated with an Ingress.*
<!--
*IngressTLS describes the transport layer security associated with an ingress.*
-->
<a name="IngressTLS"></a>
**IngressTLS 描述与 Ingress 相关的传输层安全性。**
- **tls.hosts** ([]string)
<!--
*Atomic: will be replaced during a merge*
Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.
hosts is a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.
-->
**Atomic: 将在合并期间被替换**
hosts 是 TLS 证书中包含的主机列表。
此列表中的值必须与 tlsSecret 中使用的名称匹配。
默认为实现此 Ingress 的负载均衡控制器的通配符主机设置(如果未指定)。
- **tls.secretName** (string)
<!--
SecretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.
secretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the "Host" header is used for routing.
-->
secretName 是用于终止端口 443 上 TLS 通信的 Secret 的名称。
@ -301,7 +299,7 @@ IngressBackend 描述给定服务和端口的所有端点。
<!--
- **resource** (<a href="{{< ref "../common-definitions/typed-local-object-reference#TypedLocalObjectReference" >}}">TypedLocalObjectReference</a>)
Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service".
resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service".
-->
- **resource** (<a href="{{< ref "../common-definitions/typed-local-object-reference#TypedLocalObjectReference" >}}">TypedLocalObjectReference</a>)
@ -313,24 +311,24 @@ IngressBackend 描述给定服务和端口的所有端点。
- **service** (IngressServiceBackend)
<!--
Service references a Service as a Backend. This is a mutually exclusive setting with "Resource".
service references a service as a backend. This is a mutually exclusive setting with "Resource".
<a name="IngressServiceBackend"></a>
*IngressServiceBackend references a Kubernetes Service as a Backend.*
-->
service 引用一个 Service 作为后端。此字段是一个与 `resource` 互斥的设置。
<a name="IngressServiceBackend"></a>
**IngressServiceBackend 引用一个 Kubernetes Service 作为后端。**
<!--
- **service.name** (string), required
-->
- **service.name** (string),必需
- **service.name** (string),必需
<!--
Name is the referenced service. The service must exist in the same namespace as the Ingress object.
name is the referenced service. The service must exist in the same namespace as the Ingress object.
-->
name 是引用的服务。服务必须与 Ingress 对象位于同一命名空间中。
@ -338,23 +336,22 @@ IngressBackend 描述给定服务和端口的所有端点。
<!--
- **service.port** (ServiceBackendPort)
Port of the referenced service. A port name or port number is required for a IngressServiceBackend.
port of the referenced service. A port name or port number is required for a IngressServiceBackend.
<a name="ServiceBackendPort"></a>
*ServiceBackendPort is the service port being referenced.*
-->
- **service.port** (ServiceBackendPort)
所引用的服务的端口。IngressServiceBackend 需要端口名或端口号。
<a name="ServiceBackendPort"></a>
**ServiceBackendPort 是被引用的服务的端口。**
- **service.port.name** (string)
<!--
Name is the name of the port on the Service. This is a mutually exclusive setting with "Number".
name is the name of the port on the Service. This is a mutually exclusive setting with "Number".
-->
name 是服务上的端口名称。此字段是一个与 `number` 互斥的设置。
@ -362,7 +359,7 @@ IngressBackend 描述给定服务和端口的所有端点。
- **service.port.number** (int32)
<!--
Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".
number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".
-->
number 是服务上的数字形式端口号(例如 80。此字段是一个与 `name` 互斥的设置。
@ -376,6 +373,9 @@ IngressStatus describe the current state of the Ingress.
-->
## IngressStatus {#IngressStatus}
<!--
IngressStatus describe the current state of the Ingress.
-->
IngressStatus 描述 Ingress 的当前状态。
<hr>
@ -383,7 +383,7 @@ IngressStatus 描述 Ingress 的当前状态。
- **loadBalancer** (IngressLoadBalancerStatus)
<!--
LoadBalancer contains the current status of the load-balancer.
loadBalancer contains the current status of the load-balancer.
<a name="IngressLoadBalancerStatus"></a>
*IngressLoadBalancerStatus represents the status of a load-balancer.*
@ -397,7 +397,7 @@ IngressStatus 描述 Ingress 的当前状态。
- **loadBalancer.ingress** ([]IngressLoadBalancerIngress)
<!--
Ingress is a list containing ingress points for the load-balancer.
ingress is a list containing ingress points for the load-balancer.
<a name="IngressLoadBalancerIngress"></a>
*IngressLoadBalancerIngress represents the status of a load-balancer ingress point.*
@ -411,7 +411,7 @@ IngressStatus 描述 Ingress 的当前状态。
- **loadBalancer.ingress.hostname** (string)
<!--
Hostname is set for load-balancer ingress points that are DNS based.
hostname is set for load-balancer ingress points that are DNS based.
-->
hostname 是为基于 DNS 的负载平衡器入口点所设置的主机名。
@ -419,7 +419,7 @@ IngressStatus 描述 Ingress 的当前状态。
- **loadBalancer.ingress.ip** (string)
<!--
IP is set for load-balancer ingress points that are IP based.
ip is set for load-balancer ingress points that are IP based.
-->
ip 是为基于 IP 的负载平衡器入口点设置的 IP。
@ -428,18 +428,17 @@ IngressStatus 描述 Ingress 的当前状态。
<!--
*Atomic: will be replaced during a merge*
Ports is a list of records of service ports If used, every port defined in the service should have an entry in it
Ports provides information about the ports exposed by this LoadBalancer.
ports provides information about the ports exposed by this LoadBalancer.
<a name="IngressPortStatus"></a>
*IngressPortStatus represents the error condition of a service port*
-->
**Atomic: 将在合并期间被替换**
ports 提供有关此 LoadBalancer 公开端口的信息。
<a name="IngressPortStatus"></a>
**IngressPortStatus 表示服务端口的错误情况**
@ -448,21 +447,21 @@ IngressStatus 描述 Ingress 的当前状态。
-->
- **loadBalancer.ingress.ports.port** (int32),必需
<!--
Port is the port number of the ingress port.
port is the port number of the ingress port.
-->
port 是入栈端口的端口号
<!--
<!--
- **loadBalancer.ingress.ports.protocol** (string), required
-->
- **loadBalancer.ingress.ports.protocol** (string),必需
<!--
Protocol is the protocol of the ingress port. The supported values are: "TCP", "UDP", "SCTP"
protocol is the protocol of the ingress port. The supported values are: "TCP", "UDP", "SCTP"
-->
protocol 是入栈端口的协议。支持的值为“TCP”、“UDP”、“SCTP”。
@ -470,7 +469,7 @@ IngressStatus 描述 Ingress 的当前状态。
- **loadBalancer.ingress.ports.error** (string)
<!--
Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use
error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use
CamelCase names
- cloud provider specific error values must have names that comply with the
format foo.example.com/CamelCase.
@ -489,16 +488,18 @@ IngressList is a collection of Ingress.
-->
## IngressList {#IngressList}
<!--
IngressList is a collection of Ingress.
-->
IngressList 是 Ingress 的集合。
<hr>
<!--
- **items** ([]<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>), required
Items is the list of Ingress.
items is the list of Ingress.
-->
<hr>
- **items** ([]<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>),必需
items 是 Ingress 的列表。
@ -526,10 +527,6 @@ IngressList 是 Ingress 的集合。
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
<!--
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
-->
标准的对象元数据。更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
@ -725,6 +722,13 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
<!--
- **sendInitialEvents** (*in query*): boolean
-->
- **sendInitialEvents** (**查询参数**): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
<!--
- **timeoutSeconds** (*in query*): integer
-->
@ -752,10 +756,6 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
### `list` list or watch objects of kind Ingress
#### HTTP Request
GET /apis/networking.k8s.io/v1/ingresses
#### Parameters
-->
### `list` 列出或监测 Ingress 类型对象
@ -763,6 +763,9 @@ GET /apis/networking.k8s.io/v1/ingresses
GET /apis/networking.k8s.io/v1/ingresses
<!--
#### Parameters
-->
#### 参数
<!--
@ -821,6 +824,13 @@ GET /apis/networking.k8s.io/v1/ingresses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
<!--
- **sendInitialEvents** (*in query*): boolean
- -->
- **sendInitialEvents** (**查询参数**): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
<!--
- **timeoutSeconds** (*in query*): integer
-->