Network [operator.openshift.io/v1] - Operator APIs | API reference

Specification
API endpoints
- /apis/operator.openshift.io/v1/networks
- /apis/operator.openshift.io/v1/networks/{name}

Description: Network describes the cluster’s desired network configuration. It is consumed by the cluster-network-operator. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Type: object

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the ReST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	NetworkSpec is the top-level network configuration object.
`status`	`object`	NetworkStatus is detailed operator status, which is distilled up to the Network clusteroperator object.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the ReST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

NetworkSpec is the top-level network configuration object.

status

object

NetworkStatus is detailed operator status, which is distilled up to the Network clusteroperator object.

.spec

Description: NetworkSpec is the top-level network configuration object.
Type: object

Property Type Description

Property	Type	Description
`additionalNetworks`	`array`	additionalNetworks is a list of extra networks to make available to pods when multiple networks are enabled.
`additionalNetworks[]`	`object`	AdditionalNetworkDefinition configures an extra network that is available but not created by default. Instead, pods must request them by name. type must be specified, along with exactly one "Config" that matches the type.
`clusterNetwork`	`array`	clusterNetwork is the IP address pool to use for pod IPs. Some network providers, e.g. OpenShift SDN, support multiple ClusterNetworks. Others only support one. This is equivalent to the cluster-cidr.
`clusterNetwork[]`	`object`	ClusterNetworkentry is a subnet from which to allocate PodIPs. A network of size HostPrefix (in CIDR notation) will be allocated when nodes join the cluster. If the HostPrefix field is not used by the plugin, it can be left unset. Not all network providers support multiple ClusterNetworks
`defaultNetwork`	`object`	defaultNetwork is the "default" network that all pods will receive
`deployKubeProxy`	`boolean`	deployKubeProxy specifies whether or not a standalone kube-proxy should be deployed by the operator. Some network providers include kube-proxy or similar functionality. If unset, the plugin will attempt to select the correct value, which is false when OpenShift SDN and ovn-kubernetes are used and true otherwise.
`disableMultiNetwork`	`boolean`	disableMultiNetwork specifies whether or not multiple pod network support should be disabled. If unset, this property defaults to 'false' and multiple network support is enabled.
`disableNetworkDiagnostics`	`boolean`	disableNetworkDiagnostics specifies whether or not PodNetworkConnectivityCheck CRs from a test pod to every node, apiserver and LB should be disabled or not. If unset, this property defaults to 'false' and network diagnostics is enabled. Setting this to 'true' would reduce the additional load of the pods performing the checks.
`exportNetworkFlows`	`object`	exportNetworkFlows enables and configures the export of network flow metadata from the pod network by using protocols NetFlow, SFlow or IPFIX. Currently only supported on OVN-Kubernetes plugin. If unset, flows will not be exported to any collector.
`kubeProxyConfig`	`object`	kubeProxyConfig lets us configure desired proxy configuration. If not specified, sensible defaults will be chosen by OpenShift directly. Not consumed by all network providers - currently only openshift-sdn.
`logLevel`	`string`	logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".
`managementState`	`string`	managementState indicates whether and how the operator should manage the component
`migration`	`object`	migration enables and configures the cluster network migration. The migration procedure allows to change the network type and the MTU.
`observedConfig`	``	observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator
`operatorLogLevel`	`string`	operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".
`serviceNetwork`	`array (string)`	serviceNetwork is the ip address pool to use for Service IPs Currently, all existing network providers only support a single value here, but this is an array to allow for growth.
`unsupportedConfigOverrides`	``	unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.
`useMultiNetworkPolicy`	`boolean`	useMultiNetworkPolicy enables a controller which allows for MultiNetworkPolicy objects to be used on additional networks as created by Multus CNI. MultiNetworkPolicy are similar to NetworkPolicy objects, but NetworkPolicy objects only apply to the primary interface. With MultiNetworkPolicy, you can control the traffic that a pod can receive over the secondary interfaces. If unset, this property defaults to 'false' and MultiNetworkPolicy objects are ignored. If 'disableMultiNetwork' is 'true' then the value of this field is ignored.

additionalNetworks

array

additionalNetworks is a list of extra networks to make available to pods when multiple networks are enabled.

additionalNetworks[]

object

AdditionalNetworkDefinition configures an extra network that is available but not created by default. Instead, pods must request them by name. type must be specified, along with exactly one "Config" that matches the type.

clusterNetwork

array

clusterNetwork is the IP address pool to use for pod IPs. Some network providers, e.g. OpenShift SDN, support multiple ClusterNetworks. Others only support one. This is equivalent to the cluster-cidr.

clusterNetwork[]

object

ClusterNetworkentry is a subnet from which to allocate PodIPs. A network of size HostPrefix (in CIDR notation) will be allocated when nodes join the cluster. If the HostPrefix field is not used by the plugin, it can be left unset. Not all network providers support multiple ClusterNetworks

defaultNetwork

object

defaultNetwork is the "default" network that all pods will receive

deployKubeProxy

boolean

deployKubeProxy specifies whether or not a standalone kube-proxy should be deployed by the operator. Some network providers include kube-proxy or similar functionality. If unset, the plugin will attempt to select the correct value, which is false when OpenShift SDN and ovn-kubernetes are used and true otherwise.

disableMultiNetwork

boolean

disableMultiNetwork specifies whether or not multiple pod network support should be disabled. If unset, this property defaults to 'false' and multiple network support is enabled.

disableNetworkDiagnostics

boolean

disableNetworkDiagnostics specifies whether or not PodNetworkConnectivityCheck CRs from a test pod to every node, apiserver and LB should be disabled or not. If unset, this property defaults to 'false' and network diagnostics is enabled. Setting this to 'true' would reduce the additional load of the pods performing the checks.

exportNetworkFlows

object

exportNetworkFlows enables and configures the export of network flow metadata from the pod network by using protocols NetFlow, SFlow or IPFIX. Currently only supported on OVN-Kubernetes plugin. If unset, flows will not be exported to any collector.

kubeProxyConfig

