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: - 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 CIDR array |
CIDRs is the list of IP ranges from which VTEP IPs are discovered (unmanaged mode) or allocated (managed mode). Multiple CIDRs may be specified to expand capacity over time without recreating the VTEP. Each entry must be a valid network address in CIDR notation (for example, "100.64.0.0/24" or "fd00  :/64").Each node receives at most one IP per address family from the CIDRs listed here. In managed mode, CIDRs are consumed sequentially: IPs are allocated from the first CIDR until it is exhausted, then from the next, and so on. In managed mode, CIDRs are append-only: existing entries cannot be removed, reordered, or shrunk to a smaller mask; they can only be expanded to a wider mask, and new entries may be appended. In unmanaged mode, if multiple IPs on a node match the configured CIDRs, or if the match is otherwise ambiguous, the VTEP will be placed into a failed status. In unmanaged mode, CIDRs may be freely added, removed, reordered, or resized. Caution: removing or modifying CIDRs in unmanaged mode that are actively in use may cause traffic disruption; no downtime guarantees are provided for such operations. |
MaxItems: 20 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. |