# The sys module lets you get at the command line arguments.
import sys
# Load up the cfg module, which contains all the classes and methods
# you'll need.
from oslo_config import cfg
# Define an option group
grp = cfg.OptGroup('mygroup')
# Define a couple of options
opts = [cfg.StrOpt('option1'),


        cfg.IntOpt('option2', default=42)]
# Register your config group
cfg.CONF.register_group(grp)
# Register your options within the config group
cfg.CONF.register_opts(opts, group=grp)
# Process command line arguments.  The arguments tell CONF where to
# find your config file, which it loads and parses to populate itself.
cfg.CONF(sys.argv[1:])
# Now you can access the values from the config file as
# CONF.<group>.<opt>
print("The value of option1 is %s" % cfg.CONF.mygroup.option1)
print("The value of option2 is %d" % cfg.CONF.mygroup.option2)

[mygroup]
option1 = foo
# Comment out option2 to test the default value
# option2 = 123

python oslocfgtest.py --config-file oslocfgtest.conf

The value of option1 is foo
The value of option2 is 42

[DEFAULT]
# Print debugging output (set logging level to DEBUG instead
# of default WARNING level). (boolean value)
debug = true
[database]
# The SQLAlchemy connection string used to connect to the
# database (string value)
connection = mysql+pymysql://keystone:KEYSTONE_DBPASS@controller/keystone

# The RabbitMQ broker address where a single node is used.
# (string value)
rabbit_host = controller
# The RabbitMQ broker port where a single node is used.
# (integer value)
rabbit_port = 5672
# RabbitMQ HA cluster host:port pairs. (list value)
rabbit_hosts = $rabbit_host:$rabbit_port

ldap_dns_password = $$xkj432

ldap_dns_password='a password with spaces'

Type

list of filenames

Default

['~/.project/project.conf', '~/project.conf', '/etc/project/project.conf', '/etc/project.conf']

Type

list of directory names

Default

['~/.project/project.conf.d/', '~/project.conf.d/', '/etc/project/project.conf.d/', '/etc/project.conf.d/']

Type

list

Default

[]

•

uri: URI containing the file location.

•

•

•

Type

string

Default

remote_file

Type

URI

Default

https://example.com/my-configuration.ini

Type

string

Default

/etc/ca-certificates

Type

string

Default

/etc/ca-certificates/service-client-keystore

Type

string

Default

<None>

Type

string

Default

60

•

uri: URI containing the file location.

•

•

•

abstract get(group_name, option_name, opt)

Return the value of the option from the group.

abstract list_options_for_discovery()

Return the list of options available to configure a new source.

Drivers should advertise all supported options in this method for the purpose of sample generation by oslo-config-generator.

For an example on how to implement this method you can check the remote_file driver at oslo_config.sources._uri.URIConfigurationSourceDriver.

abstract open_source_from_opt_group(conf, group_name)

Return an open configuration source.

Uses group_name to find the configuration settings for the new source and then open the configuration source and return it.

If a source cannot be open, raises an appropriate exception.

Parameters

class GroupAttr(conf, group)

Bases: Mapping

Helper class.

Represents the option values of a group as a mapping and attributes.

class StrSubWrapper(conf, group=None, namespace=None)

Bases: object

Helper class.

Exposes opt values as a dict for string substitution.

class SubCommandAttr(conf, group, dest)

Bases: object

Helper class.

Represents the name and arguments of an argparse sub-parser.

class Template(template)

Bases: Template

clear()

Reset the state of the object to before options were registered.

This method removes all registered options and discards the data from the command line and configuration files.

Any subparsers added using the add_cli_subparsers() will also be removed as a side-effect of this method.

clear_default(name, group=None)

Clear an override an opt's default value.

Clear a previously set override of the default value of given option.

clear_override(name, group=None)

Clear an override an opt value.

Clear a previously set override of the command line, config file and default values of a given option.

property config_dirs

disallow_names = ('project', 'prog', 'version', 'usage', 'default_config_files', 'default_config_dirs')

find_file(name)

Locate a file located alongside the config files.

Search for a file with the supplied basename in the directories which we have already loaded config files from and other known configuration directories.

The directory, if any, supplied by the config_dir option is searched first. Then the config_file option is iterated over and each of the base directories of the config_files values are searched. Failing both of these, the standard directories searched by the module level find_config_files() function is used. The first matching file is returned.

get_location(name, group=None)

Return the location where the option is being set.

SEE ALSO:

Added in version 5.3.0.

import_group(group, module_str)

Import an option group from a module.

Import a module and check that a given option group is registered.

This is intended for use with global configuration objects like cfg.CONF where modules commonly register options with CONF at module load time. If one module requires an option group defined by another module it can use this method to explicitly declare the dependency.

import_opt(name, module_str, group=None)

Import an option definition from a module.

Import a module and check that a given option is registered.

This is intended for use with global configuration objects like cfg.CONF where modules commonly register options with CONF at module load time. If one module requires an option defined by another module it can use this method to explicitly declare the dependency.