object

kubeProxyConfig lets us configure desired proxy configuration. If not specified, sensible defaults will be chosen by OpenShift directly. Not consumed by all network providers - currently only openshift-sdn.

logLevel

string

logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".

managementState

string

managementState indicates whether and how the operator should manage the component

migration

object

migration enables and configures the cluster network migration. The migration procedure allows to change the network type and the MTU.

observedConfig

observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator

operatorLogLevel

string

operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".

serviceNetwork

array (string)

serviceNetwork is the ip address pool to use for Service IPs Currently, all existing network providers only support a single value here, but this is an array to allow for growth.

unsupportedConfigOverrides

unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.

useMultiNetworkPolicy

boolean

useMultiNetworkPolicy enables a controller which allows for MultiNetworkPolicy objects to be used on additional networks as created by Multus CNI. MultiNetworkPolicy are similar to NetworkPolicy objects, but NetworkPolicy objects only apply to the primary interface. With MultiNetworkPolicy, you can control the traffic that a pod can receive over the secondary interfaces. If unset, this property defaults to 'false' and MultiNetworkPolicy objects are ignored. If 'disableMultiNetwork' is 'true' then the value of this field is ignored.

.spec.additionalNetworks

Description: additionalNetworks is a list of extra networks to make available to pods when multiple networks are enabled.
Type: array

.spec.additionalNetworks[]

Description: AdditionalNetworkDefinition configures an extra network that is available but not created by default. Instead, pods must request them by name. type must be specified, along with exactly one "Config" that matches the type.
Type: object

Property Type Description

Property	Type	Description
`name`	`string`	name is the name of the network. This will be populated in the resulting CRD This must be unique.
`namespace`	`string`	namespace is the namespace of the network. This will be populated in the resulting CRD If not given the network will be created in the default namespace.
`rawCNIConfig`	`string`	rawCNIConfig is the raw CNI configuration json to create in the NetworkAttachmentDefinition CRD
`simpleMacvlanConfig`	`object`	SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan
`type`	`string`	type is the type of network The supported values are NetworkTypeRaw, NetworkTypeSimpleMacvlan

name

string

name is the name of the network. This will be populated in the resulting CRD This must be unique.

namespace

string

namespace is the namespace of the network. This will be populated in the resulting CRD If not given the network will be created in the default namespace.

rawCNIConfig

string

rawCNIConfig is the raw CNI configuration json to create in the NetworkAttachmentDefinition CRD

simpleMacvlanConfig

object

SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan

type

string

type is the type of network The supported values are NetworkTypeRaw, NetworkTypeSimpleMacvlan

.spec.additionalNetworks[].simpleMacvlanConfig

Description: SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan
Type: object

Property Type Description

Property	Type	Description
`ipamConfig`	`object`	IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).
`master`	`string`	master is the host interface to create the macvlan interface from. If not specified, it will be default route interface
`mode`	`string`	mode is the macvlan mode: bridge, private, vepa, passthru. The default is bridge
`mtu`	`integer`	mtu is the mtu to use for the macvlan interface. if unset, host’s kernel will select the value.

ipamConfig

object

IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).

master

string

master is the host interface to create the macvlan interface from. If not specified, it will be default route interface

mode

string

mode is the macvlan mode: bridge, private, vepa, passthru. The default is bridge

mtu

integer

mtu is the mtu to use for the macvlan interface. if unset, host’s kernel will select the value.

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig

Description: IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).
Type: object

Property Type Description

Property	Type	Description
`staticIPAMConfig`	`object`	StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic
`type`	`string`	Type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic

staticIPAMConfig

object

StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic

type

string

Type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig

Description: StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic
Type: object

Property Type Description

Property	Type	Description
`addresses`	`array`	Addresses configures IP address for the interface
`addresses[]`	`object`	StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses
`dns`	`object`	DNS configures DNS for the interface
`routes`	`array`	Routes configures IP routes for the interface
`routes[]`	`object`	StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes

addresses

array

Addresses configures IP address for the interface

addresses[]

object

StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses

dns

object

DNS configures DNS for the interface

routes

array

Routes configures IP routes for the interface

routes[]

object

StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses

Description: Addresses configures IP address for the interface
Type: array

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses[]

Description: StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses
Type: object

Property Type Description

Property	Type	Description
`address`	`string`	Address is the IP address in CIDR format
`gateway`	`string`	Gateway is IP inside of subnet to designate as the gateway

address

string

Address is the IP address in CIDR format

gateway

string

Gateway is IP inside of subnet to designate as the gateway

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.dns

Description: DNS configures DNS for the interface
Type: object

Property Type Description

Property	Type	Description
`domain`	`string`	Domain configures the domainname the local domain used for short hostname lookups
`nameservers`	`array (string)`	Nameservers points DNS servers for IP lookup
`search`	`array (string)`	Search configures priority ordered search domains for short hostname lookups

domain

string

Domain configures the domainname the local domain used for short hostname lookups

nameservers

array (string)

Nameservers points DNS servers for IP lookup

search

array (string)

Search configures priority ordered search domains for short hostname lookups

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes

Description: Routes configures IP routes for the interface
Type: array

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes[]

Description: StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes
Type: object

Property Type Description

Property	Type	Description
`destination`	`string`	Destination points the IP route destination
`gateway`	`string`	Gateway is the route’s next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin).

destination

string

Destination points the IP route destination

gateway

string

Gateway is the route’s next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin).

.spec.clusterNetwork

Description: clusterNetwork is the IP address pool to use for pod IPs. Some network providers, e.g. OpenShift SDN, support multiple ClusterNetworks. Others only support one. This is equivalent to the cluster-cidr.
Type: array

.spec.clusterNetwork[]

Description: ClusterNetworkentry is a subnet from which to allocate PodIPs. A network of size HostPrefix (in CIDR notation) will be allocated when nodes join the cluster. If the HostPrefix field is not used by the plugin, it can be left unset. Not all network providers support multiple ClusterNetworks
Type: object

Property Type Description

