KRM API ipam.gdc.goog/v1

ipam.gdc.goog/v1

包含 IP 地址管理(IPAM) API 组的 API 架构定义。

CIDREntry

表示具有已标识 IP 版本的 CIDR 条目。

来源: - NetworkStatus

字段 说明
version IPFamily 条目的 IP 地址版本。
cidr string 条目的 CIDR。

ConsumerRef

来源: - SubnetStatus

字段 说明
version string
group string
kind string
name string
namespace string

NetworkSpec

包含为 Subnet 设置网络功能的信息。

来源: - SubnetSpec

字段 说明
enableGateway boolean 指定是否必须为子网分配网关 IP 地址。
enableVLANID boolean 指定是否必须为子网分配 VLAN ID。
staticVLANID integer 专用 VLAN ID。如果定义了此字段,则 VLANID 字段必须为 true

NetworkStatus

包含网络配置的分配结果。

来源: - SubnetStatus

字段 说明
vlanID integer 为子网获取的 VLAN ID。
gateways CIDREntry 数组 为子网获取的网关 IP 地址。如果子网是单栈,则列表中必须只有一个 IPv4/IPv6 IP 地址。如果子网是双栈,则列表中必须有一个 IPv4 地址和一个 IPv6 IP 地址。

ReferenceType

底层类型string 表示 SubnetReference 引用的子网的类型。

来源: - SubnetReference

Subnet

表示区域 Subnet 的请求和分配信息。

来源: - SubnetList

字段 说明
apiVersion string ipam.gdc.goog/v1
kind string Subnet
metadata ObjectMeta 如需了解 metadata 的字段,请参阅 Kubernetes API 文档。
spec SubnetSpec
status SubnetStatus

SubnetAllocation

包含 Subnet 的单个 IP 版本(IPv4/IPv6)的 CIDR 分配结果。

来源: - SubnetStatus

字段 说明
cidr string 分配给子网的 CIDR。
availableCIDRs 字符串数组 排除子网的子项使用的 CIDR 后剩余的 CIDR。

SubnetList

表示 Subnet 资源的集合。

字段 说明
apiVersion string ipam.gdc.goog/v1
kind string SubnetList
metadata ListMeta 如需了解 metadata 的字段,请参阅 Kubernetes API 文档。
items Subnet 数组

SubnetReference

包含用于引用单个 Subnet 的信息。

来源: - SubnetSpec - SubnetStatus

字段 说明
name string
namespace string 被引用子网的命名空间。如果在规范中使用,则命名空间可以留空,这意味着被引用的子网与引用它的对象位于同一命名空间中。
type ReferenceType 此 SubnetReference 引用的子网的类型,可以是 SingleSubnet/SubnetGroup。

SubnetRequest

包含单个 IP 地址版本(IPv4/IPv6)的 IP 地址声明信息。

来源: - SubnetSpec

字段 说明
cidr string 要分配的 CIDR。获取专用 CIDR 时,必须指定此字段。
prefixLength integer 所需的 CIDR 的前缀长度。如果对要分配的 CIDR 没有具体要求,则可以指定此字段。如果 CIDR 和前缀都留空,则请求默认获取 /32(IPv4) 或 /128(IPv6) 随机 CIDR。

SubnetSpec

定义 Subnet 的规范。

来源: - Subnet

字段 说明
type SubnetType 在 IPAM 树架构的上下文中,子网的类型。
ipv4Request SubnetRequest 用于获取 IPv4 CIDR 的请求详细信息。
ipv6Request SubnetRequest 用于获取 IPv6 CIDR 的请求详细信息。
parentReference SubnetReference 对此子网的父级的引用。如果指定了父级,此子网将从父级获取分配的 IP。如果有父级,则必须提供父级名称。仅当父级与此子网位于同一命名空间中时,才能省略父级的命名空间。
networkSpec NetworkSpec 设置网络配置所需的规范。如果 Subnet 没有网络影响,则此字段应为空。

SubnetStatus

定义 Subnet 的状态。

来源: - Subnet

字段 说明
conditions Condition 数组 对资源整体状态的观察结果。已知条件类型:Ready。
allocatedParent SubnetReference 从中分配 CIDR 的单个父级子网的信息。如果子网没有父级,则为空。
ipv4Allocation SubnetAllocation IPv4 IP 地址的分配信息。
ipv6Allocation SubnetAllocation IPv6 IP 地址的分配信息。
childrenRefs SubnetReference 数组 对此子网分配的子项的引用。此字段不适用于 Leaf 类型的子网。
networkStatus NetworkStatus 网络配置的分配结果。
consumerRef ConsumerRef 子网的活跃使用方。