oslo-config-validator

oslo-config-validator

oslo-config-validator is a utility for verifying that the entries in a config file are correct. It will report an error for any options found that are not defined by the service, and a warning for any deprecated options found.

New in version 6.5.0.

Usage

There are two primary ways to use the config validator. It can use the sample config generator configuration file found in each service to determine the list of available options, or it can consume a machine-readable sample config that provides the same information.

Sample Config Generator Configuration

Note

When using this method, all dependencies of the service must be installed in the environment where the validator is run.

There are two parameters that must be passed to the validator in this case: --config-file and --input-file. --config-file should point at the location of the sample config generator configuration file, while --input-file should point at the location of the configuration file to be validated.

Here’s an example of using the validator on Nova as installed by Devstack:

$ oslo-config-validator --config-file /opt/stack/nova/etc/nova/nova-config-generator.conf --input-file /etc/nova/nova.conf
ERROR:root:keystone_authtoken/user_domain_name not found
ERROR:root:keystone_authtoken/password not found
ERROR:root:keystone_authtoken/project_domain_name not found
ERROR:root:keystone_authtoken/project_name not found
ERROR:root:keystone_authtoken/username not found
ERROR:root:keystone_authtoken/auth_url not found

Machine-Readable Sample Config

Note

For most accurate results, the machine-readable sample config should be generated from the same version of the code as is running on the system whose config file is being validated.

In this case, a machine-readable sample config must first be generated, as described in oslo-config-generator.

This file is then passed to the validator with --opt-data, along with the config file to validated in --input-file as above.

Here’s an example of using the validator on Nova as installed by Devstack, with a sample config file config-data.yaml created by the config generator:

$ oslo-config-validator --opt-data config-data.yaml --input-file /etc/nova/nova.conf
ERROR:root:keystone_authtoken/username not found
ERROR:root:keystone_authtoken/project_domain_name not found
ERROR:root:keystone_authtoken/user_domain_name not found
ERROR:root:keystone_authtoken/project_name not found
ERROR:root:keystone_authtoken/password not found
ERROR:root:keystone_authtoken/auth_url not found
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.