list_all_sections()

List all sections from the configuration.

Returns a sorted list of all section names found in the configuration files, whether declared beforehand or not.

log_opt_values(logger, lvl)

Log the value of all registered opts.

It's often useful for an app to log its configuration to a log file at startup for debugging. This method dumps to the entire config state to the supplied logger at a given log level.

mutate_config_files()

Reload configure files and parse all options.

Only options marked as 'mutable' will appear to change.

Hooks are called in a NON-DETERMINISTIC ORDER. Do not expect hooks to be called in the same order as they were added.

print_help(file=None)

Print the help message for the current program.

This method is for use after all CLI options are known registered using __call__() method. If this method is called before the __call__() is invoked, it throws NotInitializedError

print_usage(file=None)

Print the usage message for the current program.

This method is for use after all CLI options are known registered using __call__() method. If this method is called before the __call__() is invoked, it throws NotInitializedError

register_cli_opt(opt, group=None)

Register a CLI option schema.

CLI option schemas must be registered before the command line and config files are parsed. This is to ensure that all CLI options are shown in --help and option validation works as expected.

register_cli_opts(opts, group=None)

Register multiple CLI option schemas at once.

register_group(group)

Register an option group.

An option group must be registered before options can be registered with the group.

register_mutate_hook(hook)

Registers a hook to be called by mutate_config_files.

register_opt(opt, group=None, cli=False)

Register an option schema.

Registering an option schema makes any option value which is previously or subsequently parsed from the command line or config files available as an attribute of this object.

register_opts(opts, group=None)

Register multiple option schemas at once.

reload_config_files()

Reload configure files and parse all options

reset()

Clear the object state and unset overrides and defaults.

set_default(name, default, group=None)

Override an opt's default value.

Override the default value of given option. A command line or config file value will still take precedence over this default.

set_override(name, override, group=None)

Override an opt value.

Override the command line, config file and default values of a given option.

supported_shell_completion = ['bash', 'zsh']

unregister_opt(opt, group=None)

Unregister an option.

unregister_opts(opts, group=None)

Unregister multiple CLI option schemas at once.

assignment(key, value)

Called when a full assignment is parsed.

error_no_section()

new_section(section)

Called when a new section is started.

parse()

parse_exc(msg, lineno, line=None)

Common base class for all non-exit exceptions.

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

detail

Alias for field number 1

location

Alias for field number 0

command_line = (5, True)

environment = (6, True)

opt_default = (1, False)

set_default = (2, False)

set_override = (3, False)

user = (4, True)

Parameters

multi = True

Parameters

Parameters

name

the name of the option, which may include hyphens

type

a callable object that takes string and returns converted and validated value. Default types are available from oslo_config.types

dest

the (hyphen-less) ConfigOpts property which contains the option value

short

a single character CLI option name

default

the default value of the option

sample_default

a sample default value string to include in sample config files

positional

True if the option is a positional CLI argument

metavar

the name shown as the argument to a CLI option in --help output

help

a string explaining how the option's value is used

advanced

in sample files, a bool value indicating the option is advanced

multi = False

name

the name of the group

title

the group title as displayed in --help

help

the group description as displayed in --help

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

config(**kw)

Override configuration values.

The keyword arguments are the names of configuration options to override and their values.

If a group argument is supplied, the overrides are applied to the specified configuration option group, otherwise the overrides are applied to the default group.

load_raw_values(group=None, **kwargs)

Load raw values into the configuration without registering them.

This method adds a series of parameters into the current config instance, as if they had been loaded by a ConfigParser. This method does not require that you register the configuration options first, however the values loaded will not be accessible until you do.

register_cli_opt(opt, group=None)

Register a single CLI option for the test run.

Options registered in this manner will automatically be unregistered during cleanup.

If a group argument is supplied, it will register the new option to that group, otherwise the option is registered to the default group.

CLI options must be registered before the command line and config files are parsed. This is to ensure that all CLI options are shown in --help and option validation works as expected.

register_cli_opts(opts, group=None)

Register multiple CLI options for the test run.

This works in the same manner as register_opt() but takes a list of options as the first argument. All arguments will be registered to the same group if the group argument is supplied, otherwise all options will be registered to the default group.

CLI options must be registered before the command line and config files are parsed. This is to ensure that all CLI options are shown in --help and option validation works as expected.

register_opt(opt, group=None)

Register a single option for the test run.

Options registered in this manner will automatically be unregistered during cleanup.

If a group argument is supplied, it will register the new option to that group, otherwise the option is registered to the default group.

register_opts(opts, group=None)

Register multiple options for the test run.

This works in the same manner as register_opt() but takes a list of options as the first argument. All arguments will be registered to the same group if the group argument is supplied, otherwise all options will be registered to the default group.

setUp()

Prepare the Fixture for use.

This should not be overridden. Concrete fixtures should implement _setUp. Overriding of setUp is still supported, just not recommended.

