Bug Fixes¶

• Adding the missingHostDomain config option. Previously this availabletype couldn’t been imported because no related config option was defined.

New Features¶

• AddHostDomain to handle address with underscore. Underscore areallowed in domain by RFC1033 [1][2][3].

  • [1]https://www.ietf.org/rfc/rfc1912.txt

  • [2]https://www.ietf.org/rfc/rfc1033.txt

  • [3]http://domainkeys.sourceforge.net/underscore.html

• Add a--check-defaults flag tooslo-config-validator. When set,oslo-config-validator will compare theinput-file with the samplegenerated configuration and flag any discrepancies. It also obeys thestandard--exclude-group and--fatal-warning options.

Upgrade Notes¶

• Support for Python 2.7 has been dropped. The minimum version of Python nowsupported is Python 3.6.

Upgrade Notes¶

• Positional options are now required by default, to match argparse’s defaultbehavior. To revert this behavior (and maintain optional positionalarguments), you need to explicitly specifypositional=True,required=False as part of the options definition.

Bug Fixes¶

• On the command line, oslo.config now returns command usage information fromargparse (instead of dumping a backtrace) when required arguments aremissing.

New Features¶

• Theoslo-config-validator tool now has a new option,--exclude-group, that allows deployers to ignore certain groups thatmight not appear in the sample config data, perhaps because the name ofthe group depends on other configuration values. This way the validatorcan still be used on the known groups.

New Features¶

• Support for accessing configuration data in environment variables via theenvironment backend driver, enabled by default. The environment is checkedafter command line options, but before configuration files.

  Environment variables are checked for any configuration data. The variablenames take the form:

  • A prefix ofOS_

  • The group name, uppercased

  • Separated from the option name by a__ (double underscore)

  • Followed by the name

  For an option that looks like this in the usual INI format:

  [placement_database]connection=sqlite:///

  the corresponding environment variable would beOS_PLACEMENT_DATABASE__CONNECTION.

New Features¶

• A validator for config files is now available. When run against a configfile, it will report an error for any options present that aren’t definedin the service and will report a warning for any deprecated options inthe file. In order to discover the available options for a service, itcan either use the sample config generator configuration file or amachine-readable sample config generated elsewhere.

New Features¶

• oslo.config now supports the fatal-deprecations option from oslo.log. Thisbehavior is only enabled if oslo.log is installed, but oslo.log is stillnot a hard requirement to avoid a circular dependency.

Upgrade Notes¶

• Because support for fatal-deprecations was added in this release, users whohave fatal-deprecations enabled and have deprecated config opts in use(which previously was not a problem because oslo.config didn’t respect thefatal-deprecations option) will need to resolve that before upgrading orservices may fail to start.

New Features¶

• String, Number, Integer, Float and Port now support value-descriptiontuples in the interable provided for thechoice parameter. Support forvalue-only definitions is retained.

• StringOpt and PortOpt now support a value-description tuples in theiterable provided for thechoice parameter. Support for value-onlydefinitions is retained.

• oslo-config-generator and the Sphinx extension will now outputdescriptions for option choices where provided. This will impact toolingthat relies on theyaml andjson output of the former.

New Features¶

• The sample config generator can now generate machine-readable formats ofthe sample config data. This can be consumed by deployment tools toautomatically generate configuration files that contain all of theinformation in the traditional sample configs.

New Features¶

• When a deprecated option is used, the message warning that the option isdeprecated now includes the reason for the deprecation, if there is one given.

Prelude¶

Configuration option type ofHostAddressOpt added to accept and validate both IP addresses and hostnames. Please refer to thefeatures section for more information.

New Features¶

• Configuration option type ofHostAddressOpt added to accept both valid IP address (IPv4 and IPv6) values as well as hostnames. TheHostAddressOpt will accept both IPv4 and IPv6 addresses and ensure that strict checks are performed on the IP versions. This option type will also accept and accurately validate hostnames ensuring that no invalid IP passes as a valid hostname.

New Features¶

• Add default config-dir paths if no –config-dir switches are given on thecommand line. This is similar to the default config-file handlingoslo.config already supports.If no –config-dir switches are given, oslo.config searches now in a coupleof directories (depending on the given project name) for config filesnippets. Non-existing directories are simply skipped.The directories, if no project name is given, are:

  • ~/${prog}.conf.d/

  • /etc/${prog}.conf.d/

  Only the first directory is used if that is available.If a project is given, the directories searched is a bit more complicated.2 directories are searched, first search is for the project related dir:

  • ~/.${project}/${project}.conf.d/

  • ~/${project}.conf.d/

  • /etc/${project}/${project}.conf.d/

  • /etc/${project}.conf.d/

  Then for the program name related configs, the following directories aresearched:

  • ~/.${project}/${prog}.conf.d/

  • ~/${prog}.conf.d/

  • /etc/${project}/${prog}.conf.d/

  • /etc/${prog}.conf.d/

Upgrade Notes¶

• Similar to ‘default_config_files’, ‘default_config_dirs’ is no longer an allowed config key. If that key is used, a ValueError() will be raised.

Other Notes¶

• Adding some default config-dirs makes it possible to use config dir snippets also in wsgi environments (like Apache) where it is not easily possible to pass command line parameters to a wsgi app.

New Features¶

• Integer and Float now supportmin,max andchoices. Choices must respectmin andmax (if provided).

• Added Port type as an Integer in the closed interval [0, 65535].

New Features¶

• Added minimum and maximum value limits to FloatOpt.

Other Notes¶

• Start using reno for managing release notes.