AdminPolicyBasedExternalRoute [k8s.ovn.org/v1] - 网络 API | API 参考 | OpenShift Container Platform 4.17

描述

AdminPolicyBasedExternalRoute 是一种 CRD，允许集群管理员配置要应用于所选命名空间中包含的所有 Pod 的外部网关 IP 的策略。属于所选命名空间的 Pod 到集群外部的出站流量将通过这些外部网关 IP 路由。

类型

对象

必需

spec

规格

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义此对象的表示形式的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。⽤驼峰命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	AdminPolicyBasedExternalRouteSpec 定义 AdminPolicyBasedExternalRoute 的期望状态
`status`	`对象`	AdminPolicyBasedRouteStatus 包含 AdminPolicyBased 路由类型的观察状态。

apiVersion

字符串

APIVersion 定义此对象的表示形式的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。⽤驼峰命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

AdminPolicyBasedExternalRouteSpec 定义 AdminPolicyBasedExternalRoute 的期望状态

status

对象

AdminPolicyBasedRouteStatus 包含 AdminPolicyBased 路由类型的观察状态。

.spec

描述

AdminPolicyBasedExternalRouteSpec 定义 AdminPolicyBasedExternalRoute 的期望状态

类型

对象

必需

from
nextHops

属性类型描述

属性	类型	描述
`from`	`对象`	From 定义将确定此 CR 的目标命名空间的选择器。
`nextHops`	`对象`	NextHops 定义两种类型的跳跃：静态和动态。每个跳跃至少定义一个外部网关 IP。

from

对象

From 定义将确定此 CR 的目标命名空间的选择器。

nextHops

对象

NextHops 定义两种类型的跳跃：静态和动态。每个跳跃至少定义一个外部网关 IP。

.spec.from

描述

From 定义将确定此 CR 的目标命名空间的选择器。

类型

对象

必需

namespaceSelector

属性类型描述

属性	类型	描述
`namespaceSelector`	`对象`	NamespaceSelector 定义一个选择器，⽤于确定此 CR 将定位哪些命名空间

namespaceSelector

对象

NamespaceSelector 定义一个选择器，⽤于确定此 CR 将定位哪些命名空间

.spec.from.namespaceSelector

描述: NamespaceSelector 定义一个选择器，⽤于确定此 CR 将定位哪些命名空间
类型: 对象

属性类型描述

属性	类型	描述
`matchExpressions`	`数组`	matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。
`matchExpressions[]`	`对象`	标签选择器要求是一个选择器，其中包含值、键和一个关联键和值的运算符。
`matchLabels`	`对象（字符串）`	matchLabels 是 {key,value} 对的映射。matchLabels 映射中的单个 {key,value} 等效于 matchExpressions 的一个元素，其 key 字段为“key”，运算符为“In”，而 values 数组仅包含“value”。这些要求是 ANDed 的。

matchExpressions

数组

matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。

matchExpressions[]

对象

标签选择器要求是一个选择器，其中包含值、键和一个关联键和值的运算符。

matchLabels

对象（字符串）

matchLabels 是 {key,value} 对的映射。matchLabels 映射中的单个 {key,value} 等效于 matchExpressions 的一个元素，其 key 字段为“key”，运算符为“In”，而 values 数组仅包含“value”。这些要求是 ANDed 的。

.spec.from.namespaceSelector.matchExpressions

描述: matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。
类型: 数组

.spec.from.namespaceSelector.matchExpressions[]

描述

标签选择器要求是一个选择器，其中包含值、键和一个关联键和值的运算符。

类型

对象

必需

key
operator

属性类型描述

属性	类型	描述
`key`	`字符串`	key 是选择器适⽤的标签键。
`operator`	`字符串`	operator 表示键与值集的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。
`values`	`数组（字符串）`	values 是字符串值的数组。如果运算符是 In 或 NotIn，则 values 数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则 values 数组必须为空。此数组在策略性合并修补程序期间将被替换。

key

字符串

key 是选择器适⽤的标签键。

operator

字符串

operator 表示键与值集的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

values

数组（字符串）