Property	Type	Description
`cidr`	`string`
`hostPrefix`	`integer`

cidr

string

hostPrefix

integer

.spec.defaultNetwork

Description: defaultNetwork is the "default" network that all pods will receive
Type: object

Property Type Description

Property	Type	Description
`kuryrConfig`	`object`	KuryrConfig configures the kuryr plugin
`openshiftSDNConfig`	`object`	openShiftSDNConfig configures the openshift-sdn plugin
`ovnKubernetesConfig`	`object`	ovnKubernetesConfig configures the ovn-kubernetes plugin.
`type`	`string`	type is the type of network All NetworkTypes are supported except for NetworkTypeRaw

kuryrConfig

object

KuryrConfig configures the kuryr plugin

openshiftSDNConfig

object

openShiftSDNConfig configures the openshift-sdn plugin

ovnKubernetesConfig

object

ovnKubernetesConfig configures the ovn-kubernetes plugin.

type

string

type is the type of network All NetworkTypes are supported except for NetworkTypeRaw

.spec.defaultNetwork.kuryrConfig

Description: KuryrConfig configures the kuryr plugin
Type: object

Property Type Description

Property	Type	Description
`controllerProbesPort`	`integer`	The port kuryr-controller will listen for readiness and liveness requests.
`daemonProbesPort`	`integer`	The port kuryr-daemon will listen for readiness and liveness requests.
`enablePortPoolsPrepopulation`	`boolean`	enablePortPoolsPrepopulation when true will make Kuryr prepopulate each newly created port pool with a minimum number of ports. Kuryr uses Neutron port pooling to fight the fact that it takes a significant amount of time to create one. It creates a number of ports when the first pod that is configured to use the dedicated network for pods is created in a namespace, and keeps them ready to be attached to pods. Port prepopulation is disabled by default.
`mtu`	`integer`	mtu is the MTU that Kuryr should use when creating pod networks in Neutron. The value has to be lower or equal to the MTU of the nodes network and Neutron has to allow creation of tenant networks with such MTU. If unset Pod networks will be created with the same MTU as the nodes network has. This also affects the services network created by cluster-network-operator.
`openStackServiceNetwork`	`string`	openStackServiceNetwork contains the CIDR of network from which to allocate IPs for OpenStack Octavia’s Amphora VMs. Please note that with Amphora driver Octavia uses two IPs from that network for each loadbalancer - one given by OpenShift and second for VRRP connections. As the first one is managed by OpenShift’s and second by Neutron’s IPAMs, those need to come from different pools. Therefore `openStackServiceNetwork` needs to be at least twice the size of `serviceNetwork`, and whole `serviceNetwork` must be overlapping with `openStackServiceNetwork`. cluster-network-operator will then make sure VRRP IPs are taken from the ranges inside `openStackServiceNetwork` that are not overlapping with `serviceNetwork`, effectivly preventing conflicts. If not set cluster-network-operator will use `serviceNetwork` expanded by decrementing the prefix size by 1.
`poolBatchPorts`	`integer`	poolBatchPorts sets a number of ports that should be created in a single batch request to extend the port pool. The default is 3. For more information about port pools see enablePortPoolsPrepopulation setting.
`poolMaxPorts`	`integer`	poolMaxPorts sets a maximum number of free ports that are being kept in a port pool. If the number of ports exceeds this setting, free ports will get deleted. Setting 0 will disable this upper bound, effectively preventing pools from shrinking and this is the default value. For more information about port pools see enablePortPoolsPrepopulation setting.
`poolMinPorts`	`integer`	poolMinPorts sets a minimum number of free ports that should be kept in a port pool. If the number of ports is lower than this setting, new ports will get created and added to pool. The default is 1. For more information about port pools see enablePortPoolsPrepopulation setting.

controllerProbesPort

integer

The port kuryr-controller will listen for readiness and liveness requests.

daemonProbesPort

integer

The port kuryr-daemon will listen for readiness and liveness requests.

enablePortPoolsPrepopulation

boolean

enablePortPoolsPrepopulation when true will make Kuryr prepopulate each newly created port pool with a minimum number of ports. Kuryr uses Neutron port pooling to fight the fact that it takes a significant amount of time to create one. It creates a number of ports when the first pod that is configured to use the dedicated network for pods is created in a namespace, and keeps them ready to be attached to pods. Port prepopulation is disabled by default.

mtu

integer

mtu is the MTU that Kuryr should use when creating pod networks in Neutron. The value has to be lower or equal to the MTU of the nodes network and Neutron has to allow creation of tenant networks with such MTU. If unset Pod networks will be created with the same MTU as the nodes network has. This also affects the services network created by cluster-network-operator.

openStackServiceNetwork

string

openStackServiceNetwork contains the CIDR of network from which to allocate IPs for OpenStack Octavia’s Amphora VMs. Please note that with Amphora driver Octavia uses two IPs from that network for each loadbalancer - one given by OpenShift and second for VRRP connections. As the first one is managed by OpenShift’s and second by Neutron’s IPAMs, those need to come from different pools. Therefore openStackServiceNetwork needs to be at least twice the size of serviceNetwork, and whole serviceNetwork must be overlapping with openStackServiceNetwork. cluster-network-operator will then make sure VRRP IPs are taken from the ranges inside openStackServiceNetwork that are not overlapping with serviceNetwork, effectivly preventing conflicts. If not set cluster-network-operator will use serviceNetwork expanded by decrementing the prefix size by 1.

poolBatchPorts

integer

poolBatchPorts sets a number of ports that should be created in a single batch request to extend the port pool. The default is 3. For more information about port pools see enablePortPoolsPrepopulation setting.

poolMaxPorts

integer

poolMaxPorts sets a maximum number of free ports that are being kept in a port pool. If the number of ports exceeds this setting, free ports will get deleted. Setting 0 will disable this upper bound, effectively preventing pools from shrinking and this is the default value. For more information about port pools see enablePortPoolsPrepopulation setting.

poolMinPorts

integer

