Generate the sample with oslo-config-generator

Change-Id: I38ebc1843730970e6e62d040e8558b533ed479b7

cloudkitty/common/config.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# Copyright 2014 Objectif Libre
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+#
+import copy
+import itertools
+
+import cloudkitty.api.app
+import cloudkitty.collector.ceilometer
+import cloudkitty.config
+import cloudkitty.openstack.common.lockutils
+import cloudkitty.openstack.common.log
+import cloudkitty.service
+import cloudkitty.storage
+
+__all__ = ['list_opts']
+
+_opts = [
+    ('auth', list(itertools.chain(
+        cloudkitty.config.auth_opts))),
+    ('api', list(itertools.chain(
+        cloudkitty.api.app.api_opts,))),
+    ('ceilometer_collector', list(itertools.chain(
+        cloudkitty.collector.ceilometer.ceilometer_collector_opts))),
+    ('collect', list(itertools.chain(
+        cloudkitty.config.collect_opts))),
+    ('output', list(itertools.chain(
+        cloudkitty.config.output_opts))),
+    ('state', list(itertools.chain(
+        cloudkitty.config.state_opts))),
+    ('storage', list(itertools.chain(
+        cloudkitty.storage.storage_opts))),
+    (None, list(itertools.chain(
+        cloudkitty.openstack.common.lockutils.util_opts,
+        cloudkitty.openstack.common.log.common_cli_opts,
+        cloudkitty.openstack.common.log.logging_cli_opts,
+        cloudkitty.api.app.auth_opts,
+        cloudkitty.service.service_opts)))
+]
+
+
+def list_opts():
+    return [(g, copy.deepcopy(o)) for g, o in _opts]

etc/cloudkitty/cloudkitty.conf.sample

@@ -1,617 +1,551 @@
 [DEFAULT]
 
 #
-# Options defined in oslo.messaging
+# From cloudkitty.common.config
+#
+
+# Enables or disables inter-process locks. (boolean value)
+#disable_process_locking = false
+
+# Directory to use for lock files. (string value)
+#lock_path = <None>
+
+# Print debugging output (set logging level to DEBUG instead of
+# default WARNING level). (boolean value)
+#debug = false
+
+# Print more verbose output (set logging level to INFO instead of
+# default WARNING level). (boolean value)
+#verbose = false
+
+# The name of a logging configuration file. This file is appended to
+# any existing logging configuration files. For details about logging
+# configuration files, see the Python logging module documentation.
+# (string value)
+# Deprecated group/name - [DEFAULT]/log_config
+#log_config_append = <None>
+
+# DEPRECATED. A logging.Formatter log message format string which may
+# use any of the available logging.LogRecord attributes. This option
+# is deprecated.  Please use logging_context_format_string and
+# logging_default_format_string instead. (string value)
+#log_format = <None>
+
+# Format string for %%(asctime)s in log records. Default: %(default)s
+# . (string value)
+#log_date_format = %Y-%m-%d %H:%M:%S
+
+# (Optional) Name of log file to output to. If no default is set,
+# logging will go to stdout. (string value)
+# Deprecated group/name - [DEFAULT]/logfile
+#log_file = <None>
+
+# (Optional) The base directory used for relative --log-file paths.
+# (string value)
+# Deprecated group/name - [DEFAULT]/logdir
+#log_dir = <None>
+
+# Use syslog for logging. Existing syslog format is DEPRECATED during
+# I, and will change in J to honor RFC5424. (boolean value)
+#use_syslog = false
+
+# (Optional) Enables or disables syslog rfc5424 format for logging. If
+# enabled, prefixes the MSG part of the syslog message with APP-NAME
+# (RFC5424). The format without the APP-NAME is deprecated in I, and
+# will be removed in J. (boolean value)
+#use_syslog_rfc_format = false
+
+# Syslog facility to receive log lines. (string value)
+#syslog_log_facility = LOG_USER
+
+# Configuration file for WSGI definition of API. (string value)
+#api_paste_config = api_paste.ini
+
+# Name of this node. This can be an opaque identifier. It is not
+# necessarily a hostname, FQDN, or IP address. However, the node name
+# must be valid within an AMQP key, and if using ZeroMQ, a valid
+# hostname, FQDN, or IP address. (string value)
+#host = shock
+
+#
+# From oslo.messaging
 #
 
 # Use durable queues in AMQP. (boolean value)
 # Deprecated group/name - [DEFAULT]/rabbit_durable_queues
-#amqp_durable_queues=false
+#amqp_durable_queues = false
 
 # Auto-delete queues in AMQP. (boolean value)
-#amqp_auto_delete=false
+#amqp_auto_delete = false
 
 # Size of RPC connection pool. (integer value)
-#rpc_conn_pool_size=30
+#rpc_conn_pool_size = 30
 
 # Qpid broker hostname. (string value)
-#qpid_hostname=localhost
+#qpid_hostname = localhost
 
 # Qpid broker port. (integer value)
