Services and Agents DevRef doesn't describe configuration seperation

Bug #1557119 reported by Dustin Lundquist on 2016-03-14
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Security Guide Documentation
Undecided
Unassigned
neutron
Low
Dustin Lundquist
openstack-manuals
Wishlist
Farhan Kalsekar

Bug Description

Presently the services and agents DevRef doesn't describe how configuration options should be separated.

Changed in neutron:
assignee: nobody → Dustin Lundquist (dlundquist)
status: New → In Progress
Changed in neutron:
importance: Undecided → Low
milestone: none → newton-1
tags: added: doc
Changed in neutron:
milestone: newton-1 → newton-2
Changed in neutron:
milestone: newton-2 → newton-3

Reviewed: https://review.openstack.org/275381
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=1257af45ea7fa9b0aece4a0b505778cab0e71daf
Submitter: Jenkins
Branch: master

commit 1257af45ea7fa9b0aece4a0b505778cab0e71daf
Author: Dustin Lundquist <email address hidden>
Date: Tue Feb 2 11:27:56 2016 -0800

    devref doc config option separation

    Document separation of configuration options between services and agents.

    Configurations used in devstack and deployment documentation should also be
    updated since they are referenced as examples.

    Partial-Bug: #1557119
    Change-Id: Ia4b2a542cded6cc56c1b3eaa9e9b9e0abff31707

Changed in neutron:
milestone: newton-3 → newton-rc1
Changed in neutron:
milestone: newton-rc1 → ocata-1
Changed in neutron:
milestone: ocata-1 → ocata-2
Changed in neutron:
milestone: ocata-2 → ocata-3
Changed in neutron:
milestone: ocata-3 → ocata-rc1
Boden R (boden) wrote :

Armando, based on [1] isn't this devref change already released (newton)?
IIUC this one is already fix released and can be closed out.

[1] https://github.com/openstack/neutron/commits/stable/newton/doc/source/devref/services_and_agents.rst

From the merged commit it sounds like similar content would be required to openstack deployment guide and devstack to mark this issue complete. However as far as neutron goes, we should be all set.

Changed in neutron:
status: In Progress → Fix Released
milestone: ocata-rc1 → none

At this point the openstack-manuals addition is a wishlist item.

Hi Armando,

Could you please make it clear where you believe this wishlist item should be added, and what is to be added?

Thank you,

Alex

Changed in openstack-manuals:
status: New → Incomplete
importance: Undecided → Wishlist

I could think of a couple of places, such as [1] or [2], but I am not 100% they are the appropriate ones. As for the content, I would use the same content of patch [3].

Thanks!

[1] http://docs.openstack.org/security-guide/networking/architecture.html
[2] http://docs.openstack.org/newton/networking-guide/deploy.html
[3] https://review.openstack.org/#/c/275381

Changed in openstack-manuals:
status: Incomplete → Confirmed
tags: added: networking-guide
Changed in ossp-security-documentation:
assignee: nobody → Rahul U Nair (rahulunair)
tags: added: low-hanging-fruit
Changed in openstack-manuals:
assignee: nobody → Farhan Kalsekar (ifarhan)
Farhan Kalsekar (ifarhan) wrote :

Hi Armando,

I am looking at updating the networking guide for this and need your inputs/suggestions.

Since we are referring to the configuration options between neutron-server and agents, you reckon adding this to the Configuration section [1] instead of the Deployment Examples [2] would be more meaningful? Perhaps add a subsection for Services and agents, provide some context and then add content from the patch[3] as-is?

I was also considering the Miscellaneous section [4], but I am not too sure how appropriate that would be.

Thanks,
Farhan

[1] https://docs.openstack.org/newton/networking-guide/config.html
[2] http://docs.openstack.org/newton/networking-guide/deploy.html
[3] https://review.openstack.org/#/c/275381
[4] https://docs.openstack.org/newton/networking-guide/misc.html

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

Changed in openstack-manuals:
status: Confirmed → In Progress

Reviewed: https://review.openstack.org/457180
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=8a4ea7fdf570c02bd54a013450ecd27cd5890c1c
Submitter: Jenkins
Branch: master

commit 8a4ea7fdf570c02bd54a013450ecd27cd5890c1c
Author: Farhan Kalsekar <email address hidden>
Date: Mon Apr 17 18:28:16 2017 +1000

    [networking-guide] Add configuration seperation for services and agents

    Refer:
     https://bugs.launchpad.net/openstack-manuals/+bug/1557119/comments/1
     https://bugs.launchpad.net/openstack-manuals/+bug/1557119/comments/3
     https://bugs.launchpad.net/openstack-manuals/+bug/1557119/comments/6
     https://bugs.launchpad.net/openstack-manuals/+bug/1557119/comments/7

    Change-Id: I8285728bc7fc2b8257ef431a7f489f6403fa35eb
    Partial-Bug: #1557119

Changed in openstack-manuals:
status: In Progress → Fix Released
Changed in ossp-security-documentation:
assignee: Rahul U Nair (rahulunair) → nobody
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers