Bug 1665506

Summary: FFU - Using custom roles_data required when using non-default networks
Product: Red Hat OpenStack Reporter: Harald Jensås <hjensas>
Component: documentationAssignee: Irina <igallagh>
Status: CLOSED EOL QA Contact: RHOS Documentation Team <rhos-docs>
Severity: high Docs Contact:
Priority: medium    
Version: 13.0 (Queens)CC: amcleod, igallagh, jkreger, mburns, sbaker
Target Milestone: ---Keywords: Triaged
Target Release: ---   
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: 2023-03-07 14:27:36 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:
Bug Depends On:    
Bug Blocks: 1643423    

Description Harald Jensås 2019-01-11 15:38:30 UTC
Description of problem:
-----------------------

Previously it was possible to add additional networks to a role without
using a custom role by overriding the resource registry, for example:

resource_registry:
  OS::TripleO::Compute::Ports::ExternalPort: ../network/ports/external.yaml

Another example for Management network:

resource_registry:
  OS::TripleO::Controller::Ports::ManagmentPort: ../network/ports/management.yaml
  OS::TripleO::Compute::Ports::ManagmentPort: ../network/ports/management.yaml
  OS::TripleO::Ceph::Ports::ManagmentPort: ../network/ports/management.yaml

Adding the Management network as above used to be the way to add this network prior to Composable Networks in OSP-12.


The FFU Upgrade document is not precis about the requirement to add networks to roles data.
Documentation text is:

  """ If using a custom roles_data file, edit the file to add the composable networks to each role. """

A user adding the Management network (or any other network) using resource_registry as was the documented way to do it prior to OSP-13 would be using the default roles_data (not using custom roles data).


Version-Release number of selected component (if applicable):
-------------------------------------------------------------
https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html/fast_forward_upgrades/assembly-preparing_for_overcloud_upgrade#preparing_for_composable_networks

Actual results:
---------------

The user added the Managment (or any other network) without using custom roles data.
The documented procedure only instruct to add networks if (only if) using custom roles data. This won't be sufficient once the fix for https://bugzilla.redhat.com/show_bug.cgi?id=1643423 land in the next OSP-13 maintenance release.

Expected results:
-----------------

The document must be more clear.
If any non-default network was used (such as the Management network), custom roles data with that network is now required.


Additional info:
https://review.openstack.org/#/c/629963/

Comment 1 Alex McLeod 2019-10-18 17:03:45 UTC
From triage with DFG:

Behaviour changed, if you remove or add a network, need to remove or add the role simultaneously. If any non-default network was used (such as the Management network), custom roles data with that network is now required.

Valid for 13, 14, 15