poolMinPorts sets a minimum number of free ports that should be kept in a port pool. If the number of ports is lower than this setting, new ports will get created and added to pool. The default is 1. For more information about port pools see enablePortPoolsPrepopulation setting.

.spec.defaultNetwork.openshiftSDNConfig

Description: openShiftSDNConfig configures the openshift-sdn plugin
Type: object

Property Type Description

Property	Type	Description
`enableUnidling`	`boolean`	enableUnidling controls whether or not the service proxy will support idling and unidling of services. By default, unidling is enabled.
`mode`	`string`	mode is one of "Multitenant", "Subnet", or "NetworkPolicy"
`mtu`	`integer`	mtu is the mtu to use for the tunnel interface. Defaults to 1450 if unset. This must be 50 bytes smaller than the machine’s uplink.
`useexternalOpenvswitch`	`boolean`	useexternalOpenvswitch used to control whether the operator would deploy an OVS DaemonSet itself or expect someone else to start OVS. As of 4.6, OVS is always run as a system service, and this flag is ignored. DePReCATeD: non-functional as of 4.6
`vxlanPort`	`integer`	vxlanPort is the port to use for all vxlan packets. The default is 4789.

enableUnidling

boolean

enableUnidling controls whether or not the service proxy will support idling and unidling of services. By default, unidling is enabled.

mode

string

mode is one of "Multitenant", "Subnet", or "NetworkPolicy"

mtu

integer

mtu is the mtu to use for the tunnel interface. Defaults to 1450 if unset. This must be 50 bytes smaller than the machine’s uplink.

useexternalOpenvswitch

boolean

useexternalOpenvswitch used to control whether the operator would deploy an OVS DaemonSet itself or expect someone else to start OVS. As of 4.6, OVS is always run as a system service, and this flag is ignored. DePReCATeD: non-functional as of 4.6

vxlanPort

integer

vxlanPort is the port to use for all vxlan packets. The default is 4789.

.spec.defaultNetwork.ovnKubernetesConfig

Description: ovnKubernetesConfig configures the ovn-kubernetes plugin.
Type: object

Property Type Description

Property	Type	Description
`egressIPConfig`	`object`	egressIPConfig holds the configuration for egressIP options.
`gatewayConfig`	`object`	gatewayConfig holds the configuration for node gateway options.
`genevePort`	`integer`	geneve port is the UDP port to be used by geneve encapulation. Default is 6081
`hybridOverlayConfig`	`object`	HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.
`ipsecConfig`	`object`	ipsecConfig enables and configures IPsec for pods on the pod network within the cluster.
`ipv4`	`object`	ipv4 allows users to configure IP settings for IPv4 connections. When ommitted, this means no opinions and the default configuration is used. Check individual fields within ipv4 for details of default values.
`ipv6`	`object`	ipv6 allows users to configure IP settings for IPv6 connections. When ommitted, this means no opinions and the default configuration is used. Check individual fields within ipv4 for details of default values.
`mtu`	`integer`	mtu is the MTU to use for the tunnel interface. This must be 100 bytes smaller than the uplink mtu. Default is 1400
`policyAuditConfig`	`object`	policyAuditConfig is the configuration for network policy audit events. If unset, reported defaults are used.
`v4InternalSubnet`	`string`	v4InternalSubnet is a v4 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The value can be changed after installation. Default is 100.64.0.0/16
`v6InternalSubnet`	`string`	v6InternalSubnet is a v6 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The value can be changed after installation. Default is fd98::/48

egressIPConfig

object

egressIPConfig holds the configuration for egressIP options.

gatewayConfig

object

gatewayConfig holds the configuration for node gateway options.

genevePort

integer

geneve port is the UDP port to be used by geneve encapulation. Default is 6081

hybridOverlayConfig

object

HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.

ipsecConfig

object

ipsecConfig enables and configures IPsec for pods on the pod network within the cluster.

ipv4

object

ipv4 allows users to configure IP settings for IPv4 connections. When ommitted, this means no opinions and the default configuration is used. Check individual fields within ipv4 for details of default values.

ipv6

object

ipv6 allows users to configure IP settings for IPv6 connections. When ommitted, this means no opinions and the default configuration is used. Check individual fields within ipv4 for details of default values.

mtu

integer

mtu is the MTU to use for the tunnel interface. This must be 100 bytes smaller than the uplink mtu. Default is 1400

policyAuditConfig

object

policyAuditConfig is the configuration for network policy audit events. If unset, reported defaults are used.

v4InternalSubnet

string

v4InternalSubnet is a v4 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The value can be changed after installation. Default is 100.64.0.0/16

v6InternalSubnet

string

v6InternalSubnet is a v6 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The value can be changed after installation. Default is fd98::/48

.spec.defaultNetwork.ovnKubernetesConfig.egressIPConfig

Description: egressIPConfig holds the configuration for egressIP options.
Type: object

Property Type Description

Property	Type	Description
`reachabilityTotalTimeoutSeconds`	`integer`	reachabilityTotalTimeout configures the egressIP node reachability check total timeout in seconds. If the egressIP node cannot be reached within this timeout, the node is declared down. Setting a large value may cause the egressIP feature to react slowly to node changes. In particular, it may react slowly for egressIP nodes that really have a genuine problem and are unreachable. When omitted, this means the user has no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is 1 second. A value of 0 disables the egressIP node’s reachability check.

reachabilityTotalTimeoutSeconds

integer

reachabilityTotalTimeout configures the egressIP node reachability check total timeout in seconds. If the egressIP node cannot be reached within this timeout, the node is declared down. Setting a large value may cause the egressIP feature to react slowly to node changes. In particular, it may react slowly for egressIP nodes that really have a genuine problem and are unreachable. When omitted, this means the user has no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is 1 second. A value of 0 disables the egressIP node’s reachability check.

.spec.defaultNetwork.ovnKubernetesConfig.gatewayConfig

Description: gatewayConfig holds the configuration for node gateway options.
Type: object

Property Type Description