-#qpid_port=5672
+#qpid_port = 5672
 
 # Qpid HA cluster host:port pairs. (list value)
-#qpid_hosts=$qpid_hostname:$qpid_port
+#qpid_hosts = $qpid_hostname:$qpid_port
 
 # Username for Qpid connection. (string value)
-#qpid_username=
+#qpid_username =
 
 # Password for Qpid connection. (string value)
-#qpid_password=
+#qpid_password =
 
-# Space separated list of SASL mechanisms to use for auth.
-# (string value)
-#qpid_sasl_mechanisms=
-
-# Seconds between connection keepalive heartbeats. (integer
+# Space separated list of SASL mechanisms to use for auth. (string
 # value)
-#qpid_heartbeat=60
+#qpid_sasl_mechanisms =
+
+# Seconds between connection keepalive heartbeats. (integer value)
+#qpid_heartbeat = 60
 
 # Transport to use, either 'tcp' or 'ssl'. (string value)
-#qpid_protocol=tcp
+#qpid_protocol = tcp
 
 # Whether to disable the Nagle algorithm. (boolean value)
-#qpid_tcp_nodelay=true
+#qpid_tcp_nodelay = true
 
-# The number of prefetched messages held by receiver. (integer
-# value)
-#qpid_receiver_capacity=1
+# The number of prefetched messages held by receiver. (integer value)
+#qpid_receiver_capacity = 1
 
-# The qpid topology version to use.  Version 1 is what was
-# originally used by impl_qpid.  Version 2 includes some
-# backwards-incompatible changes that allow broker federation
-# to work.  Users should update to version 2 when they are
-# able to take everything down, as it requires a clean break.
-# (integer value)
-#qpid_topology_version=1
+# The qpid topology version to use.  Version 1 is what was originally
+# used by impl_qpid.  Version 2 includes some backwards-incompatible
+# changes that allow broker federation to work.  Users should update
+# to version 2 when they are able to take everything down, as it
+# requires a clean break. (integer value)
+#qpid_topology_version = 1
 
-# SSL version to use (valid only if SSL enabled). valid values
-# are TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on
-# some distributions. (string value)
-#kombu_ssl_version=
+# SSL version to use (valid only if SSL enabled). valid values are
+# TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on some
+# distributions. (string value)
+#kombu_ssl_version =
 
 # SSL key file (valid only if SSL enabled). (string value)
-#kombu_ssl_keyfile=
+#kombu_ssl_keyfile =
 
 # SSL cert file (valid only if SSL enabled). (string value)
-#kombu_ssl_certfile=
+#kombu_ssl_certfile =
 
-# SSL certification authority file (valid only if SSL
-# enabled). (string value)
-#kombu_ssl_ca_certs=
-
-# How long to wait before reconnecting in response to an AMQP
-# consumer cancel notification. (floating point value)
-#kombu_reconnect_delay=1.0
-
-# The RabbitMQ broker address where a single node is used.
+# SSL certification authority file (valid only if SSL enabled).
 # (string value)
-#rabbit_host=localhost
+#kombu_ssl_ca_certs =
 
-# The RabbitMQ broker port where a single node is used.
-# (integer value)
-#rabbit_port=5672
+# How long to wait before reconnecting in response to an AMQP consumer
+# cancel notification. (floating point value)
+#kombu_reconnect_delay = 1.0
+
+# The RabbitMQ broker address where a single node is used. (string
+# value)
+#rabbit_host = localhost
+
+# 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
+#rabbit_hosts = $rabbit_host:$rabbit_port
 
 # Connect over SSL for RabbitMQ. (boolean value)
-#rabbit_use_ssl=false
+#rabbit_use_ssl = false
 
 # The RabbitMQ userid. (string value)
-#rabbit_userid=guest
+#rabbit_userid = guest
 
 # The RabbitMQ password. (string value)
-#rabbit_password=guest
+#rabbit_password = guest
 
 # The RabbitMQ login method. (string value)
-#rabbit_login_method=AMQPLAIN
+#rabbit_login_method = AMQPLAIN
 
 # The RabbitMQ virtual host. (string value)
-#rabbit_virtual_host=/
+#rabbit_virtual_host = /
 
-# How frequently to retry connecting with RabbitMQ. (integer
-# value)
-#rabbit_retry_interval=1
+# How frequently to retry connecting with RabbitMQ. (integer value)
+#rabbit_retry_interval = 1
 
-# How long to backoff for between retries when connecting to
-# RabbitMQ. (integer value)
-#rabbit_retry_backoff=2
+# How long to backoff for between retries when connecting to RabbitMQ.
+# (integer value)
+#rabbit_retry_backoff = 2
 
 # Maximum number of RabbitMQ connection retries. Default is 0
 # (infinite retry count). (integer value)
-#rabbit_max_retries=0
+#rabbit_max_retries = 0
 
