Bug 1347363 - [Docs][Director] Provide more details on Management Network use in Director Installation Guide
Summary: [Docs][Director] Provide more details on Management Network use in Director I...
Keywords:
Status: ASSIGNED
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 13.0 (Queens)
Hardware: Unspecified
OS: Unspecified
low
unspecified
Target Milestone: ga
: ---
Assignee: Dan Macpherson
QA Contact: RHOS Documentation Team
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-06-16 15:38 UTC by Bradford Nichols
Modified: 2020-04-05 09:37 UTC (History)
4 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 Bradford Nichols 2016-06-16 15:38:26 UTC
Description of problem:
The current Director Install guide has only a couple passing notes which reference this new network. It is not included in any lists or figures  of all possible networks. The user has no guidiance on when it is useful, what it is for etc. 

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

How reproducible:
NA

Steps to Reproduce:
1.
2.
3.

Actual results:
NA

Expected results:
NA

Additional info:
The network needs to be added to the following:
Table 3.2. Network Type Assignments
Figure 3.1. Example VLAN Topology using Bonded Interfaces
Table 3.3. Network Mappings

Comment 3 Dan Macpherson 2016-08-19 05:38:34 UTC
Hi Bradford:

Added some info about the management network in the planning and network isolation sections:

https://access.redhat.com/documentation/en/red-hat-openstack-platform/9/single/director-installation-and-usage/#sect-Planning_Networks

https://access.redhat.com/documentation/en/red-hat-openstack-platform/9/single/director-installation-and-usage/#sect-Isolating_Networks

How does this content look to you? Is there anything more we should add?

Comment 4 Bradford Nichols 2016-08-19 11:22:13 UTC
Hi Dan, 
What you've added looks good to me. A couple additional thoughts follow.
/Brad

1) I don't see any material on 'why would I choose to isolate a particular network or not' in general. Also for the management network in particular over the other isolatable networks. 

What I suggest is after the following
"The director provides a method for mapping six of these traffic types to certain subnets or VLANs. These traffic types include:
Internal API
Storage
Storage Management
Tenant Networks
External
Management
Any unassigned networks are automatically assigned to the same subnet as the Provisioning network."

Add a simple statement
'Choosing to isolate networks can be desirable from a security prospective to segregate administrative, cloud software, storage, end user traffic and also for increasing performance for specific functions where the underlying network hardware resources are available.'

2) when using the provided .yaml files ( at least in my experience on 8.0) , to enable a separate management network requires an additional step beyond the normal ones to achieve network isolation. You need to pull in additional management network yaml. 
...
-e /usr/share/openstack-tripleo-heat-templates/environments/network-isolation.yaml \
-e /usr/share/openstack-tripleo-heat-templates/environments/network-management.yaml \
...

It makes Management more 'optional' then all the others. 

Not if this is significant in highlighing that the management is not quite like all the other isolatable networks in usage... or where to pull this into the narrative. 

3) The diagram in section 3.2 showing the network isolation case. 
- the Management network needs to be accounted for. Either parenthetical under 'provisioning' or called out as its own additional network from the nic2/nic3 bond. 
- 'cluster management' with the Internal API. This is a bit confusing as the phrasing makes one wonder if this is yet another network, or maybe referring to the previously mentioned 'Management' network. If cluster management one of the functions of the Internal API, it should be mentioned in the Internal API entry in table 3.3. And the diagram label something more like "Internal API Network (includes cluster management communications)"

4) Table 3.3 of 2 examples of network mappings does not reference the management network. 
- The 'Flat Network with External Access'. 'Mappings' column should list Management Network?
- The 'Isolated Networks'. 'Mappings' either 'Network 1 Provisioning' should add '... and Management' or add another 'Network 8 - Management'

Comment 5 Dan Macpherson 2018-08-10 06:37:44 UTC
Including this BZ as part of the Overcloud Networking revamp.

Comment 7 Dan Macpherson 2019-06-12 12:55:50 UTC
Changing the version to a supported release as this BZ still has valid feedback that applies to OSP13+


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