Skip to content

API Reference

Packages

k8s.ovn.org/v1

Package v1 contains API Schema definitions for the network v1 API group

EgressIPSpec

EgressIPSpec is a desired state description of EgressIP.

Appears in: - EgressIP

Field Description Default Validation
egressIPs string array EgressIPs is the list of egress IP addresses requested. Can be IPv4 and/or IPv6.
This field is mandatory.
namespaceSelector LabelSelector NamespaceSelector applies the egress IP only to the namespace(s) whose label
matches this definition. This field is mandatory.
podSelector LabelSelector PodSelector applies the egress IP only to the pods whose label
matches this definition. This field is optional, and in case it is not set:
results in the egress IP being applied to all pods in the namespace(s)
matched by the NamespaceSelector. In case it is set: is intersected with
the NamespaceSelector, thus applying the egress IP to the pods
(in the namespace(s) already matched by the NamespaceSelector) which
match this pod selector.
Optional: {}
egressNodeSelector LabelSelector EgressNodeSelector limits the pool of nodes that can host the
EgressIPs in this object; it applies to all EgressIPs in this object.
Only nodes whose labels match this selector are eligible for assignment.
This field is optional. When not specified by the user, the CRD
default is applied: {matchExpressions: [{key:
k8s.ovn.org/egress-assignable, operator: Exists}]}.
An empty selector ({}) matches all nodes in the cluster including
control plane nodes — use with caution as it expands the eligible
node pool and health-check set to the entire cluster.
This field restricts only where the IPs in this EgressIP object are
placed; it does not reserve the matched nodes for exclusive use.
Other EgressIP objects can still consume capacity on the same nodes.
{ matchExpressions:[map[key:k8s.ovn.org/egress-assignable operator:Exists]] } Optional: {}

EgressIPStatus

Appears in: - EgressIP

Field Description Default Validation
items EgressIPStatusItem array The list of assigned egress IPs and their corresponding node assignment.

EgressIPStatusItem

The per node status, for those egress IPs who have been assigned.

Appears in: - EgressIPStatus

Field Description Default Validation
node string Assigned node name
egressIP string Assigned egress IP