After setUp has completed, the fixture will have one or more attributes which can be used (these depend totally on the concrete subclass).

set_config_dirs(config_dirs)

Specify a list of config dirs to read.

This method allows you to predefine the list of configuration dirs that are loaded by oslo_config. It will ensure that your tests do not attempt to autodetect, and accidentally pick up config files from locally installed services.

set_config_files(config_files)

Specify a list of config files to read.

This method allows you to predefine the list of configuration files that are loaded by oslo_config. It will ensure that your tests do not attempt to autodetect, and accidentally pick up config files from locally installed services.

set_default(name, default, group=None)

Set a default value for an option.

This method is not necessarily meant to be invoked directly. It is here to allow the set_defaults() functions in various Oslo libraries to work with a Config fixture instead of a ConfigOpts instance.

Use it like:

class MyTest(testtools.TestCase):


    def setUp(self):


        super(MyTest, self).setUp()


        self.conf = self.useFixture(fixture.Config())


    def test_something(self):


        some_library.set_defaults(self.conf, name='value')


        some_library.do_something_exciting()

Parameters

conf -- a ConfigOpts instance containing the generator's configuration

Parameters

Parameters

conf -- a ConfigOpts instance

Raises

DuplicateOptError, ArgsAlreadyParsedError

assignment(key, value)

Called when a full assignment is parsed.

comment(comment)

Called when a comment is parsed.

error_empty_key(line)

error_invalid_assignment(line)

error_no_section_end_bracket(line)

error_no_section_name(line)

error_unexpected_continuation(line)

lineno = 0

new_section(section)

Called when a new section is started.

parse(lineiter)

parse_exc

alias of ParseError

directives: dict[str, type[Directive]] = {'group': <class 'oslo_config.sphinxext.ConfigGroup'>, 'option': <class 'oslo_config.sphinxext.ConfigOption'>}

directive name -> directive class

initial_data: dict = {'groups': {}, 'options': {}}

data value for a fresh environment

label = 'oslo.config'

domain label: longer, more descriptive (used in messages)

merge_domaindata(docnames, otherdata)

Merge in data regarding docnames from a different domaindata inventory (coming from a subprocess in parallel builds).

name = 'oslo.config'

domain name: should be short, but unique

object_types: dict[str, ObjType] = {'configoption': <sphinx.domains.ObjType object>}

type (usually directive) name -> ObjType instance

resolve_xref(env, fromdocname, builder, typ, target, node, contnode)

Resolve cross-references

roles: dict[str, RoleFunction | XRefRole] = {'group': <oslo_config.sphinxext.ConfigGroupXRefRole object>, 'option': <oslo_config.sphinxext.ConfigOptXRefRole object>}

role name -> role callable

has_content = True

May the directive have content?

option_spec = {'namespace': <function unchanged>}

Mapping of option names to validator functions.

optional_arguments = 0

Number of optional arguments after the required arguments.

required_arguments = 1

Number of required directive arguments.

run()

process_link(env, refnode, has_explicit_title, title, target)

Called after parsing title and target text, and creating the reference node (given in refnode). This method can alter the reference node and must return a new (or the same) (title, target) tuple.

process_link(env, refnode, has_explicit_title, title, target)

Called after parsing title and target text, and creating the reference node (given in refnode). This method can alter the reference node and must return a new (or the same) (title, target) tuple.

add_target_and_index(firstname, sig, signode)

Add cross-reference IDs and entries to self.indexnode, if applicable.

name is whatever handle_signature() returned.

handle_signature(sig, signode)

Transform an option description into RST nodes.

has_content = True

May the directive have content?

option_spec = {'config-file': <function unchanged>, 'split-namespaces': <function flag>}

Mapping of option names to validator functions.

run()

Parameters

type_name -- Type name to be used in the sample config file.

FALSE_VALUES = ['false', '0', 'off', 'no']

TRUE_VALUES = ['true', '1', 'on', 'yes']

NONE_DEFAULT = '<None>'

format_defaults(default, sample_default=None)

Return a list of formatted default values.

quote_trailing_and_leading_space(str_val)

Parameters

Parameters

Parameters

Parameters

DOMAIN_REGEX = '(?!-)[A-Z0-9-_]{1,63}(?<!-)$'

Parameters

type_name -- Type name to be used in the sample config file.

HOSTNAME_REGEX = '(?!-)[A-Z0-9-]{1,63}(?<!-)$'

Parameters

Parameters

Parameters

NONE_DEFAULT = ['']

format_defaults(default, sample_default=None)

Return a list of formatted default values.

Parameters

Parameters

PORT_MAX = 65535

PORT_MIN = 0

Parameters

Parameters

Parameters

value

from oslo_config import cfg
from oslo_config import types
PortType = types.Integer(1, 65535)
common_opts = [


    cfg.StrOpt('bind_host',


               default='0.0.0.0',


               help='IP address to listen on.'),


    cfg.Opt('bind_port',


            type=PortType,


            default=9292,


            help='Port number to listen on.')
]