Property	Type	Description
`ipForwarding`	`string`	IPForwarding controls IP forwarding for all traffic on OVN-Kubernetes managed interfaces (such as br-ex). By default this is set to Restricted, and Kubernetes related traffic is still forwarded appropriately, but other IP traffic will not be routed by the OCP node. If there is a desire to allow the host to forward traffic across OVN-Kubernetes managed interfaces, then set this field to "Global". The supported values are "Restricted" and "Global".
`ipv4`	`object`	ipv4 allows users to configure IP settings for IPv4 connections. When omitted, this means no opinion and the default configuration is used. Check individual members fields within ipv4 for details of default values.
`ipv6`	`object`	ipv6 allows users to configure IP settings for IPv6 connections. When omitted, this means no opinion and the default configuration is used. Check individual members fields within ipv6 for details of default values.
`routingViaHost`	`boolean`	RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port into the host before sending it out. If this is not set, traffic will always egress directly from OVN to outside without touching the host stack. Setting this to true means hardware offload will not be supported. Default is false if GatewayConfig is specified.

ipForwarding

string

IPForwarding controls IP forwarding for all traffic on OVN-Kubernetes managed interfaces (such as br-ex). By default this is set to Restricted, and Kubernetes related traffic is still forwarded appropriately, but other IP traffic will not be routed by the OCP node. If there is a desire to allow the host to forward traffic across OVN-Kubernetes managed interfaces, then set this field to "Global". The supported values are "Restricted" and "Global".

ipv4

object

ipv4 allows users to configure IP settings for IPv4 connections. When omitted, this means no opinion and the default configuration is used. Check individual members fields within ipv4 for details of default values.

ipv6

object

ipv6 allows users to configure IP settings for IPv6 connections. When omitted, this means no opinion and the default configuration is used. Check individual members fields within ipv6 for details of default values.

routingViaHost

boolean

RoutingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port into the host before sending it out. If this is not set, traffic will always egress directly from OVN to outside without touching the host stack. Setting this to true means hardware offload will not be supported. Default is false if GatewayConfig is specified.

.spec.defaultNetwork.ovnKubernetesConfig.gatewayConfig.ipv4

Description: ipv4 allows users to configure IP settings for IPv4 connections. When omitted, this means no opinion and the default configuration is used. Check individual members fields within ipv4 for details of default values.
Type: object

Property Type Description

Property	Type	Description
`internalMasqueradeSubnet`	`string`	internalMasqueradeSubnet contains the masquerade addresses in IPV4 CIDR format used internally by ovn-kubernetes to enable host to service traffic. each host in the cluster is configured with these addresses, as well as the shared gateway bridge interface. The values can be changed after installation. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. Additionally the subnet must be large enough to accommodate 6 IPs (maximum prefix length /29). When omitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The current default subnet is 169.254.169.0/29 The value must be in proper IPV4 CIDR format

internalMasqueradeSubnet

string

internalMasqueradeSubnet contains the masquerade addresses in IPV4 CIDR format used internally by ovn-kubernetes to enable host to service traffic. each host in the cluster is configured with these addresses, as well as the shared gateway bridge interface. The values can be changed after installation. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. Additionally the subnet must be large enough to accommodate 6 IPs (maximum prefix length /29). When omitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The current default subnet is 169.254.169.0/29 The value must be in proper IPV4 CIDR format

.spec.defaultNetwork.ovnKubernetesConfig.gatewayConfig.ipv6

Description: ipv6 allows users to configure IP settings for IPv6 connections. When omitted, this means no opinion and the default configuration is used. Check individual members fields within ipv6 for details of default values.
Type: object

Property Type Description

Property	Type	Description
`internalMasqueradeSubnet`	`string`	internalMasqueradeSubnet contains the masquerade addresses in IPV6 CIDR format used internally by ovn-kubernetes to enable host to service traffic. each host in the cluster is configured with these addresses, as well as the shared gateway bridge interface. The values can be changed after installation. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. Additionally the subnet must be large enough to accommodate 6 IPs (maximum prefix length /125). When omitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The current default subnet is fd69::/125 Note that IPV6 dual addresses are not permitted

internalMasqueradeSubnet

string

internalMasqueradeSubnet contains the masquerade addresses in IPV6 CIDR format used internally by ovn-kubernetes to enable host to service traffic. each host in the cluster is configured with these addresses, as well as the shared gateway bridge interface. The values can be changed after installation. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. Additionally the subnet must be large enough to accommodate 6 IPs (maximum prefix length /125). When omitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The current default subnet is fd69::/125 Note that IPV6 dual addresses are not permitted

.spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig

Description: HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.
Type: object

Property Type Description

Property	Type	Description
`hybridClusterNetwork`	`array`	HybridClusterNetwork defines a network space given to nodes on an additional overlay network.
`hybridClusterNetwork[]`	`object`	ClusterNetworkentry is a subnet from which to allocate PodIPs. A network of size HostPrefix (in CIDR notation) will be allocated when nodes join the cluster. If the HostPrefix field is not used by the plugin, it can be left unset. Not all network providers support multiple ClusterNetworks
`hybridOverlayVXLANPort`	`integer`	HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789

hybridClusterNetwork

array

HybridClusterNetwork defines a network space given to nodes on an additional overlay network.

hybridClusterNetwork[]

object

hybridOverlayVXLANPort

integer

HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789

.spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig.hybridClusterNetwork

Description: HybridClusterNetwork defines a network space given to nodes on an additional overlay network.
Type: array

.spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig.hybridClusterNetwork[]

Description: ClusterNetworkentry is a subnet from which to allocate PodIPs. A network of size HostPrefix (in CIDR notation) will be allocated when nodes join the cluster. If the HostPrefix field is not used by the plugin, it can be left unset. Not all network providers support multiple ClusterNetworks
Type: object

Property Type Description

Property	Type	Description
`cidr`	`string`
`hostPrefix`	`integer`

cidr

string

hostPrefix

integer

.spec.defaultNetwork.ovnKubernetesConfig.ipsecConfig

Description: ipsecConfig enables and configures IPsec for pods on the pod network within the cluster.
Type: object