-# Use HA queues in RabbitMQ (x-ha-policy: all). If you change
-# this option, you must wipe the RabbitMQ database. (boolean
-# value)
-#rabbit_ha_queues=false
+# Use HA queues in RabbitMQ (x-ha-policy: all). If you change this
+# option, you must wipe the RabbitMQ database. (boolean value)
+#rabbit_ha_queues = false
 
 # Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
 # (boolean value)
-#fake_rabbit=false
+#fake_rabbit = false
 
 # ZeroMQ bind address. Should be a wildcard (*), an ethernet
-# interface, or IP. The "host" option should point or resolve
-# to this address. (string value)
-#rpc_zmq_bind_address=*
+# interface, or IP. The "host" option should point or resolve to this
+# address. (string value)
+#rpc_zmq_bind_address = *
 
 # MatchMaker driver. (string value)
-#rpc_zmq_matchmaker=oslo.messaging._drivers.matchmaker.MatchMakerLocalhost
+#rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost
 
 # ZeroMQ receiver listening port. (integer value)
-#rpc_zmq_port=9501
+#rpc_zmq_port = 9501
 
 # Number of ZeroMQ contexts, defaults to 1. (integer value)
-#rpc_zmq_contexts=1
+#rpc_zmq_contexts = 1
 
-# Maximum number of ingress messages to locally buffer per
-# topic. Default is unlimited. (integer value)
-#rpc_zmq_topic_backlog=<None>
+# Maximum number of ingress messages to locally buffer per topic.
+# Default is unlimited. (integer value)
+#rpc_zmq_topic_backlog = <None>
 
 # Directory for holding IPC sockets. (string value)
-#rpc_zmq_ipc_dir=/var/run/openstack
+#rpc_zmq_ipc_dir = /var/run/openstack
 
-# Name of this node. Must be a valid hostname, FQDN, or IP
-# address. Must match "host" option, if running Nova. (string
-# value)
-#rpc_zmq_host=cloudkitty
+# Name of this node. Must be a valid hostname, FQDN, or IP address.
+# Must match "host" option, if running Nova. (string value)
+#rpc_zmq_host = localhost
 
-# Seconds to wait before a cast expires (TTL). Only supported
-# by impl_zmq. (integer value)
-#rpc_cast_timeout=30
+# Seconds to wait before a cast expires (TTL). Only supported by
+# impl_zmq. (integer value)
+#rpc_cast_timeout = 30
 
 # Heartbeat frequency. (integer value)
-#matchmaker_heartbeat_freq=300
+#matchmaker_heartbeat_freq = 300
 
 # Heartbeat time-to-live. (integer value)
-#matchmaker_heartbeat_ttl=600
+#matchmaker_heartbeat_ttl = 600
 
 # Size of RPC greenthread pool. (integer value)
-#rpc_thread_pool_size=64
+#rpc_thread_pool_size = 64
 
-# Driver or drivers to handle sending notifications. (multi
-# valued)
-#notification_driver=
+# Driver or drivers to handle sending notifications. (multi valued)
+#notification_driver =
 
 # AMQP topic used for OpenStack notifications. (list value)
 # Deprecated group/name - [rpc_notifier2]/topics
-#notification_topics=notifications
+#notification_topics = notifications
 
 # Seconds to wait for a response from a call. (integer value)
-#rpc_response_timeout=60
+#rpc_response_timeout = 60
 
 # A URL representing the messaging driver to use and its full
-# configuration. If not set, we fall back to the rpc_backend
-# option and driver specific configuration. (string value)
-#transport_url=<None>
+# configuration. If not set, we fall back to the rpc_backend option
+# and driver specific configuration. (string value)
+#transport_url = <None>
 
-# The messaging driver to use, defaults to rabbit. Other
-# drivers include qpid and zmq. (string value)
-#rpc_backend=rabbit
+# The messaging driver to use, defaults to rabbit. Other drivers
+# include qpid and zmq. (string value)
+#rpc_backend = rabbit
 
 # The default exchange under which topics are scoped. May be