enabled_apis_opt = cfg.ListOpt('enabled_apis',


                               default=['ec2', 'osapi_compute'],


                               help='List of APIs to enable by default.')
DEFAULT_EXTENSIONS = [


    'nova.api.openstack.compute.contrib.standard_extensions'
]
osapi_compute_extension_opt = cfg.MultiStrOpt('osapi_compute_extension',


                                              default=DEFAULT_EXTENSIONS)

class ExtensionManager:


    enabled_apis_opt = cfg.ListOpt(...)


    def __init__(self, conf):


        self.conf = conf


        self.conf.register_opt(enabled_apis_opt)


        ...


    def _load_extensions(self):


        for ext_factory in self.conf.osapi_compute_extension:


            ....

opts = ...
def add_common_opts(conf):


    conf.register_opts(opts)
def get_bind_host(conf):


    return conf.bind_host
def get_bind_port(conf):


    return conf.bind_port

cli_opts = [


    cfg.BoolOpt('verbose',


                short='v',


                default=False,


                help='Print more verbose output.'),


    cfg.BoolOpt('debug',


                short='d',


                default=False,


                help='Print debugging output.'),
]
def add_common_opts(conf):


    conf.register_cli_opts(cli_opts)

rabbit_group = cfg.OptGroup(name='rabbit',


                            title='RabbitMQ options')
rabbit_host_opt = cfg.StrOpt('host',


                             default='localhost',


                             help='IP/hostname to listen on.'),
rabbit_port_opt = cfg.PortOpt('port',


                              default=5672,


                              help='Port number to listen on.')
def register_rabbit_opts(conf):


    conf.register_group(rabbit_group)


    # options can be registered under a group in either of these ways:


    conf.register_opt(rabbit_host_opt, group=rabbit_group)


    conf.register_opt(rabbit_port_opt, group='rabbit')

def register_rabbit_opts(conf):


    # The group will automatically be created, equivalent calling:


    #   conf.register_group(OptGroup(name='rabbit'))


    conf.register_opt(rabbit_port_opt, group='rabbit')

glance-api.conf:


  [DEFAULT]


  bind_port = 9292


  ...


  [rabbit]


  host = localhost


  port = 5672


  use_ssl = False


  userid = guest


  password = guest


  virtual_host = /

--rabbit-host localhost --rabbit-port 9999

opts = [


    cfg.StrOpt('service_name', required=True),


    cfg.StrOpt('image_id', required=True),


    ...
]

opts = [


   cfg.StrOpt('s3_store_access_key', secret=True),


   cfg.StrOpt('s3_store_secret_key', secret=True),


   ...
]

opts = [


    cfg.DictOpt('foo',


                default={})
]

[DEFAULT]
foo = k1:v1,k2:v2

from oslo_config import cfg
opts = [


    cfg.StrOpt('option1', default='default_value',


                advanced=True, help='This is help '


                'text.'),


    cfg.PortOpt('option2', default='default_value',


                 help='This is help text.'),
]
CONF = cfg.CONF
CONF.register_opts(opts)

[DEFAULT]
...
# This is help text. (string value)
# option2 = default_value
...
<pushed to bottom of section>
...
# This is help text. (string value)
# Advanced Option: intended for advanced users and not used
# by the majority of users, and might have a significant
# effect on stability and/or performance.
# option1 = default_value

server.start(app, conf.bind_port, conf.bind_host, conf)
self.connection = kombu.connection.BrokerConnection(


    hostname=conf.rabbit.host,


    port=conf.rabbit.port,


    ...)

class ConfigOpts:


    def __call__(self, ...):


        opts = [


            MultiStrOpt('config-file',


                    ...),


            StrOpt('config-dir',


                   ...),


        ]


        self.register_cli_opts(opts)

glance-api.conf:


  [DEFAULT]


  bind_port = 9292
glance-common.conf:


  [DEFAULT]


  bind_host = 0.0.0.0

conf = cfg.ConfigOpts()
conf.register_opt(cfg.BoolOpt('verbose', ...))
conf(sys.argv[1:])
if conf.verbose:


    ...

opts = [


    cfg.StrOpt('state_path',


               default=os.path.join(os.path.dirname(__file__), '../'),


               help='Top-level directory for maintaining nova state.'),


    cfg.StrOpt('sqlite_db',


               default='nova.sqlite',


               help='File name for SQLite.'),


    cfg.StrOpt('sql_connection',


               default='sqlite:///$state_path/$sqlite_db',


               help='Connection string for SQL database.'),
]

>>> conf = cfg.ConfigOpts()
>>> conf.register_cli_opt(cfg.MultiStrOpt('bar', positional=True))
True
>>> conf(['a', 'b'])
>>> conf.bar
['a', 'b']

