Network [operator.openshift.io/v1]

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
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
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.
additionalRoutingCapabilities	object	additionalRoutingCapabilities describes components and relevant configuration providing additional routing capabilities. When set, it enables such components and the usage of the routing capabilities they provide for the machine network. Upstream operators, like MetalLB operator, requiring these capabilities may rely on, or automatically set this attribute. Network plugins may leverage advanced routing capabilities acquired through the enablement of these components but may require specific configuration on their side to do so; refer to their respective documentation and configuration options.
clusterNetwork	array	clusterNetwork is the IP address pool to use for pod IPs. Some network providers 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 ovn-kubernetes is used and true otherwise.
disableMultiNetwork	boolean	disableMultiNetwork defaults to 'false' and this setting enables the pod multi-networking capability. disableMultiNetwork when set to 'true' at cluster install time does not install the components, typically the Multus CNI and the network-attachment-definition CRD, that enable the pod multi-networking capability. Setting the parameter to 'true' might be useful when you need install third-party CNI plugins, but these plugins are not supported by Red Hat. Changing the parameter value as a postinstallation cluster task has no effect.
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 deployKubeProxy is true. If not specified, sensible defaults will be chosen by OpenShift directly.
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 cluster network migration, for network changes that cannot be made instantly.
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`

Required

• name

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

.spec.additionalNetworks[].simpleMacvlanConfig

Description

simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan

Type

`object`

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.

.spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig

Description

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

Type

`object`

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

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

Description

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

Type

`object`

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

.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
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
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
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.additionalRoutingCapabilities

Description

additionalRoutingCapabilities describes components and relevant configuration providing additional routing capabilities. When set, it enables such components and the usage of the routing capabilities they provide for the machine network. Upstream operators, like MetalLB operator, requiring these capabilities may rely on, or automatically set this attribute. Network plugins may leverage advanced routing capabilities acquired through the enablement of these components but may require specific configuration on their side to do so; refer to their respective documentation and configuration options.

Type

`object`

Required

• providers

Property	Type	Description
providers	array (string)	providers is a set of enabled components that provide additional routing capabilities. Entries on this list must be unique. The only valid value is currrently "FRR" which provides FRR routing capabilities through the deployment of FRR.

.spec.clusterNetwork

Description

clusterNetwork is the IP address pool to use for pod IPs. Some network providers 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
cidr	string
hostPrefix	integer

.spec.defaultNetwork

Description

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

Type

`object`

Property	Type	Description
openshiftSDNConfig	object	openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported.
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.openshiftSDNConfig

Description

openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported.

Type

`object`

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.
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
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.
routeAdvertisements	string	routeAdvertisements determines if the functionality to advertise cluster network routes through a dynamic routing protocol, such as BGP, is enabled or not. This functionality is configured through the ovn-kubernetes RouteAdvertisements CRD. Requires the 'FRR' routing capability provider to be enabled as an additional routing capability. Allowed values are "Enabled", "Disabled" and ommited. When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is "Disabled".
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. 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. Default is fd98::/64

.spec.defaultNetwork.ovnKubernetesConfig.egressIPConfig

Description

egressIPConfig holds the configuration for EgressIP options.

Type

`object`

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.

.spec.defaultNetwork.ovnKubernetesConfig.gatewayConfig

Description

gatewayConfig holds the configuration for node gateway options.

Type

`object`

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.

.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
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.0.0/17 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
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::/112 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
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

.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
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`

Property	Type	Description
full	object	full defines configuration parameters for the IPsec Full mode. This is permitted only when mode is configured with Full, and forbidden otherwise.
mode	string	mode defines the behaviour of the ipsec configuration within the platform. Valid values are Disabled, External and Full. When 'Disabled', ipsec will not be enabled at the node level. When 'External', ipsec is enabled on the node level but requires the user to configure the secure communication parameters. This mode is for external secure communications and the configuration can be done using the k8s-nmstate operator. When 'Full', ipsec is configured on the node level and inter-pod secure communication within the cluster is configured. Note with Full, if ipsec is desired for communication with external (to the cluster) entities (such as storage arrays), this is left to the user to configure.

.spec.defaultNetwork.ovnKubernetesConfig.ipsecConfig.full

