8.14. Ingress [config.openshift.io/v1]

appsDomain

字符串

当在没有指定显式主机的情况下创建 Route 时，appsDomain 是要使用的可选域，而不是在 domain 字段中指定的域。如果 appsDomain 为空，则使用这个值为 Route 生成默认主机值。与 domain 不同，appsDomain 可能会在安装后进行修改。这假设已使用通配符证书设置了新的 ingresscontroller。

componentRoutes

array

componentRoutes 是由 OpenShift 组件管理的可选路由列表，cluster-admin 能够为其配置主机名和服务证书。此列表中每个路由的命名空间和名称应与 status.componentRoutes 列表中的现有条目匹配。要确定可配置的路由集合，请查看 .status.componentRoutes 列表中条目的命名空间和名称，其中参与 operator 编写可配置路由的状态。

componentRoutes[]

对象

ComponentRouteSpec 允许配置路由的主机名和服务证书。

domain

字符串

当路由的主机名为空时，域用于为路由生成默认主机名。生成的主机名将遵循此模式："<route-name>.<route-namespace>.<domain>"。它还用作 ingress 的默认通配符域后缀。默认 ingresscontroller 域将遵循此模式： "114.<domain>"。设置之后，目前不支持更改域。

requiredHSTSPolicies

array

requiredHSTSPolicies 指定需要在与策略中指定的 domainPattern/s 和 namespaceSelector/s 匹配新创建或更新路由上设置的 HSTS 策略。每个 requiredHSTSPolicy 必须至少有一个 domainPattern 和 maxAge 来验证路由 HSTS Policy 路由注解，并影响路由准入。如果有 HSTS 策略的 HSTS 策略，则会检查 candidate 路由： "haproxy.router.openshift.io/hsts_header" E.g. haproxy.router.openshift.io/hsts_header: max-age=31536000;preload;includeSubDomains - 对于每个 candidate 路由，如果它与所需的HSTSPolicy 域Pattern 和可选 namespaceSelector 匹配，则 maxAge, preloadPolicy, 和 includeSubdomainsPolicy 必须有效。否则，路由被拒绝。- 第一个匹配项（根据 domainPattern 和可选 namespaceSelector）根据 RequiredHSTSPolicies 的顺序决定路由的准入状态。- 如果 candidate 路由与任何 requiredHSTSPolicy domainPattern 和 optional namespaceSelector 不匹配，则它可能会使用任何 HSTS Policy 注解。在路由已创建后，可以更改 HSTS 策略配置。然后，如果更新的路由不符合更新的 HSTS 策略配置，则对之前接受的路由的更新可能会失败。但是，更改 HSTS 策略配置不会导致已经接受的路由停止工作。请注意，如果没有 RequiredHSTSPolicies，路由上的任何 HSTS Policy 注解有效。

requiredHSTSPolicies[]

对象

hostname

字符串

hostname 是路由应使用的主机名。

name

字符串

name 是要自定义的路由的逻辑名称。如果自定义路由，此 componentRoute 的命名空间和名称必须与 status.componentRoutes 列表中对应的条目匹配。

namespace

字符串

namespace 是要自定义的路由的命名空间。如果自定义路由，此 componentRoute 的命名空间和名称必须与 status.componentRoutes 列表中对应的条目匹配。

servingCertKeyPairSecret

对象

serviceCertKeyPairSecret 是 openshift-config 命名空间中类型为 kubernetes.io/tls 的 secret 的引用。服务证书/密钥对必须匹配，并且操作员将使用它来满足使用此名称服务的意图。如果自定义主机名使用集群的默认路由后缀，则不需要服务证书的 Secret 规格。

name

字符串

name 是引用的 secret 的 metadata.name

domainPatterns

数组（字符串）

domainPatterns 是需要 HSTS 注解的域列表。如果指定了 domainPatterns，并且使用与其中一个域的 spec.host 创建的路由，则路由必须指定匹配的 RequiredHSTSPolicy 中描述的 HSTS 策略组件。可以使用通配符： .foo .com 匹配 foo.com. foo.com 下的所有内容仅匹配 foo.com，因此需要覆盖 foo.com 及其下的所有内容，您必须指定。

