Automatically generate etc/neutron.conf file

Registered by Ihar Hrachyshka on 2014-05-07

Currently we track etc/neutron.conf file in the tree. This is bad in several ways.

- we bother developers to update etc/neutron.conf each time they add, edit or remove a setting raising maintenance cost.
- it's prone to errors (update to etc/neutron.conf may be missed in patches that update settings).
- etc/neutron.conf has several entries uncommented. This makes distributors job a bit more hard: to override any of these settings in downstream, distributors should put new values into neutron-dist.conf and to comment out the default value from etc/neutron.conf. If configuration file is automatically generated with all values commented out, then neutron-dist.conf is the only thing to edit downstream.

Other openstack projects already generate their config files on demand. F.e. nova removed the sample file (https://bugs.launchpad.net/nova/+bug/1294774)

Blueprint information

Status:
Complete
Approver:
Ihar Hrachyshka
Priority:
Low
Drafter:
Martin Hickey
Direction:
Approved
Assignee:
Martin Hickey
Definition:
Approved
Series goal:
Accepted for mitaka
Implementation:
Implemented
Milestone target:
milestone icon mitaka-2
Started by
Kyle Mestery on 2015-07-22
Completed by
Ihar Hrachyshka on 2015-12-21

Related branches

Sprints

Whiteboard

Dec-21-2015(armax): source repos contain instructions on how to generate config files. Devref documentation available in:

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

Dec-07-2015(armax): *-aas parts need to catch up, but it's close.

Related bug for config generator to handle multiple config files used in neutron: https://bugs.launchpad.net/oslo/+bug/1300546

Related bug for Neutron to use Oslo for config generator:
https://bugs.launchpad.net/neutron/+bug/1199963

Gerrit topic: https://review.openstack.org/#q,topic:bp/autogen-neutron-conf-file,n,z

Addressed by: https://review.openstack.org/203744
    Port help text for dvr_base_mac from neutron.conf

Addressed by: https://review.openstack.org/204206
    Automatically generate neutron.conf

Addressed by: https://review.openstack.org/#/c/204722/
    Neutron: Use generated config file if available

Gerrit topic: https://review.openstack.org/#q,topic:bug/1478512,n,z

Addressed by: https://review.openstack.org/207903
    Merge remote-tracking branch 'origin/master' into merge-branch

Remove Neutron core static example configuration files - addition
https://review.openstack.org/#/c/253395/

Addressed by: https://review.openstack.org/251348
    Remove Neutron core static example configuration files

Addressed by: https://review.openstack.org/251974
    Automatically generate neutron FWaaS configuration files

Addressed by: https://review.openstack.org/252981
    Automatically generate neutron LBaaS configuration files

Addressed by: https://review.openstack.org/253399
    Automatically generate neutron VPNaaS configuration files

Addressed by: https://review.openstack.org/253555
    Revert "Remove Neutron core static example configuration files"

Addressed by: https://review.openstack.org/254698
    Remove Neutron FWaaS static example configuration files

Addressed by: https://review.openstack.org/255944
    Remove Neutron LBaaS static example configuration files

Addressed by: https://review.openstack.org/257023
    Remove Neutron VPNaaS static example configuration files

(?)

Work Items

Work items:
Patches for the neutron-*aas repos: DONE
Devref documentation on how external neutron (networking-foo) repos should add their configs to neutron's: DONE

This blueprint contains Public information 
Everyone can see this information.