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).
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).
object
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. |
NetworkSpec is the top-level network configuration object.
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. Setting 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. |
|
`` |
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 holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |
|
|
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 is a list of extra networks to make available to pods when multiple networks are enabled.
array
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.
object
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 |
SimpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan
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. |
IPAMConfig configures IPAM module will be used for IP Address Management (IPAM).
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 |
StaticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic
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 |
Addresses configures IP address for the interface
array
StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses
object
Property | Type | Description |
---|---|---|
|
|
Address is the IP address in CIDR format |
|
|
Gateway is IP inside of subnet to designate as the gateway |
DNS configures DNS for the interface
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 |
Routes configures IP routes for the interface
array
StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes
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). |
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.
array
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
object
Property | Type | Description |
---|---|---|
|
|
|
|
|
defaultNetwork is the "default" network that all pods will receive
object
Property | Type | Description |
---|---|---|
|
|
KuryrConfig configures the kuryr plugin |
|
|
openShiftSDNConfig configures the openshift-sdn plugin |
|
|
oVNKubernetesConfig configures the ovn-kubernetes plugin. This is currently not implemented. |
|
|
type is the type of network All NetworkTypes are supported except for NetworkTypeRaw |
KuryrConfig configures the kuryr plugin
object
Property | Type | Description |
---|---|---|
|
|
The port kuryr-controller will listen for readiness and liveness requests. |
|
|
The port kuryr-daemon will listen for readiness and liveness requests. |
|
|
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. Instead of creating it when pod is being deployed, Kuryr keeps a number of ports ready to be attached to pods. By default port prepopulation is disabled. |
|
|
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. |
|
|
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 |
|
|
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 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 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. |
openShiftSDNConfig configures the openshift-sdn plugin
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. |
oVNKubernetesConfig configures the ovn-kubernetes plugin. This is currently not implemented.
object
Property | Type | Description |
---|---|---|
|
|
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. |
|
|
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. |
HybridOverlayConfig configures an additional overlay network for peers that are not using OVN.
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 |
HybridClusterNetwork defines a network space given to nodes on an additional overlay network.
array
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,