Automatically generate neutron core configuration files

Bug #1520722 reported by OpenStack Infra
12
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Fix Released
High
Louis Taylor
openstack-manuals
Fix Released
Medium
Matt Kassawara

Bug Description

https://review.openstack.org/204206
\Dear bug triager. This bug was created since a commit was marked with DOCIMPACT.
Your project "openstack/neutron" is set up so that we directly report the documentation bugs against it. If this needs changing, the docimpact-group option needs to be added for the project. You can ask the OpenStack infra team (#openstack-infra on freenode) for help if you need to.

commit 71190773e14260fab96e78e65a290356cdc08581
Author: Martin Hickey <email address hidden>
Date: Mon Nov 9 23:37:37 2015 +0000

    Automatically generate neutron core configuration files

    This adds a new tox environment, genconfig, which generates sample
    neutron core configuration file using oslo-config-generator.

    Updates to some configuration option help messages to reflect useful
    details that were missing in the code but were present in config files.

    It also adds details to devref on how to update config files.

    Partially-Implements: blueprint autogen-neutron-conf-file

    DocImpact

    Change-Id: I1c6dc4e7d479f1b7c755597caded24a0f018c712
    Closes-bug: #1199963
    Co-Authored-By: Louis Taylor <email address hidden>

Tags: doc neutron
Henry Gessau (gessau)
Changed in neutron:
status: New → Confirmed
importance: Undecided → High
Revision history for this message
Henry Gessau (gessau) wrote :

Something should be added to openstack-manuals, I believe, but I am not sure what the correct process is these days.

Revision history for this message
Matt Kassawara (ionosphere80) wrote :

At a minimum, we need to change the configuration reference to include configuration files built using the auto-generation script rather than referencing static files in the neutron source tree.

Changed in openstack-manuals:
status: New → Triaged
importance: Undecided → Medium
assignee: nobody → Matt Kassawara (ionosphere80)
milestone: none → mitaka
Revision history for this message
Matt Kassawara (ionosphere80) wrote :

We should also consider adding the Ubuntu neutron packaging project because this change probably impacts how they include configuration files.

no longer affects: ubuntu
tags: added: doc
Revision history for this message
Armando Migliaccio (armando-migliaccio) wrote :

We documented the steps to generate files here:

http://docs.openstack.org/developer/neutron/devref/contribute.html#configuration-files

And as far as Neutron docs goes, that's the most we can do.

Btw, this is somewhat duplicate of https://bugs.launchpad.net/neutron/+bug/1522586

Changed in neutron:
status: Confirmed → Fix Committed
assignee: nobody → Louis Taylor (kragniz)
Changed in neutron:
status: Fix Committed → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (master)

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

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

Reviewed: https://review.openstack.org/254984
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=39670ef35ab37d8e7a4db483f0f8e2a453c7a07b
Submitter: Jenkins
Branch: master

commit 39670ef35ab37d8e7a4db483f0f8e2a453c7a07b
Author: Matthew Kassawara <email address hidden>
Date: Tue Dec 8 15:02:50 2015 -0700

    [config-ref] Include neutron config files

    For Mitaka, neutron implements automatic generation of sample
    configuration files and removes static sample configuration
    files from the neutron source tree. Therefore, the
    configuration reference must include local versions of
    sample configuration files similar to other projects that
    implement automatic generation of sample configuration files.

    Change-Id: If92d048a837ffbd9ba8664559ddabe886f448a32
    Closes-Bug: #1520722

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

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.

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

Duplicates of this bug

Other bug subscribers

Remote bug watches

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