Centralize Config Options (partial - mitaka efforts)

Registered by Markus Zoeller (markus_z) on 2015-09-25

Nova has around 800 config options [1]. Those config options are the
interface to the cloud operators. Unfortunately they often lack a
good documentation which
* explains their impact,
* shows their interdependency to other config options and
* explains which of the Nova services they influence.
This cloud operator interface needs to be consolidated and one way of
doing this is, to move the config options from their declaration in
multiple modules to a few centrally managed modules. These centrally
managed modules should also provide the bigger picture of the
configuration surface we provide. This got already discussed on the
ML [2].

[1] see the "nova.flagmappings" file which get generated in the
    "openstack-manuals" project for the "configuration reference"
    manual.
[2] http://lists.openstack.org/pipermail/openstack-dev/2015-July/070306.html

Blueprint information

Status:
Complete
Approver:
John Garbutt
Priority:
Medium
Drafter:
Markus Zoeller (markus_z)
Direction:
Approved
Assignee:
Markus Zoeller (markus_z)
Definition:
Approved
Series goal:
Accepted for mitaka
Implementation:
Implemented
Milestone target:
milestone icon mitaka-3
Started by
Markus Zoeller (markus_z) on 2015-11-11
Completed by
John Garbutt on 2016-03-02

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:bp/centralize-config-options,n,z

Addressed by: https://review.openstack.org/227948
    Centralize Config Options

Addressed by: https://review.openstack.org/244177
    config options: centralize section "serial_console"

Addressed by: https://review.openstack.org/246465
    config options: enhance help test of section "serial_console"

Addressed by: https://review.openstack.org/245789
    review guide: add location details for config options

Addressed by: https://review.openstack.org/245891
    Config options: centralize section "scheduler"

Addressed by: https://review.openstack.org/247181
    WIP: Add better help text to scheduler options

Addressed by: https://review.openstack.org/248963
    config options: centralize section "guestfs"

Addressed by: https://review.openstack.org/250907
    config options: centralize libvirt options

Addressed by: https://review.openstack.org/251987
    libvirt: Add better help text for config options (rescue)

Addressed by: https://review.openstack.org/252389
    config options: centralize section: "rdp"

Addressed by: https://review.openstack.org/252687
    config options: centralize section "wsgi"

Addressed by: https://review.openstack.org/252832
    libvirt: Add better help text for config options (virt_type et al)

Addressed by: https://review.openstack.org/253437
    Config options: centralize section "scheduler"

Addressed by: https://review.openstack.org/253439
    libvirt: help text for config options (inject_data)

Addressed by: https://review.openstack.org/253556
    WIP: Add better help to rdp options

Addressed by: https://review.openstack.org/253747
    config options: centralize section "volume"

Addressed by: https://review.openstack.org/254092
    Config options: centralize "configdrive" options

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

Addressed by: https://review.openstack.org/253732
    config options: Centralise PCI options

Addressed by: https://review.openstack.org/255124
    Config options: centralize section "hyperv"

Addressed by: https://review.openstack.org/255133
    libvirt: config options help text (use_usb_tablet)

Addressed by: https://review.openstack.org/255044
    config options: centralize section: "keymgr"

Addressed by: https://review.openstack.org/255383
    WIP: Remove the opts.py from nova/scheduler

Addressed by: https://review.openstack.org/255436
    Move nova/opts.py to nova/conf/

Addressed by: https://review.openstack.org/255512
    Add better help text to scheduler options (1)

Addressed by: https://review.openstack.org/255513
    Add better help text to scheduler options (2)

Addressed by: https://review.openstack.org/255514
    Add better help text to scheduler options (3)

Addressed by: https://review.openstack.org/255515
    Add better help text to scheduler options (4)

Addressed by: https://review.openstack.org/255516
    Add better help text to scheduler options (5)

Addressed by: https://review.openstack.org/255517
    Add better help text to scheduler options (6)

Addressed by: https://review.openstack.org/255518
    Add better help text to scheduler options (7)

Addressed by: https://review.openstack.org/255578
    Add better help to the guestfs option

Addressed by: https://review.openstack.org/256094
    WIP: Add placeholders for config options

Addressed by: https://review.openstack.org/256344
    config options: Centralise hardware options

