From 0af044eecf8ad5a2fff2a7a3962424405b8ba23a Mon Sep 17 00:00:00 2001 From: Atsushi SAKAI Date: Wed, 14 Oct 2015 17:57:17 +0900 Subject: [PATCH] Update Config Reference for ironic Updates for Liberty Release Adds ironic-iboot.xml file and other updates are mainly oslo_messaging etc. Change-Id: I3b0058fc38cdb5546bfd976c5526608daffb3882 --- doc/common/tables/ironic-agent.xml | 12 +++---- doc/common/tables/ironic-api.xml | 4 +++ doc/common/tables/ironic-auth_token.xml | 4 +++ doc/common/tables/ironic-cisco_ucs.xml | 11 +++++++ doc/common/tables/ironic-deploy.xml | 8 +++++ doc/common/tables/ironic-iboot.xml | 30 +++++++++++++++++ doc/common/tables/ironic-ilo.xml | 4 +++ doc/common/tables/ironic-logging.xml | 24 ++++++++------ doc/common/tables/ironic-redis.xml | 22 +++++++------ doc/common/tables/ironic-rpc.xml | 32 ++++++++++++++----- doc/common/tables/ironic-zeromq.xml | 18 ++++++++--- .../ch_baremetalconfigure.xml | 1 + .../ironic.flagmappings | 28 ++++++++++++---- .../ironic.headers | 1 + 14 files changed, 153 insertions(+), 46 deletions(-) create mode 100644 doc/common/tables/ironic-iboot.xml diff --git a/doc/common/tables/ironic-agent.xml b/doc/common/tables/ironic-agent.xml index 3eb074137a..dadb15ddb8 100644 --- a/doc/common/tables/ironic-agent.xml +++ b/doc/common/tables/ironic-agent.xml @@ -21,14 +21,6 @@ = v1 (StrOpt) API version to use for communicating with the ramdisk agent. - - = 1 - (IntOpt) Number of iterations to be run for erasing devices. - - - = None - (IntOpt) Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the GenericHardwareManager). If set to 0, will not run during cleaning. - = nofb nomodeset vga=normal (StrOpt) DEPRECATED. Additional append parameters for baremetal PXE boot. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_append_params instead. @@ -45,6 +37,10 @@ = True (BoolOpt) Whether Ironic will manage booting of the agent ramdisk. If set to False, you will need to configure your mechanism to allow booting the agent ramdisk. + + = 0 + (IntOpt) The memory size in MiB consumed by agent when it is booted on a bare metal node. This is used for checking if the image can be downloaded and deployed on the bare metal node after booting agent ramdisk. This may be set according to the memory consumed by the agent ramdisk image. + = 6 (IntOpt) Number of times to retry getting power state to check if bare metal node has been powered off after a soft power off. diff --git a/doc/common/tables/ironic-api.xml b/doc/common/tables/ironic-api.xml index fec62c058f..4ee0e847dd 100644 --- a/doc/common/tables/ironic-api.xml +++ b/doc/common/tables/ironic-api.xml @@ -29,6 +29,10 @@ = 6385 (IntOpt) The TCP port on which ironic-api listens. + + = None + (StrOpt) Public URL to use when building the links to the API resources (for example, "https://ironic.rocks:6384"). If None the links will be built using the request's host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy's URL. Defaults to None. + [cors] diff --git a/doc/common/tables/ironic-auth_token.xml b/doc/common/tables/ironic-auth_token.xml index 13e428df29..ed4e427a9e 100644 --- a/doc/common/tables/ironic-auth_token.xml +++ b/doc/common/tables/ironic-auth_token.xml @@ -153,6 +153,10 @@ = None (ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. + + = None + (StrOpt) The region in which the identity server can be found. + = 10 (IntOpt) 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. diff --git a/doc/common/tables/ironic-cisco_ucs.xml b/doc/common/tables/ironic-cisco_ucs.xml index dea516b760..b1a48180f6 100644 --- a/doc/common/tables/ironic-cisco_ucs.xml +++ b/doc/common/tables/ironic-cisco_ucs.xml @@ -14,6 +14,17 @@ + + [cimc] + + + = 10 + (IntOpt) Amount of time in seconds to wait in between power operations + + + = 6 + (IntOpt) Number of times a power operation needs to be retried + [cisco_ucs] diff --git a/doc/common/tables/ironic-deploy.xml b/doc/common/tables/ironic-deploy.xml index 338ec495f7..43986e7cd1 100644 --- a/doc/common/tables/ironic-deploy.xml +++ b/doc/common/tables/ironic-deploy.xml @@ -25,6 +25,14 @@ = 200 (IntOpt) Size of EFI system partition in MiB when configuring UEFI systems for local boot. + + = 1 + (IntOpt) Number of iterations to be run for erasing devices. + + + = None + (IntOpt) Priority to run in-band erase devices via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 10 for the GenericHardwareManager). If set to 0, will not run during cleaning. + = /httpboot (StrOpt) ironic-conductor node's HTTP root path. diff --git a/doc/common/tables/ironic-iboot.xml b/doc/common/tables/ironic-iboot.xml new file mode 100644 index 0000000000..387abb4726 --- /dev/null +++ b/doc/common/tables/ironic-iboot.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of iBoot Web Power Switch configuration options
Configuration option = Default valueDescription
[iboot]
= 3(IntOpt) Maximum retries for iBoot operations
= 1(IntOpt) Time between retry attempts for iBoot operations
+ diff --git a/doc/common/tables/ironic-ilo.xml b/doc/common/tables/ironic-ilo.xml index 19b61bb3c0..7c5a350bc1 100644 --- a/doc/common/tables/ironic-ilo.xml +++ b/doc/common/tables/ironic-ilo.xml @@ -65,6 +65,10 @@ = 900 (IntOpt) Amount of time in seconds for Swift objects to auto-expire. + + = False + (BoolOpt) Set this to True to use http web server to host floppy images and generated boot ISO. This requires http_root and http_url to be configured in the [deploy] section of the config file. If this is set to False, then Ironic will use Swift to host the floppy images and generated boot_iso. + diff --git a/doc/common/tables/ironic-logging.xml b/doc/common/tables/ironic-logging.xml index c6cf4c1a7e..e66a728576 100644 --- a/doc/common/tables/ironic-logging.xml +++ b/doc/common/tables/ironic-logging.xml @@ -23,7 +23,7 @@ = 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 - (ListOpt) List of logger=LEVEL pairs. + (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. = False @@ -39,23 +39,23 @@ = None - (StrOpt) 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. + (StrOpt) 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 then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). = %Y-%m-%d %H:%M:%S - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . + (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. = None - (StrOpt) (Optional) The base directory used for relative --log-file paths. + (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. = None - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. + (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. = None - (StrOpt) 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. + (StrOpt) 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. = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s @@ -79,24 +79,28 @@ = LOG_USER - (StrOpt) Syslog facility to receive log lines. + (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. = True - (BoolOpt) Log output to standard error. + (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. = False - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. + (BoolOpt) 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. = True - (BoolOpt) (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 Kilo, and will be removed in Mitaka, along with this option. + (BoolOpt) (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 Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. = True (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + + = False + (BoolOpt) (Optional) 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. + diff --git a/doc/common/tables/ironic-redis.xml b/doc/common/tables/ironic-redis.xml index 2d5897ae7b..ffeb61efa4 100644 --- a/doc/common/tables/ironic-redis.xml +++ b/doc/common/tables/ironic-redis.xml @@ -15,14 +15,10 @@ - [matchmaker_redis] + [DEFAULT] - = 127.0.0.1 - (StrOpt) Host to locate redis. - - - = None + = (StrOpt) Password for Redis server (optional). @@ -30,11 +26,19 @@ (IntOpt) Use this port to connect to redis host. - [matchmaker_ring] + [matchmaker_redis] - = /etc/oslo/matchmaker_ring.json - (StrOpt) Matchmaker ring file (JSON). + = 127.0.0.1 + (StrOpt) Host to locate redis. + + + = + (StrOpt) Password for Redis server (optional). + + + = 6379 + (IntOpt) Use this port to connect to redis host. diff --git a/doc/common/tables/ironic-rpc.xml b/doc/common/tables/ironic-rpc.xml index 2fafd41269..f98fd3ba45 100644 --- a/doc/common/tables/ironic-rpc.xml +++ b/doc/common/tables/ironic-rpc.xml @@ -17,14 +17,6 @@ [DEFAULT] - - = 300 - (IntOpt) Heartbeat frequency. - - - = 600 - (IntOpt) Heartbeat time-to-live. - = rabbit (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. @@ -37,6 +29,10 @@ = 30 (IntOpt) Size of RPC connection pool. + + = 1 + (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + = 60 (IntOpt) Seconds to wait for a response from a call. @@ -75,6 +71,22 @@ = 0 (IntOpt) Timeout for inactive connections (in seconds) + + = + (StrOpt) Password for message broker authentication + + + = + (StrOpt) Path to directory that contains the SASL configuration + + + = + (StrOpt) Name of configuration file (without .conf suffix) + + + = + (StrOpt) Space separated list of acceptable SASL mechanisms + = exclusive (StrOpt) address prefix used when sending to a specific server @@ -99,6 +111,10 @@ = False (BoolOpt) Debug: dump AMQP frames to stdout + + = + (StrOpt) User name for message broker authentication + diff --git a/doc/common/tables/ironic-zeromq.xml b/doc/common/tables/ironic-zeromq.xml index bd6f9db411..206d6d6a96 100644 --- a/doc/common/tables/ironic-zeromq.xml +++ b/doc/common/tables/ironic-zeromq.xml @@ -17,10 +17,18 @@ [DEFAULT] + + = True + (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + = * (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + + = eventlet + (StrOpt) Type of concurrency used. Either "native" or "eventlet" + = 1 (IntOpt) Number of ZeroMQ contexts, defaults to 1. @@ -34,17 +42,17 @@ (StrOpt) Directory for holding IPC sockets. - = local + = redis (StrOpt) MatchMaker driver. - - = 9501 - (IntOpt) ZeroMQ receiver listening port. - = None (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + + = True + (BoolOpt) Shows whether zmq-messaging uses broker or not. + diff --git a/doc/config-reference/ch_baremetalconfigure.xml b/doc/config-reference/ch_baremetalconfigure.xml index 7943b3066a..7200b96e57 100644 --- a/doc/config-reference/ch_baremetalconfigure.xml +++ b/doc/config-reference/ch_baremetalconfigure.xml @@ -28,6 +28,7 @@ + diff --git a/tools/autogenerate-config-flagmappings/ironic.flagmappings b/tools/autogenerate-config-flagmappings/ironic.flagmappings index e5b897ad9e..a5572fb483 100644 --- a/tools/autogenerate-config-flagmappings/ironic.flagmappings +++ b/tools/autogenerate-config-flagmappings/ironic.flagmappings @@ -25,28 +25,30 @@ logging_context_format_string logging logging_debug_format_suffix logging logging_default_format_string logging logging_exception_prefix logging -matchmaker_heartbeat_freq rpc -matchmaker_heartbeat_ttl rpc memcached_servers common my_ip common notification_driver amqp notification_topics amqp parallel_image_downloads common +password redis pecan_debug debug periodic_interval common +port redis publish_errors logging pybasedir common rootwrap_config common rpc_backend rpc rpc_cast_timeout rpc rpc_conn_pool_size rpc +rpc_poll_timeout rpc rpc_response_timeout rpc +rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq -rpc_zmq_port zeromq rpc_zmq_topic_backlog zeromq state_path common syslog_log_facility logging @@ -56,13 +58,14 @@ use_stderr logging use_syslog logging use_syslog_rfc_format logging verbose logging +watch_log_file logging +zmq_use_broker zeromq agent/agent_api_version agent -agent/agent_erase_devices_iterations agent -agent/agent_erase_devices_priority agent agent/agent_pxe_append_params agent agent/agent_pxe_config_template agent agent/heartbeat_timeout agent agent/manage_agent_boot agent +agent/memory_consumed_by_agent agent agent/post_deploy_get_power_state_retries agent agent/post_deploy_get_power_state_retry_interval agent amt/action_wait amt @@ -71,6 +74,9 @@ amt/protocol amt api/host_ip api api/max_limit api api/port api +api/public_endpoint api +cimc/action_interval cisco_ucs +cimc/max_retry cisco_ucs cisco_ucs/action_interval cisco_ucs cisco_ucs/max_retry cisco_ucs conductor/api_url conductor @@ -134,6 +140,8 @@ database/sqlite_synchronous database database/use_db_reconnect database deploy/dd_block_size deploy deploy/efi_system_partition_size deploy +deploy/erase_devices_iterations deploy +deploy/erase_devices_priority deploy deploy/http_root deploy deploy/http_url deploy deploy/iscsi_verify_attempts deploy @@ -157,6 +165,8 @@ glance/swift_endpoint_url glance glance/swift_store_multiple_containers_seed glance glance/swift_temp_url_duration glance glance/swift_temp_url_key glance +iboot/max_retry iboot +iboot/retry_interval iboot ilo/clean_priority_clear_secure_boot_keys ilo ilo/clean_priority_erase_devices ilo ilo/clean_priority_reset_bios_to_default ilo @@ -169,6 +179,7 @@ ilo/power_retry ilo ilo/power_wait ilo ilo/swift_ilo_container ilo ilo/swift_object_expiry_timeout ilo +ilo/use_web_server_for_images ilo inspector/enabled inspector inspector/service_url inspector inspector/status_check_period inspector @@ -220,13 +231,13 @@ keystone_authtoken/memcache_secret_key auth_token keystone_authtoken/memcache_security_strategy auth_token keystone_authtoken/memcache_use_advanced_pool auth_token keystone_authtoken/memcached_servers auth_token +keystone_authtoken/region_name auth_token keystone_authtoken/revocation_cache_time auth_token keystone_authtoken/signing_dir auth_token keystone_authtoken/token_cache_time auth_token matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis -matchmaker_ring/ringfile redis neutron/auth_strategy neutron neutron/cleaning_network_uuid neutron neutron/retries neutron @@ -239,12 +250,17 @@ oslo_messaging_amqp/broadcast_prefix rpc oslo_messaging_amqp/container_name rpc oslo_messaging_amqp/group_request_prefix rpc oslo_messaging_amqp/idle_timeout rpc +oslo_messaging_amqp/password rpc +oslo_messaging_amqp/sasl_config_dir rpc +oslo_messaging_amqp/sasl_config_name rpc +oslo_messaging_amqp/sasl_mechanisms rpc oslo_messaging_amqp/server_request_prefix rpc oslo_messaging_amqp/ssl_ca_file rpc oslo_messaging_amqp/ssl_cert_file rpc oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc +oslo_messaging_amqp/username rpc oslo_messaging_qpid/amqp_auto_delete qpid oslo_messaging_qpid/amqp_durable_queues qpid oslo_messaging_qpid/qpid_heartbeat qpid diff --git a/tools/autogenerate-config-flagmappings/ironic.headers b/tools/autogenerate-config-flagmappings/ironic.headers index a13103d683..4f6a99d9c7 100644 --- a/tools/autogenerate-config-flagmappings/ironic.headers +++ b/tools/autogenerate-config-flagmappings/ironic.headers @@ -4,6 +4,7 @@ deploy deploy dhcp DHCP disk_partitioner disk partitioner drac DRAC +iboot iBoot Web Power Switch ilo iLO inspector inspector irmc iRMC