-# overridden by an exchange name specified in the
-# transport_url option. (string value)
-#control_exchange=openstack
-
-
-#
-# Options defined in cloudkitty.service
-#
-
-# Name of this node. This can be an opaque identifier. It is
-# not necessarily a hostname, FQDN, or IP address. However,
-# the node name must be valid within an AMQP key, and if using
-# ZeroMQ, a valid hostname, FQDN, or IP address. (string
-# value)
-#host=cloudkitty
-
-
-#
-# Options defined in cloudkitty.api.app
-#
-
-# Configuration file for WSGI definition of API. (string
-# value)
-#api_paste_config=api_paste.ini
-
-
-#
-# Options defined in cloudkitty.openstack.common.lockutils
-#
-
-# Enables or disables inter-process locks. (boolean value)
-#disable_process_locking=false
-
-# Directory to use for lock files. (string value)
-#lock_path=<None>
-
-
-#
-# Options defined in cloudkitty.openstack.common.log
-#
-
-# Print debugging output (set logging level to DEBUG instead
-# of default WARNING level). (boolean value)
-#debug=false
-
-# Print more verbose output (set logging level to INFO instead
-# of default WARNING level). (boolean value)
-#verbose=false
-
-# Log output to standard error. (boolean value)
-#use_stderr=true
-
-# Format string to use for log messages with context. (string
-# value)
-#logging_context_format_string=%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s
-
-# Format string to use for log messages without context.
-# (string value)
-#logging_default_format_string=%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
-
-# Data to append to log format when level is DEBUG. (string
-# value)
-#logging_debug_format_suffix=%(funcName)s %(pathname)s:%(lineno)d
-
-# Prefix each line of exception output with this format.
-# (string value)
-#logging_exception_prefix=%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s
-
-# List of logger=LEVEL pairs. (list value)
-#default_log_levels=amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN
-
-# Enables or disables publication of error events. (boolean
-# value)
-#publish_errors=false
-
-# Enables or disables fatal status of deprecations. (boolean
-# value)
-#fatal_deprecations=false
-
-# The format for an instance that is passed with the log
-# message. (string value)
-#instance_format="[instance: %(uuid)s] "
-
-# The format for an instance UUID that is passed with the log
-# message. (string value)
-#instance_uuid_format="[instance: %(uuid)s] "
-
-# The name of a logging configuration file. This file is
-# appended to any existing logging configuration files. For
-# details about logging configuration files, see the Python
-# logging module documentation. (string value)
-# Deprecated group/name - [DEFAULT]/log_config
-#log_config_append=<None>
-
-# DEPRECATED. A logging.Formatter log message format string
-# which may use any of the available logging.LogRecord
-# attributes. This option is deprecated.  Please use
-# logging_context_format_string and
-# logging_default_format_string instead. (string value)
-#log_format=<None>
-
-# Format string for %%(asctime)s in log records. Default:
-# %(default)s . (string value)
-#log_date_format=%Y-%m-%d %H:%M:%S
-
-# (Optional) Name of log file to output to. If no default is
-# set, logging will go to stdout. (string value)
-# Deprecated group/name - [DEFAULT]/logfile
-#log_file=<None>
-
-# (Optional) The base directory used for relative --log-file
-# paths. (string value)
-# Deprecated group/name - [DEFAULT]/logdir
-#log_dir=<None>
-
-# Use syslog for logging. Existing syslog format is DEPRECATED
-# during I, and will change in J to honor RFC5424. (boolean
-# value)
-#use_syslog=false
-
-# (Optional) Enables or disables syslog rfc5424 format for
-# logging. If enabled, prefixes the MSG part of the syslog
-# message with APP-NAME (RFC5424). The format without the APP-
-# NAME is deprecated in I, and will be removed in J. (boolean
-# value)
-#use_syslog_rfc_format=false
-
-# Syslog facility to receive log lines. (string value)
-#syslog_log_facility=LOG_USER
+# overridden by an exchange name specified in the transport_url
+# option. (string value)
+#control_exchange = openstack
 
 
 [api]
 
 #
-# Options defined in cloudkitty.api.app
+# From cloudkitty.common.config
 #
 
 # Host serving the API. (string value)
-#host_ip=0.0.0.0
+#host_ip = 0.0.0.0
 
 # Host port serving the API. (integer value)
-#port=8888
+#port = 8888
 
 
 [auth]
 
 #
-# Options defined in cloudkitty.config
+# From cloudkitty.common.config
 #
 
 # OpenStack username. (string value)
-#username=
+#username =
 
 # OpenStack password. (string value)
-#password=
+#password =
 
 # OpenStack tenant. (string value)
-#tenant=
+#tenant =
 
 # OpenStack region. (string value)
-#region=
+#region =
 
 # OpenStack auth URL. (string value)
-#url=
+#url =
 
 
 [ceilometer_collector]
 
 #
-# Options defined in cloudkitty.collector.ceilometer
+# From cloudkitty.common.config
 #
 
 # OpenStack username. (string value)
-#username=cloudkitty
+#username = cloudkitty
 
 # OpenStack password. (string value)
-#password=
+#password =
 
 # OpenStack tenant. (string value)
-#tenant=service
+#tenant = service
 
 # OpenStack region. (string value)
-#region=
+#region =
 
 # OpenStack auth URL. (string value)
-#url=http://127.0.0.1:5000
+#url = http://127.0.0.1:5000
 
 
 [collect]
 
 #
-# Options defined in cloudkitty.config
+# From cloudkitty.common.config
 #
 
 # Data collector. (string value)
-#collector=ceilometer
+#collector = ceilometer
 
 # Number of samples to collect per call. (integer value)
-#window=1800
+#window = 1800
 
 # Billing period in seconds. (integer value)
-#period=3600
+#period = 3600
 
-# Wait for N periods before collecting new data. (integer
-# value)
-#wait_periods=2
+# Wait for N periods before collecting new data. (integer value)
+#wait_periods = 2
 
 # Services to monitor. (list value)
