From 9ff3d04ef8fcab6c2e88488d009876a684811400 Mon Sep 17 00:00:00 2001 From: venkatamahesh Date: Sat, 3 Sep 2016 21:28:26 +0530 Subject: [PATCH] [config-ref] Update ironic tables Change-Id: I18b1a967ca4fb585595b15a2126a60359018de0d --- .../source/bare-metal/config-options.rst | 6 + .../source/tables/ironic-agent.rst | 16 ++- .../source/tables/ironic-amqp.rst | 2 +- .../source/tables/ironic-api.rst | 36 ++++- .../source/tables/ironic-audit.rst | 36 +++++ .../source/tables/ironic-catalog.rst | 34 +++++ .../source/tables/ironic-common.rst | 16 ++- .../source/tables/ironic-console.rst | 4 +- .../source/tables/ironic-deploy.rst | 10 +- .../source/tables/ironic-disk_partitioner.rst | 2 + .../source/tables/ironic-drac.rst | 22 +++ .../source/tables/ironic-glance.rst | 14 ++ .../source/tables/ironic-iSCSI.rst | 22 +++ .../source/tables/ironic-ilo.rst | 6 +- .../source/tables/ironic-inspector.rst | 16 ++- .../source/tables/ironic-metrics.rst | 38 ++++++ .../source/tables/ironic-metrics_stats.rst | 28 ++++ .../source/tables/ironic-neutron.rst | 26 +++- .../source/tables/ironic-oneview.rst | 16 ++- .../source/tables/ironic-pxe.rst | 6 +- .../source/tables/ironic-rabbitmq.rst | 24 ++-- .../source/tables/ironic-redis.rst | 12 +- .../source/tables/ironic-rpc.rst | 40 +++++- .../source/tables/ironic-swift.rst | 14 ++ .../source/tables/ironic-zeromq.rst | 48 ++++++- .../ironic.flagmappings | 129 ++++++++++++++++-- .../ironic.headers | 1 + 27 files changed, 558 insertions(+), 66 deletions(-) create mode 100644 doc/config-reference/source/tables/ironic-audit.rst create mode 100644 doc/config-reference/source/tables/ironic-catalog.rst create mode 100644 doc/config-reference/source/tables/ironic-drac.rst create mode 100644 doc/config-reference/source/tables/ironic-iSCSI.rst create mode 100644 doc/config-reference/source/tables/ironic-metrics.rst create mode 100644 doc/config-reference/source/tables/ironic-metrics_stats.rst diff --git a/doc/config-reference/source/bare-metal/config-options.rst b/doc/config-reference/source/bare-metal/config-options.rst index 645bbb3137..00ec869e73 100644 --- a/doc/config-reference/source/bare-metal/config-options.rst +++ b/doc/config-reference/source/bare-metal/config-options.rst @@ -8,11 +8,14 @@ service configuration options. .. include:: ../tables/ironic-agent.rst .. include:: ../tables/ironic-amqp.rst .. include:: ../tables/ironic-amt.rst +.. include:: ../tables/ironic-audit.rst .. include:: ../tables/ironic-auth.rst +.. include:: ../tables/ironic-catalog.rst .. include:: ../tables/ironic-cisco_ucs.rst .. include:: ../tables/ironic-common.rst .. include:: ../tables/ironic-conductor.rst .. include:: ../tables/ironic-console.rst +.. include:: ../tables/ironic-drac.rst .. include:: ../tables/ironic-debug.rst .. include:: ../tables/ironic-deploy.rst .. include:: ../tables/ironic-dhcp.rst @@ -23,7 +26,10 @@ service configuration options. .. include:: ../tables/ironic-inspector.rst .. include:: ../tables/ironic-ipmi.rst .. include:: ../tables/ironic-irmc.rst +.. include:: ../tables/ironic-iSCSI.rst .. include:: ../tables/ironic-keystone.rst +.. include:: ../tables/ironic-metrics.rst +.. include:: ../tables/ironic-metrics_stats.rst .. include:: ../tables/ironic-neutron.rst .. include:: ../tables/ironic-pxe.rst .. include:: ../tables/ironic-redis.rst diff --git a/doc/config-reference/source/tables/ironic-agent.rst b/doc/config-reference/source/tables/ironic-agent.rst index 3a8217e389..9492d4fbb5 100644 --- a/doc/config-reference/source/tables/ironic-agent.rst +++ b/doc/config-reference/source/tables/ironic-agent.rst @@ -20,12 +20,16 @@ - * - ``agent_api_version`` = ``v1`` - (String) API version to use for communicating with the ramdisk agent. - * - ``agent_pxe_append_params`` = ``nofb nomodeset vga=normal`` - - (String) 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. - * - ``agent_pxe_config_template`` = ``$pybasedir/drivers/modules/agent_config.template`` - - (String) DEPRECATED. Template file for PXE configuration. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_config_template instead. - * - ``heartbeat_timeout`` = ``300`` - - (Integer) Maximum interval (in seconds) for agent heartbeats. + * - ``deploy_logs_collect`` = ``on_failure`` + - (String) Whether Ironic should collect the deployment logs on deployment failure (on_failure), always or never. + * - ``deploy_logs_local_path`` = ``/var/log/ironic/deploy`` + - (String) The path to the directory where the logs should be stored, used when the deploy_logs_storage_backend is configured to "local". + * - ``deploy_logs_storage_backend`` = ``local`` + - (String) The name of the storage backend where the logs will be stored. + * - ``deploy_logs_swift_container`` = ``ironic_deploy_logs_container`` + - (String) The name of the Swift container to store the logs, used when the deploy_logs_storage_backend is configured to "swift". + * - ``deploy_logs_swift_days_to_expire`` = ``30`` + - (Integer) Number of days before a log object is marked as expired in Swift. If None, the logs will be kept forever or until manually deleted. Used when the deploy_logs_storage_backend is configured to "swift". * - ``manage_agent_boot`` = ``True`` - (Boolean) 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. * - ``memory_consumed_by_agent`` = ``0`` diff --git a/doc/config-reference/source/tables/ironic-amqp.rst b/doc/config-reference/source/tables/ironic-amqp.rst index 2171f972d1..5a9e9fad74 100644 --- a/doc/config-reference/source/tables/ironic-amqp.rst +++ b/doc/config-reference/source/tables/ironic-amqp.rst @@ -21,4 +21,4 @@ * - ``control_exchange`` = ``openstack`` - (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. * - ``transport_url`` = ``None`` - - (String) 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) A URL representing the messaging driver to use and its full configuration. diff --git a/doc/config-reference/source/tables/ironic-api.rst b/doc/config-reference/source/tables/ironic-api.rst index 13e7d24a18..2a27cd9d41 100644 --- a/doc/config-reference/source/tables/ironic-api.rst +++ b/doc/config-reference/source/tables/ironic-api.rst @@ -30,12 +30,46 @@ - (Port number) The TCP port on which ironic-api listens. * - ``public_endpoint`` = ``None`` - (String) 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. + * - ``ramdisk_heartbeat_timeout`` = ``300`` + - (Integer) Maximum interval (in seconds) for agent heartbeats. + * - ``restrict_lookup`` = ``True`` + - (Boolean) Whether to restrict the lookup API to only nodes in certain states. + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (Boolean) Indicate that the actual request can include user credentials + * - ``allow_headers`` = + - (List) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH`` + - (List) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "://[:]", no trailing slash. Example: https://horizon.example.com + * - ``expose_headers`` = + - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (Integer) Maximum cache age of CORS preflight requests. + * - **[cors.subdomain]** + - + * - ``allow_credentials`` = ``True`` + - (Boolean) Indicate that the actual request can include user credentials + * - ``allow_headers`` = + - (List) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, PATCH`` + - (List) Indicate which methods can be used during the actual request. + * - ``allowed_origin`` = ``None`` + - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. Format: "://[:]", no trailing slash. Example: https://horizon.example.com + * - ``expose_headers`` = + - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + * - ``max_age`` = ``3600`` + - (Integer) Maximum cache age of CORS preflight requests. * - **[oslo_middleware]** - + * - ``enable_proxy_headers_parsing`` = ``False`` + - (Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. * - ``max_request_body_size`` = ``114688`` - (Integer) The maximum body size for each request, in bytes. * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` - - (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. + - (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy. * - **[oslo_versionedobjects]** - * - ``fatal_exception_format_errors`` = ``False`` diff --git a/doc/config-reference/source/tables/ironic-audit.rst b/doc/config-reference/source/tables/ironic-audit.rst new file mode 100644 index 0000000000..4688bc40d3 --- /dev/null +++ b/doc/config-reference/source/tables/ironic-audit.rst @@ -0,0 +1,36 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _ironic-audit: + +.. list-table:: Description of audit configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[audit]** + - + * - ``audit_map_file`` = ``/etc/ironic/ironic_api_audit_map.conf`` + - (String) Path to audit map file for ironic-api service. Used only when API audit is enabled. + * - ``enabled`` = ``False`` + - (Boolean) Enable auditing of API requests (for ironic-api service). + * - ``ignore_req_list`` = ``None`` + - (String) Comma separated list of Ironic REST API HTTP methods to be ignored during audit. For example: auditing will not be done on any GET or POST requests if this is set to "GET,POST". It is used only when API audit is enabled. + * - ``namespace`` = ``openstack`` + - (String) namespace prefix for generated id + * - **[audit_middleware_notifications]** + - + * - ``driver`` = ``None`` + - (String) The Driver to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop. If not specified, then value from oslo_messaging_notifications conf section is used. + * - ``topics`` = ``None`` + - (List) List of AMQP topics used for OpenStack notifications. If not specified, then value from oslo_messaging_notifications conf section is used. + * - ``transport_url`` = ``None`` + - (String) A URL representing messaging driver to use for notification. If not specified, we fall back to the same configuration used for RPC. diff --git a/doc/config-reference/source/tables/ironic-catalog.rst b/doc/config-reference/source/tables/ironic-catalog.rst new file mode 100644 index 0000000000..be1ef5c6b0 --- /dev/null +++ b/doc/config-reference/source/tables/ironic-catalog.rst @@ -0,0 +1,34 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _ironic-catalog: + +.. list-table:: Description of catalog configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[service_catalog]** + - + * - ``auth_section`` = ``None`` + - (Unknown) Config Section from which to load plugin specific options + * - ``auth_type`` = ``None`` + - (Unknown) Authentication type to load + * - ``cafile`` = ``None`` + - (String) PEM encoded Certificate Authority to use when verifying HTTPs connections. + * - ``certfile`` = ``None`` + - (String) PEM encoded client certificate cert file + * - ``insecure`` = ``False`` + - (Boolean) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (String) PEM encoded client certificate key file + * - ``timeout`` = ``None`` + - (Integer) Timeout value for http requests diff --git a/doc/config-reference/source/tables/ironic-common.rst b/doc/config-reference/source/tables/ironic-common.rst index 4d86cd50f8..4628a227e9 100644 --- a/doc/config-reference/source/tables/ironic-common.rst +++ b/doc/config-reference/source/tables/ironic-common.rst @@ -22,12 +22,16 @@ - (String) Directory where ironic binaries are installed. * - ``debug_tracebacks_in_api`` = ``False`` - (Boolean) Return server tracebacks in the API response for any error responses. WARNING: this is insecure and should not be used in a production environment. + * - ``default_network_interface`` = ``None`` + - (String) Default network interface to be used for nodes that do not have network_interface field set. A complete list of network interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.network" entrypoint. * - ``enabled_drivers`` = ``pxe_ipmitool`` - (List) Specify the list of drivers to load during service initialization. Missing drivers, or drivers which fail to initialize, will prevent the conductor service from starting. The option default is a recommended set of production-oriented drivers. A complete list of drivers present on your system may be found by enumerating the "ironic.drivers" entrypoint. An example may be found in the developer documentation online. + * - ``enabled_network_interfaces`` = ``flat, noop`` + - (List) Specify the list of network interfaces to load during service initialization. Missing network interfaces, or network interfaces which fail to initialize, will prevent the conductor service from starting. The option default is a recommended set of production-oriented network interfaces. A complete list of network interfaces present on your system may be found by enumerating the "ironic.hardware.interfaces.network" entrypoint. This value must be the same on all ironic-conductor and ironic-api services, because it is used by ironic-api service to validate a new or updated node's network_interface value. * - ``executor_thread_pool_size`` = ``64`` - (Integer) Size of executor thread pool. - * - ``fatal_deprecations`` = ``False`` - - (Boolean) Enables or disables fatal status of deprecations. + * - ``fatal_exception_format_errors`` = ``False`` + - (Boolean) Used if there is a formatting error when generating an exception message (a programming error). If True, raise an exception; if False, use the unformatted message. * - ``force_raw_images`` = ``True`` - (Boolean) If True, convert backing images to "raw" disk image format. * - ``grub_config_template`` = ``$pybasedir/common/grub_conf.template`` @@ -44,14 +48,12 @@ - (String) Path to isolinux binary file. * - ``isolinux_config_template`` = ``$pybasedir/common/isolinux_config.template`` - (String) Template file for isolinux configuration file. - * - ``memcached_servers`` = ``None`` - - (List) Memcached servers or None for in process cache. - * - ``my_ip`` = ``10.0.0.1`` + * - ``my_ip`` = ``127.0.0.1`` - (String) IP address of this host. If unset, will determine the IP programmatically. If unable to do so, will use "127.0.0.1". + * - ``notification_level`` = ``None`` + - (String) Specifies the minimum level for which to send notifications. If not set, no notifications will be sent. The default is for this option to be unset. * - ``parallel_image_downloads`` = ``False`` - (Boolean) Run image downloads and raw format conversions in parallel. - * - ``periodic_interval`` = ``60`` - - (Integer) DEPRECATED: Default interval (in seconds) for running driver periodic tasks. * - ``pybasedir`` = ``/usr/lib/python/site-packages/ironic/ironic`` - (String) Directory where the ironic python module is installed. * - ``rootwrap_config`` = ``/etc/ironic/rootwrap.conf`` diff --git a/doc/config-reference/source/tables/ironic-console.rst b/doc/config-reference/source/tables/ironic-console.rst index 41d5db249f..2a179a825d 100644 --- a/doc/config-reference/source/tables/ironic-console.rst +++ b/doc/config-reference/source/tables/ironic-console.rst @@ -23,8 +23,8 @@ * - ``subprocess_timeout`` = ``10`` - (Integer) Time (in seconds) to wait for the console subprocess to start. * - ``terminal`` = ``shellinaboxd`` - - (String) Path to serial console terminal program + - (String) Path to serial console terminal program. Used only by Shell In A Box console. * - ``terminal_cert_dir`` = ``None`` - - (String) Directory containing the terminal SSL cert(PEM) for serial console access + - (String) Directory containing the terminal SSL cert (PEM) for serial console access. Used only by Shell In A Box console. * - ``terminal_pid_dir`` = ``None`` - (String) Directory for holding terminal pid files. If not specified, the temporary directory will be used. diff --git a/doc/config-reference/source/tables/ironic-deploy.rst b/doc/config-reference/source/tables/ironic-deploy.rst index d54fa9d561..bb80930f70 100644 --- a/doc/config-reference/source/tables/ironic-deploy.rst +++ b/doc/config-reference/source/tables/ironic-deploy.rst @@ -18,8 +18,10 @@ - Description * - **[deploy]** - - * - ``erase_devices_iterations`` = ``1`` - - (Integer) Number of iterations to be run for erasing devices. + * - ``continue_if_disk_secure_erase_fails`` = ``False`` + - (Boolean) Defines what to do if an ATA secure erase operation fails during cleaning in the Ironic Python Agent. If False, the cleaning operation will fail and the node will be put in ``clean failed`` state. If True, shred will be invoked and cleaning will continue. + * - ``erase_devices_metadata_priority`` = ``None`` + - (Integer) Priority to run in-band clean step that erases metadata from devices, via the Ironic Python Agent ramdisk. If unset, will use the priority set in the ramdisk (defaults to 99 for the GenericHardwareManager). If set to 0, will not run during cleaning. * - ``erase_devices_priority`` = ``None`` - (Integer) 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. * - ``http_root`` = ``/httpboot`` @@ -28,3 +30,7 @@ - (String) ironic-conductor node's HTTP server URL. Example: http://192.1.2.3:8080 * - ``power_off_after_deploy_failure`` = ``True`` - (Boolean) Whether to power off a node after deploy failure. Defaults to True. + * - ``shred_final_overwrite_with_zeros`` = ``True`` + - (Boolean) Whether to write zeros to a node's block devices after writing random data. This will write zeros to the device even when deploy.shred_random_overwrite_iterations is 0. This option is only used if a device could not be ATA Secure Erased. Defaults to True. + * - ``shred_random_overwrite_iterations`` = ``1`` + - (Integer) During shred, overwrite all block devices N times with random data. This is only used if a device could not be ATA Secure Erased. Defaults to 1. diff --git a/doc/config-reference/source/tables/ironic-disk_partitioner.rst b/doc/config-reference/source/tables/ironic-disk_partitioner.rst index ecf61b6992..16496e29b0 100644 --- a/doc/config-reference/source/tables/ironic-disk_partitioner.rst +++ b/doc/config-reference/source/tables/ironic-disk_partitioner.rst @@ -24,6 +24,8 @@ - (Integer) The maximum number of times to check that the device is not accessed by another process. If the device is still busy after that, the disk partitioning will be treated as having failed. * - **[disk_utils]** - + * - ``bios_boot_partition_size`` = ``1`` + - (Integer) Size of BIOS Boot partition in MiB when configuring GPT partitioned systems for local boot in BIOS. * - ``dd_block_size`` = ``1M`` - (String) Block size to use when writing to the nodes disk. * - ``efi_system_partition_size`` = ``200`` diff --git a/doc/config-reference/source/tables/ironic-drac.rst b/doc/config-reference/source/tables/ironic-drac.rst new file mode 100644 index 0000000000..061e64fb81 --- /dev/null +++ b/doc/config-reference/source/tables/ironic-drac.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _ironic-drac: + +.. list-table:: Description of DRAC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[drac]** + - + * - ``query_raid_config_job_status_interval`` = ``120`` + - (Integer) Interval (in seconds) between periodic RAID job status checks to determine whether the asynchronous RAID configuration was successfully finished or not. diff --git a/doc/config-reference/source/tables/ironic-glance.rst b/doc/config-reference/source/tables/ironic-glance.rst index 965bbafa90..b6a559048e 100644 --- a/doc/config-reference/source/tables/ironic-glance.rst +++ b/doc/config-reference/source/tables/ironic-glance.rst @@ -20,8 +20,16 @@ - * - ``allowed_direct_url_schemes`` = - (List) A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file]. + * - ``auth_section`` = ``None`` + - (Unknown) Config Section from which to load plugin specific options * - ``auth_strategy`` = ``keystone`` - (String) Authentication strategy to use when connecting to glance. + * - ``auth_type`` = ``None`` + - (Unknown) Authentication type to load + * - ``cafile`` = ``None`` + - (String) PEM encoded Certificate Authority to use when verifying HTTPs connections. + * - ``certfile`` = ``None`` + - (String) PEM encoded client certificate cert file * - ``glance_api_insecure`` = ``False`` - (Boolean) Allow to perform insecure SSL (https) requests to glance. * - ``glance_api_servers`` = ``None`` @@ -36,6 +44,10 @@ - (Port number) Default glance port. * - ``glance_protocol`` = ``http`` - (String) Default protocol to use when connecting to glance. Set to https for SSL. + * - ``insecure`` = ``False`` + - (Boolean) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (String) PEM encoded client certificate key file * - ``swift_account`` = ``None`` - (String) The account that Glance uses to communicate with Swift. The format is "AUTH_uuid". "uuid" is the UUID for the account configured in the glance-api.conf. Required for temporary URLs when Glance backend is Swift. For example: "AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30". Swift temporary URL format: "endpoint_url/api_version/[account/]container/object_id" * - ``swift_api_version`` = ``v1`` @@ -56,3 +68,5 @@ - (String) The secret token given to Swift to allow temporary URL downloads. Required for temporary URLs. * - ``temp_url_endpoint_type`` = ``swift`` - (String) Type of endpoint to use for temporary URLs. If the Glance backend is Swift, use "swift"; if it is CEPH with RADOS gateway, use "radosgw". + * - ``timeout`` = ``None`` + - (Integer) Timeout value for http requests diff --git a/doc/config-reference/source/tables/ironic-iSCSI.rst b/doc/config-reference/source/tables/ironic-iSCSI.rst new file mode 100644 index 0000000000..26f7db33cf --- /dev/null +++ b/doc/config-reference/source/tables/ironic-iSCSI.rst @@ -0,0 +1,22 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _ironic-iSCSI: + +.. list-table:: Description of iSCSI configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[iscsi]** + - + * - ``portal_port`` = ``3260`` + - (Port number) The port number on which the iSCSI portal listens for incoming connections. diff --git a/doc/config-reference/source/tables/ironic-ilo.rst b/doc/config-reference/source/tables/ironic-ilo.rst index 6878970a1a..2471a73f86 100644 --- a/doc/config-reference/source/tables/ironic-ilo.rst +++ b/doc/config-reference/source/tables/ironic-ilo.rst @@ -18,10 +18,12 @@ - Description * - **[ilo]** - + * - ``ca_file`` = ``None`` + - (String) CA certificate file to validate iLO. * - ``clean_priority_clear_secure_boot_keys`` = ``0`` - (Integer) Priority for clear_secure_boot_keys clean step. This step is not enabled by default. It can be enabled to clear all secure boot keys enrolled with iLO. * - ``clean_priority_erase_devices`` = ``None`` - - (Integer) Priority for erase devices clean step. If unset, it defaults to 10. If set to 0, the step will be disabled and will not run during cleaning. + - (Integer) DEPRECATED: Priority for erase devices clean step. If unset, it defaults to 10. If set to 0, the step will be disabled and will not run during cleaning. This configuration option is duplicated by [deploy] erase_devices_priority, please use that instead. * - ``clean_priority_reset_bios_to_default`` = ``10`` - (Integer) Priority for reset_bios_to_default clean step. * - ``clean_priority_reset_ilo`` = ``0`` @@ -34,6 +36,8 @@ - (Port number) Port to be used for iLO operations * - ``client_timeout`` = ``60`` - (Integer) Timeout (in seconds) for iLO operations + * - ``default_boot_mode`` = ``auto`` + - (String) Default boot mode to be used in provisioning when "boot_mode" capability is not provided in the "properties/capabilities" of the node. The default is "auto" for backward compatibility. When "auto" is specified, default boot mode will be selected based on boot mode settings on the system. * - ``power_retry`` = ``6`` - (Integer) Number of times a power operation needs to be retried * - ``power_wait`` = ``2`` diff --git a/doc/config-reference/source/tables/ironic-inspector.rst b/doc/config-reference/source/tables/ironic-inspector.rst index d5f81fe560..f7d9c5ecbe 100644 --- a/doc/config-reference/source/tables/ironic-inspector.rst +++ b/doc/config-reference/source/tables/ironic-inspector.rst @@ -18,9 +18,23 @@ - Description * - **[inspector]** - + * - ``auth_section`` = ``None`` + - (Unknown) Config Section from which to load plugin specific options + * - ``auth_type`` = ``None`` + - (Unknown) Authentication type to load + * - ``cafile`` = ``None`` + - (String) PEM encoded Certificate Authority to use when verifying HTTPs connections. + * - ``certfile`` = ``None`` + - (String) PEM encoded client certificate cert file * - ``enabled`` = ``False`` - (Boolean) whether to enable inspection using ironic-inspector + * - ``insecure`` = ``False`` + - (Boolean) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (String) PEM encoded client certificate key file * - ``service_url`` = ``None`` - - (String) ironic-inspector HTTP endpoint. If this is not set, the ironic-inspector client default (http://127.0.0.1:5050) will be used. + - (String) ironic-inspector HTTP endpoint. If this is not set, the service catalog will be used. * - ``status_check_period`` = ``60`` - (Integer) period (in seconds) to check status of nodes on inspection + * - ``timeout`` = ``None`` + - (Integer) Timeout value for http requests diff --git a/doc/config-reference/source/tables/ironic-metrics.rst b/doc/config-reference/source/tables/ironic-metrics.rst new file mode 100644 index 0000000000..49db22bb7d --- /dev/null +++ b/doc/config-reference/source/tables/ironic-metrics.rst @@ -0,0 +1,38 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _ironic-metrics: + +.. list-table:: Description of metrics configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[metrics]** + - + * - ``agent_backend`` = ``noop`` + - (String) Backend for the agent ramdisk to use for metrics. Default possible backends are "noop" and "statsd". + * - ``agent_global_prefix`` = ``None`` + - (String) Prefix all metric names sent by the agent ramdisk with this value. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name. + * - ``agent_prepend_host`` = ``False`` + - (Boolean) Prepend the hostname to all metric names sent by the agent ramdisk. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name. + * - ``agent_prepend_host_reverse`` = ``True`` + - (Boolean) Split the prepended host value by "." and reverse it for metrics sent by the agent ramdisk (to better match the reverse hierarchical form of domain names). + * - ``agent_prepend_uuid`` = ``False`` + - (Boolean) Prepend the node's Ironic uuid to all metric names sent by the agent ramdisk. The format of metric names is [global_prefix.][uuid.][host_name.]prefix.metric_name. + * - ``backend`` = ``noop`` + - (String) Backend to use for the metrics system. + * - ``global_prefix`` = ``None`` + - (String) Prefix all metric names with this value. By default, there is no global prefix. The format of metric names is [global_prefix.][host_name.]prefix.metric_name. + * - ``prepend_host`` = ``False`` + - (Boolean) Prepend the hostname to all metric names. The format of metric names is [global_prefix.][host_name.]prefix.metric_name. + * - ``prepend_host_reverse`` = ``True`` + - (Boolean) Split the prepended host value by "." and reverse it (to better match the reverse hierarchical form of domain names). diff --git a/doc/config-reference/source/tables/ironic-metrics_stats.rst b/doc/config-reference/source/tables/ironic-metrics_stats.rst new file mode 100644 index 0000000000..fea2fa6b08 --- /dev/null +++ b/doc/config-reference/source/tables/ironic-metrics_stats.rst @@ -0,0 +1,28 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _ironic-metrics_stats: + +.. list-table:: Description of metrics_stats configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[metrics_statsd]** + - + * - ``agent_statsd_host`` = ``localhost`` + - (String) Host for the agent ramdisk to use with the statsd backend. This must be accessible from networks the agent is booted on. + * - ``agent_statsd_port`` = ``8125`` + - (Port number) Port for the agent ramdisk to use with the statsd backend. + * - ``statsd_host`` = ``localhost`` + - (String) Host for use with the statsd backend. + * - ``statsd_port`` = ``8125`` + - (Port number) Port to use with the statsd backend. diff --git a/doc/config-reference/source/tables/ironic-neutron.rst b/doc/config-reference/source/tables/ironic-neutron.rst index 7d1a6a7fab..9308d76b34 100644 --- a/doc/config-reference/source/tables/ironic-neutron.rst +++ b/doc/config-reference/source/tables/ironic-neutron.rst @@ -18,13 +18,31 @@ - Description * - **[neutron]** - + * - ``auth_section`` = ``None`` + - (Unknown) Config Section from which to load plugin specific options * - ``auth_strategy`` = ``keystone`` - - (String) Default authentication strategy to use when connecting to neutron. Running neutron in noauth mode (related to but not affected by this setting) is insecure and should only be used for testing. + - (String) Authentication strategy to use when connecting to neutron. Running neutron in noauth mode (related to but not affected by this setting) is insecure and should only be used for testing. + * - ``auth_type`` = ``None`` + - (Unknown) Authentication type to load + * - ``cafile`` = ``None`` + - (String) PEM encoded Certificate Authority to use when verifying HTTPs connections. + * - ``certfile`` = ``None`` + - (String) PEM encoded client certificate cert file * - ``cleaning_network_uuid`` = ``None`` - - (String) UUID of the network to create Neutron ports on, when booting to a ramdisk for cleaning using Neutron DHCP. + - (String) Neutron network UUID for the ramdisk to be booted into for cleaning nodes. Required for "neutron" network interface. It is also required if cleaning nodes when using "flat" network interface or "neutron" DHCP provider. + * - ``insecure`` = ``False`` + - (Boolean) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (String) PEM encoded client certificate key file + * - ``port_setup_delay`` = ``0`` + - (Integer) Delay value to wait for Neutron agents to setup sufficient DHCP configuration for port. + * - ``provisioning_network_uuid`` = ``None`` + - (String) Neutron network UUID for the ramdisk to be booted into for provisioning nodes. Required for "neutron" network interface. * - ``retries`` = ``3`` - (Integer) Client retries in the case of a failed request. - * - ``url`` = ``http://$my_ip:9696`` - - (String) URL for connecting to neutron. + * - ``timeout`` = ``None`` + - (Integer) Timeout value for http requests + * - ``url`` = ``None`` + - (String) URL for connecting to neutron. Default value translates to 'http://$my_ip:9696' when auth_strategy is 'noauth', and to discovery from Keystone catalog when auth_strategy is 'keystone'. * - ``url_timeout`` = ``30`` - (Integer) Timeout value for connecting to neutron in seconds. diff --git a/doc/config-reference/source/tables/ironic-oneview.rst b/doc/config-reference/source/tables/ironic-oneview.rst index fdcbf1d306..a19d00f974 100644 --- a/doc/config-reference/source/tables/ironic-oneview.rst +++ b/doc/config-reference/source/tables/ironic-oneview.rst @@ -19,14 +19,18 @@ * - **[oneview]** - * - ``allow_insecure_connections`` = ``False`` - - (Boolean) Option to allow insecure connection with OneView + - (Boolean) Option to allow insecure connection with OneView. + * - ``enable_periodic_tasks`` = ``True`` + - (Boolean) Whether to enable the periodic tasks for OneView driver be aware when OneView hardware resources are taken and released by Ironic or OneView users and proactively manage nodes in clean fail state according to Dynamic Allocation model of hardware resources allocation in OneView. * - ``manager_url`` = ``None`` - - (String) URL where OneView is available + - (String) URL where OneView is available. * - ``max_polling_attempts`` = ``12`` - - (Integer) Max connection retries to check changes on OneView + - (Integer) Max connection retries to check changes on OneView. * - ``password`` = ``None`` - - (String) OneView password to be used + - (String) OneView password to be used. + * - ``periodic_check_interval`` = ``300`` + - (Integer) Period (in seconds) for periodic tasks to be executed when enable_periodic_tasks=True. * - ``tls_cacert_file`` = ``None`` - - (String) Path to CA certificate + - (String) Path to CA certificate. * - ``username`` = ``None`` - - (String) OneView username to be used + - (String) OneView username to be used. diff --git a/doc/config-reference/source/tables/ironic-pxe.rst b/doc/config-reference/source/tables/ironic-pxe.rst index cdfdac5e88..9f6ae42414 100644 --- a/doc/config-reference/source/tables/ironic-pxe.rst +++ b/doc/config-reference/source/tables/ironic-pxe.rst @@ -20,8 +20,6 @@ - * - ``default_ephemeral_format`` = ``ext4`` - (String) Default file system format for ephemeral partition, if one is created. - * - ``disk_devices`` = ``cciss/c0d0,sda,hda,vda`` - - (String) The disk devices to scan while doing the deploy. * - ``image_cache_size`` = ``20480`` - (Integer) Maximum size (in MiB) of cache for master images, including those in use. * - ``image_cache_ttl`` = ``10080`` @@ -50,7 +48,7 @@ - (String) ironic-conductor node's TFTP root path. The ironic-conductor must have read/write access to this path. * - ``tftp_server`` = ``$my_ip`` - (String) IP address of ironic-conductor node's TFTP server. - * - ``uefi_pxe_bootfile_name`` = ``elilo.efi`` + * - ``uefi_pxe_bootfile_name`` = ``bootx64.efi`` - (String) Bootfile DHCP parameter for UEFI boot mode. - * - ``uefi_pxe_config_template`` = ``$pybasedir/drivers/modules/elilo_efi_pxe_config.template`` + * - ``uefi_pxe_config_template`` = ``$pybasedir/drivers/modules/pxe_grub_config.template`` - (String) On ironic-conductor node, template file for PXE configuration for UEFI boot loader. diff --git a/doc/config-reference/source/tables/ironic-rabbitmq.rst b/doc/config-reference/source/tables/ironic-rabbitmq.rst index 0fcaf06177..b8305ae615 100644 --- a/doc/config-reference/source/tables/ironic-rabbitmq.rst +++ b/doc/config-reference/source/tables/ironic-rabbitmq.rst @@ -24,8 +24,10 @@ - (Boolean) Use durable queues in AMQP. * - ``channel_max`` = ``None`` - (Integer) Maximum number of channels to allow + * - ``connection_factory`` = ``single`` + - (String) Connection factory implementation * - ``default_notification_exchange`` = ``${control_exchange}_notification`` - - (String) Exchange name for for sending notifications + - (String) Exchange name for sending notifications * - ``default_notification_retry_attempts`` = ``-1`` - (Integer) Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry. * - ``default_rpc_exchange`` = ``${control_exchange}_rpc`` @@ -36,7 +38,7 @@ - (Boolean) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake * - ``frame_max`` = ``None`` - (Integer) The maximum byte size for an AMQP frame - * - ``heartbeat_interval`` = ``1`` + * - ``heartbeat_interval`` = ``3`` - (Integer) How often to send heartbeats for consumer's connections * - ``heartbeat_rate`` = ``2`` - (Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat. @@ -45,7 +47,7 @@ * - ``host_connection_reconnect_delay`` = ``0.25`` - (Floating point) Set delay for reconnection to some host which has connection error * - ``kombu_compression`` = ``None`` - - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions. + - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. * - ``kombu_failover_strategy`` = ``round-robin`` - (String) 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. * - ``kombu_missing_consumer_retry_timeout`` = ``60`` @@ -68,7 +70,7 @@ - (Floating point) Reconnecting retry delay in case of connectivity problem during sending notification message * - ``pool_max_overflow`` = ``0`` - (Integer) Maximum number of connections to create above `pool_max_size`. - * - ``pool_max_size`` = ``10`` + * - ``pool_max_size`` = ``30`` - (Integer) Maximum number of connections to keep queued. * - ``pool_recycle`` = ``600`` - (Integer) Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire. @@ -79,19 +81,19 @@ * - ``rabbit_ha_queues`` = ``False`` - (Boolean) Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: "rabbitmqctl set_policy HA '^(?!amq\.).*' '{"ha-mode": "all"}' " * - ``rabbit_host`` = ``localhost`` - - (String) The RabbitMQ broker address where a single node is used. + - (String) DEPRECATED: The RabbitMQ broker address where a single node is used. Replaced by [DEFAULT]/transport_url * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` - - (List) RabbitMQ HA cluster host:port pairs. + - (List) DEPRECATED: RabbitMQ HA cluster host:port pairs. Replaced by [DEFAULT]/transport_url * - ``rabbit_interval_max`` = ``30`` - (Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds. * - ``rabbit_login_method`` = ``AMQPLAIN`` - (String) The RabbitMQ login method. * - ``rabbit_max_retries`` = ``0`` - - (Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + - (Integer) DEPRECATED: Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). * - ``rabbit_password`` = ``guest`` - - (String) The RabbitMQ password. + - (String) DEPRECATED: The RabbitMQ password. Replaced by [DEFAULT]/transport_url * - ``rabbit_port`` = ``5672`` - - (Port number) The RabbitMQ broker port where a single node is used. + - (Port number) DEPRECATED: The RabbitMQ broker port where a single node is used. Replaced by [DEFAULT]/transport_url * - ``rabbit_qos_prefetch_count`` = ``0`` - (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. * - ``rabbit_retry_backoff`` = ``2`` @@ -103,9 +105,9 @@ * - ``rabbit_use_ssl`` = ``False`` - (Boolean) Connect over SSL for RabbitMQ. * - ``rabbit_userid`` = ``guest`` - - (String) The RabbitMQ userid. + - (String) DEPRECATED: The RabbitMQ userid. Replaced by [DEFAULT]/transport_url * - ``rabbit_virtual_host`` = ``/`` - - (String) The RabbitMQ virtual host. + - (String) DEPRECATED: The RabbitMQ virtual host. Replaced by [DEFAULT]/transport_url * - ``rpc_listener_prefetch_count`` = ``100`` - (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc listener. * - ``rpc_queue_expiration`` = ``60`` diff --git a/doc/config-reference/source/tables/ironic-redis.rst b/doc/config-reference/source/tables/ironic-redis.rst index 066eed8f0d..3a6f847921 100644 --- a/doc/config-reference/source/tables/ironic-redis.rst +++ b/doc/config-reference/source/tables/ironic-redis.rst @@ -21,16 +21,16 @@ * - ``check_timeout`` = ``20000`` - (Integer) Time in ms to wait before the transaction is killed. * - ``host`` = ``127.0.0.1`` - - (String) Host to locate redis. + - (String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url * - ``password`` = - - (String) Password for Redis server (optional). + - (String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url * - ``port`` = ``6379`` - - (Port number) Use this port to connect to redis host. + - (Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url * - ``sentinel_group_name`` = ``oslo-messaging-zeromq`` - (String) Redis replica set name. * - ``sentinel_hosts`` = - - (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] - * - ``socket_timeout`` = ``1000`` + - (List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] Replaced by [DEFAULT]/transport_url + * - ``socket_timeout`` = ``10000`` - (Integer) Timeout in ms on blocking socket operations - * - ``wait_timeout`` = ``500`` + * - ``wait_timeout`` = ``2000`` - (Integer) Time in ms to wait between connection attempts. diff --git a/doc/config-reference/source/tables/ironic-rpc.rst b/doc/config-reference/source/tables/ironic-rpc.rst index b14fa84906..0bf4b390c6 100644 --- a/doc/config-reference/source/tables/ironic-rpc.rst +++ b/doc/config-reference/source/tables/ironic-rpc.rst @@ -19,7 +19,7 @@ * - **[DEFAULT]** - * - ``rpc_backend`` = ``rabbit`` - - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. + - (String) DEPRECATED: The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. Replaced by [DEFAULT]/transport_url * - ``rpc_cast_timeout`` = ``-1`` - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. * - ``rpc_conn_pool_size`` = ``30`` @@ -36,18 +36,52 @@ - (String) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. * - **[oslo_messaging_amqp]** - + * - ``addressing_mode`` = ``dynamic`` + - (String) Indicates the addressing mode used by the driver. Permitted values: 'legacy' - use legacy non-routable addressing 'routable' - use routable addresses 'dynamic' - use legacy addresses if the message bus does not support routing otherwise use routable addressing * - ``allow_insecure_clients`` = ``False`` - (Boolean) Accept clients using either SSL or plain TCP + * - ``anycast_address`` = ``anycast`` + - (String) Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers. * - ``broadcast_prefix`` = ``broadcast`` - (String) address prefix used when broadcasting to all servers + * - ``connection_retry_backoff`` = ``2`` + - (Integer) Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. + * - ``connection_retry_interval`` = ``1`` + - (Integer) Seconds to pause before attempting to re-connect. + * - ``connection_retry_interval_max`` = ``30`` + - (Integer) Maximum limit for connection_retry_interval + connection_retry_backoff * - ``container_name`` = ``None`` - - (String) Name for the AMQP container + - (String) Name for the AMQP container. must be globally unique. Defaults to a generated UUID + * - ``default_notification_exchange`` = ``None`` + - (String) Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else 'notify' + * - ``default_notify_timeout`` = ``30`` + - (Integer) The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. + * - ``default_reply_timeout`` = ``30`` + - (Integer) The deadline for an rpc reply message delivery. Only used when caller does not provide a timeout expiry. + * - ``default_rpc_exchange`` = ``None`` + - (String) Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else 'rpc' + * - ``default_send_timeout`` = ``30`` + - (Integer) The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. * - ``group_request_prefix`` = ``unicast`` - (String) address prefix when sending to any server in group * - ``idle_timeout`` = ``0`` - (Integer) Timeout for inactive connections (in seconds) + * - ``link_retry_delay`` = ``10`` + - (Integer) Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. + * - ``multicast_address`` = ``multicast`` + - (String) Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. + * - ``notify_address_prefix`` = ``openstack.org/om/notify`` + - (String) Address prefix for all generated Notification addresses + * - ``notify_server_credit`` = ``100`` + - (Integer) Window size for incoming Notification messages * - ``password`` = - (String) Password for message broker authentication + * - ``reply_link_credit`` = ``200`` + - (Integer) Window size for incoming RPC Reply messages. + * - ``rpc_address_prefix`` = ``openstack.org/om/rpc`` + - (String) Address prefix for all generated RPC addresses + * - ``rpc_server_credit`` = ``100`` + - (Integer) Window size for incoming RPC Request messages * - ``sasl_config_dir`` = - (String) Path to directory that contains the SASL configuration * - ``sasl_config_name`` = @@ -66,6 +100,8 @@ - (String) Password for decrypting ssl_key_file (if encrypted) * - ``trace`` = ``False`` - (Boolean) Debug: dump AMQP frames to stdout + * - ``unicast_address`` = ``unicast`` + - (String) Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination. * - ``username`` = - (String) User name for message broker authentication * - **[oslo_messaging_notifications]** diff --git a/doc/config-reference/source/tables/ironic-swift.rst b/doc/config-reference/source/tables/ironic-swift.rst index 091f0a5651..5d67916263 100644 --- a/doc/config-reference/source/tables/ironic-swift.rst +++ b/doc/config-reference/source/tables/ironic-swift.rst @@ -18,5 +18,19 @@ - Description * - **[swift]** - + * - ``auth_section`` = ``None`` + - (Unknown) Config Section from which to load plugin specific options + * - ``auth_type`` = ``None`` + - (Unknown) Authentication type to load + * - ``cafile`` = ``None`` + - (String) PEM encoded Certificate Authority to use when verifying HTTPs connections. + * - ``certfile`` = ``None`` + - (String) PEM encoded client certificate cert file + * - ``insecure`` = ``False`` + - (Boolean) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (String) PEM encoded client certificate key file * - ``swift_max_retries`` = ``2`` - (Integer) Maximum number of times to retry a Swift request, before failing. + * - ``timeout`` = ``None`` + - (Integer) Timeout value for http requests diff --git a/doc/config-reference/source/tables/ironic-zeromq.rst b/doc/config-reference/source/tables/ironic-zeromq.rst index 30c8e87a5d..c6f3349d46 100644 --- a/doc/config-reference/source/tables/ironic-zeromq.rst +++ b/doc/config-reference/source/tables/ironic-zeromq.rst @@ -22,8 +22,6 @@ - (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. * - ``rpc_zmq_bind_port_retries`` = ``100`` - (Integer) Number of retries to find free port number before fail with ZMQBindError. - * - ``rpc_zmq_concurrency`` = ``eventlet`` - - (String) Type of concurrency used. Either "native" or "eventlet" * - ``rpc_zmq_contexts`` = ``1`` - (Integer) Number of ZeroMQ contexts, defaults to 1. * - ``rpc_zmq_host`` = ``localhost`` @@ -34,11 +32,53 @@ - (String) MatchMaker driver. * - ``rpc_zmq_max_port`` = ``65536`` - (Integer) Maximal port number for random ports range. - * - ``rpc_zmq_min_port`` = ``49152`` + * - ``rpc_zmq_min_port`` = ``49153`` - (Port number) Minimal port number for random ports range. + * - ``rpc_zmq_serialization`` = ``json`` + - (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages * - ``rpc_zmq_topic_backlog`` = ``None`` - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. * - ``use_pub_sub`` = ``True`` - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. - * - ``zmq_target_expire`` = ``120`` + * - ``zmq_immediate`` = ``False`` + - (Boolean) This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it. + * - ``zmq_target_expire`` = ``300`` - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). + * - ``zmq_target_update`` = ``180`` + - (Integer) Update period in seconds of a name service record about existing target. + * - **[oslo_messaging_zmq]** + - + * - ``rpc_cast_timeout`` = ``-1`` + - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. + * - ``rpc_poll_timeout`` = ``1`` + - (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_zmq_bind_address`` = ``*`` + - (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (Integer) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_contexts`` = ``1`` + - (Integer) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (String) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (String) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (String) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (Integer) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49153`` + - (Port number) Minimal port number for random ports range. + * - ``rpc_zmq_serialization`` = ``json`` + - (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``use_pub_sub`` = ``True`` + - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. + * - ``use_router_proxy`` = ``True`` + - (Boolean) Use ROUTER remote proxy. + * - ``zmq_immediate`` = ``False`` + - (Boolean) This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it. + * - ``zmq_target_expire`` = ``300`` + - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). + * - ``zmq_target_update`` = ``180`` + - (Integer) Update period in seconds of a name service record about existing target. diff --git a/tools/autogenerate-config-flagmappings/ironic.flagmappings b/tools/autogenerate-config-flagmappings/ironic.flagmappings index c8e6eda41f..0f92474b7c 100644 --- a/tools/autogenerate-config-flagmappings/ironic.flagmappings +++ b/tools/autogenerate-config-flagmappings/ironic.flagmappings @@ -1,10 +1,14 @@ auth_strategy auth bindir common +conn_pool_min_size disable +conn_pool_ttl disable control_exchange amqp debug disable debug_tracebacks_in_api common default_log_levels disable +default_network_interface common enabled_drivers common +enabled_network_interfaces common executor_thread_pool_size common fatal_deprecations disable fatal_exception_format_errors common @@ -27,11 +31,10 @@ logging_debug_format_suffix disable logging_default_format_string disable logging_exception_prefix disable logging_user_identity_format disable -memcached_servers common my_ip common +notification_level common parallel_image_downloads common pecan_debug debug -periodic_interval common publish_errors disable pybasedir common rootwrap_config common @@ -42,28 +45,33 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_bind_address zeromq rpc_zmq_bind_port_retries zeromq -rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq rpc_zmq_max_port zeromq rpc_zmq_min_port zeromq +rpc_zmq_serialization zeromq rpc_zmq_topic_backlog zeromq state_path common syslog_log_facility disable tempdir common transport_url amqp use_pub_sub zeromq +use_router_proxy disable use_stderr disable use_syslog disable verbose disable watch_log_file disable +zmq_immediate zeromq zmq_target_expire zeromq +zmq_target_update zeromq agent/agent_api_version agent -agent/agent_pxe_append_params agent -agent/agent_pxe_config_template agent -agent/heartbeat_timeout agent +agent/deploy_logs_collect agent +agent/deploy_logs_local_path agent +agent/deploy_logs_storage_backend agent +agent/deploy_logs_swift_container agent +agent/deploy_logs_swift_days_to_expire agent agent/manage_agent_boot agent agent/memory_consumed_by_agent agent agent/post_deploy_get_power_state_retries agent @@ -79,6 +87,15 @@ api/host_ip api api/max_limit api api/port api api/public_endpoint api +api/ramdisk_heartbeat_timeout api +api/restrict_lookup api +audit/audit_map_file audit +audit/enabled audit +audit/ignore_req_list audit +audit/namespace audit +audit_middleware_notifications/driver audit +audit_middleware_notifications/topics audit +audit_middleware_notifications/transport_url audit cimc/action_interval cisco_ucs cimc/max_retry cisco_ucs cisco_ucs/action_interval cisco_ucs @@ -142,19 +159,28 @@ database/slave_connection disable database/sqlite_db disable database/sqlite_synchronous disable database/use_db_reconnect disable -deploy/erase_devices_iterations deploy +deploy/continue_if_disk_secure_erase_fails deploy +deploy/erase_devices_metadata_priority deploy deploy/erase_devices_priority deploy deploy/http_root deploy deploy/http_url deploy deploy/power_off_after_deploy_failure deploy +deploy/shred_final_overwrite_with_zeros deploy +deploy/shred_random_overwrite_iterations deploy dhcp/dhcp_provider dhcp disk_partitioner/check_device_interval disk_partitioner disk_partitioner/check_device_max_retries disk_partitioner +disk_utils/bios_boot_partition_size disk_partitioner disk_utils/dd_block_size disk_partitioner disk_utils/efi_system_partition_size disk_partitioner disk_utils/iscsi_verify_attempts disk_partitioner +drac/query_raid_config_job_status_interval drac glance/allowed_direct_url_schemes glance +glance/auth_section glance glance/auth_strategy glance +glance/auth_type glance +glance/cafile glance +glance/certfile glance glance/glance_api_insecure glance glance/glance_api_servers glance glance/glance_cafile glance @@ -162,6 +188,8 @@ glance/glance_host glance glance/glance_num_retries glance glance/glance_port glance glance/glance_protocol glance +glance/insecure glance +glance/keyfile glance glance/swift_account glance glance/swift_api_version glance glance/swift_container glance @@ -172,9 +200,11 @@ glance/swift_temp_url_duration glance glance/swift_temp_url_expected_download_start_delay glance glance/swift_temp_url_key glance glance/temp_url_endpoint_type glance +glance/timeout glance iboot/max_retry iboot iboot/reboot_delay iboot iboot/retry_interval iboot +ilo/ca_file ilo ilo/clean_priority_clear_secure_boot_keys ilo ilo/clean_priority_erase_devices ilo ilo/clean_priority_reset_bios_to_default ilo @@ -183,14 +213,22 @@ ilo/clean_priority_reset_ilo_credential ilo ilo/clean_priority_reset_secure_boot_keys_to_default ilo ilo/client_port ilo ilo/client_timeout ilo +ilo/default_boot_mode ilo 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/auth_section inspector +inspector/auth_type inspector +inspector/cafile inspector +inspector/certfile inspector inspector/enabled inspector +inspector/insecure inspector +inspector/keyfile inspector inspector/service_url inspector inspector/status_check_period inspector +inspector/timeout inspector ipmi/min_command_interval ipmi ipmi/retry_timeout ipmi irmc/auth_method irmc @@ -210,6 +248,7 @@ irmc/snmp_security irmc irmc/snmp_version irmc ironic_lib/fatal_exception_format_errors common ironic_lib/root_helper common +iscsi/portal_port iSCSI keystone/region_name keystone keystone_authtoken/admin_password disable keystone_authtoken/admin_tenant_name disable @@ -257,25 +296,66 @@ matchmaker_redis/sentinel_group_name redis matchmaker_redis/sentinel_hosts redis matchmaker_redis/socket_timeout redis matchmaker_redis/wait_timeout redis +metrics/agent_backend metrics +metrics/agent_global_prefix metrics +metrics/agent_prepend_host metrics +metrics/agent_prepend_host_reverse metrics +metrics/agent_prepend_uuid metrics +metrics/backend metrics +metrics/global_prefix metrics +metrics/prepend_host metrics +metrics/prepend_host_reverse metrics +metrics_statsd/agent_statsd_host metrics_stats +metrics_statsd/agent_statsd_port metrics_stats +metrics_statsd/statsd_host metrics_stats +metrics_statsd/statsd_port metrics_stats +neutron/auth_section neutron neutron/auth_strategy neutron +neutron/auth_type neutron +neutron/cafile neutron +neutron/certfile neutron neutron/cleaning_network_uuid neutron +neutron/insecure neutron +neutron/keyfile neutron +neutron/port_setup_delay neutron +neutron/provisioning_network_uuid neutron neutron/retries neutron +neutron/timeout neutron neutron/url neutron neutron/url_timeout neutron oneview/allow_insecure_connections oneview +oneview/enable_periodic_tasks oneview oneview/manager_url oneview oneview/max_polling_attempts oneview oneview/password oneview +oneview/periodic_check_interval oneview oneview/tls_cacert_file oneview oneview/username oneview oslo_concurrency/disable_process_locking rpc oslo_concurrency/lock_path rpc +oslo_messaging_amqp/addressing_mode rpc oslo_messaging_amqp/allow_insecure_clients rpc +oslo_messaging_amqp/anycast_address rpc oslo_messaging_amqp/broadcast_prefix rpc +oslo_messaging_amqp/connection_retry_backoff rpc +oslo_messaging_amqp/connection_retry_interval rpc +oslo_messaging_amqp/connection_retry_interval_max rpc oslo_messaging_amqp/container_name rpc +oslo_messaging_amqp/default_notification_exchange rpc +oslo_messaging_amqp/default_notify_timeout rpc +oslo_messaging_amqp/default_reply_timeout rpc +oslo_messaging_amqp/default_rpc_exchange rpc +oslo_messaging_amqp/default_send_timeout rpc oslo_messaging_amqp/group_request_prefix rpc oslo_messaging_amqp/idle_timeout rpc +oslo_messaging_amqp/link_retry_delay rpc +oslo_messaging_amqp/multicast_address rpc +oslo_messaging_amqp/notify_address_prefix rpc +oslo_messaging_amqp/notify_server_credit rpc oslo_messaging_amqp/password rpc +oslo_messaging_amqp/reply_link_credit rpc +oslo_messaging_amqp/rpc_address_prefix rpc +oslo_messaging_amqp/rpc_server_credit rpc oslo_messaging_amqp/sasl_config_dir rpc oslo_messaging_amqp/sasl_config_name rpc oslo_messaging_amqp/sasl_mechanisms rpc @@ -285,6 +365,7 @@ 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/unicast_address rpc oslo_messaging_amqp/username rpc oslo_messaging_notifications/driver rpc oslo_messaging_notifications/topics rpc @@ -292,6 +373,7 @@ oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/connection_factory rabbitmq oslo_messaging_rabbit/default_notification_exchange rabbitmq oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq oslo_messaging_rabbit/default_rpc_exchange rabbitmq @@ -344,6 +426,24 @@ oslo_messaging_rabbit/socket_timeout rabbitmq oslo_messaging_rabbit/ssl rabbitmq oslo_messaging_rabbit/ssl_options rabbitmq oslo_messaging_rabbit/tcp_user_timeout rabbitmq +oslo_messaging_zmq/rpc_cast_timeout zeromq +oslo_messaging_zmq/rpc_poll_timeout zeromq +oslo_messaging_zmq/rpc_zmq_bind_address zeromq +oslo_messaging_zmq/rpc_zmq_bind_port_retries zeromq +oslo_messaging_zmq/rpc_zmq_contexts zeromq +oslo_messaging_zmq/rpc_zmq_host zeromq +oslo_messaging_zmq/rpc_zmq_ipc_dir zeromq +oslo_messaging_zmq/rpc_zmq_matchmaker zeromq +oslo_messaging_zmq/rpc_zmq_max_port zeromq +oslo_messaging_zmq/rpc_zmq_min_port zeromq +oslo_messaging_zmq/rpc_zmq_serialization zeromq +oslo_messaging_zmq/rpc_zmq_topic_backlog zeromq +oslo_messaging_zmq/use_pub_sub zeromq +oslo_messaging_zmq/use_router_proxy zeromq +oslo_messaging_zmq/zmq_immediate zeromq +oslo_messaging_zmq/zmq_target_expire zeromq +oslo_messaging_zmq/zmq_target_update zeromq +oslo_middleware/enable_proxy_headers_parsing api oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule disable @@ -351,7 +451,6 @@ oslo_policy/policy_dirs disable oslo_policy/policy_file disable oslo_versionedobjects/fatal_exception_format_errors api pxe/default_ephemeral_format pxe -pxe/disk_devices pxe pxe/image_cache_size pxe pxe/image_cache_ttl pxe pxe/images_path pxe @@ -370,10 +469,24 @@ pxe/uefi_pxe_bootfile_name pxe pxe/uefi_pxe_config_template pxe seamicro/action_timeout seamicro seamicro/max_retry seamicro +service_catalog/auth_section catalog +service_catalog/auth_type catalog +service_catalog/cafile catalog +service_catalog/certfile catalog +service_catalog/insecure catalog +service_catalog/keyfile catalog +service_catalog/timeout catalog snmp/power_timeout snmp snmp/reboot_delay snmp ssh/get_vm_name_attempts ssh ssh/get_vm_name_retry_interval ssh ssh/libvirt_uri ssh +swift/auth_section swift +swift/auth_type swift +swift/cafile swift +swift/certfile swift +swift/insecure swift +swift/keyfile swift swift/swift_max_retries swift +swift/timeout swift virtualbox/port virtualbox diff --git a/tools/autogenerate-config-flagmappings/ironic.headers b/tools/autogenerate-config-flagmappings/ironic.headers index d654c7ec8f..5eace97b2d 100644 --- a/tools/autogenerate-config-flagmappings/ironic.headers +++ b/tools/autogenerate-config-flagmappings/ironic.headers @@ -8,6 +8,7 @@ iboot iBoot Web Power Switch ilo iLO inspector inspector irmc iRMC +iscsi iSCSI keystone keystone oneview OneView seamicro SeaMicro