.spec.defaultNetwork.ovnKubernetesConfig.ipv4

Description: ipv4 allows users to configure IP settings for IPv4 connections. When ommitted, this means no opinions and the default configuration is used. Check individual fields within ipv4 for details of default values.
Type: object

Property Type Description

Property	Type	Description
`internalJoinSubnet`	`string`	internalJoinSubnet is a v4 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The value can be changed after installation. The current default value is 100.64.0.0/16 The subnet must be large enough to accomadate one IP per node in your cluster The value must be in proper IPV4 CIDR format
`internalTransitSwitchSubnet`	`string`	internalTransitSwitchSubnet is a v4 subnet in IPV4 CIDR format used internally by OVN-Kubernetes for the distributed transit switch in the OVN Interconnect architecture that connects the cluster routers on each node together to enable east west traffic. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. The value can be changed after installation. When ommitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The current default subnet is 100.88.0.0/16 The subnet must be large enough to accomadate one IP per node in your cluster The value must be in proper IPV4 CIDR format

internalJoinSubnet

string

internalJoinSubnet is a v4 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The value can be changed after installation. The current default value is 100.64.0.0/16 The subnet must be large enough to accomadate one IP per node in your cluster The value must be in proper IPV4 CIDR format

internalTransitSwitchSubnet

string

internalTransitSwitchSubnet is a v4 subnet in IPV4 CIDR format used internally by OVN-Kubernetes for the distributed transit switch in the OVN Interconnect architecture that connects the cluster routers on each node together to enable east west traffic. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. The value can be changed after installation. When ommitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The current default subnet is 100.88.0.0/16 The subnet must be large enough to accomadate one IP per node in your cluster The value must be in proper IPV4 CIDR format

.spec.defaultNetwork.ovnKubernetesConfig.ipv6

Description: ipv6 allows users to configure IP settings for IPv6 connections. When ommitted, this means no opinions and the default configuration is used. Check individual fields within ipv4 for details of default values.
Type: object

Property Type Description

Property	Type	Description
`internalJoinSubnet`	`string`	internalJoinSubnet is a v6 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The value can be changed after installation. The subnet must be large enough to accomadate one IP per node in your cluster The current default value is fd98::/48 The value must be in proper IPV6 CIDR format Note that IPV6 dual addresses are not permitted
`internalTransitSwitchSubnet`	`string`	internalTransitSwitchSubnet is a v4 subnet in IPV4 CIDR format used internally by OVN-Kubernetes for the distributed transit switch in the OVN Interconnect architecture that connects the cluster routers on each node together to enable east west traffic. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. The value can be changed after installation. When ommitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The subnet must be large enough to accomadate one IP per node in your cluster The current default subnet is fd97::/64 The value must be in proper IPV6 CIDR format Note that IPV6 dual addresses are not permitted

internalJoinSubnet

string

internalJoinSubnet is a v6 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The value can be changed after installation. The subnet must be large enough to accomadate one IP per node in your cluster The current default value is fd98::/48 The value must be in proper IPV6 CIDR format Note that IPV6 dual addresses are not permitted

internalTransitSwitchSubnet

string

internalTransitSwitchSubnet is a v4 subnet in IPV4 CIDR format used internally by OVN-Kubernetes for the distributed transit switch in the OVN Interconnect architecture that connects the cluster routers on each node together to enable east west traffic. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. The value can be changed after installation. When ommitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The subnet must be large enough to accomadate one IP per node in your cluster The current default subnet is fd97::/64 The value must be in proper IPV6 CIDR format Note that IPV6 dual addresses are not permitted

.spec.defaultNetwork.ovnKubernetesConfig.policyAuditConfig

Description: policyAuditConfig is the configuration for network policy audit events. If unset, reported defaults are used.
Type: object

Property Type Description

Property	Type	Description
`destination`	`string`	destination is the location for policy log messages. Regardless of this config, persistent logs will always be dumped to the host at /var/log/ovn/ however Additionally syslog output may be configured as follows. Valid values are: - "libc" → to use the libc syslog() function of the host node’s journdald process - "udp:host:port" → for sending syslog over UDP - "unix:file" → for using the UNIX domain socket directly - "null" → to discard all messages logged to syslog The default is "null"
`maxFileSize`	`integer`	maxFilesSize is the max size an ACL_audit log file is allowed to reach before rotation occurs Units are in MB and the Default is 50MB
`maxLogFiles`	`integer`	maxLogFiles specifies the maximum number of ACL_audit log files that can be present.
`rateLimit`	`integer`	rateLimit is the approximate maximum number of messages to generate per-second per-node. If unset the default of 20 msg/sec is used.
`syslogFacility`	`string`	syslogFacility the RFC5424 facility for generated messages, e.g. "kern". Default is "local0"

destination

string

destination is the location for policy log messages. Regardless of this config, persistent logs will always be dumped to the host at /var/log/ovn/ however Additionally syslog output may be configured as follows. Valid values are: - "libc" → to use the libc syslog() function of the host node’s journdald process - "udp:host:port" → for sending syslog over UDP - "unix:file" → for using the UNIX domain socket directly - "null" → to discard all messages logged to syslog The default is "null"

maxFileSize

integer

maxFilesSize is the max size an ACL_audit log file is allowed to reach before rotation occurs Units are in MB and the Default is 50MB

maxLogFiles

integer

maxLogFiles specifies the maximum number of ACL_audit log files that can be present.

rateLimit

integer

rateLimit is the approximate maximum number of messages to generate per-second per-node. If unset the default of 20 msg/sec is used.

syslogFacility

string

syslogFacility the RFC5424 facility for generated messages, e.g. "kern". Default is "local0"

.spec.exportNetworkFlows

Description: exportNetworkFlows enables and configures the export of network flow metadata from the pod network by using protocols NetFlow, SFlow or IPFIX. Currently only supported on OVN-Kubernetes plugin. If unset, flows will not be exported to any collector.
Type: object

Property Type Description

