Skip to content

Commit 9e96ba8

Browse files
committed
OSDOCS-14023: Clarified secondary/additional networks
1 parent 837a3e8 commit 9e96ba8

File tree

41 files changed

+211
-214
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+211
-214
lines changed

modules/cnf-assigning-a-secondary-network-to-a-vrf.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="cnf-creating-an-additional-network-attachment-with-the-cni-vrf-plug-in_{context}"]
7-
= Creating an additional network attachment with the CNI VRF plugin
7+
= Creating a secondary network attachment with the CNI VRF plugin
88

9-
The Cluster Network Operator (CNO) manages additional network definitions. When you specify an additional network to create, the CNO creates the `NetworkAttachmentDefinition` custom resource (CR) automatically.
9+
The Cluster Network Operator (CNO) manages secondary network definitions. When you specify a secondary network to create, the CNO creates the `NetworkAttachmentDefinition` custom resource (CR) automatically.
1010

1111
[NOTE]
1212
====
13-
Do not edit the `NetworkAttachmentDefinition` CRs that the Cluster Network Operator manages. Doing so might disrupt network traffic on your additional network.
13+
Do not edit the `NetworkAttachmentDefinition` CRs that the Cluster Network Operator manages. Doing so might disrupt network traffic on your secondary network.
1414
====
1515

16-
To create an additional network attachment with the CNI VRF plugin, perform the following procedure.
16+
To create a secondary network attachment with the CNI VRF plugin, perform the following procedure.
1717

1818
.Prerequisites
1919

@@ -22,7 +22,7 @@ To create an additional network attachment with the CNI VRF plugin, perform the
2222
2323
.Procedure
2424

25-
. Create the `Network` custom resource (CR) for the additional network attachment and insert the `rawCNIConfig` configuration for the additional network, as in the following example CR. Save the YAML as the file `additional-network-attachment.yaml`.
25+
. Create the `Network` custom resource (CR) for the additional network attachment and insert the `rawCNIConfig` configuration for the secondary network, as in the following example CR. Save the YAML as the file `additional-network-attachment.yaml`.
2626
+
2727
[source,yaml]
2828
----
@@ -96,7 +96,7 @@ There might be a delay before the CNO creates the CR.
9696

9797
.Verification
9898

99-
. Create a pod and assign it to the additional network with the VRF instance:
99+
. Create a pod and assign it to the secondary network with the VRF instance:
100100

101101
.. Create a YAML file that defines the `Pod` resource:
102102
+
@@ -119,7 +119,7 @@ spec:
119119
command: ["/bin/bash", "-c", "sleep 9000000"]
120120
image: centos:8
121121
----
122-
<1> Specify the name of the additional network with the VRF instance.
122+
<1> Specify the name of the secondary network with the VRF instance.
123123

124124
.. Create the `Pod` resource by running the following command:
125125
+
@@ -134,7 +134,7 @@ $ oc create -f pod-additional-net.yaml
134134
pod/test-pod created
135135
----
136136

137-
. Verify that the pod network attachment is connected to the VRF additional network. Start a remote session with the pod and run the following command:
137+
. Verify that the pod network attachment is connected to the VRF secondary network. Start a remote session with the pod and run the following command:
138138
+
139139
[source,terminal]
140140
----
@@ -148,7 +148,7 @@ Name Table
148148
-----------------------
149149
vrf-1 1001
150150
----
151-
. Confirm that the VRF interface is the controller for the additional interface:
151+
. Confirm that the VRF interface is the controller for the secondary interface:
152152
+
153153
[source,terminal]
154154
----

modules/configuration-ovnk-multi-network-policy.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ a|
2626

2727
|====
2828

29-
For example, the following multi-network policy is valid only if the `subnets` field is defined in the additional network CNI configuration for the additional network named `blue2`:
29+
For example, the following multi-network policy is valid only if the `subnets` field is defined in the secondary network CNI configuration for the secondary network named `blue2`:
3030

3131
.Example multi-network policy that uses a pod selector
3232
[source,yaml]
@@ -44,7 +44,7 @@ spec:
4444
- podSelector: {}
4545
----
4646

47-
The following example uses the `ipBlock` network policy selector, which is always valid for an OVN-Kubernetes additional network:
47+
The following example uses the `ipBlock` network policy selector, which is always valid for an OVN-Kubernetes secondary network:
4848

4949
.Example multi-network policy that uses an IP block selector
5050
[source,yaml]

modules/configuration-ovnk-network-plugin-json-object.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,6 @@ A comma-separated list of CIDRs and IP addresses. IP addresses are removed from
6363
|`vlanID`
6464
|`integer`
6565
|
66-
If topology is set to `localnet`, the specified VLAN tag is assigned to traffic from this additional network. The default is to not assign a VLAN tag.
66+
If topology is set to `localnet`, the specified VLAN tag is assigned to traffic from this secondary network. The default is to not assign a VLAN tag.
6767

