Skip to content

Customer-provided networks in ShiftStack installation - OSDOCS #22186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maxwelldb merged 4 commits into from
Jul 2, 2020
Merged

Customer-provided networks in ShiftStack installation - OSDOCS #22186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c53757e
Customer-provided networks docs draft.
maxwelldb May 15, 2020
086947b
Add "Optionally"
maxwelldb Jun 25, 2020
3663f6a
Add new mod to assemblies
maxwelldb Jun 25, 2020
cf9d16e
Addressing peer review feedback
maxwelldb Jul 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions installing/installing_openstack/installing-openstack-installer-custom.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
include::modules/installation-initializing.adoc[leveloffset=+1]
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2]
include::modules/installation-osp-config-yaml.adoc[leveloffset=+2]
include::modules/ssh-agent-using.adoc[leveloffset=+1]
include::modules/installation-osp-accessing-api.adoc[leveloffset=+1]
Expand Down
1 change: 1 addition & 0 deletions installing/installing_openstack/installing-openstack-installer-kuryr.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
include::modules/installation-initializing.adoc[leveloffset=+1]
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2]
include::modules/installation-osp-kuryr-config-yaml.adoc[leveloffset=+2]
include::modules/ssh-agent-using.adoc[leveloffset=+1]
include::modules/installation-osp-accessing-api.adoc[leveloffset=+1]
Expand Down
1 change: 1 addition & 0 deletions installing/installing_openstack/installing-openstack-user-kuryr.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+
include::modules/installation-user-infra-generate.adoc[leveloffset=+1]
include::modules/installation-initializing.adoc[leveloffset=+1]
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2]
include::modules/installation-osp-kuryr-config-yaml.adoc[leveloffset=+2]
include::modules/installation-osp-fixing-subnet.adoc[leveloffset=+2]
include::modules/installation-osp-emptying-worker-pools.adoc[leveloffset=+2]
Expand Down
1 change: 1 addition & 0 deletions installing/installing_openstack/installing-openstack-user.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+
include::modules/installation-user-infra-generate.adoc[leveloffset=+1]
include::modules/installation-initializing.adoc[leveloffset=+1]
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2]
include::modules/installation-osp-config-yaml.adoc[leveloffset=+2]
include::modules/installation-osp-fixing-subnet.adoc[leveloffset=+2]
include::modules/installation-osp-emptying-worker-pools.adoc[leveloffset=+2]
Expand Down
26 changes: 21 additions & 5 deletions modules/installation-configuration-parameters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,10 +283,6 @@ ifdef::osp[]
`clouds.yaml` file.
|String, for example `MyCloud`.

|`platform.openstack.externalDNS`
|_Optional_. IP addresses for external DNS servers that cluster instances use for DNS resolution.
|A list of IP addresses as strings, for example `["8.8.8.8", "192.168.1.12"]`.

|`platform.openstack.externalNetwork`
|The {rh-openstack} external network name to be used for installation.
|String, for example `external`.
Expand All @@ -298,9 +294,19 @@ ifdef::osp[]
|`platform.openstack.lbFloatingIP`
|An existing floating IP address to associate with the load balancer API.
|An IP address, for example `128.0.0.1`.
|====

.Optional {rh-openstack} parameters
[cols=".^2m,.^3a,^3a,options="header"]
|====
|Parameter|Description|Values

|`platform.openstack.externalDNS`
|IP addresses for external DNS servers that cluster instances use for DNS resolution.
|A list of IP addresses as strings, for example `["8.8.8.8", "192.168.1.12"]`.

|`platform.openstack.defaultMachinePlatform`
| _Optional_. The default machine pool platform configuration.
|The default machine pool platform configuration.
|
[source,json]
----
Expand All @@ -312,6 +318,16 @@ ifdef::osp[]
}
}
----

|`platform.openstack.machinesSubnet`
|The UUID of a {rh-openstack} subnet that the cluster's nodes use. Nodes and VIP ports are created on this subnet.

The first item in `networking.machineNetwork` must match the value of `machinesSubnet`.

If you deploy to a custom subnet, you cannot specify an external DNS server to the {product-title} installer. Instead, link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.0/html/command_line_interface_reference/subnet[add DNS to the subnet in {rh-openstack}].

|A UUID as a string, for example `fa806b2f-ac49-4bce-b9db-124bc64209bf`.

|====
endif::osp[]

Expand Down
32 changes: 32 additions & 0 deletions modules/installation-osp-custom-subnet.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Module included in the following assemblies:
//

// * installing/installing_openstack/installing-openstack-installer-custom.adoc
// * installing/installing_openstack/installing-openstack-installer-kuryr.adoc
// * installing/installing_openstack/installing-openstack-user.adoc
// * installing/installing_openstack/installing-openstack-user-kuryr.adoc

[id="installation-osp-custom-subnet_{context}"]
= Custom subnets in {rh-openstack} deployments

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.

Before you run the {product-title} installer with a custom subnet, verify that:

* The target network and subnet are available.

* DHCP is enabled on the target subnet.

* 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.

[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.
====