-#services=compute,image
+#services = compute,image
 
 
 [database]
 
 #
-# Options defined in oslo.db
+# From oslo.db
 #
 
 # The file name to use with SQLite. (string value)
-#sqlite_db=oslo.sqlite
+# Deprecated group/name - [DEFAULT]/sqlite_db
+#sqlite_db = oslo.sqlite
 
 # If True, SQLite uses synchronous mode. (boolean value)
-#sqlite_synchronous=true
+# Deprecated group/name - [DEFAULT]/sqlite_synchronous
+#sqlite_synchronous = true
 
 # The back end to use for the database. (string value)
 # Deprecated group/name - [DEFAULT]/db_backend
-#backend=sqlalchemy
+#backend = sqlalchemy
 
-# The SQLAlchemy connection string to use to connect to the
-# database. (string value)
+# The SQLAlchemy connection string to use to connect to the database.
+# (string value)
 # Deprecated group/name - [DEFAULT]/sql_connection
 # Deprecated group/name - [DATABASE]/sql_connection
 # Deprecated group/name - [sql]/connection
-#connection=<None>
+#connection = <None>
 
-# The SQLAlchemy connection string to use to connect to the
-# slave database. (string value)
-#slave_connection=<None>
+# The SQLAlchemy connection string to use to connect to the slave
+# database. (string value)
+#slave_connection = <None>
 
-# The SQL mode to be used for MySQL sessions. This option,
-# including the default, overrides any server-set SQL mode. To
-# use whatever SQL mode is set by the server configuration,
-# set this to no value. Example: mysql_sql_mode= (string
-# value)
-#mysql_sql_mode=TRADITIONAL
+# The SQL mode to be used for MySQL sessions. This option, including
+# the default, overrides any server-set SQL mode. To use whatever SQL
+# mode is set by the server configuration, set this to no value.
+# Example: mysql_sql_mode= (string value)
+#mysql_sql_mode = TRADITIONAL
 
-# Timeout before idle SQL connections are reaped. (integer
-# value)
+# Timeout before idle SQL connections are reaped. (integer value)
 # Deprecated group/name - [DEFAULT]/sql_idle_timeout
 # Deprecated group/name - [DATABASE]/sql_idle_timeout
 # Deprecated group/name - [sql]/idle_timeout
-#idle_timeout=3600
+#idle_timeout = 3600
 
-# Minimum number of SQL connections to keep open in a pool.
-# (integer value)
+# Minimum number of SQL connections to keep open in a pool. (integer
+# value)
 # Deprecated group/name - [DEFAULT]/sql_min_pool_size
 # Deprecated group/name - [DATABASE]/sql_min_pool_size
-#min_pool_size=1
+#min_pool_size = 1
 
-# Maximum number of SQL connections to keep open in a pool.
-# (integer value)
+# Maximum number of SQL connections to keep open in a pool. (integer
+# value)
 # Deprecated group/name - [DEFAULT]/sql_max_pool_size
 # Deprecated group/name - [DATABASE]/sql_max_pool_size
-#max_pool_size=<None>
+#max_pool_size = <None>
 
-# Maximum number of database connection retries during
-# startup. Set to -1 to specify an infinite retry count.
-# (integer value)
+# Maximum number of database connection retries during startup. Set to
+# -1 to specify an infinite retry count. (integer value)
 # Deprecated group/name - [DEFAULT]/sql_max_retries
 # Deprecated group/name - [DATABASE]/sql_max_retries
-#max_retries=10
+#max_retries = 10
 
-# Interval between retries of opening a SQL connection.
-# (integer value)
+# Interval between retries of opening a SQL connection. (integer
+# value)
 # Deprecated group/name - [DEFAULT]/sql_retry_interval
 # Deprecated group/name - [DATABASE]/reconnect_interval
-#retry_interval=10
+#retry_interval = 10
 
-# If set, use this value for max_overflow with SQLAlchemy.
-# (integer value)
+# If set, use this value for max_overflow with SQLAlchemy. (integer
+# value)
 # Deprecated group/name - [DEFAULT]/sql_max_overflow
 # Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow
-#max_overflow=<None>
+#max_overflow = <None>
 
-# Verbosity of SQL debugging information: 0=None,
-# 100=Everything. (integer value)
-# Deprecated group/name - [DEFAULT]/sql_connection_debug
-#connection_debug=0
-
-# Add Python stack traces to SQL as comment strings. (boolean
-# value)
-# Deprecated group/name - [DEFAULT]/sql_connection_trace
-#connection_trace=false
-
-# If set, use this value for pool_timeout with SQLAlchemy.
+# Verbosity of SQL debugging information: 0=None, 100=Everything.
 # (integer value)
-# Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout
-#pool_timeout=<None>
+# Deprecated group/name - [DEFAULT]/sql_connection_debug
+#connection_debug = 0
 
-# Enable the experimental use of database reconnect on
-# connection lost. (boolean value)
-#use_db_reconnect=false
+# Add Python stack traces to SQL as comment strings. (boolean value)
+# Deprecated group/name - [DEFAULT]/sql_connection_trace
+#connection_trace = false
 