values 是字符串值的数组。如果运算符是 In 或 NotIn，则 values 数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则 values 数组必须为空。此数组在策略性合并修补程序期间将被替换。

.spec.nextHops

描述: NextHops 定义两种类型的跳跃：静态和动态。每个跳跃至少定义一个外部网关 IP。
类型: 对象

属性类型描述

属性	类型	描述
`dynamic`	`数组`	DynamicHops 定义 DynamicHop 的切片。此字段是可选的。
`dynamic[]`	`对象`	DynamicHop 定义动态外部网关接口的配置。这些接口围绕驻留在集群内的 Pod 对象包装。NetworkAttachmentName 字段捕获在检索要使用的网关 IP 时要使用的 multus 网络名称。PodSelector 和 NamespaceSelector 是必填字段。
`static`	`数组`	StaticHops 定义 StaticHop 的切片。此字段是可选的。
`static[]`	`对象`	StaticHop 定义充当外部网关接口的静态 IP 的配置。IP 字段是必填的。

dynamic

数组

DynamicHops 定义 DynamicHop 的切片。此字段是可选的。

dynamic[]

对象

DynamicHop 定义动态外部网关接口的配置。这些接口围绕驻留在集群内的 Pod 对象包装。NetworkAttachmentName 字段捕获在检索要使用的网关 IP 时要使用的 multus 网络名称。PodSelector 和 NamespaceSelector 是必填字段。

static

数组

StaticHops 定义 StaticHop 的切片。此字段是可选的。

static[]

对象

StaticHop 定义充当外部网关接口的静态 IP 的配置。IP 字段是必填的。

.spec.nextHops.dynamic

描述: DynamicHops 定义 DynamicHop 的切片。此字段是可选的。
类型: 数组

.spec.nextHops.dynamic[]

描述

类型

对象

必需

namespaceSelector
podSelector

属性类型描述

属性	类型	描述
`bfdEnabled`	`布尔值`	BFDEnabled 确定接口是否实现双向转发检测协议。默认为 false。
`namespaceSelector`	`对象`	NamespaceSelector 定义一个选择器，⽤于筛选 Pod 网关所在的命名空间。
`networkAttachmentName`	`字符串`	NetworkAttachmentName 确定在检索将⽤作网关 IP 的 Pod IP 时要使用的 multus 网络名称。当此字段为空时，逻辑假设 Pod 已配置 HostNetwork 并正在使⽤节点的 IP 作为网关。
`podSelector`	`对象`	PodSelector 定义选择器，⽤于筛选充当外部网关的 Pod。

bfdEnabled

布尔值

BFDEnabled 确定接口是否实现双向转发检测协议。默认为 false。

namespaceSelector

对象

NamespaceSelector 定义一个选择器，⽤于筛选 Pod 网关所在的命名空间。

networkAttachmentName

字符串

NetworkAttachmentName 确定在检索将⽤作网关 IP 的 Pod IP 时要使用的 multus 网络名称。当此字段为空时，逻辑假设 Pod 已配置 HostNetwork 并正在使⽤节点的 IP 作为网关。

podSelector

对象

PodSelector 定义选择器，⽤于筛选充当外部网关的 Pod。

.spec.nextHops.dynamic[].namespaceSelector

描述: NamespaceSelector 定义一个选择器，⽤于筛选 Pod 网关所在的命名空间。
类型: 对象

属性类型描述

属性	类型	描述
`matchExpressions`	`数组`	matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。
`matchExpressions[]`	`对象`	标签选择器要求是一个选择器，其中包含值、键和一个关联键和值的运算符。
`matchLabels`	`对象（字符串）`	matchLabels 是 {key,value} 对的映射。matchLabels 映射中的单个 {key,value} 等效于 matchExpressions 的一个元素，其 key 字段为“key”，运算符为“In”，而 values 数组仅包含“value”。这些要求是 ANDed 的。

matchExpressions

数组

matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。

matchExpressions[]

对象

标签选择器要求是一个选择器，其中包含值、键和一个关联键和值的运算符。

matchLabels

对象（字符串）

.spec.nextHops.dynamic[].namespaceSelector.matchExpressions

