Bug 1880022

Summary:	[OSP] Custom subnets in RHOSP deployments documentation is missing details on machineNetwork and example
Product:	OpenShift Container Platform	Reporter:	Robert Heinzmann <rheinzma>
Component:	Documentation	Assignee:	Max Bridges <mbridges>
Status:	CLOSED EOL	QA Contact:	Xiaoli Tian <xtian>
Severity:	low	Docs Contact:
Priority:	low
Version:	4.5	CC:	mbridges
Target Milestone:	---
Target Release:	4.5.z
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2022-09-09 14:09:26 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Robert Heinzmann 2020-09-17 14:44:06 UTC

Document URL: 

https://docs.openshift.com/container-platform/4.5/installing/installing_openstack/installing-openstack-installer-custom.html#installation-osp-custom-subnet_installing-openstack-installer-custom

Section Number and Name: 

Section "Custom subnets in RHOSP deployments"

Describe the issue: 

- When deploying with a custom subnet, the subnet must be added as UUID to the install-config.yaml file. While this is documented in the text it may be easily overseen. Currently there is no example in the documentation. Adding a example would help the users to not run into issues.

- When deploying with a custom subnet, the machineNetwork CIDR must match the CIDR of the already provisioned subnet for the machines. This step is required as shown here https://github.com/openshift/installer/blob/release-4.6/docs/user/openstack/customization.md#custom-subnets. Currently this requirement is missing from the documentation.

Suggestions for improvement:

- Adding an Example for machinesSubnet
- Description and example that machineNetwork CIDR must match the CIDR of the subnet provided.

Additional information:

Comment 2 Robert Heinzmann 2020-09-18 06:22:22 UTC

Regarding the second point I would like to clarify.

> - When deploying with a custom subnet, the machineNetwork CIDR must match the CIDR of the already provisioned subnet for the machines. This step is required as shown here https://github.com/openshift/installer/blob/release-4.6/docs/user/openstack/customization.md#custom-subnets. Currently this requirement is missing from the documentation.

Actually I missed the description of the parameter in the table, so the information is contained in the docs. I still thing making this requirement, as it is a hard requirement, more obvious, would be a good idea. I think a (i) section with the same not to the "Custom subnets in RHOSP deployments" section would be great, as other requirements (e.g. FIP's) are listed there too.

(i) The first item in networking.machineNetwork must match the CIDR of machinesSubnet specified.

Comment 7 Max Bridges 2022-09-09 14:09:26 UTC

OCP 4.5 is no longer on full support [1]. Marking this bug as CLOSED EOL.

If you have a customer case with a support exception or if you think this issue
still applies on 4.8+, please reopen and include those details or open a new Jira issue [2] with updated information. When reopening,
please set the Target Release to the appropriate version where needed.

[1]: https://access.redhat.com/support/policy/updates/openshift
[2]: https://issues.redhat.com/projects/OCPBUGS