Skip to content

Commit b29a8f0

Browse files
committed
Refresh cluster network configuration
The configuration for this is unwieldy. As additional fields are added, this becomes increasingly difficult to maintain. And the installation procedure is needlessly confusing. So this introduces: - An updated procedure for creating a manifest - A table-based presentation of the CNO object - Ancillary materials as might be necessary
1 parent 471da24 commit b29a8f0

11 files changed

+308
-196
lines changed

installing/installing_aws/installing-aws-network-customizations.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1]
5454

5555
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
5656

57+
include::modules/nw-network-config.adoc[leveloffset=+1]
58+
5759
include::modules/installation-initializing.adoc[leveloffset=+1]
5860

5961
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
@@ -66,6 +68,7 @@ include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
6668
// include::modules/installation-configure-proxy.adoc[leveloffset=+2]
6769

6870
// Network Operator specific configuration
71+
include::modules/nw-operator-cr.adoc[leveloffset=+1]
6972
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
7073

7174
[NOTE]
@@ -75,8 +78,6 @@ For more information on using a Network Load Balancer (NLB) on AWS, see xref:../
7578

7679
include::modules/nw-aws-nlb-new-cluster.adoc[leveloffset=+1]
7780

78-
include::modules/nw-operator-cr.adoc[leveloffset=+1]
79-
8081
include::modules/configuring-hybrid-ovnkubernetes.adoc[leveloffset=+1]
8182

8283
[NOTE]

installing/installing_azure/installing-azure-network-customizations.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ include::modules/installation-azure-config-yaml.adoc[leveloffset=+2]
4747
// include::modules/installation-configure-proxy.adoc[leveloffset=+2]
4848

4949
// Network Operator specific configuration
50+
include::modules/nw-network-config.adoc[leveloffset=+1]
5051
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
5152
include::modules/nw-operator-cr.adoc[leveloffset=+1]
5253
include::modules/configuring-hybrid-ovnkubernetes.adoc[leveloffset=+1]

installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
5050
include::modules/nw-install-config-parameters.adoc[leveloffset=+2]
5151

5252
// Network Operator specific configuration
53-
53+
include::modules/nw-network-config.adoc[leveloffset=+1]
5454
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
5555
include::modules/nw-operator-cr.adoc[leveloffset=+1]
5656

installing/installing_gcp/installing-gcp-network-customizations.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
5454
// include::modules/installation-configure-proxy.adoc[leveloffset=+2]
5555

5656
// Network Operator specific configuration
57+
include::modules/nw-network-config.adoc[leveloffset=+1]
5758
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
5859
include::modules/nw-operator-cr.adoc[leveloffset=+1]
5960

installing/installing_vmc/installing-vmc-network-customizations.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ include::modules/nw-install-config-parameters.adoc[leveloffset=+2]
4747
include::modules/installation-installer-provisioned-vsphere-config-yaml.adoc[leveloffset=+2]
4848

4949
// begin network customization
50+
include::modules/nw-network-config.adoc[leveloffset=+1]
5051
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
5152
include::modules/nw-operator-cr.adoc[leveloffset=+1]
5253
// end network customization

installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ include::modules/nw-install-config-parameters.adoc[leveloffset=+2]
4949
include::modules/installation-installer-provisioned-vsphere-config-yaml.adoc[leveloffset=+2]
5050

5151
// begin network customization
52+
include::modules/nw-network-config.adoc[leveloffset=+1]
5253
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
5354
include::modules/nw-operator-cr.adoc[leveloffset=+1]
5455
// end network customization

installing/installing_vsphere/installing-vsphere-network-customizations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ include::modules/installation-vsphere-config-yaml.adoc[leveloffset=+2]
5555
include::modules/nw-install-config-parameters.adoc[leveloffset=+2]
5656

5757
// Network Operator specific configuration
58-
58+
include::modules/nw-network-config.adoc[leveloffset=+1]
5959
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
6060
include::modules/nw-operator-cr.adoc[leveloffset=+1]
6161

modules/nw-modifying-operator-install-config.adoc

Lines changed: 42 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,10 @@ ifeval::["{context}" == "installing-vmc-network-customizations-user-infra"]
2222
endif::[]
2323

2424
[id="modifying-nwoperator-config-startup_{context}"]
25-
= Modifying advanced network configuration parameters
25+
= Specifying advanced network configuration
2626

27-
You can modify the advanced network configuration parameters only before you
28-
install the cluster. Advanced configuration customization lets you integrate
29-
your cluster into your existing network environment by specifying an MTU or
30-
VXLAN port, by allowing customization of
31-
link:https://kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/[kube-proxy]
32-
settings, and by specifying a different `mode` for the `openshiftSDNConfig`
33-
parameter.
27+
You can use advanced configuration customization to integrate your cluster into your existing network environment by specifying additional configuration for your cluster network provider.
28+
You can specify advanced network configuration only before you install the cluster.
3429