6868
|====

modules/configuring-localnet-switched-topology.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ The switched `localnet` topology interconnects the workloads created as Network
1414
// end::localnet-intro[]
1515

1616
// tag::localnet-content[]
17-
You must map an additional network to the OVN bridge to use it as an OVN-Kubernetes additional network. Bridge mappings allow network traffic to reach the physical network. A bridge mapping associates a physical network name, also known as an interface label, to a bridge created with Open vSwitch (OVS).
17+
You must map a secondary network to the OVN bridge to use it as an OVN-Kubernetes secondary network. Bridge mappings allow network traffic to reach the physical network. A bridge mapping associates a physical network name, also known as an interface label, to a bridge created with Open vSwitch (OVS).
1818

19-
You can create an `NodeNetworkConfigurationPolicy` (NNCP) object, part of the `nmstate.io/v1` API group, to declaratively create the mapping. This API is provided by the NMState Operator. By using this API you can apply the bridge mapping to nodes that match your specified `nodeSelector` expression, such as `node-role.kubernetes.io/worker: ''`. With this declarative approach, the NMState Operator applies additional network configuration to all nodes specified by the node selector automatically and transparently.
19+
You can create an `NodeNetworkConfigurationPolicy` (NNCP) object, part of the `nmstate.io/v1` API group, to declaratively create the mapping. This API is provided by the NMState Operator. By using this API you can apply the bridge mapping to nodes that match your specified `nodeSelector` expression, such as `node-role.kubernetes.io/worker: ''`. With this declarative approach, the NMState Operator applies secondary network configuration to all nodes specified by the node selector automatically and transparently.
2020

21-
When attaching an additional network, you can either use the existing `br-ex` bridge or create a new bridge. Which approach to use depends on your specific network infrastructure. Consider the following approaches:
21+
When attaching a secondary network, you can either use the existing `br-ex` bridge or create a new bridge. Which approach to use depends on your specific network infrastructure. Consider the following approaches:
2222

2323
- If your nodes include only a single network interface, you must use the existing bridge. This network interface is owned and managed by OVN-Kubernetes and you must not remove it from the `br-ex` bridge or alter the interface configuration. If you remove or alter the network interface, your cluster network will stop working correctly.
24-
- If your nodes include several network interfaces, you can attach a different network interface to a new bridge, and use that for your additional network. This approach provides for traffic isolation from your primary cluster network.
24+
- If your nodes include several network interfaces, you can attach a different network interface to a new bridge, and use that for your secondary network. This approach provides for traffic isolation from your primary cluster network.
2525
2626
The `localnet1` network is mapped to the `br-ex` bridge in the following example:
2727

@@ -44,7 +44,7 @@ spec:
4444
----
4545
<1> The name for the configuration object.
4646
<2> A node selector that specifies the nodes to apply the node network configuration policy to.
47-
<3> The name for the additional network from which traffic is forwarded to the OVS bridge. This additional network must match the name of the `spec.config.name` field of the `NetworkAttachmentDefinition` CRD that defines the OVN-Kubernetes additional network.
47+
<3> The name for the secondary network from which traffic is forwarded to the OVS bridge. This secondary network must match the name of the `spec.config.name` field of the `NetworkAttachmentDefinition` CRD that defines the OVN-Kubernetes secondary network.
4848
<4> The name of the OVS bridge on the node. This value is required only if you specify `state: present`.
4949
<5> The state for the mapping. Must be either `present` to add the bridge or `absent` to remove the bridge. The default value is `present`.
5050
+
@@ -66,7 +66,7 @@ The following JSON example configures a localnet secondary network that is named
6666
}
6767
----
6868

69-
In the following example, the `localnet2` network interface is attached to the `ovs-br1` bridge. Through this attachment, the network interface is available to the OVN-Kubernetes network plugin as an additional network.
69+
In the following example, the `localnet2` network interface is attached to the `ovs-br1` bridge. Through this attachment, the network interface is available to the OVN-Kubernetes network plugin as a secondary network.
7070

