API Reference¶
Packages¶
k8s.ovn.org/v1¶
Package v1 contains API Schema definitions for the network v1 API group
Resource Types¶
CIDR¶
Underlying type: string
CIDR represents a CIDR notation IP range.
Validation: - MaxLength: 43
Appears in: - DualStackCIDRs
DualStackCIDRs¶
Underlying type: CIDR
DualStackCIDRs is a list of CIDRs that supports dual-stack (IPv4 and IPv6).
Validation: - MaxItems: 2 - MaxLength: 43 - MinItems: 1
Appears in: - VTEPSpec
VTEP¶
VTEP defines VTEP (VXLAN Tunnel Endpoint) IP configuration for EVPN.
Appears in: - VTEPList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
k8s.ovn.org/v1 |
||
kind string |
VTEP |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec VTEPSpec |
Spec defines the desired VTEP configuration. | Required: {} |
|
status VTEPStatus |
Status contains the observed state of the VTEP. |
VTEPList¶
VTEPList contains a list of VTEP.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
k8s.ovn.org/v1 |
||
kind string |
VTEPList |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items VTEP array |
VTEPMode¶
Underlying type: string
VTEPMode defines the mode of VTEP IP allocation.
Validation: - Enum: [Managed Unmanaged]
Appears in: - VTEPSpec
| Field | Description |
|---|---|
Managed |
VTEPModeManaged means OVN-Kubernetes allocates and assigns VTEP IPs per node automatically. |
Unmanaged |
VTEPModeUnmanaged means an external provider handles IP assignment; OVN-Kubernetes discovers existing IPs on nodes. |
VTEPSpec¶
VTEPSpec defines the desired state of VTEP.
Appears in: - VTEP
| Field | Description | Default | Validation |
|---|---|---|---|
cidrs DualStackCIDRs |
CIDRs is the list of IP ranges from which VTEP IPs are allocated. Dual-stack clusters may set 2 CIDRs (one for each IP family), otherwise only 1 CIDR is allowed. The format should match standard CIDR notation (for example, "100.64.0.0/24" or "fd00::/64"). |
MaxItems: 2 MaxLength: 43 MinItems: 1 Required: {} |
|
mode VTEPMode |
Mode specifies how VTEP IPs are managed. "Managed" means OVN-Kubernetes allocates and assigns VTEP IPs per node automatically. "Unmanaged" means an external provider handles IP assignment; OVN-Kubernetes discovers existing IPs on nodes. Defaults to "Managed". |
Managed | Enum: [Managed Unmanaged] |
VTEPStatus¶
VTEPStatus contains the observed state of the VTEP.
Appears in: - VTEP
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array |
Conditions slice of condition objects indicating details about VTEP status. |