-# Seconds between database connection retries. (integer value)
-#db_retry_interval=1
-
-# If True, increases the interval between database connection
-# retries up to db_max_retry_interval. (boolean value)
-#db_inc_retry_interval=true
-
-# If db_inc_retry_interval is set, the maximum seconds between
-# database connection retries. (integer value)
-#db_max_retry_interval=10
-
-# Maximum database connection retries before error is raised.
-# Set to -1 to specify an infinite retry count. (integer
+# If set, use this value for pool_timeout with SQLAlchemy. (integer
 # value)
-#db_max_retries=20
+# Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout
+#pool_timeout = <None>
+
+# Enable the experimental use of database reconnect on connection
+# lost. (boolean value)
+#use_db_reconnect = false
+
+# Seconds between retries of a database transaction. (integer value)
+#db_retry_interval = 1
+
+# If True, increases the interval between retries of a database
+# operation up to db_max_retry_interval. (boolean value)
+#db_inc_retry_interval = true
+
+# If db_inc_retry_interval is set, the maximum seconds between retries
+# of a database operation. (integer value)
+#db_max_retry_interval = 10
+
+# Maximum retries in case of connection error or deadlock error before
+# error is raised. Set to -1 to specify an infinite retry count.
+# (integer value)
+#db_max_retries = 20
 
 
 [matchmaker_redis]
 
 #
-# Options defined in oslo.messaging
+# From oslo.messaging
 #
 
 # Host to locate redis. (string value)
-#host=127.0.0.1
+#host = 127.0.0.1
 
 # Use this port to connect to redis host. (integer value)
-#port=6379
+#port = 6379
 
 # Password for Redis server (optional). (string value)
-#password=<None>
+#password = <None>
 
 
 [matchmaker_ring]
 
 #
-# Options defined in oslo.messaging
+# From oslo.messaging
 #
 
 # Matchmaker ring file (JSON). (string value)
 # Deprecated group/name - [DEFAULT]/matchmaker_ringfile
-#ringfile=/etc/oslo/matchmaker_ring.json
+#ringfile = /etc/oslo/matchmaker_ring.json
 
 
 [oslo_messaging_amqp]
 
 #
-# Options defined in oslo.messaging
+# From oslo.messaging
 #
 
-# address prefix used when sending to a specific server
-# (string value)
-#server_request_prefix=exclusive
+# address prefix used when sending to a specific server (string value)
+# Deprecated group/name - [amqp1]/server_request_prefix
+#server_request_prefix = exclusive
 
-# address prefix used when broadcasting to all servers (string
-# value)
-#broadcast_prefix=broadcast
+# address prefix used when broadcasting to all servers (string value)
+# Deprecated group/name - [amqp1]/broadcast_prefix
+#broadcast_prefix = broadcast
 
-# address prefix when sending to any server in group (string
-# value)
-#group_request_prefix=unicast
+# address prefix when sending to any server in group (string value)
+# Deprecated group/name - [amqp1]/group_request_prefix
+#group_request_prefix = unicast
 
 # Name for the AMQP container (string value)
-#container_name=<None>
+# Deprecated group/name - [amqp1]/container_name
+#container_name = <None>
 
-# Timeout for inactive connections (in seconds) (integer
-# value)
-#idle_timeout=0
+# Timeout for inactive connections (in seconds) (integer value)
+# Deprecated group/name - [amqp1]/idle_timeout
+#idle_timeout = 0
 
 # Debug: dump AMQP frames to stdout (boolean value)
-#trace=false
+# Deprecated group/name - [amqp1]/trace
+#trace = false
 
-# CA certificate PEM file for verifing server certificate
-# (string value)
-#ssl_ca_file=
-
-# Identifying certificate PEM file to present to clients
-# (string value)
-#ssl_cert_file=
-
-# Private key PEM file used to sign cert_file certificate
-# (string value)
-#ssl_key_file=
-
-# Password for decrypting ssl_key_file (if encrypted) (string
+# CA certificate PEM file for verifing server certificate (string
 # value)
-#ssl_key_password=<None>
+# Deprecated group/name - [amqp1]/ssl_ca_file
+#ssl_ca_file =
+
+# Identifying certificate PEM file to present to clients (string
+# value)
+# Deprecated group/name - [amqp1]/ssl_cert_file
+#ssl_cert_file =
+
+# Private key PEM file used to sign cert_file certificate (string
+# value)
+# Deprecated group/name - [amqp1]/ssl_key_file
+#ssl_key_file =
+
+# Password for decrypting ssl_key_file (if encrypted) (string value)
+# Deprecated group/name - [amqp1]/ssl_key_password
+#ssl_key_password = <None>
 
 # Accept clients using either SSL or plain TCP (boolean value)
-#allow_insecure_clients=false
+# Deprecated group/name - [amqp1]/allow_insecure_clients
+#allow_insecure_clients = false
 
 
 [output]
 
 #