Addressed by: https://review.openstack.org/256368
    Improve 'virt' conf options documentation

Addressed by: https://review.openstack.org/256569
    WIP: config options: centralize section "service"

Addressed by: https://review.openstack.org/257087
    config options: Centralise floating ip options

Addressed by: https://review.openstack.org/257153
    config options: centralize section: "glance"

Addressed by: https://review.openstack.org/257176
    config options: centralize section: "compute" and "emphemeral_storage_encryption".

Addressed by: https://review.openstack.org/257956
    config options: Centralise driver options

Addressed by: https://review.openstack.org/257995
    config options: Centralise 'virt.firewall' options

Addressed by: https://review.openstack.org/258004
    config options: Centralise 'virt.images' options

Addressed by: https://review.openstack.org/258009
    config options: Centralise 'virt.netutils' options

Addressed by: https://review.openstack.org/258180
    Move config options from nova/api directory

Addressed by: https://review.openstack.org/258912
    config options: Centralise 'virt.disk' options

Addressed by: https://review.openstack.org/243335
    Improve 'pci' conf options documentation

Addressed by: https://review.openstack.org/258984
    config options: Centralise 'virt.imagecache' options

Addressed by: https://review.openstack.org/259014
    config options: Centralise 'virt.ironic' options

Addressed by: https://review.openstack.org/259406
    Config options: centralize base path configuration

Addressed by: https://review.openstack.org/259553
    WIP: Flesh out nova.conf.virt documentation

Addressed by: https://review.openstack.org/260015
    single point of entry for sample config generation

Addressed by: https://review.openstack.org/260181
    Config options: centralize section "cells"

Addressed by: https://review.openstack.org/260586
    Improve the help text for the API options (1)

Addressed by: https://review.openstack.org/260587
    Improve the help text for the API options (2)

Addressed by: https://review.openstack.org/260588
    Improve the help text for the API options (3)

Addressed by: https://review.openstack.org/263460
    Single point of entry for sample config generation

Addressed by: https://review.openstack.org/234836
    Put deprecated vnc items into its own group

Addressed by: https://review.openstack.org/235398
    make xvp proxy into vnc group

Addressed by: https://review.openstack.org/263763
    config options: Centralise 'vnc' options

Addressed by: https://review.openstack.org/263804
    config options: centralize section "database" + "api_database"

Addressed by: https://review.openstack.org/263812
    config options: Move wsgi options into a group

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

Gerrit topic: https://review.openstack.org/#q,topic:document_osapi_max_limit-patch5,n,z

Addressed by: https://review.openstack.org/264271
    config options: centralize 'spice' options

Addressed by: https://review.openstack.org/266273
    Improve 'vnc' conf options documentation

Addressed by: https://review.openstack.org/266364
    Improve 'virt.driver' conf options documentation

Addressed by: https://review.openstack.org/266365
    Improve 'virt.firewall' conf options documentation

Addressed by: https://review.openstack.org/266875
    Improve the help text for configdrive options

Addressed by: https://review.openstack.org/267014
    spec update: centralize-config-options

Addressed by: https://review.openstack.org/267022
    cleanup: Don't call import_opt for 'vcpu_pin_set'

Addressed by: https://review.openstack.org/267841
    Move config options from nova/cert directory

Addressed by: https://review.openstack.org/268175
    Improve the help text for hyperv options

Addressed by: https://review.openstack.org/268186
    Improve the help text for the cert options

Addressed by: https://review.openstack.org/269240
    Move config options from nova/objects/network.py

Addressed by: https://review.openstack.org/269313
    Improve help text for the network object options

Addressed by: https://review.openstack.org/269635
    config options: Make noVNC proxy into vnc group

Addressed by: https://review.openstack.org/269910
    config options: centralize 'spice' options

Addressed by: https://review.openstack.org/270263
    config options: centralize s3 opts

Addressed by: https://review.openstack.org/270441
    Move config options from nova/network/linux_net.py

Addressed by: https://review.openstack.org/270959
    Improve the help text for the linuxnet options (1)

Addressed by: https://review.openstack.org/271354
    Consider deprecating isolated_images

Addressed by: https://review.openstack.org/271489
    Improve the help text for the linuxnet options (2)

