API Reference¶
Packages¶
k8s.ovn.org/v1alpha1¶
Package v1alpha1 contains API Schema definitions for the Uplink v1alpha1 API group.
Resource Types¶
HostFunction¶
HostFunction identifies a PCI function: a physical function by its index, or a virtual function by the PF index and its own index on that PF.
Appears in: - UplinkStateStatus
| Field | Description | Default | Validation |
|---|---|---|---|
pfID integer |
PFID is the index of the physical function backing the host interface. | Minimum: 0 Required: {} |
|
vfID integer |
VFID is the index of the virtual function on the physical function. Absent when the host interface is the physical function itself. |
Minimum: 0 Optional: {} |
IPAddress¶
Underlying type: string
IPAddress is an IP address.
Validation: - MaxLength: 64
Appears in: - UplinkStateStatus
IPAddressCIDR¶
Underlying type: string
IPAddressCIDR is an IP address with a network prefix.
Validation: - MaxLength: 64
Appears in: - UplinkStateStatus
InterfaceName¶
Underlying type: string
InterfaceName is a Linux interface name.
Validation:
- MaxLength: 15
- MinLength: 1
- Pattern: ^[^/\s]+$
Appears in: - UplinkNodeConfig - UplinkStateStatus
MACAddress¶
Underlying type: string
MACAddress is an IEEE 802 MAC address.
Validation:
- Pattern: ^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$
Appears in: - UplinkStateStatus
OVSBridgeStatus¶
Appears in: - UplinkStateStatus
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name is the resolved OVS bridge used for OVN bridge mappings and flows. | MaxLength: 15 MinLength: 1 Pattern: ^[^/\s]+$ Optional: {} |
Uplink¶
Uplink represents a physical network path out of a node that OVN-Kubernetes can connect its logical topology to. Supported node config type: OVSBridge.
Appears in: - UplinkList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
k8s.ovn.org/v1alpha1 |
||
kind string |
Uplink |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec UplinkSpec |
Required: {} Required: {} |
||
status UplinkStatus |
Optional: {} |
UplinkList¶
UplinkList contains a list of Uplink resources.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
k8s.ovn.org/v1alpha1 |
||
kind string |
UplinkList |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items Uplink array |
UplinkNodeConfig¶
Appears in: - UplinkSpec
| Field | Description | Default | Validation |
|---|---|---|---|
type UplinkType |
Type is the uplink node config type. Supported value: OVSBridge. | Enum: [OVSBridge] Required: {} Required: {} |
|
nodeSelector LabelSelector |
NodeSelector selects nodes where this uplink config applies. An empty selector matches all nodes. |
Required: {} Required: {} |
|
hostInterfaceName InterfaceName |
HostInterfaceName is the host-visible Linux interface that carries the gateway L3 identity for this uplink. In non-accelerated deployments, this is typically the OVS bridge Linux interface, whose name usually matches the OVS bridge name. In SmartNIC accelerated deployments, this is the VF/SF netdevice and OVN-Kubernetes resolves the OVS bridge through its representor. In DPU deployments, this is the DPU-host PF interface whose DPU-side PF representor is attached to the OVS bridge. |
MaxLength: 15 MinLength: 1 Pattern: ^[^/\s]+$ Required: {} Required: {} |
UplinkSpec¶
Appears in: - Uplink
| Field | Description | Default | Validation |
|---|---|---|---|
nodeConfigs UplinkNodeConfig array |
NodeConfigs contains mappings of nodes to uplink configuration. A node may be selected by at most one nodeConfig entry. Multiple nodeConfigs that select the same node are treated as a configuration error. |
MaxItems: 64 MinItems: 1 Required: {} Required: {} |
UplinkState¶
UplinkState contains node-local discovery and gateway state for an Uplink.
Appears in: - UplinkStateList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
k8s.ovn.org/v1alpha1 |
||
kind string |
UplinkState |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec UplinkStateSpec |
Required: {} Required: {} |
||
status UplinkStateStatus |
Optional: {} |
UplinkStateList¶
UplinkStateList contains a list of UplinkState resources.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
k8s.ovn.org/v1alpha1 |
||
kind string |
UplinkStateList |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
items UplinkState array |
UplinkStateSpec¶
Appears in: - UplinkState
| Field | Description | Default | Validation |
|---|---|---|---|
uplinkName string |
UplinkName is the Uplink this state belongs to. | MaxLength: 253 MinLength: 1 Required: {} |
|
nodeName string |
NodeName is the node this state belongs to. | MaxLength: 253 MinLength: 1 Required: {} |
UplinkStateStatus¶
Appears in: - UplinkState
| Field | Description | Default | Validation |
|---|---|---|---|
type UplinkType |
Type is defined by the matched nodeConfig of the Uplink. | Enum: [OVSBridge] Optional: {} |
|
hostInterfaceName InterfaceName |
HostInterfaceName is the host-visible Linux interface selected by Uplink spec. It carries the host-side gateway L3 identity in all modes. |
MaxLength: 15 MinLength: 1 Pattern: ^[^/\s]+$ Optional: {} |
|
ovsBridge OVSBridgeStatus |
OVSBridge contains resolved OVS bridge data. | Optional: {} |
|
macAddress MACAddress |
MACAddress is the MAC address used for the OVN gateway interface. | Pattern: ^([0-9a-fA-F]\{2\}:)\{5\}[0-9a-fA-F]\{2\}$ Optional: {} |
|
hostFunction HostFunction |
HostFunction identifies the PCI function (a PF, or a VF on that PF) backing the host interface. Only SR-IOV capable functions are published: they are the ones that can have a representor on a DPU, which is what this field exists to resolve. In split DPU mode the DPU-host publishes it so the DPU can resolve the interface's representor and OVS bridge directly, without scanning bridges by host MAC. Absent when the host interface has no such function or its identity cannot be resolved. |
Optional: {} |
|
ipAddresses IPAddressCIDR array |
IPAddresses are host-side shared gateway IP addresses. | MaxItems: 2 MaxLength: 64 Optional: {} |
|
defaultGateways IPAddress array |
DefaultGateways are distinct next-hop IPs from the selected host interface's lowest-metric default routes per IP family. Among those next hops only the ones with the highest weight are published; weights themselves are not represented, so lighter next hops of an unequal-weight multipath route are omitted rather than programmed as equal-cost paths. The limit is 256 total across both IP families per node and Uplink; it is an API bound, not a guarantee of dataplane or hardware offload capacity. |
MaxItems: 256 MaxLength: 64 Optional: {} |
|
conditions Condition array |
Conditions reports node-local discovery and gateway programming state for this resolved uplink. |
Optional: {} |
UplinkStatus¶
Appears in: - Uplink
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array |
Conditions reports aggregate Uplink state. | Optional: {} |
UplinkType¶
Underlying type: string
Appears in: - UplinkNodeConfig - UplinkStateStatus
| Field | Description |
|---|---|
OVSBridge |