-# Options defined in cloudkitty.config
+# From cloudkitty.common.config
 #
 
 # Backend for the output manager. (string value)
-#backend=cloudkitty.backend.file.FileBackend
+#backend = cloudkitty.backend.file.FileBackend
 
-# Storage directory for the file output backend. (string
-# value)
-#basepath=/var/lib/cloudkitty/states/
+# Storage directory for the file output backend. (string value)
+#basepath = /var/lib/cloudkitty/states/
 
 # Output pipeline (list value)
-#pipeline=osrf
+#pipeline = osrf
 
 
 [state]
 
 #
-# Options defined in cloudkitty.config
+# From cloudkitty.common.config
 #
 
 # Backend for the state manager. (string value)
-#backend=cloudkitty.backend.file.FileBackend
+#backend = cloudkitty.backend.file.FileBackend
 
 # Storage directory for the file state backend. (string value)
-#basepath=/var/lib/cloudkitty/states/
+#basepath = /var/lib/cloudkitty/states/
 
 
 [storage]
 
 #
-# Options defined in cloudkitty.storage
+# From cloudkitty.common.config
 #
 
 # Name of the storage backend driver. (string value)
-#backend=sqlalchemy
-
-
+#backend = sqlalchemy

etc/oslo-config-generator/cloudkitty.conf

@@ -0,0 +1,5 @@
+[DEFAULT]
+output_file = etc/cloudkitty/cloudkitty.conf.sample
+namespace = cloudkitty.common.config
+namespace = oslo.messaging
+namespace = oslo.db

setup.cfg

@@ -26,6 +26,9 @@ console_scripts =
     cloudkitty-storage-init = cloudkitty.cli.storage:main
     cloudkitty-writer = cloudkitty.cli.writer:main
 
+oslo.config.opts =
+    cloudkitty.common.config = cloudkitty.common.config:list_opts
+
 cloudkitty.collector.backends =
     ceilometer = cloudkitty.collector.ceilometer:CeilometerCollector
     meta = cloudkitty.collector.meta:MetaCollector

tools/config/check_uptodate.sh

@@ -1,29 +0,0 @@
-#!/usr/bin/env bash
-
-PROJECT_NAME=${PROJECT_NAME:-cloudkitty}
-CFGFILE_NAME=${PROJECT_NAME}.conf.sample
-
-if [ -e etc/${PROJECT_NAME}/${CFGFILE_NAME} ]; then
-    CFGFILE=etc/${PROJECT_NAME}/${CFGFILE_NAME}
-elif [ -e etc/${CFGFILE_NAME} ]; then
-    CFGFILE=etc/${CFGFILE_NAME}
-else
-    echo "${0##*/}: can not find config file"
-    exit 1
-fi
-
-TEMPDIR=`mktemp -d /tmp/${PROJECT_NAME}.XXXXXX`
-trap "rm -rf $TEMPDIR" EXIT
-
-tools/config/generate_sample.sh -b ./ -p ${PROJECT_NAME} -o ${TEMPDIR}
-if [ $? != 0 ]
-then
-    exit 1
-fi
-
-if ! diff -u ${TEMPDIR}/${CFGFILE_NAME} ${CFGFILE}
-then
-   echo "${0##*/}: ${PROJECT_NAME}.conf.sample is not up to date."
-   echo "${0##*/}: Please run ${0%%${0##*/}}generate_sample.sh."
-   exit 1
-fi

tools/config/generate_sample.sh

