diff --git a/doc/common/section_config_format.xml b/doc/common/section_config_format.xml index a6088b3ee8..6e3c048fb3 100644 --- a/doc/common/section_config_format.xml +++ b/doc/common/section_config_format.xml @@ -4,6 +4,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> + Configuration file format @@ -17,10 +18,16 @@ [DEFAULT] # Print debugging output (set logging level to DEBUG instead # of default WARNING level). (boolean value) -debug=true +debug = true # Print more verbose output (set logging level to INFO instead # of default WARNING level). (boolean value) -verbose=true +verbose = true + +[database] +# The SQLAlchemy connection string used to connect to the +# database (string value) +connection = mysql://keystone:KEYSTONE_DBPASS@controller/keystone + Options can have different type for values. The comments in the @@ -37,7 +44,7 @@ verbose=true # Enable the experimental use of database reconnect on # connection lost (boolean value) -use_db_reconnect=false +use_db_reconnect = false @@ -48,7 +55,7 @@ use_db_reconnect=false # Sleep time in seconds for polling an ongoing async task # (floating point value) -task_poll_interval=0.5 +task_poll_interval = 0.5 @@ -60,7 +67,7 @@ task_poll_interval=0.5 # The port which the OpenStack Compute service listens on. # (integer value) -compute_port=8774 +compute_port = 8774 @@ -78,7 +85,7 @@ compute_port=8774 # Modules of exceptions that are permitted to be recreated # upon receiving exception data from an rpc call. (list value) -allowed_rpc_exception_modules=oslo.messaging.exceptions,nova.exception,cinder.exception,exceptions +allowed_rpc_exception_modules = oslo.messaging.exceptions,nova.exception,cinder.exception,exceptions @@ -106,26 +113,56 @@ notification_driver = ceilometer.compute.nova_notifier # systemd, one could set shell command: "onready = systemd- # notify --ready" or a module with notify() method: "onready = # keystone.common.systemd". (string value) -onready=systemd-notify --ready +onready = systemd-notify --ready # If an instance is passed with the log message, format it # like this (string value) -instance_format="[instance: %(uuid)s] " +instance_format = "[instance: %(uuid)s] " + +
+ Sections + + Configuration options are grouped by section. Most + configuration file supports at least the following sections: + + + + [DEFAULT] + + + Contains most configuration options. If the + documentation for a configuration option does not + specify its section, assume that it appears in this + section. + + + + + [database] + + + Configuration options for the database that stores + the state of the OpenStack service. + + + + + +
+
Substitution - Option values may reference other values using PEP - 292 string substitution. An option can be referenced by - adding a $ in front of its name, like - $OPTION. To avoid substitution, use - $$, it is replaced by a single - $. + The configuration file supports variable substitution. After + you set a configuration option, it can be referenced in later + configuration values when you precede it with a + $, like + $OPTION. The following example uses the values of @@ -136,15 +173,51 @@ instance_format="[instance: %(uuid)s] " # The RabbitMQ broker address where a single node is used. # (string value) -rabbit_host=controller +rabbit_host = controller # The RabbitMQ broker port where a single node is used. # (integer value) -rabbit_port=5672 +rabbit_port = 5672 # RabbitMQ HA cluster host:port pairs. (list value) -rabbit_hosts=$rabbit_host:$rabbit_port +rabbit_hosts = $rabbit_host:$rabbit_port + + To avoid substitution, use $$, it is replaced + by a single $. For example, if your LDAP DNS + password is $xkj432, specify it, as follows: + ldap_dns_password = $$xkj432 + + + The code uses the Python + string.Template.safe_substitute() method to + implement variable substitution. For more details on how + variable substitution is resolved, see http://docs.python.org/2/library/string.html#template-strings + and PEP 292. + + +
+
+ Whitespace + + To include whitespace in a configuration value, use a quoted + string. For example: + ldap_dns_passsword='a password with spaces' +
+
+ Define an alternate location for a config file + + Most services and the and the *-manage + command-line clients load the configuration file. To define + an alternate location for the configuration file, pass the + --config-file + CONFIG_FILE parameter + when you start a service or call a + *-manage command. +
diff --git a/doc/config-reference/compute/section_nova-conf.xml b/doc/config-reference/compute/section_nova-conf.xml index 89ad8eacd7..e6f42cb2ab 100644 --- a/doc/config-reference/compute/section_nova-conf.xml +++ b/doc/config-reference/compute/section_nova-conf.xml @@ -4,96 +4,29 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> Overview of nova.conf - The nova.conf configuration file is + The nova.conf configuration file is an INI file format file that specifies options as - key=value pairs, which are grouped into - sections. The DEFAULT section contains most - of the configuration options. For example: - [DEFAULT] -debug=true -verbose=true - -[trusted_computing] -server=10.3.4.2 + >INI file format as explained in . You can use a particular configuration option file by using the option (nova.conf) parameter when you run one of the nova-* services. This parameter inserts configuration option definitions from the specified configuration file name, which might be useful for debugging or performance tuning. - To place comments in the nova.conf - file, start a new line that begins with the pound - (#) character. For a list of - configuration options, see the tables in this guide. + For a list of configuration options, see the tables in this + guide. To learn more about the nova.conf configuration file, review the general purpose configuration options documented in . - - Types of configuration options - Each configuration option has an associated data type. - The supported data types for configuration options - are: - - - BoolOpt - - Boolean option. Value must be either - true or - false . - Example:debug=false - - - - StrOpt - - String option. Value is an arbitrary string. - Example:my_ip=10.0.0.1 - - - - IntOption - - Integer option. Value must be an integer. - Example: - glance_port=9292 - - - - MultiStrOpt - - String option. Same as StrOpt, except that - it can be declared multiple times to indicate - multiple values. Example: - ldap_dns_servers=dns1.example.org -ldap_dns_servers=dns2.example.org - - - - ListOpt - - List option. Value is a list of arbitrary - strings separated by commas. Example: - enabled_apis=ec2,osapi_compute,metadata - - - - FloatOpt - - Floating-point option. Value must be a - floating-point number. Example: - ram_allocation_ratio=1.5 - - - Do not specify quotes around Nova options. - Sections Configuration options are grouped by section. The - Compute configuration file supports the following sections: + Compute configuration file supports the following sections: + [DEFAULT] @@ -141,49 +74,4 @@ ldap_dns_servers=dns2.example.org - - Variable substitution - The configuration file supports variable substitution. - After you set a configuration option, it can be referenced - in later configuration values when you precede it with - $. This example defines - my_ip and then uses - $my_ip as a - variable:my_ip=10.2.3.4 -glance_host=$my_ip -metadata_host=$my_ip - If a value must contain the $ - character, escape it with $$. For - example, if your LDAP DNS password is - $xkj432, specify it, as - follows:ldap_dns_password=$$xkj432 - The Compute code uses the Python - string.Template.safe_substitute() - method to implement variable substitution. For more - details on how variable substitution is resolved, see - http://docs.python.org/2/library/string.html#template-strings - and http://www.python.org/dev/peps/pep-0292/. - - - Whitespace - To include whitespace in a configuration value, use a - quoted string. For example: - ldap_dns_passsword='a password with spaces' - - - Define an alternate location for nova.conf - All nova-* - services and the nova-manage - command-line client load the configuration file. To define - an alternate location for the configuration file, pass the - --config-file - /path/to/nova.conf - parameter when you start a nova-* service or call a - nova-manage command. -