描述: matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。
类型: 数组

.spec.nextHops.dynamic[].namespaceSelector.matchExpressions[]

描述

标签选择器要求是一个选择器，其中包含值、键和一个关联键和值的运算符。

类型

对象

必需

key
operator

属性类型描述

属性	类型	描述
`key`	`字符串`	key 是选择器适⽤的标签键。
`operator`	`字符串`	operator 表示键与值集的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。
`values`	`数组（字符串）`	values 是字符串值的数组。如果运算符是 In 或 NotIn，则 values 数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则 values 数组必须为空。此数组在策略性合并修补程序期间将被替换。

key

字符串

key 是选择器适⽤的标签键。

operator

字符串

operator 表示键与值集的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

values

数组（字符串）

.spec.nextHops.dynamic[].podSelector

描述: PodSelector 定义选择器，⽤于筛选充当外部网关的 Pod。
类型: 对象

属性类型描述

属性	类型	描述
`matchExpressions`	`数组`	matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。
`matchExpressions[]`	`对象`	标签选择器要求是一个选择器，其中包含值、键和一个关联键和值的运算符。
`matchLabels`	`对象（字符串）`	matchLabels 是 {key,value} 对的映射。matchLabels 映射中的单个 {key,value} 等效于 matchExpressions 的一个元素，其 key 字段为“key”，运算符为“In”，而 values 数组仅包含“value”。这些要求是 ANDed 的。

matchExpressions

数组

matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。

matchExpressions[]

对象

标签选择器要求是一个选择器，其中包含值、键和一个关联键和值的运算符。

matchLabels

对象（字符串）

.spec.nextHops.dynamic[].podSelector.matchExpressions

描述: matchExpressions 是标签选择器要求的列表。这些要求是 ANDed 的。
类型: 数组

.spec.nextHops.dynamic[].podSelector.matchExpressions[]

描述

标签选择器要求是一个选择器，其中包含值、键和一个关联键和值的运算符。

类型

对象

必需

key
operator

属性类型描述

属性	类型	描述
`key`	`字符串`	key 是选择器适⽤的标签键。
`operator`	`字符串`	operator 表示键与值集的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。
`values`	`数组（字符串）`	values 是字符串值的数组。如果运算符是 In 或 NotIn，则 values 数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则 values 数组必须为空。此数组在策略性合并修补程序期间将被替换。

key

字符串

key 是选择器适⽤的标签键。

operator

字符串

operator 表示键与值集的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

values

数组（字符串）

.spec.nextHops.static

描述: StaticHops 定义 StaticHop 的切片。此字段是可选的。
类型: 数组

.spec.nextHops.static[]

描述

StaticHop 定义充当外部网关接口的静态 IP 的配置。IP 字段是必填的。

类型

对象

必需

ip

属性类型描述

属性	类型	描述
`bfdEnabled`	`布尔值`	BFDEnabled 确定接口是否实现双向转发检测协议。默认为 false。
`ip`	`字符串`	IP 定义用于出站流量的静态 IP 地址。IP 可以是 IPv4 或 IPv6。

bfdEnabled

布尔值

BFDEnabled 确定接口是否实现双向转发检测协议。默认为 false。

ip

字符串

IP 定义用于出站流量的静态 IP 地址。IP 可以是 IPv4 或 IPv6。

.status

描述: AdminPolicyBasedRouteStatus 包含 AdminPolicyBased 路由类型的观察状态。
类型: 对象

属性类型描述

属性	类型	描述
`lastTransitionTime`	`字符串`	捕获最后一次应用更改的时间。
`messages`	`数组（字符串）`	一个包含关于对象状态详细信息的可读消息数组。
`status`	`字符串`	简洁地指示 AdminPolicyBasedRoute 资源是否成功应用。

lastTransitionTime

字符串

捕获最后一次应用更改的时间。

messages

数组（字符串）

一个包含关于对象状态详细信息的可读消息数组。

status

字符串

简洁地指示 AdminPolicyBasedRoute 资源是否成功应用。

API 端点

以下 API 端点可用：