>>> def add_parsers(subparsers):
...     list_action = subparsers.add_parser('list')
...     list_action.add_argument('id')
...
>>> conf = cfg.ConfigOpts()
>>> conf.register_cli_opt(cfg.SubCommandOpt('action', handler=add_parsers))
True
>>> conf(args=['list', '10'])
>>> conf.action.name, conf.action.id
('list', '10')

from oslo_config import cfg
conf = cfg.ConfigOpts()
opt_1 = cfg.StrOpt('opt_1', default='foo', deprecated_name='opt1')
opt_2 = cfg.StrOpt('opt_2', default='spam', deprecated_group='DEFAULT')
opt_3 = cfg.BoolOpt('opt_3', default=False, deprecated_for_removal=True)
conf.register_opt(opt_1, group='group_1')
conf.register_opt(opt_2, group='group_2')
conf.register_opt(opt_3)
conf(['--config-file', 'config.conf'])
assert conf.group_1.opt_1 == 'bar'
assert conf.group_2.opt_2 == 'eggs'
assert conf.opt_3

[group_1]
opt1 = bar
[DEFAULT]
opt_2 = eggs
opt_3 = True

from oslo_config import cfg
opts = [


    cfg.StrOpt('bind_host', default='0.0.0.0'),


    cfg.PortOpt('bind_port', default=9292),
]
CONF = cfg.CONF
CONF.register_opts(opts)
def start(server, app):


    server.start(app, CONF.bind_port, CONF.bind_host)

cfg.StrOpt('bind_host',


           default='0.0.0.0',


           help='IP address to listen on.'),
cfg.PortOpt('bind_port',


            default=9292,


            help='Port number to listen on.')

• The option is checked every time
• The option is cached on the stack
• The option affects state

service.ProcessLauncher(CONF, restart_method='mutate')

while True:


    progress_timeout = CONF.libvirt.live_migration_progress_timeout


    completion_timeout = int(


        CONF.libvirt.live_migration_completion_timeout * data_gb)


    if libvirt_migrate.should_abort(instance, now, progress_time,


                                    progress_timeout, completion_timeout):


        guest.abort_job()

progress_timeout = CONF.libvirt.live_migration_progress_timeout
completion_timeout = int(


    CONF.libvirt.live_migration_completion_timeout * data_gb)
while True:


    if libvirt_migrate.should_abort(instance, now, progress_time,


                                    progress_timeout, completion_timeout):


        guest.abort_job()

def _mutate_hook(conf, fresh):


    if (None, 'debug') in fresh:


        if conf.debug:


            log_root.setLevel(logging.DEBUG)
def register_options(conf):


    ... snip ...


    conf.register_mutate_hook(_mutate_hook)

{ (group, option_name): (old_value, new_value), ... }

{ (None, 'debug'): (False, True),


  ('libvirt', 'live_migration_progress_timeout'): (50, 75) }

loc = CONF.get_location('normal_opt').location
if loc.is_user_controlled:


   print('normal_opt was set by the user')
else:


   print('normal_opt was set by the application')

1.

config_file

2.

DEFAULT.config_file

config_generator_config_file = [


    ('../../etc/glance-api.conf', 'api'),


    ('../../etc/glance-cache.conf', 'cache'),


    ('../../etc/glance-glare.conf', None),


    ('../../etc/glance-registry.conf', None),


    ('../../etc/glance-scrubber.conf', None),
]

[DEFAULT]
config_source = external_config_group
[external_config_group]
driver = remote_file
uri = http://mydomain.com/path/to/config/data.conf

[DEFAULT]
config_source = external_config_group
[external_config_group]
driver = remote_file
uri = https://mydomain.com/path/to/config/data.conf
ca_path = /path/to/server/ca.pem
client_key = /path/to/my/key.pem
client_cert = /path/to/my/cert.pem

Required options:

Non-required options:

Parameters

[placement_database]
connection = sqlite:///

def set_defaults(logging_context_format_string=None,


                 default_log_levels=None):


    """Set default values for the configuration options used by oslo.log."""


    # Just in case the caller is not setting the


    # default_log_level. This is insurance because


    # we introduced the default_log_level parameter


    # later in a backwards in-compatible change


    if default_log_levels is not None:


        cfg.set_defaults(


            _options.log_opts,


            default_log_levels=default_log_levels)


    if logging_context_format_string is not None:


        cfg.set_defaults(


            _options.log_opts,


            logging_context_format_string=logging_context_format_string)

cfg.CONF.set_default('default_log_levels', default_log_levels)

log_file = cfg.CONF.log_file

oslo-config-generator


   --namespace <namespace> [--namespace <namespace> ...]


   [--output-file <output-file>]


   [--wrap-width <wrap-width>]


   [--format <format>]


   [--minimal]


   [--summarize]

Default

stdout

Default

70

Choices

ini, json, yaml

$ oslo-config-generator --namespace oslo.messaging > oslo.messaging.conf

$ oslo-config-generator --namespace myapp \


    --namespace oslo.messaging > myapp.conf

