From 21892987282c138fad8fd018444a5837cc5a253a Mon Sep 17 00:00:00 2001 From: Graham Hayes Date: Fri, 13 Feb 2015 17:26:52 +0000 Subject: [PATCH] Updated Sample Config and Documentation Page Change-Id: I7aae6cbebb11859325269b358f4d738edc6c1572 --- doc/source/configuration.rst | 161 +--------------------------- etc/designate/designate.conf.sample | 62 ++++------- 2 files changed, 26 insertions(+), 197 deletions(-) diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 8ca207156..00ab01e61 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -24,162 +24,7 @@ Configuration Options ======================= -Designate specific -================== +We provide a sample configuration file in `etc/designate/designate.conf.sample` -=============================== ==================================== ============================================================== -Parameter Default Note -=============================== ==================================== ============================================================== -api_host 0.0.0.0 API listen host -api_port 9001 API listen port -control_exchange designate The MQ Control exchange -central_topic central The topic that the Central should use -os-username glance Username to use for openstack service access -os-password admin Password to use for openstack service access -os-tenant-id Tenant ID to use for openstack service access -os-tenant-name admin Tenant name to use for openstack service access -os-auth-url http://localhost:5000/v2.0 Auth URL to use for openstack service access -connection sqlite:///$pystatepath/designate.db Database connection string -=============================== ==================================== ============================================================== - -Storage - SQL Alchemy -===================== - -========================== ==================================== ============================================================== -Parameter Default Note -========================== ==================================== ============================================================== -connection_debug 0 Verbosity of SQL debugging information. 0=None, 100=Everything -connection_trace False Add python stack traces to SQL as comment strings -idle_timeout 3600 timeout before idle sql connections are reaped -max_retries 10 maximum db connection retries during startup. - (setting -1 implies an infinite retry count) -retry_interval 10 interval between retries of opening a sql connection -mysql_engine InnoDB MySQL engine to use -sqlite_synchronous True If passed, use synchronous mode for sqlite -========================== ==================================== ============================================================== - - -Backend - General -================= - -=========================== ==================================== ============================================================== -Parameter Default Note -=========================== ==================================== ============================================================== -some_opt Insert something Insert something -=========================== ==================================== ============================================================== - - -Backend - Bind9 -================= - -=========================== ==================================== ============================================================== -Parameter Default Note -=========================== ==================================== ============================================================== -rndc_path /usr/sbin/rndc RNDC Path -rndc_host 127.0.0.1 RNDC Host -rndc_port 953 RNDC Port -rndc_config-file None RNDC Config File -rndc_key-file None RNDC Key File -=========================== ==================================== ============================================================== - - -Handler - General -================= - -=========================== ==================================== ============================================================== -Parameter Default Note -=========================== ==================================== ============================================================== -domain_id None The domain ID to use -=========================== ==================================== ============================================================== - -.. _handler-nova: - -Handler - Nova * -================ - -=========================== ==================================== ============================================================== -Parameter Default Note -=========================== ==================================== ============================================================== -notification_topics notifications Notification Topics -control_exchange nova Nova Control Exchange -domain_id None UUID of a domain/zone where records are to be created/deleted -format None you can use any field in the notification message, - compute.instance.create.end, eg: |br| - format = '%(octet0)s-%(octet1)s-%(octet2)s-%(octet3)s.%(domain)s' |br| - format = '%(display_name)s.%(domain)s' -=========================== ==================================== ============================================================== - - -General options -=============== - -The following is the list of openstack-common options that we use: - -=========================== ==================================== ============================================================== -Parameter Default Note -=========================== ==================================== ============================================================== -default_notification_level INFO Default notification level for outgoing notifications -default_publisher_id $host Default publisher_id for outgoing notifications -bind_host 0.0.0.0 IP address to listen on -bind_port 9001 Port numver to listen on -port 5672 Rabbit MQ port to liste on -fake_rabbit False If passed, use a fake RabbitMQ provider -publish_errors False publish error events -use_stderr True Log output to standard error -logfile_mode 0644 Default file mode used when creating log files -logdir Log output to a per-service log file in named directory -logfile Log output to a named file -default_log_levels ['amqplib=WARN',sqlalchemy=WARN,...] Default log level per components -notification_topics ['notifications', ] AMQP topic used for openstack notifications -enabled_apis ['ec2', 'osapi_compute'] List of APIs to enable by default -verbose False Print more verbose output -debug False Print debugging output -state_path currentdir Top-level directory for maintaining nova state -sqlite_db nova.sqlite file name for sqlite -matchmaker_ringfile /etc/designate/matchmaker_ring.json Matchmaker ring file (JSON) -rpc_zmq_bind_address '*' ZeroMQ bind address -rpc_zmq_matchmaker designate.openstack.common.rpc. MatchMaker drivers - matchmaker.MatchMakerLocalhost -rpc_zmq_port 9501 ZeroMQ receiver listening port -rpc_zmq_port_pub 9502 ZeroMQ fanout publisher port -rpc_zmq_contexts 1 Number of ZeroMQ contexts -rpc_zmq_ipc_dir /var/run/openstack Directory for holding IPC sockets -rabbit_port 5672 The RabbitMQ broker port where a single node is used -rabbit_host localhost The RabbitMQ broker address where a single node is used -rabbit_hosts ['$rabbit_host:$rabbit_port'] The list of rabbit hosts to listen to -rabbit_userid guest the RabbitMQ userid -rabbit_password guest the RabbitMQ password -rabbit_virtual_host / the RabbitMQ virtual host -rabbit_retry_interval 1 how frequently to retry connecting with RabbitMQ -rabbit_retry_backoff 2 how long to backoff for between retries when connecting -rabbit_max_retries 0 maximum retries with trying to connect to RabbitMQ - (the default of 0 implies an infinite retry count) -rabbit_durable_queues False use durable queues in RabbitMQ -rabbit_use_ssl False connect over SSL for RabbitMQ -rabbit_durable_queues False use durable queues in RabbitMQ -rabbit_ha_queues False use H/A queues in RabbitMQ (x-ha-policy: all). -kombu_ssl_version SSL version to use (valid only if SSL enabled) -kombu_ssl_keyfile SSL key file (valid only if SSL enabled) -kombu_ssl_certfile SSL cert file (valid only if SSL enabled) -kombu_ssl_ca_certs SSL certification authority file -qpid_hostname localhost Qpid broker hostname -qpid_port 5672 Qpid broker port -qpid_username Username for qpid connection -qpid_password Password for qpid connection -qpid_sasl_mechanisms Space separated list of SASL mechanisms to use for auth -qpid_reconnect_timeout 0 Reconnection timeout in seconds -qpid_reconnect_limit 0 Max reconnections before giving up -qpid_reconnect_interval_min 0 Minimum seconds between reconnection attempts -qpid_reconnect_interval_max 0 Maximum seconds between reconnection attempts -qpid_reconnect_interval 0 Equivalent to setting max and min to the same value -qpid_heartbeat 60 Seconds between connection keepalive heartbeats -qpid_protocol tcp Transport to use, either 'tcp' or 'ssl' -qpid_reconnect True Automatically reconnect -qpid_tcp_nodelay True Disable Nagle algorithm -rpc_backend kombu The messaging module to use, defaults to kombu. -rpc_thread_pool_size 64 Size of RPC thread pool -rpc_conn_pool_size 30 Size of RPC connection pool -rpc_response_timeout 60 Seconds to wait for a response from call or multicall -rpc_cast_timeout 30 Seconds to wait before a cast expires (TTL). - Only supported by impl_zmq. -=========================== ==================================== ============================================================== +The majority of the options are OK to be left as default values, but may need +to be tweaked depending on your deployment. diff --git a/etc/designate/designate.conf.sample b/etc/designate/designate.conf.sample index 8da668d2d..74d5c7875 100644 --- a/etc/designate/designate.conf.sample +++ b/etc/designate/designate.conf.sample @@ -1,4 +1,7 @@ [DEFAULT] +# Where an option is commented out, but filled in this shows the default +# value of that option + ######################## ## General Configuration ######################## @@ -82,13 +85,17 @@ debug = False #enable_api_v2 = False # Show the pecan HTML based debug interface (v2 only) +# This is only useful for development, and WILL break python-designateclient +# if an error occurs #pecan_debug = False # Enabled API Version 1 extensions -#enabled_extensions_v1 = diagnostics, quotas, reports, sync, touch +# Can be one or more of : diagnostics, quotas, reports, sync, touch +#enabled_extensions_v1 = # Enabled API Version 2 extensions -#enabled_extensions_v2 = reports, quotas +# Can be one or more of : reports, quotas +#enabled_extensions_v2 = #----------------------- # Keystone Middleware @@ -107,7 +114,8 @@ debug = False [service:sink] # List of notification handlers to enable, configuration of these needs to # correspond to a [handler:my_driver] section below or else in the config -#enabled_notification_handlers = nova_fixed +# Can be one or more of : nova_fixed, neutron_floatingip +#enabled_notification_handlers = #----------------------- # mDNS Service @@ -116,7 +124,7 @@ debug = False #workers = None #host = 0.0.0.0 #port = 5354 -#tcp_backlog =1 00 +#tcp_backlog = 100 #----------------------- # Agent Service @@ -152,6 +160,7 @@ debug = False ## Network API ############## [network_api:neutron] +# Comma separated list of values, formatted "|" #endpoints = RegionOne|http://localhost:9696 #endpoint_type = publicURL #timeout = 30 @@ -161,7 +170,7 @@ debug = False #auth_url = http://localhost:35357/v2.0 #insecure = False #auth_strategy = keystone -#ca_certificates_file = /etc/path/to/ca.pem +#ca_certificates_file = ######################## ## Storage Configuration @@ -173,7 +182,7 @@ debug = False # Database connection string - to configure options for a given implementation # like sqlalchemy or other see below #connection = sqlite:///$state_path/designate.sqlite -#connection_debug = 100 +#connection_debug = 0 #connection_trace = False #sqlite_synchronous = True #idle_timeout = 3600 @@ -187,7 +196,8 @@ debug = False # Nova Fixed Handler #----------------------- [handler:nova_fixed] -#domain_id = +# Domain ID of domain to create records in. Should be pre-created +#domain_id = #notification_topics = notifications #control_exchange = 'nova' #format = '%(octet0)s-%(octet1)s-%(octet2)s-%(octet3)s.%(domain)s' @@ -196,7 +206,8 @@ debug = False # Neutron Floating Handler #------------------------ [handler:neutron_floatingip] -#domain_id = +# Domain ID of domain to create records in. Should be pre-created +#domain_id = #notification_topics = notifications #control_exchange = 'neutron' #format = '%(octet0)s-%(octet1)s-%(octet2)s-%(octet3)s.%(domain)s' @@ -216,40 +227,13 @@ debug = False #max_retries = 10 #retry_interval = 10 -######################## -## Backend Configuration -######################## -#----------------------- -# PowerDNS Backend -#----------------------- -[backend:powerdns] -#connection = mysql://user:password@host/pdns -#connection_debug = 100 -#connection_trace = False -#sqlite_synchronous = True -#idle_timeout = 3600 -#max_retries = 10 -#retry_interval = 10 - -#----------------------- -# NSD4Slave Backend -#----------------------- -[backend:nsd4slave] -#keyfile =/etc/nsd/nsd_control.key -#certfile = /etc/nsd/nsd_control.pem -#servers = 127.0.0.1,127.0.1.1:4242 -#pattern = slave - -#----------------------- -# Multi Backend -#----------------------- -[backend:multi] -#master = fake -#slave = fake - ############################# ## Pool Backend Configuration ############################# + +# This section does not have the defaults filled in but demonstrates an +# example pool / server set up. Different backends will have different options. + #----------------------- # Global Bind9 Pool Backend #-----------------------