Configuration Options from oslo.config¶
When loading values from the sources defined by the following options, the precedence is as follows:
- Command Line
- Environment Variables
- Config Files from
--config-dir
[1] - Config Files from
--config-file
- Pluggable Config Sources
If a value is specified in multiple locations, the location used will be the one higher in the list. For example, if a value is specified both on the command line and in an environment variable, the value from the command line will be the one returned.
[1] | Files in a config dir are parsed in alphabetical order. Later files take precedence over earlier ones. |
DEFAULT¶
-
config_file
¶ Type: list of filenames Default: ~/.project/project.conf,~/project.conf,/etc/project/project.conf,/etc/project.conf
Path to a config file to use. Multiple config files can be specified, with values in later files taking precedence. Defaults to the value above. This option must be set from the command-line.
-
config_dir
¶ Type: list of directory names Default: ~/.project/project.conf.d/,~/project.conf.d/,/etc/project/project.conf.d/,/etc/project.conf.d/
Path to a config directory to pull *.conf files from. This file set is sorted, so as to provide a predictable parse order if individual options are over-ridden. The set is parsed after the file(s) specified via previous –config-file, arguments hence over-ridden options in the directory take precedence. This option must be set from the command-line.
-
config_source
¶ Type: list Default: u''
Lists configuration groups that provide more details for accessing configuration settings from locations other than local files.
sample_remote_file_source¶
Example of using a remote_file source
remote_file: A backend driver for remote files served through http[s].
- Required options:
- uri: URI containing the file location.
- Non-required options:
- ca_path: The path to a CA_BUNDLE file or directory with
- certificates of trusted CAs.
- client_cert: Client side certificate, as a single file path
- containing either the certificate only or the private key and the certificate.
- client_key: Client side private key, in case client_cert is
- specified but does not includes the private key.
-
driver
¶ Type: string Default: remote_file
This option has a sample default set, which means that its actual default value may vary from the one documented above.
The name of the driver that can load this configuration source.
-
uri
¶ Type: URI Default: https://example.com/my-configuration.ini
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Required option with the URI of the extra configuration file’s location.
-
ca_path
¶ Type: string Default: /etc/ca-certificates
This option has a sample default set, which means that its actual default value may vary from the one documented above.
The path to a CA_BUNDLE file or directory with certificates of trusted CAs.
-
client_cert
¶ Type: string Default: /etc/ca-certificates/service-client-keystore
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Client side certificate, as a single file path containing either the certificate only or the private key and the certificate.
-
client_key
¶ Type: string Default: <None>
Client side private key, in case client_cert is specified but does not includes the private key.