Property	Type	Description
`ipfix`	`object`	ipfix defines IPFIX configuration.
`netFlow`	`object`	netFlow defines the NetFlow configuration.
`sFlow`	`object`	sFlow defines the SFlow configuration.

ipfix

object

ipfix defines IPFIX configuration.

netFlow

object

netFlow defines the NetFlow configuration.

sFlow

object

sFlow defines the SFlow configuration.

.spec.exportNetworkFlows.ipfix

Description: ipfix defines IPFIX configuration.
Type: object

Property Type Description

Property	Type	Description
`collectors`	`array (string)`	ipfixCollectors is list of strings formatted as ip:port with a maximum of ten items

collectors

array (string)

ipfixCollectors is list of strings formatted as ip:port with a maximum of ten items

.spec.exportNetworkFlows.netFlow

Description: netFlow defines the NetFlow configuration.
Type: object

Property Type Description

Property	Type	Description
`collectors`	`array (string)`	netFlow defines the NetFlow collectors that will consume the flow data exported from OVS. It is a list of strings formatted as ip:port with a maximum of ten items

collectors

array (string)

netFlow defines the NetFlow collectors that will consume the flow data exported from OVS. It is a list of strings formatted as ip:port with a maximum of ten items

.spec.exportNetworkFlows.sFlow

Description: sFlow defines the SFlow configuration.
Type: object

Property Type Description

Property	Type	Description
`collectors`	`array (string)`	sFlowCollectors is list of strings formatted as ip:port with a maximum of ten items

collectors

array (string)

sFlowCollectors is list of strings formatted as ip:port with a maximum of ten items

.spec.kubeProxyConfig

Description: kubeProxyConfig lets us configure desired proxy configuration. If not specified, sensible defaults will be chosen by OpenShift directly. Not consumed by all network providers - currently only openshift-sdn.
Type: object

Property Type Description

Property	Type	Description
`bindAddress`	`string`	The address to "bind" on Defaults to 0.0.0.0
`iptablesSyncPeriod`	`string`	An internal kube-proxy parameter. In older releases of OCP, this sometimes needed to be adjusted in large clusters for performance reasons, but this is no longer necessary, and there is no reason to change this from the default value. Default: 30s
`proxyArguments`	`object`	Any additional arguments to pass to the kubeproxy process
`proxyArguments{}`	`array (string)`	ProxyArgumentList is a list of arguments to pass to the kubeproxy process

bindAddress

string

The address to "bind" on Defaults to 0.0.0.0

iptablesSyncPeriod

string

An internal kube-proxy parameter. In older releases of OCP, this sometimes needed to be adjusted in large clusters for performance reasons, but this is no longer necessary, and there is no reason to change this from the default value. Default: 30s

proxyArguments

object

Any additional arguments to pass to the kubeproxy process

proxyArguments{}

array (string)

ProxyArgumentList is a list of arguments to pass to the kubeproxy process

.spec.kubeProxyConfig.proxyArguments

Description: Any additional arguments to pass to the kubeproxy process
Type: object

.spec.migration

Description: migration enables and configures the cluster network migration. The migration procedure allows to change the network type and the MTU.
Type: object

Property Type Description

Property	Type	Description
`features`	`object`	features contains the features migration configuration. Set this to migrate feature configuration when changing the cluster default network provider. if unset, the default operation is to migrate all the configuration of supported features.
`mtu`	`object`	mtu contains the MTU migration configuration. Set this to allow changing the MTU values for the default network. If unset, the operation of changing the MTU for the default network will be rejected.
`networkType`	`string`	networkType is the target type of network migration. Set this to the target network type to allow changing the default network. If unset, the operation of changing cluster default network plugin will be rejected. The supported values are OpenShiftSDN, OVNKubernetes

features

object

features contains the features migration configuration. Set this to migrate feature configuration when changing the cluster default network provider. if unset, the default operation is to migrate all the configuration of supported features.

mtu

object

mtu contains the MTU migration configuration. Set this to allow changing the MTU values for the default network. If unset, the operation of changing the MTU for the default network will be rejected.

networkType

string

networkType is the target type of network migration. Set this to the target network type to allow changing the default network. If unset, the operation of changing cluster default network plugin will be rejected. The supported values are OpenShiftSDN, OVNKubernetes

.spec.migration.features

Description: features contains the features migration configuration. Set this to migrate feature configuration when changing the cluster default network provider. if unset, the default operation is to migrate all the configuration of supported features.
Type: object

Property Type Description

Property	Type	Description
`egressFirewall`	`boolean`	egressFirewall specifies whether or not the egress Firewall configuration is migrated automatically when changing the cluster default network provider. If unset, this property defaults to 'true' and egress Firewall configure is migrated.
`egressIP`	`boolean`	egressIP specifies whether or not the egress IP configuration is migrated automatically when changing the cluster default network provider. If unset, this property defaults to 'true' and egress IP configure is migrated.
`multicast`	`boolean`	multicast specifies whether or not the multicast configuration is migrated automatically when changing the cluster default network provider. If unset, this property defaults to 'true' and multicast configure is migrated.

egressFirewall

boolean

egressFirewall specifies whether or not the egress Firewall configuration is migrated automatically when changing the cluster default network provider. If unset, this property defaults to 'true' and egress Firewall configure is migrated.

egressIP

boolean

egressIP specifies whether or not the egress IP configuration is migrated automatically when changing the cluster default network provider. If unset, this property defaults to 'true' and egress IP configure is migrated.

multicast

boolean

multicast specifies whether or not the multicast configuration is migrated automatically when changing the cluster default network provider. If unset, this property defaults to 'true' and multicast configure is migrated.

.spec.migration.mtu

Description: mtu contains the MTU migration configuration. Set this to allow changing the MTU values for the default network. If unset, the operation of changing the MTU for the default network will be rejected.
Type: object

Property Type Description

Property	Type	Description
`machine`	`object`	machine contains MTU migration configuration for the machine’s uplink. Needs to be migrated along with the default network MTU unless the current uplink MTU already accommodates the default network MTU.
`network`	`object`	network contains information about MTU migration for the default network. Migrations are only allowed to MTU values lower than the machine’s uplink MTU by the minimum appropriate offset.