Addressed by: https://review.openstack.org/271546
    Config options: centralize options in availability_zones

Addressed by: https://review.openstack.org/272231
    Improve the help text for the linuxnet options (3)

Addressed by: https://review.openstack.org/272949
    config options: centralize section "cloudpipe"

Addressed by: https://review.openstack.org/272959
    config options: centralize section "monitors"

Addressed by: https://review.openstack.org/273208
    Improve the help text for the EC2 API options (1)

Addressed by: https://review.openstack.org/273209
    Improve the help text for the EC2 API options (2)

Addressed by: https://review.openstack.org/273266
    Improve the help text for the legacy API options

Addressed by: https://review.openstack.org/273898
    config options: centralize section: "keymgr"

Addressed by: https://review.openstack.org/273916
    config options: centralize section: "crypto"

Addressed by: https://review.openstack.org/274126
    Improve the help text for the metadata API options

Addressed by: https://review.openstack.org/274259
    Config options: centralize options in conductor api

Addressed by: https://review.openstack.org/274698
    Improve the help text for cells options

Addressed by: https://review.openstack.org/274879
    Improve the help text for the OSAPI options

Addressed by: https://review.openstack.org/275423
    Improve the help text for the linuxnet options (4)

Addressed by: https://review.openstack.org/274298
    Config options: Centralize debugger options

Addressed by: https://review.openstack.org/276087
    Improve the help text for cells options (2)

Addressed by: https://review.openstack.org/276088
    Improve the help text for cells options (3)

Addressed by: https://review.openstack.org/276090
    Improve the help text for cells options (4)

Addressed by: https://review.openstack.org/276095
    Improve the help text for cells options (5)

Addressed by: https://review.openstack.org/276099
    Improve the help text for cells options (6)

Addressed by: https://review.openstack.org/277392
    Update the CONF import path for VNC

Addressed by: https://review.openstack.org/278023
    config options: Remove 'wsgi_' prefix from opts

Addressed by: https://review.openstack.org/278024
    trivial: Fix alignment of wsgi options

Addressed by: https://review.openstack.org/278235
    Improve the help text for hyperv options (2)

Addressed by: https://review.openstack.org/278236
    Improve the help text for hyperv options (3)

Addressed by: https://review.openstack.org/278927
    Improve the help text for cells options (7)

Addressed by: https://review.openstack.org/279507
    Removal of unnecessary `import_opt`s for cells config options

Addressed by: https://review.openstack.org/279540
    Removal of unnecessary `import_opt`s for centralized config options

Addressed by: https://review.openstack.org/280370
    Move config options from nova/network/manager.py

Addressed by: https://review.openstack.org/280415
    Improve the help text for the network options (1)

Addressed by: https://review.openstack.org/280438
    Improve the help text for the network options (2)

Addressed by: https://review.openstack.org/281901
    Improve the help text for the network options (3)

Addressed by: https://review.openstack.org/281942
    config options: Centralize 'nova.rpc' options

Addressed by: https://review.openstack.org/282039
    Improve the help text for the network options (4)

Addressed by: https://review.openstack.org/293118
    Config options: Centralize consoleauth options

Addressed by: https://review.openstack.org/294211
    Config options: Centralize resource tracker options

Addressed by: https://review.openstack.org/294312
    Config options: Centralize netconf options

Addressed by: https://review.openstack.org/294382
    Config options: centralize test service options

Addressed by: https://review.openstack.org/294179
    Config options: Centralize ldapdns options

Addressed by: https://review.openstack.org/294261
    Config options: Centralize console options

Gerrit topic: https://review.openstack.org/#q,topic:bp/centralize-config-options-newton,n,z

Addressed by: https://review.openstack.org/297838
    config options: centralize xenserver options

Addressed by: https://review.openstack.org/222113
    Config options: centralize common console options

Addressed by: https://review.openstack.org/300036
    Config options: make console a group

Addressed by: https://review.openstack.org/349959
    Group scheduler options

Addressed by: https://review.openstack.org/362708
    Add usage of the allow_resize_same_host

Gerrit topic: https://review.openstack.org/#q,topic:bp/centralize-config-options-ocata,n,z

Addressed by: https://review.openstack.org/397835
    conf: Remove 'vendordata_driver' opt

(?)

Work Items

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.