Description

full defines configuration parameters for the IPsec Full mode. This is permitted only when mode is configured with Full, and forbidden otherwise.

Type

`object`

Property	Type	Description
encapsulation	string	encapsulation option to configure libreswan on how inter-pod traffic across nodes are encapsulated to handle NAT traversal. When configured it uses UDP port 4500 for the encapsulation. Valid values are Always, Auto and omitted. Always means enable UDP encapsulation regardless of whether NAT is detected. Auto means enable UDP encapsulation based on the detection of NAT. 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 is Auto.

.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
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 current default value is 100.64.0.0/16 The subnet must be large enough to accommodate 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. 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 accommodate 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
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 subnet must be large enough to accommodate one IP per node in your cluster The current default value is fd98::/64 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. 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 accommodate 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
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
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
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
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
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 deployKubeProxy is true. If not specified, sensible defaults will be chosen by OpenShift directly.

Type

`object`

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

.spec.kubeProxyConfig.proxyArguments

Description

Any additional arguments to pass to the kubeproxy process

Type

`object`

.spec.migration

Description

migration enables and configures cluster network migration, for network changes that cannot be made instantly.

Type

`object`

Property	Type	Description
features	object	features was previously used to configure which network plugin features would be migrated in a network type migration. DEPRECATED: network type migration is no longer supported, and setting this to a non-empty value will result in the network operator rejecting the configuration.
mode	string	mode indicates the mode of network type migration. DEPRECATED: network type migration is no longer supported, and setting this to a non-empty value will result in the network operator rejecting the configuration.
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 was previously used when changing the default network type. DEPRECATED: network type migration is no longer supported, and setting this to a non-empty value will result in the network operator rejecting the configuration.

.spec.migration.features

Description

features was previously used to configure which network plugin features would be migrated in a network type migration. DEPRECATED: network type migration is no longer supported, and setting this to a non-empty value will result in the network operator rejecting the configuration.

Type

`object`

Property	Type	Description
egressFirewall	boolean	egressFirewall specified whether or not the Egress Firewall configuration was migrated. DEPRECATED: network type migration is no longer supported.
egressIP	boolean	egressIP specified whether or not the Egress IP configuration was migrated. DEPRECATED: network type migration is no longer supported.
multicast	boolean	multicast specified whether or not the multicast configuration was migrated. DEPRECATED: network type migration is no longer supported.

.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
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
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
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
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.
latestAvailableRevision	integer	latestAvailableRevision is the deploymentID of the most recent deployment
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`

Required

• lastTransitionTime
• status
• type

Property	Type	Description
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message	string
reason	string
status	string	status of the condition, one of True, False, Unknown.
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.

.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`

Required

• group
• name
• namespace
• resource

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

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/{name}/status
  • GET: read status of the specified Network
  • PATCH: partially update status of the specified Network
  • PUT: replace status of the specified Network

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

HTTP method

`DELETE`

Description

delete collection of Network

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list objects of kind Network

HTTP responses

HTTP code	Reponse body
200 - OK	NetworkList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create a Network

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
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.

Body parameters

Parameter	Type	Description
body	Network schema

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}

Global path parameters

Parameter	Type	Description
name	string	name of the Network

HTTP method

`DELETE`

Description

delete a Network

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

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

HTTP responses

HTTP code	Reponse body
200 - OK	Network schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified Network

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
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.

HTTP responses

HTTP code	Reponse body
200 - OK	Network schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified Network

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
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.

Body parameters

Parameter	Type	Description
body	Network schema

HTTP responses

HTTP code	Reponse body
200 - OK	Network schema
201 - Created	Network schema
401 - Unauthorized	Empty

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

Global path parameters

Parameter	Type	Description
name	string	name of the Network

HTTP method

`GET`

Description

read status of the specified Network

HTTP responses

HTTP code	Reponse body
200 - OK	Network schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified Network

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
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.

HTTP responses

HTTP code	Reponse body
200 - OK	Network schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified Network

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
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.

Body parameters

Parameter	Type	Description
body	Network schema

HTTP responses

HTTP code	Reponse body
200 - OK	Network schema
201 - Created	Network schema
401 - Unauthorized	Empty