includeSubDomainsPolicy

字符串

includeSubDomainsPolicy 表示 HSTS 策略应该应用到主机的域名的任何子域。因此，对于主机 bar.foo.com，如果 includeSubDomainsPolicy 设置为 RequireIncludeSubDomains: - 主机 app.bar.foo.com 将继承 bar.foo.com 的 HSTS 策略 - 主机 bar.foo.com 将继承 bar.foo.com 的 HSTS 策略。 不会继承 bar.foo.com 的 HSTS 策略 - 主机 def.foo.com 不会继承 bar.foo.com 的 HSTS 策略

maxAge

对象

maxAge 是 delta 时间范围（以秒为单位），其中主机被视为 HSTS 主机。如果设置为 0，它将对效果进行优化，主机将作为 HSTS 主机被删除。如果设置为 0，并且指定了 includeSubdomains，则主机的所有子域也会作为 HSTS 主机被删除。maxAge 是一个生存时间值，如果此策略没有在客户端上刷新，则 HSTS 策略最终会在那个客户端上过期。

namespaceSelector

对象

namespaceSelector 指定标签选择器，以便策略只适用于带有与选择器匹配的标签的命名空间中的路由，并在其中一个 DomainPatterns 中。默认为空 LabelSelector，它匹配所有内容。

preloadPolicy

字符串

preloadPolicy 指示客户端在其主机预加载列表中包括主机，使其不需要执行初始负载来获取 HSTS 标头（请注意，这没有在 RFC 6797 中定义，因此客户端实现）。

largestMaxAge

整数

RequiredHSTSPolicy max-age 的最大允许值（以秒为单位）可以被指定，在这种情况下，不会强制实施上限。

smallestMaxAge

整数

RequiredHSTSPolicy max-age Setting max-age=0 的最小允许值（以秒为单位）允许从主机删除现有 HSTS 标头。这是管理员快速更正错误的必要工具。这个值可以被指定，在这种情况下不会强制实施较低限制。

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。

matchLabels

对象（字符串）

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

值

数组（字符串）

值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。

componentRoutes

array

componentRoutes 是参与操作员为主机名和服务证书通过 cluster-admin 自定义的路由的当前路由状态。

componentRoutes[]

对象

ComponentRouteStatus 包含允许配置路由主机名和服务证书的信息。

conditions

array

条件用于通信 componentRoutes 条目的状态。支持的条件包括 Available、Degraded 和 Progressing。如果可用，则路由提供的内容可以被用户访问。这包括在配置 cluster-admin 指定的自定义路由时，默认可能会继续提供内容。如果为 true，这意味着一些错误试图处理 componentRoutes 条目。currentHostnames 字段可能是或者可能无效。如果为 true，这意味着组件正在执行与 componentRoutes 条目相关的一些操作。

conditions[]

对象

条件包含此 API 资源当前状态的一个方面的详情。--- 这个结构旨在直接用作字段路径 .status.conditions 中的数组。例如，输入 FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

consumingUsers

数组（字符串）

使用Users 是 ServiceAccounts 的片段，需要对 serviceCertKeyPairSecret secret 具有读取权限。

currentHostnames

数组（字符串）

currentHostnames 是路由使用的当前名称列表。通常，此列表应由一个主机名组成，但如果 Operator 可能会将多个条目写入此列表的路由支持多个主机名。

defaultHostname

字符串

defaultHostname 是自定义前此路由的主机名。

name

字符串

name 是要自定义的路由的逻辑名称。它不一定是路由资源的实际名称，但不能重命名。如果自定义路由，此 componentRoute 的命名空间和名称必须与 spec.componentRoutes 列表中对应的条目匹配。

namespace

字符串

namespace 是要自定义的路由的命名空间。它必须是实际命名空间。使用实际命名空间可确保没有两个组件冲突，同一组件可以多次安装。如果自定义路由，此 componentRoute 的命名空间和名称必须与 spec.componentRoutes 列表中对应的条目匹配。

relatedObjects

array