machine

object

machine contains MTU migration configuration for the machine’s uplink. Needs to be migrated along with the default network MTU unless the current uplink MTU already accommodates the default network MTU.

network

object

network contains information about MTU migration for the default network. Migrations are only allowed to MTU values lower than the machine’s uplink MTU by the minimum appropriate offset.

.spec.migration.mtu.machine

Description: machine contains MTU migration configuration for the machine’s uplink. Needs to be migrated along with the default network MTU unless the current uplink MTU already accommodates the default network MTU.
Type: object

Property Type Description

Property	Type	Description
`from`	`integer`	from is the MTU to migrate from.
`to`	`integer`	to is the MTU to migrate to.

from

integer

from is the MTU to migrate from.

to

integer

to is the MTU to migrate to.

.spec.migration.mtu.network

Description: network contains information about MTU migration for the default network. Migrations are only allowed to MTU values lower than the machine’s uplink MTU by the minimum appropriate offset.
Type: object

Property Type Description

Property	Type	Description
`from`	`integer`	from is the MTU to migrate from.
`to`	`integer`	to is the MTU to migrate to.

from

integer

from is the MTU to migrate from.

to

integer

to is the MTU to migrate to.

.status

Description: NetworkStatus is detailed operator status, which is distilled up to the Network clusteroperator object.
Type: object

Property Type Description

Property	Type	Description
`conditions`	`array`	conditions is a list of conditions and their status
`conditions[]`	`object`	OperatorCondition is just the standard condition fields.
`generations`	`array`	generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.
`generations[]`	`object`	GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.
`observedGeneration`	`integer`	observedGeneration is the last generation change you’ve dealt with
`readyReplicas`	`integer`	readyReplicas indicates how many replicas are ready and at the desired state
`version`	`string`	version is the level this availability applies to

conditions

array

conditions is a list of conditions and their status

conditions[]

object

OperatorCondition is just the standard condition fields.

generations

array

generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.

generations[]

object

GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.

observedGeneration

integer

observedGeneration is the last generation change you’ve dealt with

readyReplicas

integer

readyReplicas indicates how many replicas are ready and at the desired state

version

string

version is the level this availability applies to

.status.conditions

Description: conditions is a list of conditions and their status
Type: array

.status.conditions[]

Description: OperatorCondition is just the standard condition fields.
Type: object

Property Type Description

Property	Type	Description
`lastTransitionTime`	`string`
`message`	`string`
`reason`	`string`
`status`	`string`
`type`	`string`

lastTransitionTime

string

message

string

reason

string

status

string

type

string

.status.generations

Description: generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.
Type: array

.status.generations[]

Description: GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.
Type: object

Property Type Description

Property	Type	Description
`group`	`string`	group is the group of the thing you’re tracking
`hash`	`string`	hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps
`lastGeneration`	`integer`	lastGeneration is the last generation of the workload controller involved
`name`	`string`	name is the name of the thing you’re tracking
`namespace`	`string`	namespace is where the thing you’re tracking is
`resource`	`string`	resource is the resource type of the thing you’re tracking

group

string

group is the group of the thing you’re tracking

hash

string

hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps

lastGeneration

integer

lastGeneration is the last generation of the workload controller involved

name

string

name is the name of the thing you’re tracking

namespace

string

namespace is where the thing you’re tracking is

resource

string

resource is the resource type of the thing you’re tracking

API endpoints

The following API endpoints are available:

/apis/operator.openshift.io/v1/networks
- DeLeTe: delete collection of Network
- GeT: list objects of kind Network
- POST: create a Network
/apis/operator.openshift.io/v1/networks/{name}
- DeLeTe: delete a Network
- GeT: read the specified Network
- PATCH: partially update the specified Network
- PUT: replace the specified Network

/apis/operator.openshift.io/v1/networks

Table 1. Global query parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DeLeTe
Description: delete collection of Network

Table 2. Query parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 Resourceexpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch`	`string`	resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`sendInitialevents`	`boolean`	`sendInitialevents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `"k8s.io/initial-events-end": "true"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialevents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as "data at least as new as the provided resourceVersion`" and the bookmark event is send when the state is synced to a `resourceVersion at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as "consistent read" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=""` or `resourceVersion="0"` (for backward compatibility reasons) and to false otherwise.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	empty

HTTP method: GeT
Description: list objects of kind Network

Table 4. Query parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 Resourceexpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch`	`string`	resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`sendInitialevents`	`boolean`	`sendInitialevents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `"k8s.io/initial-events-end": "true"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialevents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as "data at least as new as the provided resourceVersion`" and the bookmark event is send when the state is synced to a `resourceVersion at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as "consistent read" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=""` or `resourceVersion="0"` (for backward compatibility reasons) and to false otherwise.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`NetworkList` schema
401 - Unauthorized	empty

HTTP method: POST
Description: create a Network

Table 6. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 7. Body parameters
Parameter	Type	Description
`body`	`Network` schema

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Network` schema
201 - Created	`Network` schema
202 - Accepted	`Network` schema
401 - Unauthorized	empty

/apis/operator.openshift.io/v1/networks/{name}

Table 9. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Network

Table 10. Global query parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DeLeTe
Description: delete a Network

Table 11. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 12. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions` schema

Table 13. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	empty

HTTP method: GeT
Description: read the specified Network

Table 14. Query parameters
Parameter	Type	Description
`resourceVersion`	`string`	resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`Network` schema
401 - Unauthorized	empty

HTTP method: PATCH
Description: partially update the specified Network

Table 16. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
`force`	`boolean`	Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

Table 17. Body parameters
Parameter	Type	Description
`body`	`Patch` schema

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`Network` schema
401 - Unauthorized	empty

HTTP method: PUT
Description: replace the specified Network

Table 19. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 20. Body parameters
Parameter	Type	Description
`body`	`Network` schema

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`Network` schema
201 - Created	`Network` schema
401 - Unauthorized	empty