3530
[IMPORTANT]
3631
====
@@ -50,64 +45,64 @@ endif::ignition-config[]
5045
+
5146
[source,terminal]
5247
----
53-
$ ./openshift-install create manifests --dir=<installation_directory> <1>
48+
$ ./openshift-install create manifests --dir=<installation_directory>
5449
----
55-
<1> For `<installation_directory>`, specify the name of the directory that
56-
contains the `install-config.yaml` file for your cluster.
50+
+
51+
--
52+
where:
53+
54+
`<installation_directory>`:: Specifies the name of the directory that contains the `install-config.yaml` file for your cluster.
55+
--
5756

58-
. Create a file that is named `cluster-network-03-config.yml` in the
59-
`<installation_directory>/manifests/` directory:
57+
. Create a stub manifest file for the advanced network configuration that is named `cluster-network-03-config.yml` in the `<installation_directory>/manifests/` directory:
6058
+
6159
[source,terminal]
6260
----
63-
$ touch <installation_directory>/manifests/cluster-network-03-config.yml <1>
61+
$ cat <<EOF > <installation_directory>/manifests/cluster-network-03-config.yml
62+
apiVersion: operator.openshift.io/v1
63+
kind: Network
64+
metadata:
65+
name: cluster
66+
spec:
67+
EOF
6468
----
65-
<1> For `<installation_directory>`, specify the directory name that contains the
66-
`manifests/` directory for your cluster.
6769
+
68-
After creating the file, several network configuration files are in the
69-
`manifests/` directory, as shown:
70-
+
71-
[source,terminal]
72-
----
73-
$ ls <installation_directory>/manifests/cluster-network-*
74-
----
70+
--
71+
where:
72+
73+
`<installation_directory>`:: Specifies the directory name that contains the
74+
`manifests/` directory for your cluster.
75+
--
76+
77+
. Open the `cluster-network-03-config.yml` file in an editor and specify the advanced network configuration for your cluster, such as in the following examples:
7578
+
76-
.Example output
77-
[source,terminal]
79+
--
80+
.Specify a different VXLAN port for the OpenShift SDN network provider
81+
[source,yaml]
7882
----
79-
cluster-network-01-crd.yml
80-
cluster-network-02-config.yml
81-
cluster-network-03-config.yml
83+
apiVersion: operator.openshift.io/v1
84+
kind: Network
85+
metadata:
86+
name: cluster
87+
spec:
88+
defaultNetwork:
89+
openshiftSDNConfig:
90+
vxlanPort: 4800
8291
----
8392

84-
. Open the `cluster-network-03-config.yml` file in an editor and enter a custom resource (CR) that
85-
describes the Operator configuration you want:
86-
+
93+
.Enable IPsec for the OVN-Kubernetes network provider
8794
[source,yaml]
8895
----
8996
apiVersion: operator.openshift.io/v1
9097
kind: Network
9198
metadata:
9299
name: cluster
93-
spec: <1>
94-
clusterNetwork:
95-
- cidr: 10.128.0.0/14
96-
hostPrefix: 23
97-
serviceNetwork:
98-
- 172.30.0.0/16
100+
spec:
99101
defaultNetwork:
100-
type: OpenShiftSDN
101-
openshiftSDNConfig:
102-
mode: NetworkPolicy
103-
mtu: 1450
104-
vxlanPort: 4789
102+
ovnKubernetesConfig:
103+
ipsecConfig: {}
105104
----
106-
<1> The parameters for the `spec` parameter are only an example. Specify your
107-
configuration for the Cluster Network Operator in the CR.
108-
+
109-
The CNO provides default values for the parameters in the CR, so you must
110-
specify only the parameters that you want to change.
105+
--
111106

112107
. Save the `cluster-network-03-config.yml` file and quit the text editor.
113108
. Optional: Back up the `manifests/cluster-network-03-config.yml` file. The

modules/nw-network-config.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// TODO - possibly delete this file
2+
// Or does it add actual value?
3+
4+
// Module included in the following assemblies:
5+
//
6+
// * networking/cluster-network-operator.adoc
7+
// * installing/installing_aws/installing-aws-network-customizations.adoc
8+
// * installing/installing_azure/installing-azure-network-customizations.adoc
9+
// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
10+
// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc
11+
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc
12+
// * installing/installing_gcp/installing-gcp-network-customizations.adoc
13+
14+
[id="nw-network-config_{context}"]
15+
= Network configuration phases
16+
17+
When specifying a cluster configuration prior to installation, there are several phases in the installation procedures when you can modify the network configuration:
18+
19+
Phase 1:: After entering the `openshift-install create install-config` command. In the `install-config.yaml` file, you can customize the following network-related fields:
20+
+
21+
* `networking.networkType`
22+
* `networking.clusterNetwork`
23+
* `networking.serviceNetwork`
24+
* `networking.machineNetwork`
25+
+
26+
For more information on these fields, refer to "Installation configuration parameters".
27+
28+
Phase 2:: After entering the `openshift-install create manifests` command. If you must specify advanced network configuration, during this phase you can define a customized Cluster Network Operator manifest with only the fields you want to modify.
29+
30+
You cannot override the values specified in phase 1 in the `install-config.yaml` file during phase 2. However, you can further customize the cluster network provider during phase 2.

0 commit comments

Comments
 (0)