diff --git a/.gitignore b/.gitignore index a55d9e254..a9a14577e 100644 --- a/.gitignore +++ b/.gitignore @@ -44,6 +44,8 @@ output/*/index.html # Sphinx doc/build doc/source/api +doc/source/samples +doc/source/watcher.conf.sample # pbr generates these AUTHORS diff --git a/doc/source/conf.py b/doc/source/conf.py index 94df31175..129eea81d 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -18,6 +18,7 @@ from watcher import version as watcher_version # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ + 'oslo_config.sphinxconfiggen', 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinxcontrib.httpdomain', @@ -28,7 +29,8 @@ extensions = [ ] wsme_protocols = ['restjson'] - +config_generator_config_file = '../../etc/watcher/watcher-config-generator.conf' +sample_config_basename = 'watcher' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. diff --git a/doc/source/config-generator.conf b/doc/source/config-generator.conf new file mode 100644 index 000000000..e704259f1 --- /dev/null +++ b/doc/source/config-generator.conf @@ -0,0 +1 @@ +../../etc/watcher/watcher-config-generator.conf diff --git a/doc/source/deploy/conf-files.rst b/doc/source/deploy/conf-files.rst new file mode 100644 index 000000000..792bc2ccd --- /dev/null +++ b/doc/source/deploy/conf-files.rst @@ -0,0 +1,14 @@ +.. _watcher_sample_configuration_files: + +================================== +Watcher sample configuration files +================================== + +watcher.conf +~~~~~~~~~~~~ + +The ``watcher.conf`` file contains most of the options to configure the +Watcher services. + +.. literalinclude:: ../watcher.conf.sample + :language: ini diff --git a/doc/source/deploy/configuration.rst b/doc/source/deploy/configuration.rst index 37a30f731..099814f8c 100644 --- a/doc/source/deploy/configuration.rst +++ b/doc/source/deploy/configuration.rst @@ -163,6 +163,16 @@ Configure the Watcher service The Watcher service is configured via its configuration file. This file is typically located at ``/etc/watcher/watcher.conf``. +You can easily generate and update a sample configuration file +named :ref:`watcher.conf.sample ` by using +these following commands:: + + $ git clone git://git.openstack.org/openstack/watcher + $ cd watcher/ + $ tox -econfig + $ vi etc/watcher/watcher.conf.sample + + The configuration file is organized into the following sections: * ``[DEFAULT]`` - General configuration diff --git a/doc/source/index.rst b/doc/source/index.rst index 95168d32c..ffa549103 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -55,9 +55,9 @@ Getting Started dev/environment dev/devstack deploy/configuration + deploy/conf-files dev/testing - API References -------------- diff --git a/etc/watcher/README-watcher.conf.txt b/etc/watcher/README-watcher.conf.txt new file mode 100644 index 000000000..dc45112ae --- /dev/null +++ b/etc/watcher/README-watcher.conf.txt @@ -0,0 +1,4 @@ +To generate the sample watcher.conf file, run the following +command from the top level of the watcher directory: + +tox -econfig \ No newline at end of file diff --git a/etc/watcher/watcher-config-generator.conf b/etc/watcher/watcher-config-generator.conf new file mode 100644 index 000000000..0bcaafae1 --- /dev/null +++ b/etc/watcher/watcher-config-generator.conf @@ -0,0 +1,9 @@ +[DEFAULT] +output_file = etc/watcher/watcher.conf.sample +wrap_width = 79 + +namespace = watcher +namespace = keystonemiddleware.auth_token +namespace = oslo.log +namespace = oslo.db +namespace = oslo.messaging diff --git a/etc/watcher/watcher.conf.sample b/etc/watcher/watcher.conf.sample deleted file mode 100644 index 46697c756..000000000 --- a/etc/watcher/watcher.conf.sample +++ /dev/null @@ -1,962 +0,0 @@ -[DEFAULT] - -# -# From oslo.log -# - -# Defines the format string for %(user_identity)s that is used in -# logging_context_format_string. (string value) -#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s - -# List of package logging levels in logger=LEVEL pairs. This option is -# ignored if log_config_append is set. (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,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN,keystoneauth=WARN - -# Enables or disables publication of error events. (boolean value) -#publish_errors = false - -# If set to true, the logging level will be set to DEBUG instead of -# the default INFO level. (boolean value) -#debug = 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] " - -# If set to false, the logging level will be set to WARNING instead of -# the default INFO level. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#verbose = true - -# Enables or disables fatal status of deprecations. (boolean value) -#fatal_deprecations = 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. -# Note that when logging configuration files are used all logging -# configuration is defined in the configuration file and other logging -# configuration options are ignored (for example, log_format). (string -# value) -# Deprecated group/name - [DEFAULT]/log_config -#log_config_append = - -# 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. This option is ignored if -# log_config_append is set. (string value) -#log_format = - -# Defines the format string for %%(asctime)s in log records. Default: -# %(default)s . This option is ignored if log_config_append is set. -# (string value) -#log_date_format = %Y-%m-%d %H:%M:%S - -# (Optional) Name of log file to send logging output to. If no default -# is set, logging will go to stderr as defined by use_stderr. This -# option is ignored if log_config_append is set. (string value) -# Deprecated group/name - [DEFAULT]/logfile -#log_file = - -# (Optional) The base directory used for relative log_file paths. -# This option is ignored if log_config_append is set. (string value) -# Deprecated group/name - [DEFAULT]/logdir -#log_dir = - -# Uses logging handler designed to watch file system. When log file is -# moved or removed this handler will open a new log file with -# specified path instantaneously. It makes sense only if log_file -# option is specified and Linux platform is used. This option is -# ignored if log_config_append is set. (boolean value) -#watch_log_file = false - -# Use syslog for logging. Existing syslog format is DEPRECATED and -# will be changed later to honor RFC5424. This option is ignored if -# log_config_append is set. (boolean value) -#use_syslog = false - -# 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 Kilo, and will be -# removed in Mitaka, along with this option. This option is ignored if -# log_config_append is set. (boolean value) -# This option is deprecated for removal. -# Its value may be silently ignored in the future. -#use_syslog_rfc_format = true - -# Syslog facility to receive log lines. This option is ignored if -# log_config_append is set. (string value) -#syslog_log_facility = LOG_USER - -# Log output to standard error. This option is ignored if -# log_config_append is set. (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 when context is undefined. -# (string value) -#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s - -# Additional data to append to log message when logging level for the -# message 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 ERROR %(name)s %(instance)s - -# -# From oslo.messaging -# - -# Size of executor thread pool. (integer value) -# Deprecated group/name - [DEFAULT]/rpc_thread_pool_size -#executor_thread_pool_size = 64 - -# Minimal port number for random ports range. (port value) -# Minimum value: 0 -# Maximum value: 65535 -#rpc_zmq_min_port = 49152 - -# Seconds to wait for a response from a call. (integer value) -#rpc_response_timeout = 60 - -# Size of RPC connection pool. (integer value) -# Deprecated group/name - [DEFAULT]/rpc_conn_pool_size -#rpc_conn_pool_size = 30 - -# 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 = - -# Number of retries to find free port number before fail with -# ZMQBindError. (integer value) -#rpc_zmq_bind_port_retries = 100 - -# The messaging driver to use, defaults to rabbit. Other drivers -# include amqp and zmq. (string value) -#rpc_backend = rabbit - -# Host to locate redis. (string value) -#host = 127.0.0.1 - -# 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 = * - -# MatchMaker driver. (string value) -#rpc_zmq_matchmaker = redis - -# 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 - -# Use this port to connect to redis host. (port value) -# Minimum value: 0 -# Maximum value: 65535 -#port = 6379 - -# Type of concurrency used. Either "native" or "eventlet" (string -# value) -#rpc_zmq_concurrency = eventlet - -# Password for Redis server (optional). (string value) -#password = - -# Number of ZeroMQ contexts, defaults to 1. (integer value) -#rpc_zmq_contexts = 1 - -# Maximum number of ingress messages to locally buffer per topic. -# Default is unlimited. (integer value) -#rpc_zmq_topic_backlog = - -# List of Redis Sentinel hosts (fault tolerance mode) e.g. -# [host:port, host1:port ... ] (list value) -#sentinel_hosts = - -# Directory for holding IPC sockets. (string value) -#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 = localhost - -# Redis replica set name. (string value) -#sentinel_group_name = oslo-messaging-zeromq - -# Seconds to wait before a cast expires (TTL). Only supported by -# impl_zmq. (integer value) -#rpc_cast_timeout = 30 - -# Time in ms to wait between connection attempts. (integer value) -#wait_timeout = 500 - -# The default number of seconds that poll should wait. Poll raises -# timeout exception when timeout expired. (integer value) -#rpc_poll_timeout = 1 - -# Time in ms to wait before the transaction is killed. (integer value) -#check_timeout = 20000 - -# Expiration timeout in seconds of a name service record about -# existing target ( < 0 means no timeout). (integer value) -#zmq_target_expire = 120 - -# Timeout in ms on blocking socket operations (integer value) -#socket_timeout = 1000 - -# Maximal port number for random ports range. (integer value) -# Minimum value: 1 -# Maximum value: 65536 -#rpc_zmq_max_port = 65536 - -# Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. -# (boolean value) -#use_pub_sub = true - - -[api] - -# -# From watcher -# - -# The port for the watcher API server (integer value) -#port = 9322 - -# The maximum number of items returned in a single response from a -# collection resource. (integer value) -#max_limit = 1000 - -# The listen IP for the watcher API server (string value) -#host = 0.0.0.0 - - -[ceilometer_client] - -# -# From watcher -# - -# Version of Ceilometer API to use in ceilometerclient. (string value) -#api_version = 2 - - -[cinder_client] - -# -# From watcher -# - -# Version of Cinder API to use in cinderclient. (string value) -#api_version = 2 - - -[database] - -# -# From oslo.db -# - -# 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 = - -# Add Python stack traces to SQL as comment strings. (boolean value) -# Deprecated group/name - [DEFAULT]/sql_connection_trace -#connection_trace = false - -# 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 = - -# If db_inc_retry_interval is set, the maximum seconds between retries -# of a database operation. (integer value) -#db_max_retry_interval = 10 - -# 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 - -# The file name to use with SQLite. (string value) -# Deprecated group/name - [DEFAULT]/sqlite_db -#sqlite_db = oslo.sqlite - -# 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 - -# If set, use this value for pool_timeout with SQLAlchemy. (integer -# value) -# Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout -#pool_timeout = - -# 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 - -# 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 - -# Enable the experimental use of database reconnect on connection -# lost. (boolean value) -#use_db_reconnect = false - -# The SQLAlchemy connection string to use to connect to the slave -# database. (string value) -#slave_connection = - -# 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 - -# 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 = - -# If True, SQLite uses synchronous mode. (boolean value) -# Deprecated group/name - [DEFAULT]/sqlite_synchronous -#sqlite_synchronous = true - -# 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 - -# Seconds between retries of a database transaction. (integer value) -#db_retry_interval = 1 - -# Verbosity of SQL debugging information: 0=None, 100=Everything. -# (integer value) -# Deprecated group/name - [DEFAULT]/sql_connection_debug -#connection_debug = 0 - -# The back end to use for the database. (string value) -# Deprecated group/name - [DEFAULT]/db_backend -#backend = sqlalchemy - -# If True, increases the interval between retries of a database -# operation up to db_max_retry_interval. (boolean value) -#db_inc_retry_interval = true - - -[glance_client] - -# -# From watcher -# - -# Version of Glance API to use in glanceclient. (string value) -#api_version = 2 - - -[keystone_authtoken] - -# -# From keystonemiddleware.auth_token -# - -# (Optional, mandatory if memcache_security_strategy is defined) This -# string is used for key derivation. (string value) -#memcache_secret_key = - -# In order to prevent excessive effort spent validating tokens, the -# middleware caches previously-seen tokens for a configurable duration -# (in seconds). Set to -1 to disable caching completely. (integer -# value) -#token_cache_time = 300 - -# Determines the frequency at which the list of revoked tokens is -# retrieved from the Identity service (in seconds). A high number of -# revocation events combined with a low cache duration may -# significantly reduce performance. (integer value) -#revocation_cache_time = 10 - -# (Optional) If defined, indicate whether token data should be -# authenticated or authenticated and encrypted. If MAC, token data is -# authenticated (with HMAC) in the cache. If ENCRYPT, token data is -# encrypted and authenticated in the cache. If the value is not one of -# these options or empty, auth_token will raise an exception on -# initialization. (string value) -# Allowed values: None, MAC, ENCRYPT -#memcache_security_strategy = None - -# (Optional) Number of seconds memcached server is considered dead -# before it is tried again. (integer value) -#memcache_pool_dead_retry = 300 - -# (Optional) Maximum total number of open connections to every -# memcached server. (integer value) -#memcache_pool_maxsize = 10 - -# Complete public Identity API endpoint. (string value) -#auth_uri = - -# (Optional) Socket timeout in seconds for communicating with a -# memcached server. (integer value) -#memcache_pool_socket_timeout = 3 - -# (Optional) Number of seconds a connection to memcached is held -# unused in the pool before it is closed. (integer value) -#memcache_pool_unused_timeout = 60 - -# API version of the admin Identity API endpoint. (string value) -#auth_version = - -# (Optional) Number of seconds that an operation will wait to get a -# memcached client connection from the pool. (integer value) -#memcache_pool_conn_get_timeout = 10 - -# Do not handle authorization requests within the middleware, but -# delegate the authorization decision to downstream WSGI components. -# (boolean value) -#delay_auth_decision = false - -# (Optional) Use the advanced (eventlet safe) memcached client pool. -# The advanced pool will only work under python 2.x. (boolean value) -#memcache_use_advanced_pool = false - -# Request timeout value for communicating with Identity API server. -# (integer value) -#http_connect_timeout = - -# (Optional) Indicate whether to set the X-Service-Catalog header. If -# False, middleware will not ask for service catalog on token -# validation and will not set the X-Service-Catalog header. (boolean -# value) -#include_service_catalog = true - -# How many times are we trying to reconnect when communicating with -# Identity API Server. (integer value) -#http_request_max_retries = 3 - -# Used to control the use and type of token binding. Can be set to: -# "disabled" to not check token binding. "permissive" (default) to -# validate binding information if the bind type is of a form known to -# the server and ignore it if not. "strict" like "permissive" but if -# the bind type is unknown the token will be rejected. "required" any -# form of token binding is needed to be allowed. Finally the name of a -# binding method that must be present in tokens. (string value) -#enforce_token_bind = permissive - -# Env key for the swift cache. (string value) -#cache = - -# If true, the revocation list will be checked for cached tokens. This -# requires that PKI tokens are configured on the identity server. -# (boolean value) -#check_revocations_for_cached = false - -# Required if identity server requires client certificate (string -# value) -#certfile = - -# Hash algorithms to use for hashing PKI tokens. This may be a single -# algorithm or multiple. The algorithms are those supported by Python -# standard hashlib.new(). The hashes will be tried in the order given, -# so put the preferred one first for performance. The result of the -# first hash will be stored in the cache. This will typically be set -# to multiple values only while migrating from a less secure algorithm -# to a more secure one. Once all the old tokens are expired this -# option should be set to a single value for better performance. (list -# value) -#hash_algorithms = md5 - -# Required if identity server requires client certificate (string -# value) -#keyfile = - -# A PEM encoded Certificate Authority to use when verifying HTTPs -# connections. Defaults to system CAs. (string value) -#cafile = - -# Authentication type to load (unknown value) -# Deprecated group/name - [DEFAULT]/auth_plugin -#auth_type = - -# Config Section from which to load plugin specific options (unknown -# value) -#auth_section = - -# Verify HTTPS connections. (boolean value) -#insecure = false - -# The region in which the identity server can be found. (string value) -#region_name = - -# Directory used to cache files related to PKI tokens. (string value) -#signing_dir = - -# Optionally specify a list of memcached server(s) to use for caching. -# If left undefined, tokens will instead be cached in-process. (list -# value) -# Deprecated group/name - [DEFAULT]/memcache_servers -#memcached_servers = - - -[matchmaker_redis] - -# -# From oslo.messaging -# - -# Time in ms to wait before the transaction is killed. (integer value) -#check_timeout = 20000 - -# Password for Redis server (optional). (string value) -#password = - -# Timeout in ms on blocking socket operations (integer value) -#socket_timeout = 1000 - -# List of Redis Sentinel hosts (fault tolerance mode) e.g. -# [host:port, host1:port ... ] (list value) -#sentinel_hosts = - -# Redis replica set name. (string value) -#sentinel_group_name = oslo-messaging-zeromq - -# Host to locate redis. (string value) -#host = 127.0.0.1 - -# Time in ms to wait between connection attempts. (integer value) -#wait_timeout = 500 - -# Use this port to connect to redis host. (port value) -# Minimum value: 0 -# Maximum value: 65535 -#port = 6379 - - -[neutron_client] - -# -# From watcher -# - -# Version of Neutron API to use in neutronclient. (string value) -#api_version = 2 - - -[nova_client] - -# -# From watcher -# - -# Version of Nova API to use in novaclient. (string value) -#api_version = 2 - - -[oslo_messaging_amqp] - -# -# From oslo.messaging -# - -# CA certificate PEM file to verify server certificate (string value) -# Deprecated group/name - [amqp1]/ssl_ca_file -#ssl_ca_file = - -# Private key PEM file used to sign cert_file certificate (string -# value) -# Deprecated group/name - [amqp1]/ssl_key_file -#ssl_key_file = - -# User name for message broker authentication (string value) -# Deprecated group/name - [amqp1]/username -#username = - -# Name for the AMQP container (string value) -# Deprecated group/name - [amqp1]/container_name -#container_name = - -# Space separated list of acceptable SASL mechanisms (string value) -# Deprecated group/name - [amqp1]/sasl_mechanisms -#sasl_mechanisms = - -# address prefix used when sending to a specific server (string value) -# Deprecated group/name - [amqp1]/server_request_prefix -#server_request_prefix = exclusive - -# Password for decrypting ssl_key_file (if encrypted) (string value) -# Deprecated group/name - [amqp1]/ssl_key_password -#ssl_key_password = - -# Timeout for inactive connections (in seconds) (integer value) -# Deprecated group/name - [amqp1]/idle_timeout -#idle_timeout = 0 - -# Identifying certificate PEM file to present to clients (string -# value) -# Deprecated group/name - [amqp1]/ssl_cert_file -#ssl_cert_file = - -# address prefix used when broadcasting to all servers (string value) -# Deprecated group/name - [amqp1]/broadcast_prefix -#broadcast_prefix = broadcast - -# Debug: dump AMQP frames to stdout (boolean value) -# Deprecated group/name - [amqp1]/trace -#trace = false - -# Password for message broker authentication (string value) -# Deprecated group/name - [amqp1]/password -#password = - -# Accept clients using either SSL or plain TCP (boolean value) -# Deprecated group/name - [amqp1]/allow_insecure_clients -#allow_insecure_clients = false - -# Name of configuration file (without .conf suffix) (string value) -# Deprecated group/name - [amqp1]/sasl_config_name -#sasl_config_name = - -# Path to directory that contains the SASL configuration (string -# value) -# Deprecated group/name - [amqp1]/sasl_config_dir -#sasl_config_dir = - -# address prefix when sending to any server in group (string value) -# Deprecated group/name - [amqp1]/group_request_prefix -#group_request_prefix = unicast - - -[oslo_messaging_notifications] - -# -# From oslo.messaging -# - -# The Drivers(s) to handle sending notifications. Possible values are -# messaging, messagingv2, routing, log, test, noop (multi valued) -# Deprecated group/name - [DEFAULT]/notification_driver -#driver = - -# A URL representing the messaging driver to use for notifications. If -# not set, we fall back to the same configuration used for RPC. -# (string value) -# Deprecated group/name - [DEFAULT]/notification_transport_url -#transport_url = - -# AMQP topic used for OpenStack notifications. (list value) -# Deprecated group/name - [rpc_notifier2]/topics -# Deprecated group/name - [DEFAULT]/notification_topics -#topics = notifications - - -[oslo_messaging_rabbit] - -# -# From oslo.messaging -# - -# How often times during the heartbeat_timeout_threshold we check the -# heartbeat. (integer value) -#heartbeat_rate = 2 - -# Connect over SSL for RabbitMQ. (boolean value) -# Deprecated group/name - [DEFAULT]/rabbit_use_ssl -#rabbit_use_ssl = false - -# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake -# (boolean value) -# Deprecated group/name - [DEFAULT]/fake_rabbit -#fake_rabbit = false - -# The RabbitMQ userid. (string value) -# Deprecated group/name - [DEFAULT]/rabbit_userid -#rabbit_userid = guest - -# The RabbitMQ broker address where a single node is used. (string -# value) -# Deprecated group/name - [DEFAULT]/rabbit_host -#rabbit_host = localhost - -# The RabbitMQ password. (string value) -# Deprecated group/name - [DEFAULT]/rabbit_password -#rabbit_password = guest - -# Use durable queues in AMQP. (boolean value) -# Deprecated group/name - [DEFAULT]/amqp_durable_queues -# Deprecated group/name - [DEFAULT]/rabbit_durable_queues -#amqp_durable_queues = false - -# The RabbitMQ login method. (string value) -# Deprecated group/name - [DEFAULT]/rabbit_login_method -#rabbit_login_method = AMQPLAIN - -# Maximum number of RabbitMQ connection retries. Default is 0 -# (infinite retry count). (integer value) -# Deprecated group/name - [DEFAULT]/rabbit_max_retries -#rabbit_max_retries = 0 - -# Auto-delete queues in AMQP. (boolean value) -# Deprecated group/name - [DEFAULT]/amqp_auto_delete -#amqp_auto_delete = false - -# The RabbitMQ virtual host. (string value) -# Deprecated group/name - [DEFAULT]/rabbit_virtual_host -#rabbit_virtual_host = / - -# SSL version to use (valid only if SSL enabled). Valid values are -# TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be -# available on some distributions. (string value) -# Deprecated group/name - [DEFAULT]/kombu_ssl_version -#kombu_ssl_version = - -# How frequently to retry connecting with RabbitMQ. (integer value) -#rabbit_retry_interval = 1 - -# SSL key file (valid only if SSL enabled). (string value) -# Deprecated group/name - [DEFAULT]/kombu_ssl_keyfile -#kombu_ssl_keyfile = - -# Maximum interval of RabbitMQ connection retries. Default is 30 -# seconds. (integer value) -#rabbit_interval_max = 30 - -# How long to backoff for between retries when connecting to RabbitMQ. -# (integer value) -# Deprecated group/name - [DEFAULT]/rabbit_retry_backoff -#rabbit_retry_backoff = 2 - -# SSL certification authority file (valid only if SSL enabled). -# (string value) -# Deprecated group/name - [DEFAULT]/kombu_ssl_ca_certs -#kombu_ssl_ca_certs = - -# Positive integer representing duration in seconds for queue TTL -# (x-expires). Queues which are unused for the duration of the TTL are -# automatically deleted. The parameter affects only reply and fanout -# queues. (integer value) -# Minimum value: 1 -#rabbit_transient_queues_ttl = 600 - -# How long to wait before reconnecting in response to an AMQP consumer -# cancel notification. (floating point value) -# Deprecated group/name - [DEFAULT]/kombu_reconnect_delay -#kombu_reconnect_delay = 1.0 - -# Use HA queues in RabbitMQ (x-ha-policy: all). If you change this -# option, you must wipe the RabbitMQ database. (boolean value) -# Deprecated group/name - [DEFAULT]/rabbit_ha_queues -#rabbit_ha_queues = false - -# How long to wait a missing client beforce abandoning to send it its -# replies. This value should not be longer than rpc_response_timeout. -# (integer value) -# Deprecated group/name - [DEFAULT]/kombu_reconnect_timeout -#kombu_missing_consumer_retry_timeout = 60 - -# Determines how the next RabbitMQ node is chosen in case the one we -# are currently connected to becomes unavailable. Takes effect only if -# more than one RabbitMQ node is provided in config. (string value) -# Allowed values: round-robin, shuffle -#kombu_failover_strategy = round-robin - -# Specifies the number of messages to prefetch. Setting to zero allows -# unlimited messages. (integer value) -#rabbit_qos_prefetch_count = 0 - -# The RabbitMQ broker port where a single node is used. (port value) -# Minimum value: 0 -# Maximum value: 65535 -# Deprecated group/name - [DEFAULT]/rabbit_port -#rabbit_port = 5672 - -# SSL cert file (valid only if SSL enabled). (string value) -# Deprecated group/name - [DEFAULT]/kombu_ssl_certfile -#kombu_ssl_certfile = - -# Number of seconds after which the Rabbit broker is considered down -# if heartbeat's keep-alive fails (0 disable the heartbeat). -# EXPERIMENTAL (integer value) -#heartbeat_timeout_threshold = 60 - -# RabbitMQ HA cluster host:port pairs. (list value) -# Deprecated group/name - [DEFAULT]/rabbit_hosts -#rabbit_hosts = $rabbit_host:$rabbit_port - - -[watcher_applier] - -# -# From watcher -# - -# The topic name used for status events, this topic is used so as to -# notifythe others components of the system (string value) -#status_topic = watcher.applier.status - -# Select the engine to use to execute the workflow (string value) -#workflow_engine = taskflow - -# The topic name used forcontrol events, this topic used for rpc call -# (string value) -#conductor_topic = watcher.applier.control - -# Number of workers for applier, default value is 1. (integer value) -# Minimum value: 1 -#workers = 1 - -# The identifier used by watcher module on the message broker (string -# value) -#publisher_id = watcher.applier.api - - -[watcher_clients_auth] - -# -# From watcher -# - -# Optional domain name to use with v3 API and v2 parameters. It will -# be used for both the user and project domain in v3 and ignored in v2 -# authentication. (unknown value) -#default_domain_name = - -# Authentication URL (unknown value) -#auth_url = - -# Domain ID to scope to (unknown value) -#domain_id = - -# Domain name to scope to (unknown value) -#domain_name = - -# Project ID to scope to (unknown value) -# Deprecated group/name - [DEFAULT]/tenant-id -#project_id = - -# Project name to scope to (unknown value) -# Deprecated group/name - [DEFAULT]/tenant-name -#project_name = - -# Domain ID containing project (unknown value) -#project_domain_id = - -# PEM encoded client certificate cert file (string value) -#certfile = - -# Domain name containing project (unknown value) -#project_domain_name = - -# Trust ID (unknown value) -#trust_id = - -# Optional domain ID to use with v3 and v2 parameters. It will be used -# for both the user and project domain in v3 and ignored in v2 -# authentication. (unknown value) -#default_domain_id = - -# Verify HTTPS connections. (boolean value) -#insecure = false - -# User id (unknown value) -#user_id = - -# PEM encoded client certificate key file (string value) -#keyfile = - -# Username (unknown value) -# Deprecated group/name - [DEFAULT]/username -#username = - -# User's domain id (unknown value) -#user_domain_id = - -# User's domain name (unknown value) -#user_domain_name = - -# Timeout value for http requests (integer value) -#timeout = - -# User's password (unknown value) -#password = - -# Authentication type to load (unknown value) -# Deprecated group/name - [DEFAULT]/auth_plugin -#auth_type = - -# Config Section from which to load plugin specific options (unknown -# value) -#auth_section = - -# PEM encoded Certificate Authority to use when verifying HTTPs -# connections. (string value) -#cafile = - - -[watcher_decision_engine] - -# -# From watcher -# - -# The maximum number of threads that can be used to execute strategies -# (integer value) -#max_workers = 2 - -# The topic name used for status events, this topic is used so as to -# notifythe others components of the system (string value) -#status_topic = watcher.decision.status - -# The topic name used forcontrol events, this topic used for rpc call -# (string value) -#conductor_topic = watcher.decision.control - -# The identifier used by watcher module on the message broker (string -# value) -#publisher_id = watcher.decision.api - - -[watcher_goals] - -# -# From watcher -# - -# Goals used for the optimization. Maps each goal to an associated -# strategy (for example: BASIC_CONSOLIDATION:basic, -# MY_GOAL:my_strategy_1) (dict value) -#goals = DUMMY:dummy - - -[watcher_planner] - -# -# From watcher -# - -# The selected planner used to schedule the actions (string value) -#planner = default diff --git a/tox.ini b/tox.ini index 36f76fe13..22e8274b0 100644 --- a/tox.ini +++ b/tox.ini @@ -40,12 +40,7 @@ commands = oslo_debug_helper -t watcher/tests {posargs} [testenv:config] sitepackages = False commands = - oslo-config-generator --namespace watcher \ - --namespace keystonemiddleware.auth_token \ - --namespace oslo.log \ - --namespace oslo.db \ - --namespace oslo.messaging \ - --output-file etc/watcher/watcher.conf.sample + oslo-config-generator --config-file etc/watcher/watcher-config-generator.conf [flake8] show-source=True