relatedObjects 是资源列表，在调试或检查如何应用 spec.componentRoutes 时很有用。

relatedObjects[]

对象

ObjectReference 包含足够信息供您检查或修改引用的对象。

lastTransitionTime

字符串

lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。

message

字符串

Message 是人类可读的消息，指示有关转换的详细信息。这可以是一个空字符串。

observedGeneration

整数

observedGeneration 代表 .metadata.generation，这是条件设置所基于的条件。例如，如果 .metadata.generation 目前为 12，但 .status.conditions[x].observedGeneration 是 9，则代表条件与实例的当前状态已不匹配。

reason

字符串

reason 包含程序标识符，指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义，以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段可能不是空的。

status

字符串

条件的状态，True, False, Unknown 之一。

type

字符串

CamelCase 或 foo.example.com/CamelCase 中的条件类型。-- Many .condition.type 值在可用资源间是一致的，但因为任意条件可能很有用（请参阅 .node.status.conditions），取消限制的能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)? (qualifiedNameFmt)

group

字符串

引用的组。

name

字符串

引用的名称。

namespace

字符串

引用的命名空间。

resource

字符串

引用的资源。

pretty

字符串

如果 'true'，则输出被用户友善。

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须在没有 continue 字段的情况下重启其列表。否则，客户端可能会发送另一个列表请求，并带有 410 错误收到的令牌，服务器将通过从下一个密钥开始的列表进行响应，但从最新的快照（从最后一个列表结果中不一致） - 在第一个列表请求后创建、修改或删除的对象将包含在响应中，只要其密钥在"next key"后。

当 watch 为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视，而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值，以检索下一个结果集。在过滤所有请求的对象时，设置限制可能会返回比请求的项目数量少（最多为零项），客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数，并将返回所有可用的结果。如果指定了限制，并且 continue 字段为空，客户端可能会假设没有更多可用的结果。如果 watch 为 true，则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象，则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间，无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改，并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

200 - OK

Status_v2 模式

401 - Unauthorized

空

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须在没有 continue 字段的情况下重启其列表。否则，客户端可能会发送另一个列表请求，并带有 410 错误收到的令牌，服务器将通过从下一个密钥开始的列表进行响应，但从最新的快照（从最后一个列表结果中不一致） - 在第一个列表请求后创建、修改或删除的对象将包含在响应中，只要其密钥在"next key"后。

当 watch 为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视，而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值，以检索下一个结果集。在过滤所有请求的对象时，设置限制可能会返回比请求的项目数量少（最多为零项），客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数，并将返回所有可用的结果。如果指定了限制，并且 continue 字段为空，客户端可能会假设没有更多可用的结果。如果 watch 为 true，则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象，则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间，无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改，并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

200 - OK

IngressList 模式

401 - Unauthorized

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

正文（body）

Ingress 模式

200 - OK

Ingress 模式

201 - Created

Ingress 模式

202 - Accepted

Ingress 模式

401 - Unauthorized

空

name

字符串

Ingress 的名称

pretty

字符串

如果 'true'，则输出被用户友善。

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值是 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

弃用：请使用 PropagationPolicy，此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false，"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置两者。

propagationPolicy

字符串

是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为： 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系； 'Foreground' - 一个删除前台所有依赖的级联策略。

正文（body）

DeleteOptions_v2 schema

200 - OK

Status_v2 模式

202 - Accepted

Status_v2 模式

401 - Unauthorized

空

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

200 - OK

Ingress 模式

401 - Unauthorized

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

正文（body）

Patch 模式

200 - OK

Ingress 模式

401 - Unauthorized

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

正文（body）

Ingress 模式

200 - OK

Ingress 模式

201 - Created

Ingress 模式

401 - Unauthorized

空

name

字符串

Ingress 的名称

pretty

字符串

如果 'true'，则输出被用户友善。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

200 - OK

Ingress 模式

401 - Unauthorized

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

正文（body）

Patch 模式

200 - OK

Ingress 模式

401 - Unauthorized

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

正文（body）

Ingress 模式

200 - OK

Ingress 模式

201 - Created

Ingress 模式

401 - Unauthorized

空