$ oslo-config-generator --namespace oslo.messaging \


    --format json > oslo.messaging.conf

[entry_points]
oslo.config.opts =


    oslo.messaging = oslo.messaging.opts:list_opts

from oslo_config import cfg
opts1 = [


    cfg.StrOpt('foo'),


    cfg.StrOpt('bar'),
]
opts2 = [


    cfg.StrOpt('baz'),
]
baz_group = cfg.OptGroup(name='baz_group'


                         title='Baz group options',


                         help='Baz group help text')
cfg.CONF.register_group(baz_group)
cfg.CONF.register_opts(opts1, group='blaa')
cfg.CONF.register_opts(opts2, group=baz_group)
def list_opts():


    # Allows the generation of the help text for


    # the baz_group OptGroup object. No help


    # text is generated for the 'blaa' group.


    return [('blaa', opts1), (baz_group, opts2)]

[entry_points]
oslo.config.opts.defaults =


    keystone = keystone.common.config:update_opt_defaults

In this case, the name of the entry point for the default override function must match the name of one of the entry points defining options for the application in order to be detected and used. Applications that have multiple list_opts functions should use one that is present in the inputs for the config generator where the changed defaults need to appear. For example, if an application defines foo.api to list the API-related options, and needs to override the defaults in the oslo.middleware.cors library, the application should register foo.api under oslo.config.opts.defaults and point to a function within the application code space that changes the defaults for oslo.middleware.cors.

from oslo_log import log
def update_opt_defaults():


    log.set_defaults(


        default_log_levels=log.get_default_log_levels() + ['noisy=WARN'],


    )

generator_options:


  config_dir: []


  config_file: []


  format_: yaml


  minimal: false


  namespace:


  - keystone


  output_file: null


  summarize: false


  wrap_width: 70
options:


  DEFAULT:


    help: ''


    opts:


    - advanced: false


      choices: []


      default: null


      deprecated_for_removal: false


      deprecated_opts: []


      deprecated_reason: null


      deprecated_since: null


      dest: admin_token


      help: Using this feature is *NOT* recommended. Instead, use the `keystone-manage


        bootstrap` command. The value of this option is treated as a "shared secret"


        that can be used to bootstrap Keystone through the API. This "token" does


        not represent a user (it has no identity), and carries no explicit authorization


        (it effectively bypasses most authorization checks). If set to `None`, the


        value is ignored and the `admin_token` middleware is effectively disabled.


        However, to completely disable `admin_token` in production (highly recommended,


        as it presents a security risk), remove `AdminTokenAuthMiddleware` (the `admin_token_auth`


        filter) from your paste application pipelines (for example, in `keystone-paste.ini`).


      max: null


      metavar: null


      min: null


      mutable: false


      name: admin_token


      namespace: keystone


      positional: false


      required: false


      sample_default: null


      secret: true


      short: null


      type: string value


    - ...


  ...
deprecated_options:


  DEFAULT:


  - name: bind_host


    replacement_group: eventlet_server


    replacement_name: public_bind_host

For information on the various attributes of each option, refer to oslo_config.cfg.Opt and its subclasses.

[entry_points]
oslo.config.opts =


    nova.common = nova.config:list_common_opts


    nova.api = nova.config:list_api_opts


    nova.compute = nova.config:list_compute_opts

$ oslo-config-generator --namespace oslo.messaging \


                        --namespace nova.common \


                        --namespace nova.api > nova-api.conf
$ oslo-config-generator --namespace oslo.messaging \


                        --namespace nova.common \


                        --namespace nova.compute > nova-compute.conf

$ cat > config-generator/api.conf <<EOF
[DEFAULT]
output_file = etc/nova/nova-api.conf
namespace = oslo.messaging
namespace = nova.common
namespace = nova.api
EOF
$ cat > config-generator/compute.conf <<EOF
[DEFAULT]
output_file = etc/nova/nova-compute.conf
namespace = oslo.messaging
namespace = nova.common
namespace = nova.compute
EOF
$ oslo-config-generator --config-file config-generator/api.conf
$ oslo-config-generator --config-file config-generator/compute.conf

cfg.StrOpt('base_dir'


           default=os.getcwd(),


           sample_default='/usr/lib/myapp')

$ oslo-config-validator --config-file /opt/stack/nova/etc/nova/nova-config-generator.conf --input-file /etc/nova/nova.conf
ERROR:root:foo/bar is not part of the sample config
INFO:root:Ignoring missing option "project_domain_name" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "project_name" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "user_domain_name" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "password" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "username" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "auth_url" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.

$ oslo-config-validator --opt-data config-data.yaml --input-file /etc/nova/nova.conf
ERROR:root:foo/bar is not part of the sample config
INFO:root:Ignoring missing option "project_domain_name" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "project_name" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "user_domain_name" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "password" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "username" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "auth_url" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.

