Chapter 22. 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
22.1. Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| NetworkSpec is the top-level network configuration object. |
|
| NetworkStatus is detailed operator status, which is distilled up to the Network clusteroperator object. |
22.1.1. .spec
- Description
- NetworkSpec is the top-level network configuration object.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| additionalNetworks is a list of extra networks to make available to pods when multiple networks are enabled. |
|
| 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 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. |
|
| 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 is the "default" network that all pods will receive |
|
| 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 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 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 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 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 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 indicates whether and how the operator should manage the component |
|
| migration enables and configures the cluster network migration. The migration procedure allows to change the network type and the MTU. |
| `` | 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 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 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 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 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. |
22.1.2. .spec.additionalNetworks
- Description
- additionalNetworks is a list of extra networks to make available to pods when multiple networks are enabled.
- Type
-
array
22.1.3. .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 is the name of the network. This will be populated in the resulting CRD This must be unique. |
|
| 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 is the raw CNI configuration json to create in the NetworkAttachmentDefinition CRD |
|
| SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan |
|
| type is the type of network The supported values are NetworkTypeRaw, NetworkTypeSimpleMacvlan |
22.1.4. .spec.additionalNetworks[].simpleMacvlanConfig
- Description
- SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan
- Type
-
object
Property | Type | Description |
---|---|---|
|
| IPAMConfig configures IPAM module will be used for IP Address Management (IPAM). |
|
| master is the host interface to create the macvlan interface from. If not specified, it will be default route interface |
|
| mode is the macvlan mode: bridge, private, vepa, passthru. The default is bridge |
|
| mtu is the mtu to use for the macvlan interface. if unset, host’s kernel will select the value. |
22.1.5. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig
- Description
- IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).
- Type
-
object
Property | Type | Description |
---|---|---|
|
| StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic |
|
| Type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic |
22.1.6. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig
- Description
- StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic
- Type
-
object
Property | Type | Description |
---|---|---|
|
| Addresses configures IP address for the interface |
|
| StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses |
|
| DNS configures DNS for the interface |
|
| Routes configures IP routes for the interface |
|
| StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes |
22.1.7. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses
- Description
- Addresses configures IP address for the interface
- Type
-
array
22.1.8. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses[]
- Description
- StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses
- Type
-
object
Property | Type | Description |
---|---|---|
|
| Address is the IP address in CIDR format |
|
| Gateway is IP inside of subnet to designate as the gateway |
22.1.9. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.dns
- Description
- DNS configures DNS for the interface
- Type
-
object
Property | Type | Description |
---|---|---|
|
| Domain configures the domainname the local domain used for short hostname lookups |
|
| Nameservers points DNS servers for IP lookup |
|
| Search configures priority ordered search domains for short hostname lookups |
22.1.10. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes
- Description
- Routes configures IP routes for the interface
- Type
-
array
22.1.11. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes[]
- Description
- StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes
- Type
-
object
Property | Type | Description |
---|---|---|
|
| Destination points the IP route destination |
|
| Gateway is the route’s next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin). |
22.1.12. .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
22.1.13. .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 |
---|---|---|
|
| |
|
|
22.1.14. .spec.defaultNetwork
- Description
- defaultNetwork is the "default" network that all pods will receive
- Type
-
object
Property | Type | Description |
---|---|---|
|
| openShiftSDNConfig configures the openshift-sdn plugin |
|
| ovnKubernetesConfig configures the ovn-kubernetes plugin. |
|
| type is the type of network All NetworkTypes are supported except for NetworkTypeRaw |
22.1.15. .spec.defaultNetwork.openshiftSDNConfig
- Description
- openShiftSDNConfig configures the openshift-sdn plugin
- Type
-
object
Property | Type | Description |
---|---|---|
|
| enableUnidling controls whether or not the service proxy will support idling and unidling of services. By default, unidling is enabled. |
|
| mode is one of "Multitenant", "Subnet", or "NetworkPolicy" |
|
| 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 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 is the port to use for all vxlan packets. The default is 4789. |
22.1.16. .spec.defaultNetwork.ovnKubernetesConfig
- Description
- ovnKubernetesConfig configures the ovn-kubernetes plugin.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| egressIPConfig holds the configuration for EgressIP options. |
|
| gatewayConfig holds the configuration for node gateway options. |
|
| geneve port is the UDP port to be used by geneve encapulation. Default is 6081 |
|
| HybridOverlayConfig configures an additional overlay network for peers that are not using OVN. |
|
| ipsecConfig enables and configures IPsec for pods on the pod network within the cluster. |
|
| 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 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 is the MTU to use for the tunnel interface. This must be 100 bytes smaller than the uplink mtu. Default is 1400 |
|
| policyAuditConfig is the configuration for network policy audit events. If unset, reported defaults are used. |
|
| 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 cannot be changed after installation. Default is 100.64.0.0/16 |
|
| 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 cannot be changed after installation. Default is fd98::/48 |
22.1.17. .spec.defaultNetwork.ovnKubernetesConfig.egressIPConfig
- Description
- egressIPConfig holds the configuration for EgressIP options.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| 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. |
22.1.18. .spec.defaultNetwork.ovnKubernetesConfig.gatewayConfig
- Description
- gatewayConfig holds the configuration for node gateway options.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| 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 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 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 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. |
22.1.19. .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 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 |
22.1.20. .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 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 |
22.1.21. .spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig
- Description
- HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| HybridClusterNetwork defines a network space given to nodes on an additional overlay network. |
|
| 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 defines the VXLAN port number to be used by the additional overlay network. Default is 4789 |
22.1.22. .spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig.hybridClusterNetwork
- Description
- HybridClusterNetwork defines a network space given to nodes on an additional overlay network.
- Type
-
array
22.1.23. .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 |
---|---|---|
|
| |
|
|
22.1.24. .spec.defaultNetwork.ovnKubernetesConfig.ipsecConfig
- Description
- ipsecConfig enables and configures IPsec for pods on the pod network within the cluster.
- Type
-
object
Property | Type | Description |
---|---|---|
|
|
mode defines the behaviour of the ipsec configuration within the platform. Valid values are |
22.1.25. .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 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 cannot 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 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 cannot 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 |
22.1.26. .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 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 cannot 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 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 cannot 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 |
22.1.27. .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 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" |
|
| 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 specifies the maximum number of ACL_audit log files that can be present. |
|
| 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 the RFC5424 facility for generated messages, e.g. "kern". Default is "local0" |
22.1.28. .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 defines IPFIX configuration. |
|
| netFlow defines the NetFlow configuration. |
|
| sFlow defines the SFlow configuration. |
22.1.29. .spec.exportNetworkFlows.ipfix
- Description
- ipfix defines IPFIX configuration.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| ipfixCollectors is list of strings formatted as ip:port with a maximum of ten items |
22.1.30. .spec.exportNetworkFlows.netFlow
- Description
- netFlow defines the NetFlow configuration.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| 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 |
22.1.31. .spec.exportNetworkFlows.sFlow
- Description
- sFlow defines the SFlow configuration.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| sFlowCollectors is list of strings formatted as ip:port with a maximum of ten items |
22.1.32. .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 |
---|---|---|
|
| The address to "bind" on Defaults to 0.0.0.0 |
|
| 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 |
|
| Any additional arguments to pass to the kubeproxy process |
|
| ProxyArgumentList is a list of arguments to pass to the kubeproxy process |
22.1.33. .spec.kubeProxyConfig.proxyArguments
- Description
- Any additional arguments to pass to the kubeproxy process
- Type
-
object
22.1.34. .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 |
---|---|---|
|
| 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. |
|
| mode indicates the mode of network migration. The supported values are "Live", "Offline" and omitted. A "Live" migration operation will not cause service interruption by migrating the CNI of each node one by one. The cluster network will work as normal during the network migration. An "Offline" migration operation will cause service interruption. During an "Offline" migration, two rounds of node reboots are required. The cluster network will be malfunctioning during the network migration. 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 value is "Offline". |
|
| 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 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 |
22.1.35. .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 |
---|---|---|
|
| 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 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 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. |
22.1.36. .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 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 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. |
22.1.37. .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 is the MTU to migrate from. |
|
| to is the MTU to migrate to. |
22.1.38. .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 is the MTU to migrate from. |
|
| to is the MTU to migrate to. |
22.1.39. .status
- Description
- NetworkStatus is detailed operator status, which is distilled up to the Network clusteroperator object.
- Type
-
object
Property | Type | Description |
---|---|---|
|
| conditions is a list of conditions and their status |
|
| OperatorCondition is just the standard condition fields. |
|
| generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction. |
|
| GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made. |
|
| observedGeneration is the last generation change you’ve dealt with |
|
| readyReplicas indicates how many replicas are ready and at the desired state |
|
| version is the level this availability applies to |
22.1.40. .status.conditions
- Description
- conditions is a list of conditions and their status
- Type
-
array
22.1.41. .status.conditions[]
- Description
- OperatorCondition is just the standard condition fields.
- Type
-
object
- Required
-
type
-
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
22.1.42. .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
22.1.43. .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 |
---|---|---|
|
| group is the group of the thing you’re tracking |
|
| hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps |
|
| lastGeneration is the last generation of the workload controller involved |
|
| name is the name of the thing you’re tracking |
|
| namespace is where the thing you’re tracking is |
|
| resource is the resource type of the thing you’re tracking |
22.2. 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
-
22.2.1. /apis/operator.openshift.io/v1/networks
- HTTP method
-
DELETE
- Description
- delete collection of Network
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- list objects of kind Network
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
POST
- Description
- create a Network
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
22.2.2. /apis/operator.openshift.io/v1/networks/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the Network |
- HTTP method
-
DELETE
- Description
- delete a Network
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | Empty |
- HTTP method
-
GET
- Description
- read the specified Network
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PATCH
- Description
- partially update the specified Network
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized | Empty |
- HTTP method
-
PUT
- Description
- replace the specified Network
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | Empty |