From d0b07c4f931107a142cddb9090daa41d1fe02359 Mon Sep 17 00:00:00 2001 From: Max Bridges Date: Wed, 23 Dec 2020 13:53:36 -0500 Subject: [PATCH 1/8] Document multi-network OSP machinesets --- modules/installation-osp-custom-subnet.adoc | 18 ++++++++++-------- modules/machineset-yaml-osp.adoc | 8 ++++++-- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/modules/installation-osp-custom-subnet.adoc b/modules/installation-osp-custom-subnet.adoc index 731c4ceb43c3..5b5a7672663b 100644 --- a/modules/installation-osp-custom-subnet.adoc +++ b/modules/installation-osp-custom-subnet.adoc @@ -11,22 +11,24 @@ Optionally, you can deploy a cluster on a {rh-openstack-first} subnet of your choice. The subnet's GUID is passed as the value of `platform.openstack.machinesSubnet` in the `install-config.yaml` file. -This subnet is used as the cluster's primary subnet; nodes and ports are created on it. +This subnet is used as the cluster's primary subnet. By default, nodes and ports are created on it. You can create nodes and ports on a different {rh-openstack} subnet by setting the value of the `platform.openstack.machinesSubnet` property to the subnet's UUID. Before you run the {product-title} installer with a custom subnet, verify that: -* The target network and subnet are available. +* The subnet that is used by `platform.openstack.machinesSubnet` has DHCP enabled. +* The CIDR of `platform.openstack.machinesSubnet` matches the CIDR of `networking.machineNetwork`. +* The installer user has permission to create ports on this network, including ports with fixed IP addresses. -* DHCP is enabled on the target subnet. +Clusters that use custom subnets have the following limitations: -* You can provide installer credentials that have permission to create ports on the target network. - -* If your network configuration requires a router, it is created in {rh-openstack}. Some configurations rely on routers for floating IP address translation. - -* Your network configuration does not rely on a provider network. Provider networks are not supported. +* If you plan to install a cluster that uses floating IPs, the `platform.openstack.machinesSubnet` subnet must be attached to a router that is connected to the `externalNetwork` network. +* The installer cannot create a private network or subnet for your {rh-openstack} machines if the `platform.openstack.machinesSubnet` value is set in the `install-config.yaml`. +* You cannot use the `platform.openstack.externalDNS` property at the same time as a custom subnet. To add DNS to a cluster that uses a custom subnet, configure DNS on the {rh-openstack} network. [NOTE] ==== By default, the API VIP takes x.x.x.5 and the Ingress VIP takes x.x.x.7 from your network's CIDR block. To override these default values, set values for `platform.openstack.apiVIP` and `platform.openstack.ingressVIP` that are outside of the DHCP allocation pool. ==== + + diff --git a/modules/machineset-yaml-osp.adoc b/modules/machineset-yaml-osp.adoc index 0f672bd31d78..3aaa39faf94e 100644 --- a/modules/machineset-yaml-osp.adoc +++ b/modules/machineset-yaml-osp.adoc @@ -46,12 +46,13 @@ spec: image: serverGroupID: <4> kind: OpenstackProviderSpec - networks: + networks: <5> - filter: {} subnets: - filter: name: tags: openshiftClusterID= + primarySubnet: <6> securityGroups: - filter: {} name: - @@ -73,4 +74,7 @@ $ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster ---- <2> Specify the node label to add. <3> Specify the infrastructure ID and node label. -<4> To set a server group policy for the machine set, enter the value that is returned from link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.0/html/command_line_interface_reference/server#server_group_create[creating a server group]. For most deployments, `anti-affinity` or `soft-anti-affinity` policies are recommended. +<4> To set a server group policy for the MachineSet, enter the value that is returned from +link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.0/html/command_line_interface_reference/server#server_group_create[creating a server group]. For most deployments, `anti-affinity` or `soft-anti-affinity` policies are recommended. +<5> Required for deployments to multiple networks. If deploying to multiple networks, this list must include the network that is used as the `primarySubnet` value. +<6> Specify the {rh-openstack} subnet that you want the endpoints of nodes to be published on. Usually, this is the same subnet that is used as the value of `machinesSubnet` in the `install-config.yaml` file. \ No newline at end of file From 606654e16b4e51c0686cf200c080474368652dde Mon Sep 17 00:00:00 2001 From: Max Bridges <50179998+maxwelldb@users.noreply.github.com> Date: Mon, 11 Jan 2021 08:06:30 -0500 Subject: [PATCH 2/8] Cannot/does not clarification --- modules/installation-osp-custom-subnet.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/installation-osp-custom-subnet.adoc b/modules/installation-osp-custom-subnet.adoc index 5b5a7672663b..6e4a006ed795 100644 --- a/modules/installation-osp-custom-subnet.adoc +++ b/modules/installation-osp-custom-subnet.adoc @@ -22,7 +22,7 @@ Before you run the {product-title} installer with a custom subnet, verify that: Clusters that use custom subnets have the following limitations: * If you plan to install a cluster that uses floating IPs, the `platform.openstack.machinesSubnet` subnet must be attached to a router that is connected to the `externalNetwork` network. -* The installer cannot create a private network or subnet for your {rh-openstack} machines if the `platform.openstack.machinesSubnet` value is set in the `install-config.yaml`. +* The installer does not create a private network or subnet for your {rh-openstack} machines if the `platform.openstack.machinesSubnet` value is set in the `install-config.yaml`. * You cannot use the `platform.openstack.externalDNS` property at the same time as a custom subnet. To add DNS to a cluster that uses a custom subnet, configure DNS on the {rh-openstack} network. [NOTE] @@ -31,4 +31,3 @@ By default, the API VIP takes x.x.x.5 and the Ingress VIP takes x.x.x.7 from you set values for `platform.openstack.apiVIP` and `platform.openstack.ingressVIP` that are outside of the DHCP allocation pool. ==== - From 8961b2542fcba95b8aa41221f097c30770df56c7 Mon Sep 17 00:00:00 2001 From: Max Bridges <50179998+maxwelldb@users.noreply.github.com> Date: Mon, 18 Jan 2021 14:36:20 -0500 Subject: [PATCH 3/8] Update modules/installation-osp-custom-subnet.adoc Co-authored-by: Kathryn Alexander <37149781+kalexand-rh@users.noreply.github.com> --- modules/installation-osp-custom-subnet.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/installation-osp-custom-subnet.adoc b/modules/installation-osp-custom-subnet.adoc index 6e4a006ed795..9227df5d1e34 100644 --- a/modules/installation-osp-custom-subnet.adoc +++ b/modules/installation-osp-custom-subnet.adoc @@ -17,7 +17,7 @@ Before you run the {product-title} installer with a custom subnet, verify that: * The subnet that is used by `platform.openstack.machinesSubnet` has DHCP enabled. * The CIDR of `platform.openstack.machinesSubnet` matches the CIDR of `networking.machineNetwork`. -* The installer user has permission to create ports on this network, including ports with fixed IP addresses. +* The installation program user has permission to create ports on this network, including ports with fixed IP addresses. Clusters that use custom subnets have the following limitations: @@ -30,4 +30,3 @@ Clusters that use custom subnets have the following limitations: By default, the API VIP takes x.x.x.5 and the Ingress VIP takes x.x.x.7 from your network's CIDR block. To override these default values, set values for `platform.openstack.apiVIP` and `platform.openstack.ingressVIP` that are outside of the DHCP allocation pool. ==== - From 4a173652bf263d54a0dce36d9838036bb131adc3 Mon Sep 17 00:00:00 2001 From: Max Bridges <50179998+maxwelldb@users.noreply.github.com> Date: Mon, 18 Jan 2021 14:36:29 -0500 Subject: [PATCH 4/8] Update modules/installation-osp-custom-subnet.adoc Co-authored-by: Kathryn Alexander <37149781+kalexand-rh@users.noreply.github.com> --- modules/installation-osp-custom-subnet.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-osp-custom-subnet.adoc b/modules/installation-osp-custom-subnet.adoc index 9227df5d1e34..97f5314508fd 100644 --- a/modules/installation-osp-custom-subnet.adoc +++ b/modules/installation-osp-custom-subnet.adoc @@ -21,7 +21,7 @@ Before you run the {product-title} installer with a custom subnet, verify that: Clusters that use custom subnets have the following limitations: -* If you plan to install a cluster that uses floating IPs, the `platform.openstack.machinesSubnet` subnet must be attached to a router that is connected to the `externalNetwork` network. +* If you plan to install a cluster that uses floating IP addresses, the `platform.openstack.machinesSubnet` subnet must be attached to a router that is connected to the `externalNetwork` network. * The installer does not create a private network or subnet for your {rh-openstack} machines if the `platform.openstack.machinesSubnet` value is set in the `install-config.yaml`. * You cannot use the `platform.openstack.externalDNS` property at the same time as a custom subnet. To add DNS to a cluster that uses a custom subnet, configure DNS on the {rh-openstack} network. From f2bd53a57bf9b255eed9277f502a76130a928604 Mon Sep 17 00:00:00 2001 From: Max Bridges <50179998+maxwelldb@users.noreply.github.com> Date: Mon, 18 Jan 2021 14:41:16 -0500 Subject: [PATCH 5/8] Update modules/installation-osp-custom-subnet.adoc --- modules/installation-osp-custom-subnet.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation-osp-custom-subnet.adoc b/modules/installation-osp-custom-subnet.adoc index 97f5314508fd..af387462fb34 100644 --- a/modules/installation-osp-custom-subnet.adoc +++ b/modules/installation-osp-custom-subnet.adoc @@ -13,7 +13,7 @@ Optionally, you can deploy a cluster on a {rh-openstack-first} subnet of your ch This subnet is used as the cluster's primary subnet. By default, nodes and ports are created on it. You can create nodes and ports on a different {rh-openstack} subnet by setting the value of the `platform.openstack.machinesSubnet` property to the subnet's UUID. -Before you run the {product-title} installer with a custom subnet, verify that: +Before you run the {product-title} installer with a custom subnet, verify that your configuration meets the following requirements: * The subnet that is used by `platform.openstack.machinesSubnet` has DHCP enabled. * The CIDR of `platform.openstack.machinesSubnet` matches the CIDR of `networking.machineNetwork`. From 1844bdca9c1eda1a9f9b304967471412320d2af1 Mon Sep 17 00:00:00 2001 From: Max Bridges <50179998+maxwelldb@users.noreply.github.com> Date: Mon, 18 Jan 2021 14:42:37 -0500 Subject: [PATCH 6/8] Update modules/installation-osp-custom-subnet.adoc --- modules/installation-osp-custom-subnet.adoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/modules/installation-osp-custom-subnet.adoc b/modules/installation-osp-custom-subnet.adoc index af387462fb34..e6f9d06a93bd 100644 --- a/modules/installation-osp-custom-subnet.adoc +++ b/modules/installation-osp-custom-subnet.adoc @@ -22,7 +22,10 @@ Before you run the {product-title} installer with a custom subnet, verify that y Clusters that use custom subnets have the following limitations: * If you plan to install a cluster that uses floating IP addresses, the `platform.openstack.machinesSubnet` subnet must be attached to a router that is connected to the `externalNetwork` network. -* The installer does not create a private network or subnet for your {rh-openstack} machines if the `platform.openstack.machinesSubnet` value is set in the `install-config.yaml`. +[NOTE] +==== +The installation program does not create a private network or subnet for your {rh-openstack} machines if the `platform.openstack.machinesSubnet` value is set in the `install-config.yaml` file. +==== * You cannot use the `platform.openstack.externalDNS` property at the same time as a custom subnet. To add DNS to a cluster that uses a custom subnet, configure DNS on the {rh-openstack} network. [NOTE] From 9b4d41c46bbb7e601b31133c9aeba5e4b2d353a3 Mon Sep 17 00:00:00 2001 From: Max Bridges <50179998+maxwelldb@users.noreply.github.com> Date: Mon, 18 Jan 2021 14:45:15 -0500 Subject: [PATCH 7/8] Update modules/installation-osp-custom-subnet.adoc --- modules/installation-osp-custom-subnet.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/installation-osp-custom-subnet.adoc b/modules/installation-osp-custom-subnet.adoc index e6f9d06a93bd..afd93f02ff07 100644 --- a/modules/installation-osp-custom-subnet.adoc +++ b/modules/installation-osp-custom-subnet.adoc @@ -22,6 +22,7 @@ Before you run the {product-title} installer with a custom subnet, verify that y Clusters that use custom subnets have the following limitations: * If you plan to install a cluster that uses floating IP addresses, the `platform.openstack.machinesSubnet` subnet must be attached to a router that is connected to the `externalNetwork` network. ++ [NOTE] ==== The installation program does not create a private network or subnet for your {rh-openstack} machines if the `platform.openstack.machinesSubnet` value is set in the `install-config.yaml` file. From aed646dabc18c6b2184481bc8a774147630ca82c Mon Sep 17 00:00:00 2001 From: Max Bridges <50179998+maxwelldb@users.noreply.github.com> Date: Mon, 18 Jan 2021 15:36:17 -0500 Subject: [PATCH 8/8] Reordering an UL element --- modules/installation-osp-custom-subnet.adoc | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/modules/installation-osp-custom-subnet.adoc b/modules/installation-osp-custom-subnet.adoc index afd93f02ff07..3c1f9077a31d 100644 --- a/modules/installation-osp-custom-subnet.adoc +++ b/modules/installation-osp-custom-subnet.adoc @@ -22,11 +22,9 @@ Before you run the {product-title} installer with a custom subnet, verify that y Clusters that use custom subnets have the following limitations: * If you plan to install a cluster that uses floating IP addresses, the `platform.openstack.machinesSubnet` subnet must be attached to a router that is connected to the `externalNetwork` network. -+ -[NOTE] -==== -The installation program does not create a private network or subnet for your {rh-openstack} machines if the `platform.openstack.machinesSubnet` value is set in the `install-config.yaml` file. -==== + +* If the `platform.openstack.machinesSubnet` value is set in the `install-config.yaml` file, the installation program does not create a private network or subnet for your {rh-openstack} machines. + * You cannot use the `platform.openstack.externalDNS` property at the same time as a custom subnet. To add DNS to a cluster that uses a custom subnet, configure DNS on the {rh-openstack} network. [NOTE]