@@ -1,138 +0,0 @@
-#!/usr/bin/env bash
-
-# Generate sample configuration for your project.
-#
-# Aside from the command line flags, it also respects a config file which
-# should be named oslo.config.generator.rc and be placed in the same directory.
-#
-# You can then export the following variables:
-# CLOUDKITTY_CONFIG_GENERATOR_EXTRA_MODULES: list of modules to interrogate for options.
-# CLOUDKITTY_CONFIG_GENERATOR_EXTRA_LIBRARIES: list of libraries to discover.
-# CLOUDKITTY_CONFIG_GENERATOR_EXCLUDED_FILES: list of files to remove from automatic listing.
-
-print_hint() {
-    echo "Try \`${0##*/} --help' for more information." >&2
-}
-
-PARSED_OPTIONS=$(getopt -n "${0##*/}" -o hb:p:m:l:o: \
-                 --long help,base-dir:,package-name:,output-dir:,module:,library: -- "$@")
-
-if [ $? != 0 ] ; then print_hint ; exit 1 ; fi
-
-eval set -- "$PARSED_OPTIONS"
-
-while true; do
-    case "$1" in
-        -h|--help)
-            echo "${0##*/} [options]"
-            echo ""
-            echo "options:"
-            echo "-h, --help                show brief help"
-            echo "-b, --base-dir=DIR        project base directory"
-            echo "-p, --package-name=NAME   project package name"
-            echo "-o, --output-dir=DIR      file output directory"
-            echo "-m, --module=MOD          extra python module to interrogate for options"
-            echo "-l, --library=LIB         extra library that registers options for discovery"
-            exit 0
-            ;;
-        -b|--base-dir)
-            shift
-            BASEDIR=`echo $1 | sed -e 's/\/*$//g'`
-            shift
-            ;;
-        -p|--package-name)
-            shift
-            PACKAGENAME=`echo $1`
-            shift
-            ;;
-        -o|--output-dir)
-            shift
-            OUTPUTDIR=`echo $1 | sed -e 's/\/*$//g'`
-            shift
-            ;;
-        -m|--module)
-            shift
-            MODULES="$MODULES -m $1"
-            shift
-            ;;
-        -l|--library)
-            shift
-            LIBRARIES="$LIBRARIES -l $1"
-            shift
-            ;;
-        --)
-            break
-            ;;
-    esac
-done
-
-BASEDIR=${BASEDIR:-`pwd`}
-if ! [ -d $BASEDIR ]
-then
-    echo "${0##*/}: missing project base directory" >&2 ; print_hint ; exit 1
-elif [[ $BASEDIR != /* ]]
-then
-    BASEDIR=$(cd "$BASEDIR" && pwd)
-fi
-
-PACKAGENAME=${PACKAGENAME:-$(python setup.py --name)}
-TARGETDIR=$BASEDIR/$PACKAGENAME
-if ! [ -d $TARGETDIR ]
-then
-    echo "${0##*/}: invalid project package name" >&2 ; print_hint ; exit 1
-fi
-
-OUTPUTDIR=${OUTPUTDIR:-$BASEDIR/etc}
-# NOTE(bnemec): Some projects put their sample config in etc/,
-#               some in etc/$PACKAGENAME/
-if [ -d $OUTPUTDIR/$PACKAGENAME ]
-then
-    OUTPUTDIR=$OUTPUTDIR/$PACKAGENAME
-elif ! [ -d $OUTPUTDIR ]
-then
-    echo "${0##*/}: cannot access \`$OUTPUTDIR': No such file or directory" >&2
-    exit 1
-fi
-
-BASEDIRESC=`echo $BASEDIR | sed -e 's/\//\\\\\//g'`
-find $TARGETDIR -type f -name "*.pyc" -delete
-FILES=$(find $TARGETDIR -type f -name "*.py" ! -path "*/tests/*" \
-        -exec grep -l "Opt(" {} + | sed -e "s/^$BASEDIRESC\///g" | sort -u)
-
-RC_FILE="`dirname $0`/oslo.config.generator.rc"
-if test -r "$RC_FILE"
-then
-    source "$RC_FILE"
-fi
-
-for filename in ${CLOUDKITTY_CONFIG_GENERATOR_EXCLUDED_FILES}; do
-    FILES="${FILES[@]/$filename/}"
-done
-
-for mod in ${CLOUDKITTY_CONFIG_GENERATOR_EXTRA_MODULES}; do
-    MODULES="$MODULES -m $mod"
-done
-
-for lib in ${CLOUDKITTY_CONFIG_GENERATOR_EXTRA_LIBRARIES}; do
-    LIBRARIES="$LIBRARIES -l $lib"
-done
-
-export EVENTLET_NO_GREENDNS=yes
-
-OS_VARS=$(set | sed -n '/^OS_/s/=[^=]*$//gp' | xargs)
-[ "$OS_VARS" ] && eval "unset \$OS_VARS"
-DEFAULT_MODULEPATH=cloudkitty.openstack.common.config.generator
-MODULEPATH=${MODULEPATH:-$DEFAULT_MODULEPATH}
-OUTPUTFILE=$OUTPUTDIR/$PACKAGENAME.conf.sample
-python -m $MODULEPATH $MODULES $LIBRARIES $FILES > $OUTPUTFILE
-if [ $? != 0 ]
-then
-    echo "Can not generate $OUTPUTFILE"
-    exit 1
-fi
-
-# Hook to allow projects to append custom config file snippets
-CONCAT_FILES=$(ls $BASEDIR/tools/config/*.conf.sample 2>/dev/null)
-for CONCAT_FILE in $CONCAT_FILES; do
-    cat $CONCAT_FILE >> $OUTPUTFILE
-done

tools/config/oslo.config.generator.rc

@@ -1 +0,0 @@
-CLOUDKITTY_CONFIG_GENERATOR_EXTRA_LIBRARIES="oslo.messaging oslo.db"

tox.ini

@@ -32,10 +32,8 @@ commands =
   {toxinidir}/tools/config/check_uptodate.sh
 
 [testenv:genconfig]
-sitepackages = False
-envdir = {toxworkdir}/venv
 commands =
-  {toxinidir}/tools/config/generate_sample.sh -b . -p cloudkitty -o etc/cloudkitty
+  oslo-config-generator --config-file etc/oslo-config-generator/cloudkitty.conf
 
 [testenv:docs]
 commands = python setup.py build_sphinx