7171
.Example mapping for nodes with multiple interfaces
7272
[source,yaml]
@@ -104,7 +104,7 @@ spec:
104104
<3> Specifies a new OVS bridge that operates separately from the default bridge used by OVN-Kubernetes for cluster traffic.
105105
<4> Specifies whether to enable multicast snooping. When enabled, multicast snooping prevents network devices from flooding multicast traffic to all network members. By default, an OVS bridge does not enable multicast snooping. The default value is `false`.
106106
<5> Specifies the network device on the host system to associate with the new OVS bridge.
107-
<6> Specifies the name of the additional network that forwards traffic to the OVS bridge. This name must match the value of the `spec.config.name` field in the `NetworkAttachmentDefinition` CRD that defines the OVN-Kubernetes additional network.
107+
<6> Specifies the name of the secondary network that forwards traffic to the OVS bridge. This name must match the value of the `spec.config.name` field in the `NetworkAttachmentDefinition` CRD that defines the OVN-Kubernetes secondary network.
108108
<7> Specifies the name of the OVS bridge on the node. The value is required only when `state: present` is set.
109109
<8> Specifies the state of the mapping. Valid values are `present` to add the bridge or `absent` to remove the bridge. The default value is `present`.
110110
+

modules/configuring-ovnk-additional-networks.adoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="configuration-ovnk-additional-networks_{context}"]
7-
= Configuration for an OVN-Kubernetes additional network
7+
= Configuration for an OVN-Kubernetes secondary network
88

99
The {openshift-networking} OVN-Kubernetes network plugin allows the configuration of secondary network interfaces for pods. To configure secondary network interfaces, you must define the configurations in the `NetworkAttachmentDefinition` custom resource definition (CRD).
1010

@@ -13,10 +13,7 @@ The {openshift-networking} OVN-Kubernetes network plugin allows the configuratio
1313
Pod and multi-network policy creation might remain in a pending state until the OVN-Kubernetes control plane agent in the nodes processes the associated `network-attachment-definition` CRD.
1414
====
1515

16-
You can configure an OVN-Kubernetes additional network in either _layer 2_ or _localnet_ topologies.
17-
18-
- A layer 2 topology supports east-west cluster traffic, but does not allow access to the underlying physical network.
19-
- A localnet topology allows connections to the physical network, but requires additional configuration of the underlying Open vSwitch (OVS) bridge on cluster nodes.
16+
You can configure an OVN-Kubernetes secondary network in layer 2, layer 3, or localnet topologies. For more information about features supported on these topologies, see "UserDefinedNetwork and NetworkAttachmentDefinition support matrix".
2017

2118
The following sections provide example configurations for each of the topologies that OVN-Kubernetes currently allows for secondary networks.
2219

