install-guide define contents of /etc/network/interfaces for both the controller node and compute node that differ

Bug #1547598 reported by Grelaud
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack-Ansible
Fix Released
Low
Hector Gonzalez

Bug Description

For great understanding and consistency between github (https://github.com/openstack/openstack-ansible) and install-guide (http://docs.openstack.org/developer/openstack-ansible/install-guide/targethosts-networkexample.html).

In Github (openstack-ansible/etc/network/interfaces.d/), in the file openstack_interface.cfg.example, you point out that for br-vxlan and br-storage, "only compute node have an IP on this bridge. When used by infra nodes, IPs exist in the containers and inet should be set to manual".

So in install-guide, chapter 3, "Configuring the network on target host", we can provide the contents of /etc/network/interfaces for both controller node (with br-vxlan and br-storage as manual without IP) and compute node (br-vxlan and br-storage as static with IP).

Revision history for this message
Jesse Pretorius (jesse-pretorius) wrote :

This is a docs bug, and is good commentary on the consistency of the documentation we provide. I would really like to see us getting rid of two sources of truth (docs and .examples files) and move towards just docs.

Changed in openstack-ansible:
status: New → Confirmed
importance: Undecided → Low
Changed in openstack-ansible:
assignee: nobody → Hector Gonzalez (theizaakk)
Revision history for this message
Hector Gonzalez (theizaakk) wrote :

Jesse, One question on this:

Should we remove the comments on the .example file that are making this docs confusing or leave the comments on the .example file the same as the docs?

Revision history for this message
Grelaud (fabrice-grelaud) wrote :

Personally, i will leave the comments on the .exemple file.

And I will detail further the section of Chapter 3 (install-guide), "Configuring the network on a target host" that i reappoint "Configuring the network on target hosts" with an example for one controller and one compute node (/etc/network/interfaces). Because finally, this network doc is a typical example of production start.

For example, something like this:

Addresses for controllers ( 3 nodes):

Host management: 10.240.0.11 (.12, .13)
Host management gateway: 10.240.0.1
DNS servers: 69.20.0.164 69.20.0.196
Container management: 172.29.236.11 (.12, .13)
Tunnel: no IP (because IP exist in the containers)
Storage: no IP (because IP exist in the containers)

Addresses for compute (2 nodes):

Host management: 10.240.0.21 (.22)
Host management gateway: 10.240.0.1
DNS servers: 69.20.0.164 69.20.0.196
Container management: 172.29.236.21 (.22)
Tunnel: 172.29.240.21 (.22)
Storage: 172.29.244.21 (.22)

And after each figure (3.2 and 3.3) i will give the contents of /etc/network/interfaces.

Or alternatively, in the "Home OpenStack-Ansible Installation Guide", i will present the chapter 3 as this:

-Chapter 3. Target hosts
...
    . Configuring the network on target hosts
        > Target hosts for infrastructure, networking, and storage services
        > Target hosts for Compute service

And the above details for each.

Regards

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-ansible (master)

Fix proposed to branch: master
Review: https://review.openstack.org/291310

Changed in openstack-ansible:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-ansible (master)

Reviewed: https://review.openstack.org/291310
Committed: https://git.openstack.org/cgit/openstack/openstack-ansible/commit/?id=0086227b3d482a9b3852edfc360a5dd625cae545
Submitter: Jenkins
Branch: master

commit 0086227b3d482a9b3852edfc360a5dd625cae545
Author: Hector I Gonzalez <email address hidden>
Date: Thu Mar 10 11:17:26 2016 -0600

    Doc: Configuring the network on target refactor

    For better understanding and avoiding inconsistencies,
    this commit removes focuses on a simpler "single host"
    page.

    Change-Id: I097aa2495276dc3073d4d1fd947091c37abab7db
    Closes-bug: 1547598

Changed in openstack-ansible:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/312421
Committed: https://git.openstack.org/cgit/openstack/openstack-ansible/commit/?id=7e8d629108605930d6fdacebba07c03024012ce3
Submitter: Jenkins
Branch: master

commit 7e8d629108605930d6fdacebba07c03024012ce3
Author: Jean-Philippe Evrard <email address hidden>
Date: Wed May 4 11:03:13 2016 +0100

    Doc: Configuring the network refactor

    For better understanding and avoiding inconsistencies, this commit
    removes focuses on a consistent network configuration explanation,
    with 2 paths for the deployer:

    - The reference "path"
    - The single host "path"

    Each path is explained the same way, this way the deployers know how to
    follow the path.

    Closes-bug: #1547598

    Change-Id: I6e187ab5d88f1387876012d4f40f96205cc7a6ee
    Signed-off-by: Jean-Philippe Evrard <email address hidden>

Revision history for this message
Thierry Carrez (ttx) wrote : Fix included in openstack/openstack-ansible 14.0.0.0b1

This issue was fixed in the openstack/openstack-ansible 14.0.0.0b1 development milestone.

Revision history for this message
Doug Hellmann (doug-hellmann) wrote : Fix included in openstack/openstack-ansible 14.0.0.0b2

This issue was fixed in the openstack/openstack-ansible 14.0.0.0b2 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.