Bug 1664321 - ODL docs add External network without updating the roles data
Summary: ODL docs add External network without updating the roles data
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 13.0 (Queens)
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: ---
Assignee: RHOS Documentation Team
QA Contact: RHOS Documentation Team
URL:
Whiteboard:
Depends On:
Blocks: 1643423
TreeView+ depends on / blocked
 
Reported: 2019-01-08 12:53 UTC by Harald Jensås
Modified: 2019-03-06 16:17 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-03-06 16:16:11 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Harald Jensås 2019-01-08 12:53:09 UTC
Description of problem:

The book on ODL adds the External network to Compute role by adding a resource_registry override in environment without also using a custom role for Compute with the "External" network added to the Compute role.

Section "3.3. Install OpenDaylight in custom role":
---------------------------------------------------
does not add External network.

Section: "3.2. Basic installation of OpenDaylight":
---------------------------------------------------

Deploying without custom role may not be valid, unless ODL can be deployed without adding the External network, or some other Floating IP network?

Section: "6.1.5.3. The network-environment.yaml file"
-----------------------------------------------------

The resource_registry overrides are not necessary if proper networks data and roles data is provided. The default jinja rendered network-isolation.yaml in THT can be used instead if proper networks data is provided.

NOTE: Upstream docs are moving to use the default jinja2 rendered network-environment.yaml as well. And using a smaller network-environments-overrides.yaml as a custom environment. (Most of network-environment.yaml will render to correctly when networks data is provided). See: https://docs.openstack.org/tripleo-docs/latest/install/advanced_deployment/network_isolation.html#create-network-environment-overrides-file

Version-Release number of selected component (if applicable):

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html-single/red_hat_opendaylight_installation_and_configuration_guide/#red_hat_openstack_platform_director_and_opendaylight


Actual results:


Expected results:
The External network (or some other Floting IP network) should be added to the Compute role by creating a custom role for Compute with the External (or other Floating IP network) network added.

The default network-isolation.yaml will then be rendered using the correct template for the OS::TripleO::Compute::Ports::ExternalPort resource. Making the manual override of this resource redundant.

Additional info:

NOTE: Once https://review.openstack.org/#/q/I07822ec0cba7eed352c0010eb893b5e5a522e95c makes it downstream the Doc as it is not will no longer work. Networks _must_ be added to roles data!

See: https://review.openstack.org/629163 for some more details.

Comment 2 Franck Baudin 2019-03-06 16:16:11 UTC
As per depreciation notice [1], closing this bug. Please reopen if relevant for RHOSP13, as this is the only version shipping ODL.

[1] https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/14/html-single/release_notes/index#deprecated_functionality

Comment 3 Franck Baudin 2019-03-06 16:17:37 UTC
As per depreciation notice [1], closing this bug. Please reopen if relevant for RHOSP13, as this is the only version shipping ODL.

[1] https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/14/html-single/release_notes/index#deprecated_functionality


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