$ oslo-config-validator --input-file /etc/nova/nova.conf \


                        --check-defaults \


                        --namespace nova.conf \


                        --namespace oslo.log \


                        --namespace oslo.messaging \


                        --namespace oslo.policy \


                        --namespace oslo.privsep \


                        --namespace oslo.service.periodic_task \


                        --namespace oslo.service.service \


                        --namespace oslo.db \


                        --namespace oslo.middleware \


                        --namespace oslo.concurrency \


                        --namespace keystonemiddleware.auth_token \


                        --namespace osprofiler
INFO:keyring.backend:Loading Gnome
INFO:keyring.backend:Loading Google
INFO:keyring.backend:Loading Windows (alt)
INFO:keyring.backend:Loading file
INFO:keyring.backend:Loading keyczar
INFO:keyring.backend:Loading multi
INFO:keyring.backend:Loading pyfs
WARNING:root:DEFAULT/compute_driver sample value is empty but input-file has libvirt.LibvirtDriver
WARNING:root:DEFAULT/allow_resize_to_same_host sample value is empty but input-file has True
WARNING:root:DEFAULT/default_ephemeral_format sample value is empty but input-file has ext4
WARNING:root:DEFAULT/pointer_model sample value ['usbtablet'] is not in ['ps2mouse']
WARNING:root:DEFAULT/instances_path sample value ['$state_path/instances'] is not in ['/opt/stack/data/nova/instances']
WARNING:root:DEFAULT/shutdown_timeout sample value ['60'] is not in ['0']
INFO:root:DEFAULT/my_ip Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:DEFAULT/state_path sample value ['$pybasedir'] is not in ['/opt/stack/data/nova']
INFO:root:DEFAULT/osapi_compute_listen Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:DEFAULT/osapi_compute_workers sample value is empty but input-file has 2
WARNING:root:DEFAULT/metadata_workers sample value is empty but input-file has 2
WARNING:root:DEFAULT/graceful_shutdown_timeout sample value ['60'] is not in ['5']
INFO:root:DEFAULT/transport_url Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:DEFAULT/debug sample value is empty but input-file has True
WARNING:root:DEFAULT/logging_context_format_string sample value ['%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s'] is not in ['%(color)s%(levelname)s %(name)s [\x1b[01;36m%(global_request_id)s %(request_id)s \x1b[00;36m%(project_name)s %(user_name)s%(color)s] \x1b[01;35m%(instance)s%(color)s%(message)s\x1b[00m']
WARNING:root:DEFAULT/logging_default_format_string sample value ['%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s'] is not in ['%(color)s%(levelname)s %(name)s [\x1b[00;36m-%(color)s] \x1b[01;35m%(instance)s%(color)s%(message)s\x1b[00m']
WARNING:root:DEFAULT/logging_debug_format_suffix sample value ['%(funcName)s %(pathname)s:%(lineno)d'] is not in ['\x1b[00;33m{{(pid=%(process)d) %(funcName)s %(pathname)s:%(lineno)d}}\x1b[00m']
WARNING:root:DEFAULT/logging_exception_prefix sample value ['%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s'] is not in ['ERROR %(name)s \x1b[01;35m%(instance)s\x1b[00m']
WARNING:root:Group api from the sample config is not defined in input-file
WARNING:root:cache/backend sample value ['dogpile.cache.null'] is not in ['dogpile.cache.memcached']
WARNING:root:cache/enabled sample value is empty but input-file has True
WARNING:root:cinder/os_region_name sample value is empty but input-file has RegionOne
WARNING:root:cinder/auth_type sample value is empty but input-file has password
INFO:root:cinder/auth_url Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:cinder/project_name sample value is empty but input-file has service
WARNING:root:cinder/project_domain_name sample value is empty but input-file has Default
INFO:root:cinder/username Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:cinder/user_domain_name sample value is empty but input-file has Default
INFO:root:cinder/password Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:Group compute from the sample config is not defined in input-file
WARNING:root:conductor/workers sample value is empty but input-file has 2
WARNING:root:Group console from the sample config is not defined in input-file
WARNING:root:Group consoleauth from the sample config is not defined in input-file
WARNING:root:Group cyborg from the sample config is not defined in input-file
INFO:root:api_database/connection Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:Group devices from the sample config is not defined in input-file
WARNING:root:Group ephemeral_storage_encryption from the sample config is not defined in input-file
WARNING:root:Group glance from the sample config is not defined in input-file
WARNING:root:Group guestfs from the sample config is not defined in input-file
WARNING:root:Group hyperv from the sample config is not defined in input-file
WARNING:root:Group image_cache from the sample config is not defined in input-file
WARNING:root:Group ironic from the sample config is not defined in input-file
WARNING:root:key_manager/fixed_key sample value is empty but input-file has bae3516cc1c0eb18b05440eba8012a4a880a2ee04d584a9c1579445e675b12defdc716ec
WARNING:root:key_manager/backend sample value ['barbican'] is not in ['nova.keymgr.conf_key_mgr.ConfKeyManager']
WARNING:root:Group barbican from the sample config is not defined in input-file
WARNING:root:Group vault from the sample config is not defined in input-file
WARNING:root:Group keystone from the sample config is not defined in input-file
INFO:root:libvirt/live_migration_uri Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:libvirt/cpu_mode sample value is empty but input-file has none
WARNING:root:Group mks from the sample config is not defined in input-file
WARNING:root:neutron/default_floating_pool sample value ['nova'] is not in ['public']
WARNING:root:neutron/service_metadata_proxy sample value is empty but input-file has True
WARNING:root:neutron/auth_type sample value is empty but input-file has password
INFO:root:neutron/auth_url Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:neutron/project_name sample value is empty but input-file has service
WARNING:root:neutron/project_domain_name sample value is empty but input-file has Default
INFO:root:neutron/username Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:neutron/user_domain_name sample value is empty but input-file has Default
INFO:root:neutron/password Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:neutron/region_name sample value is empty but input-file has RegionOne
WARNING:root:Group pci from the sample config is not defined in input-file
WARNING:root:placement/auth_type sample value is empty but input-file has password
INFO:root:placement/auth_url Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:placement/project_name sample value is empty but input-file has service
WARNING:root:placement/project_domain_name sample value is empty but input-file has Default
INFO:root:placement/username Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:placement/user_domain_name sample value is empty but input-file has Default
INFO:root:placement/password Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:placement/region_name sample value is empty but input-file has RegionOne
WARNING:root:Group powervm from the sample config is not defined in input-file
WARNING:root:Group quota from the sample config is not defined in input-file
WARNING:root:Group rdp from the sample config is not defined in input-file
WARNING:root:Group remote_debug from the sample config is not defined in input-file
WARNING:root:scheduler/workers sample value is empty but input-file has 2
WARNING:root:filter_scheduler/track_instance_changes sample value ['True'] is not in ['False']
WARNING:root:filter_scheduler/enabled_filters sample value ['AvailabilityZoneFilter', 'ComputeFilter', 'ComputeCapabilitiesFilter', 'ImagePropertiesFilter', 'ServerGroupAntiAffinityFilter', 'ServerGroupAffinityFilter'] is not in ['AvailabilityZoneFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,ServerGroupAntiAffinityFilter,ServerGroupAffinityFilter,SameHostFilter,DifferentHostFilter']
WARNING:root:Group metrics from the sample config is not defined in input-file
WARNING:root:Group serial_console from the sample config is not defined in input-file
WARNING:root:Group service_user from the sample config is not defined in input-file
WARNING:root:Group spice from the sample config is not defined in input-file
WARNING:root:upgrade_levels/compute sample value is empty but input-file has auto
WARNING:root:Group vendordata_dynamic_auth from the sample config is not defined in input-file
WARNING:root:Group vmware from the sample config is not defined in input-file
WARNING:root:Group vnc from the sample config is not defined in input-file
WARNING:root:Group workarounds from the sample config is not defined in input-file
WARNING:root:wsgi/api_paste_config sample value ['api-paste.ini'] is not in ['/etc/nova/api-paste.ini']
WARNING:root:Group zvm from the sample config is not defined in input-file
WARNING:root:oslo_concurrency/lock_path sample value is empty but input-file has /opt/stack/data/nova
WARNING:root:Group oslo_middleware from the sample config is not defined in input-file
WARNING:root:Group cors from the sample config is not defined in input-file
WARNING:root:Group healthcheck from the sample config is not defined in input-file
WARNING:root:Group oslo_messaging_amqp from the sample config is not defined in input-file
WARNING:root:oslo_messaging_notifications/driver sample value is empty but input-file has messagingv2
INFO:root:oslo_messaging_notifications/transport_url Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:Group oslo_messaging_rabbit from the sample config is not defined in input-file
WARNING:root:Group oslo_messaging_kafka from the sample config is not defined in input-file
WARNING:root:Group oslo_policy from the sample config is not defined in input-file
WARNING:root:Group privsep from the sample config is not defined in input-file
WARNING:root:Group profiler from the sample config is not defined in input-file
INFO:root:database/connection Ignoring option because it is part of the excluded patterns. This can be changed with the --exclude-options argument.
WARNING:root:keystone_authtoken/interface sample value ['internal'] is not in ['public']
WARNING:root:keystone_authtoken/cafile sample value is empty but input-file has /opt/stack/data/ca-bundle.pem
WARNING:root:keystone_authtoken/memcached_servers sample value is empty but input-file has localhost:11211
WARNING:root:keystone_authtoken/auth_type sample value is empty but input-file has password
ERROR:root:neutron/auth_strategy is not part of the sample config
INFO:root:Ignoring missing option "project_domain_name" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "project_name" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "user_domain_name" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "password" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "username" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly.
INFO:root:Ignoring missing option "auth_url" from group "keystone_authtoken" because the group is known to have incomplete sample config data and thus cannot be validated properly