Bug 1880022 - [OSP] Custom subnets in RHOSP deployments documentation is missing details on machineNetwork and example
Summary: [OSP] Custom subnets in RHOSP deployments documentation is missing details on...
Keywords:
Status: ASSIGNED
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.5
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: 4.5.z
Assignee: Max Bridges
QA Contact: Xiaoli Tian
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-09-17 14:44 UTC by Robert Heinzmann
Modified: 2021-04-13 13:09 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Target Upstream Version:


Attachments (Terms of Use)

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.


Note You need to log in before you can comment on or make changes to this bug.