This information was valid at the time this article was written (juno-2).
UPDATE: Fixed Cinder, Heat and Ironic generate_sample.sh commands. Thanks Mike Spreitzer.
Each OpenStack project is a bit different. One of those differences is how sample config files are managed (or not) in the repository.
Here is a summary about how each project manage them.
Ceilometer
Ceilometer does not provide any sample config file in its repository.
To generate the sample config file, execute the following command:
tox -egenconfig
The sample config file will be located here:
- ./etc/ceilometer/ceilometer.conf.sample
Cinder
Cinder provides a sample config file in its repository.
The sample config file can be found here:
- ./etc/cinder/cinder.conf.sample
To (re)generate the sample config file, execute the following command:
tox -egenconfig
Before this change got merged, you had to execute the following command:
tox -evenv -- bash ./tools/config/generate_sample.sh -b . -p cinder -o etc/cinder
Glance
Glance provides multiple sample config files in its repository.
The sample config files can be found here:
- ./etc/glance/glance-api.conf
- ./etc/glance/glance-cache.conf
- ./etc/glance/glance-registry.conf
- ./etc/glance/glance-scrubber.conf
The current oslo.config.generator does not support configs being split in multiple config files. Therefore, they cannot not be regenerated. Someone already reported this limitation in oslo.config on Launchpad.
Julien Danjou recently suggested unifying all Glance config files into a single one. A blueprint already exists about it.
Heat
Heat provides a sample config file in its repository.
The sample config file can be found here:
- ./etc/heat/heat.conf.sample
To (re)generate the sample config file, execute the following command:
tox -evenv -- bash ./tools/config/generate_sample.sh -b . -p heat -o etc/heat
Horizon
Horizon provides a sample config file in its repository.
The sample config file can be found here:
- openstack_dashboard/local/local_settings.py.example
The sample config file does not use oslo.config and cannot be regenerated, it is manually updated.
Radomir Dopieralski proposes using oslo.config to manage Horizon configs. Thanks to Tom Fifield for pointing that one out on the openstack-operators mailinglist.
Ironic
Ironic provides a sample config file in its repository.
The sample config file can be found here:
- ./etc/ironic/ironic.conf.sample
To (re)generate the sample config file, execute the following command:
tox -egenconfig
Before this change got merged, you had to execute the following command:
tox -evenv -- bash ./tools/config/generate_sample.sh -b . -p ironic -o etc/ironic
Keystone
Keystone does not provide any sample config file in its repository.
To generate the sample config file, execute the following command:
tox -esample_config
The sample config file will be located here:
- ./etc/keystone/keystone.conf.sample
Neutron
Neutron provides multiple sample config files in its repository.
The sample config files can be found here:
- ./etc/dhcp_agent.ini
- ./etc/fwaas_driver.ini
- ./etc/l3_agent.ini
- ./etc/lbaas_agent.ini
- ./etc/metadata_agent.ini
- ./etc/metering_agent.ini
- ./etc/neutron.conf
- ./etc/services.conf
- ./etc/vpn_agent.ini
- ./etc/plugins/*
The current oslo.config.generator does not support configs being split in multiple config files. Therefore, they cannot not be regenerated. Someone already reported this limitation in oslo.config on Launchpad.
Note that a blueprint exists suggesting the sample config files should be removed in favor of auto-generated ones like Nova already does.
Nova
Nova does not provide any sample config file in its repository.
To generate the sample config file, execute the following command:
tox -egenconfig
The sample config file will be located here:
- ./etc/nova/nova.conf.sample
Swift
Swift provides multiple sample config files in its repository.
The sample config files can be found here:
- ./etc/account-server.conf-sample
- ./etc/container-server.conf-sample
- ./etc/dispersion-server.conf-sample
- ./etc/driver-audit.conf-sample
- ./etc/memcache.conf-sample
- ./etc/object-expirer.conf-sample
- ./etc/object-server.conf-sample
- ./etc/proxy-server.conf-sample
- ./etc/swift-bench.conf-sample
- ./etc/swift.conf-sample
Swift does not use oslo.config. Sample config files cannot be regenerated, they are manually updated.