OVN-Kubernetes API Reference Guide¶

OVN-Kubernetes implements core Kubernetes Networking features as well as advanced features using Custom Resource Definitions.

Core Kubernetes features API Reference¶

This section contains the API Reference guide for core Kubernetes APIs that OVN-Kubernetes watches

• Nodes
• Namespaces
• Pods
• Services
• Endpoints
• EndpointSlices
• NetworkPolicies

Extended Kubernetes features API Reference¶

This section contains the API Reference guide for extended Kubernetes ecosystem APIs that OVN-Kubernetes watches and implements

• AdminNetworkPolicies - shipped by SIG-Network-Policy-API
• BaselineAdminNetworkPolicies - shipped by SIG-Network-Policy-API
• NetworkAttachmentDefinitions - shipped by Kubernetes-Network-Plumbing-WG
• MultiNetworkPolicies - shipped by Kubernetes-Network-Plumbing-WG

OVN-Kubernetes features API Reference¶

This section contains the API Reference guide for features designed and implemented by OVN-Kubernetes

• EgressIP
• EgressService
• EgressQoS
• EgressFirewall
• AdminPolicyBasedExternalRoutes
• UserDefinedNetwork
• Uplink and UplinkState
• RouteAdvertisements
• VTEP
• ClusterNetworkConnect

Updating API reference docs¶

Update the API reference docs by running the following make target:

$ make -C docs/ generate-api-reference