/apis/k8s.ovn.org/v1/adminpolicybasedexternalroutes
- DELETE: 删除 AdminPolicyBasedExternalRoute 集合
- GET: 列出 AdminPolicyBasedExternalRoute 对象
- POST: 创建 AdminPolicyBasedExternalRoute
/apis/k8s.ovn.org/v1/adminpolicybasedexternalroutes/{name}
- DELETE: 删除 AdminPolicyBasedExternalRoute
- GET: 读取指定的 AdminPolicyBasedExternalRoute
- PATCH: 部分更新指定的 AdminPolicyBasedExternalRoute
- PUT: 替换指定的 AdminPolicyBasedExternalRoute
/apis/k8s.ovn.org/v1/adminpolicybasedexternalroutes/{name}/status
- GET: 读取指定的 AdminPolicyBasedExternalRoute 的状态
- PATCH: 部分更新指定的 AdminPolicyBasedExternalRoute 的状态
- PUT: 替换指定的 AdminPolicyBasedExternalRoute 的状态

/apis/k8s.ovn.org/v1/adminpolicybasedexternalroutes

HTTP 方法: DELETE
描述: 删除 AdminPolicyBasedExternalRoute 集合

表 1. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 列出 AdminPolicyBasedExternalRoute 对象

表 2. HTTP 响应
HTTP 代码	响应体
200 - OK	`AdminPolicyBasedExternalRouteList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建 AdminPolicyBasedExternalRoute

表 3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并且将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 4. 请求体参数
参数	类型	描述
`body`	`AdminPolicyBasedExternalRoute` 模式

表 5. HTTP 响应
HTTP 代码	响应体
200 - OK	`AdminPolicyBasedExternalRoute` 模式
201 - 已创建	`AdminPolicyBasedExternalRoute` 模式
202 - 已接受	`AdminPolicyBasedExternalRoute` 模式
401 - 未授权	空

/apis/k8s.ovn.org/v1/adminpolicybasedexternalroutes/{name}

表 6. 全局路径参数
参数	类型	描述
`name`	`字符串`	AdminPolicyBasedExternalRoute 的名称

HTTP 方法: DELETE
描述: 删除 AdminPolicyBasedExternalRoute

表 7. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 8. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
202 - 已接受	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 读取指定的 AdminPolicyBasedExternalRoute

表 9. HTTP 响应
HTTP 代码	响应体
200 - OK	`AdminPolicyBasedExternalRoute` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 AdminPolicyBasedExternalRoute

表 10. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并且将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 11. HTTP 响应
HTTP 代码	响应体
200 - OK	`AdminPolicyBasedExternalRoute` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 AdminPolicyBasedExternalRoute

表 12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并且将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 13. 请求体参数
参数	类型	描述
`body`	`AdminPolicyBasedExternalRoute` 模式

表 14. HTTP 响应
HTTP 代码	响应体
200 - OK	`AdminPolicyBasedExternalRoute` 模式
201 - 已创建	`AdminPolicyBasedExternalRoute` 模式
401 - 未授权	空

/apis/k8s.ovn.org/v1/adminpolicybasedexternalroutes/{name}/status

表 15. 全局路径参数
参数	类型	描述
`name`	`字符串`	AdminPolicyBasedExternalRoute 的名称

HTTP 方法: GET
描述: 读取指定的 AdminPolicyBasedExternalRoute 的状态

表 16. HTTP 响应
HTTP 代码	响应体
200 - OK	`AdminPolicyBasedExternalRoute` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 AdminPolicyBasedExternalRoute 的状态

表 17. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并且将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 18. HTTP 响应
HTTP 代码	响应体
200 - OK	`AdminPolicyBasedExternalRoute` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 AdminPolicyBasedExternalRoute 的状态

表 19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并且将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，则这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 20. 请求体参数
参数	类型	描述
`body`	`AdminPolicyBasedExternalRoute` 模式

表 21. HTTP 响应
HTTP 代码	响应体
200 - OK	`AdminPolicyBasedExternalRoute` 模式
201 - 已创建	`AdminPolicyBasedExternalRoute` 模式
401 - 未授权	空