@@ -26,9 +23,9 @@ Networks names must be unique. For example, creating multiple `NetworkAttachment
2623
====
2724

2825
[id="configuration-additional-network-types-supported-platforms_{context}"]
29-
== Supported platforms for OVN-Kubernetes additional network
26+
== Supported platforms for OVN-Kubernetes secondary network
3027

31-
You can use an OVN-Kubernetes additional network with the following supported platforms:
28+
You can use an OVN-Kubernetes secondary network with the following supported platforms:
3229

3330
- Bare metal
3431
- {ibm-power-name}

modules/configuring-pods-secondary-network.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_mod-docs-content-type: REFERENCE
66
[id="configuring-pods-secondary-network_{context}"]
7-
= Configuring pods for additional networks
7+
= Configuring pods for secondary networks
88

99
You must specify the secondary network attachments through the `k8s.v1.cni.cncf.io/networks` annotation.
1010

modules/configuring-pods-static-ip.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following example provisions a pod with a static IP address.
1010

1111
[NOTE]
1212
====
13-
* You can specify the IP address for the secondary network attachment of a pod only when the additional network attachment, a namespaced-scoped object, uses a layer 2 or localnet topology.
13+
* You can specify the IP address for the secondary network attachment of a pod only when the secondary network attachment, a namespaced-scoped object, uses a layer 2 or localnet topology.
1414
* Specifying a static IP address for the pod is only possible when the attachment configuration does not feature subnets.
1515
====
1616

modules/microshift-multus-intro.adoc

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,31 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="microshift-multus-intro_{context}"]
7-
= Additional networks in {microshift-short}
7+
= Secondary networks in {microshift-short}
88

99
During cluster installation, the _default_ pod network is configured with default values unless you customize the configuration. The default network handles all ordinary network traffic for the cluster. Using the {microshift-short} Multus CNI plugin, you can add additional interfaces to pods from other networks. This gives you flexibility when you configure pods that deliver network functionality, such as switching or routing.
1010

1111
[id="microshift-supported-additional-networks_{context}"]
12-
== Supported additional networks for network isolation
13-
The following additional networks are supported in {microshift-short} {product-version}:
12+
== Supported secondary networks for network isolation
13+
The following secondary networks are supported in {microshift-short} {product-version}:
1414

1515
* Bridge: Allows pods on the same host to communicate with each other and the host.
1616

1717
* IPVLAN: Allows pods on a host to communicate with other hosts.
18-
** This is similar to a MACVLAN-based additional network.
19-
** Each pod shares the same MAC address as the parent physical network interface, unlike a MACVLAN-based additional network.
18+
** This is similar to a MACVLAN-based secondary network.
19+
** Each pod shares the same MAC address as the parent physical network interface, unlike a MACVLAN-based secondary network.
2020

21-
* MACVLAN: Allows pods on a host to communicate with other hosts and the pods on those other hosts by using a physical network interface. Each pod that is attached to a MACVLAN-based additional network is provided with a unique MAC address.
21+
* MACVLAN: Allows pods on a host to communicate with other hosts and the pods on those other hosts by using a physical network interface. Each pod that is attached to a MACVLAN-based secondary network is provided with a unique MAC address.
2222

2323
[NOTE]
2424
====
25-
Setting network policies for additional networks is not supported.
25+
Setting network policies for secondary networks is not supported.
2626
====
2727

2828
[id="microshift-additional-network-use-cases_{context}"]
29-
== Use case: Additional networks for network isolation
29+
== Use case: Secondary networks for network isolation
3030

31-
You can use an additional network in situations where network isolation is needed, including control plane and data plane separation. For example, you can configure an additional interface if you want pods to access a network on the host and also communicate with devices deployed to the edge. These edge devices might be on an isolated operator network or are periodically disconnected.
31+
You can use an secondary network in situations where network isolation is needed, including control plane and data plane separation. For example, you can configure an secondary interface if you want pods to access a network on the host and also communicate with devices deployed to the edge. These edge devices might be on an isolated operator network or are periodically disconnected.
3232

3333
Isolating network traffic is useful for the following performance and security reasons:
3434

@@ -41,25 +41,25 @@ The Multus CNI plugin is deployed when the {microshift-short} service starts up.
4141
====
4242

4343
[id="microshift-additional-network-how-implemented_{context}"]
44-
== How additional networks are implemented
44+
== How secondary networks are implemented
4545

4646
All of the pods in the cluster still use the cluster-wide default network to maintain connectivity across the cluster. Every pod has an `eth0` interface that is attached to the cluster-wide pod network.
4747

4848
* You can view the interfaces for a pod by using the `oc get pod <pod_name> -o=jsonpath='{ .metadata.annotations.k8s\.v1\.cni\.cncf\.io/network-status }'` command.
49-
* If you add additional network interfaces that use the {microshift-short} Multus CNI, they are named `net1`, `net2`, ..., `netN`.
49+
* If you add secondary network interfaces that use the {microshift-short} Multus CNI, they are named `net1`, `net2`, ..., `netN`.
5050
* The CNI configuration is created when the {microshift-short} Multus DaemonSet starts. This configuration is autogenerated and includes the primary CNI that is the default delegate. For {microshift-short}, the default CNI is OVN-Kubernetes.
5151

5252
[id="microshift-additional-network-how-attached-pods_{context}"]
53-
== How to attached additional networks to pods
53+
== How to attached secondary networks to pods
5454

55-
To attach additional network interfaces to a pod, you must create and apply configurations that define how the interfaces are attached.
55+
To attach secondary network interfaces to a pod, you must create and apply configurations that define how the interfaces are attached.
5656

57-
* You must configure any additional networks you want to use. Because of individual differences in networks, no default configuration is provided.
57+
* You must configure any secondary networks you want to use. Because of individual differences in networks, no default configuration is provided.
5858
* You must apply YAML manifest to specify each interface by using a `NetworkAttachmentDefinition` custom resource (CR). A configuration inside each of these CRs defines how that interface is created.
5959
* CRI-O must be configured to use Multus. A default configuration is included in the `microshift-multus` RPM.
6060
** If the Multus CNI is installed on an existing {microshift-short} instance, the host must be restarted.
6161
** If the Multus CNI is installed alongside {microshift-short}, you can add CRs and pods and then start the {microshift-short} service. Restarting the host in this scenario is not needed.
6262

6363
[id="microshift-config-examples-additional-networks_{context}"]
64-
== Configurations for additional network types
65-
The specific configuration fields for additional networks is described in the following sections.
64+
== Configurations for secondary network types
65+
The specific configuration fields for secondary networks is described in the following sections.

modules/nw-multi-network-policy-differences.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ kind: MultiNetworkPolicy
1818
1919
* You must use the `multi-networkpolicy` resource name when using the CLI to interact with multi-network policies. For example, you can view a multi-network policy object with the `oc get multi-networkpolicy <name>` command where `<name>` is the name of a multi-network policy.
2020
21-
* You must specify an annotation with the name of the network attachment definition that defines the additional network:
21+
* You must specify an annotation with the name of the network attachment definition that defines the secondary network:
2222
+
2323
[source,yaml]
2424
----

0 commit comments

Comments
 (0)