From 9345473f62419e14cea64f577c5a519aab99fa9e Mon Sep 17 00:00:00 2001 From: Atsushi SAKAI Date: Thu, 3 Sep 2015 14:52:38 +0900 Subject: [PATCH] Update Config reference for ironic Change-Id: I39e5bc772b229767b989a8fcdf5434149dc0c8cf Partial-Bug: #1407581 --- doc/common/tables/ironic-agent.xml | 12 ++-- doc/common/tables/ironic-api.xml | 65 +++++++++++++++++++ doc/common/tables/ironic-common.xml | 8 ++- doc/common/tables/ironic-conductor.xml | 4 ++ doc/common/tables/ironic-deploy.xml | 8 +++ doc/common/tables/ironic-logging.xml | 10 +-- doc/common/tables/ironic-pxe.xml | 8 --- doc/common/tables/ironic-qpid.xml | 2 +- doc/common/tables/ironic-rabbitmq.xml | 2 +- doc/common/tables/ironic-rpc.xml | 4 -- .../ironic.flagmappings | 24 +++++-- 11 files changed, 113 insertions(+), 34 deletions(-) diff --git a/doc/common/tables/ironic-agent.xml b/doc/common/tables/ironic-agent.xml index 565e13cde2..3eb074137a 100644 --- a/doc/common/tables/ironic-agent.xml +++ b/doc/common/tables/ironic-agent.xml @@ -31,23 +31,19 @@ = nofb nomodeset vga=normal - (StrOpt) Additional append parameters for baremetal PXE boot. - - - = pxelinux.0 - (StrOpt) Neutron bootfile DHCP parameter. + (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. = $pybasedir/drivers/modules/agent_config.template - (StrOpt) Template file for PXE configuration. + (StrOpt) DEPRECATED. Template file for PXE configuration. This option is deprecated and will be removed in Mitaka release. Please use [pxe]pxe_config_template instead. = 300 (IntOpt) Maximum interval (in seconds) for agent heartbeats. - = True - (BoolOpt) Whether Ironic will manage TFTP files for the deploy ramdisks. If set to False, you will need to configure your own TFTP server that allows booting the deploy ramdisks. + = 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. = 6 diff --git a/doc/common/tables/ironic-api.xml b/doc/common/tables/ironic-api.xml index a5534b76dc..fec62c058f 100644 --- a/doc/common/tables/ironic-api.xml +++ b/doc/common/tables/ironic-api.xml @@ -29,6 +29,71 @@ = 6385 (IntOpt) The TCP port on which ironic-api listens. + + [cors] + + + = True + (BoolOpt) Indicate that the actual request can include user credentials + + + = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma + (ListOpt) Indicate which header field names may be used during the actual request. + + + = GET, POST, PUT, DELETE, OPTIONS + (ListOpt) Indicate which methods can be used during the actual request. + + + = None + (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + + + = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma + (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + + + = 3600 + (IntOpt) Maximum cache age of CORS preflight requests. + + + [cors.subdomain] + + + = True + (BoolOpt) Indicate that the actual request can include user credentials + + + = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma + (ListOpt) Indicate which header field names may be used during the actual request. + + + = GET, POST, PUT, DELETE, OPTIONS + (ListOpt) Indicate which methods can be used during the actual request. + + + = None + (StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. + + + = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma + (ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. + + + = 3600 + (IntOpt) Maximum cache age of CORS preflight requests. + + + [oslo_middleware] + + + = 114688 + (IntOpt) The maximum body size for each request, in bytes. + + + = X-Forwarded-Proto + (StrOpt) 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. + [oslo_versionedobjects] diff --git a/doc/common/tables/ironic-common.xml b/doc/common/tables/ironic-common.xml index b292126b61..c28b075447 100644 --- a/doc/common/tables/ironic-common.xml +++ b/doc/common/tables/ironic-common.xml @@ -25,6 +25,10 @@ = pxe_ipmitool (ListOpt) 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. + + = 64 + (IntOpt) Size of executor thread pool. + = False (BoolOpt) Enables or disables fatal status of deprecations. @@ -46,7 +50,7 @@ (IntOpt) Exponent to determine number of hash partitions to use when distributing load across conductors. Larger values will result in more even distribution of load and less load when rebalancing the ring, but more memory usage. Number of partitions per conductor is (2^hash_partition_exponent). This determines the granularity of rebalancing: given 10 hosts, and an exponent of the 2, there are 40 partitions in the ring.A few thousand partitions should make rebalancing smooth in most cases. The default is suitable for up to a few hundred conductors. Too many partitions has a CPU impact. - = sd-52009.dedibox.fr + = localhost (StrOpt) Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address. @@ -74,7 +78,7 @@ (IntOpt) Seconds between running periodic tasks. - = /usr/lib/python/site-packages/ironic/ironic + = /home/sakaia/work/openstack-doc-tools/autogenerate_config_docs/sources/ironic/ironic (StrOpt) Directory where the ironic python module is installed. diff --git a/doc/common/tables/ironic-conductor.xml b/doc/common/tables/ironic-conductor.xml index 4beb6b23c1..e88225cd35 100644 --- a/doc/common/tables/ironic-conductor.xml +++ b/doc/common/tables/ironic-conductor.xml @@ -25,6 +25,10 @@ = 60 (IntOpt) Interval between checks of provision timeouts, in seconds. + + = 1800 + (IntOpt) Timeout (seconds) to wait for a callback from the ramdisk doing the cleaning. If the timeout is reached the node will be put in the "clean failed" provision state. Set to 0 to disable timeout. + = True (BoolOpt) Cleaning is a configurable set of steps, such as erasing disk drives, that are performed on the node to ensure it is in a baseline state and ready to be deployed to. This is done after instance deletion, and during the transition from a "managed" to "available" state. When enabled, the particular steps performed to clean a node depend on which driver that node is managed by; see the individual driver's documentation for details. NOTE: The introduction of the cleaning operation causes instance deletion to take significantly longer. In an environment where all tenants are trusted (eg, because there is only one tenant), this option could be safely disabled. diff --git a/doc/common/tables/ironic-deploy.xml b/doc/common/tables/ironic-deploy.xml index 93dac5d699..338ec495f7 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. + + = /httpboot + (StrOpt) ironic-conductor node's HTTP root path. + + + = None + (StrOpt) ironic-conductor node's HTTP server URL. Example: http://192.1.2.3:8080 + = 3 (IntOpt) Maximum attempts to verify an iSCSI connection is active, sleeping 1 second between attempts. diff --git a/doc/common/tables/ironic-logging.xml b/doc/common/tables/ironic-logging.xml index 5893ffc789..c6cf4c1a7e 100644 --- a/doc/common/tables/ironic-logging.xml +++ b/doc/common/tables/ironic-logging.xml @@ -19,10 +19,10 @@ = False - (BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). + (BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). - = 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 + = 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. @@ -91,11 +91,11 @@ = 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 K, and will be removed in M, 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. - = False - (BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). + = True + (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. diff --git a/doc/common/tables/ironic-pxe.xml b/doc/common/tables/ironic-pxe.xml index 194e09126a..c940ebe262 100644 --- a/doc/common/tables/ironic-pxe.xml +++ b/doc/common/tables/ironic-pxe.xml @@ -25,14 +25,6 @@ = cciss/c0d0,sda,hda,vda (StrOpt) The disk devices to scan while doing the deploy. - - = /httpboot - (StrOpt) ironic-conductor node's HTTP root path. - - - = None - (StrOpt) ironic-conductor node's HTTP server URL. Example: http://192.1.2.3:8080 - = 20480 (IntOpt) Maximum size (in MiB) of cache for master images, including those in use. diff --git a/doc/common/tables/ironic-qpid.xml b/doc/common/tables/ironic-qpid.xml index 421cc58b24..773fe8ce16 100644 --- a/doc/common/tables/ironic-qpid.xml +++ b/doc/common/tables/ironic-qpid.xml @@ -71,7 +71,7 @@ = False - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release. + (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/common/tables/ironic-rabbitmq.xml b/doc/common/tables/ironic-rabbitmq.xml index 232ba1095c..eeac5a27e2 100644 --- a/doc/common/tables/ironic-rabbitmq.xml +++ b/doc/common/tables/ironic-rabbitmq.xml @@ -111,7 +111,7 @@ = False - (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release. + (BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. diff --git a/doc/common/tables/ironic-rpc.xml b/doc/common/tables/ironic-rpc.xml index 8724e1a6ef..2fafd41269 100644 --- a/doc/common/tables/ironic-rpc.xml +++ b/doc/common/tables/ironic-rpc.xml @@ -41,10 +41,6 @@ = 60 (IntOpt) Seconds to wait for a response from a call. - - = 64 - (IntOpt) Size of RPC thread pool. - [oslo_concurrency] diff --git a/tools/autogenerate-config-flagmappings/ironic.flagmappings b/tools/autogenerate-config-flagmappings/ironic.flagmappings index 677928f211..e5b897ad9e 100644 --- a/tools/autogenerate-config-flagmappings/ironic.flagmappings +++ b/tools/autogenerate-config-flagmappings/ironic.flagmappings @@ -4,6 +4,7 @@ control_exchange amqp debug logging default_log_levels logging enabled_drivers common +executor_thread_pool_size common fatal_deprecations common fatal_exception_format_errors logging force_raw_images common @@ -40,7 +41,6 @@ rpc_backend rpc rpc_cast_timeout rpc rpc_conn_pool_size rpc rpc_response_timeout rpc -rpc_thread_pool_size rpc rpc_zmq_bind_address zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq @@ -60,10 +60,9 @@ 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_bootfile_name agent agent/agent_pxe_config_template agent agent/heartbeat_timeout agent -agent/manage_tftp agent +agent/manage_agent_boot agent agent/post_deploy_get_power_state_retries agent agent/post_deploy_get_power_state_retry_interval agent amt/action_wait amt @@ -76,6 +75,7 @@ cisco_ucs/action_interval cisco_ucs cisco_ucs/max_retry cisco_ucs conductor/api_url conductor conductor/check_provision_state_interval conductor +conductor/clean_callback_timeout conductor conductor/clean_nodes conductor conductor/configdrive_swift_container conductor conductor/configdrive_use_swift conductor @@ -99,6 +99,18 @@ console/subprocess_timeout console console/terminal console console/terminal_cert_dir console console/terminal_pid_dir console +cors/allow_credentials api +cors/allow_headers api +cors/allow_methods api +cors/allowed_origin api +cors/expose_headers api +cors/max_age api +cors.subdomain/allow_credentials api +cors.subdomain/allow_headers api +cors.subdomain/allow_methods api +cors.subdomain/allowed_origin api +cors.subdomain/expose_headers api +cors.subdomain/max_age api database/backend database database/connection database database/connection_debug database @@ -122,6 +134,8 @@ database/sqlite_synchronous database database/use_db_reconnect database deploy/dd_block_size deploy deploy/efi_system_partition_size deploy +deploy/http_root deploy +deploy/http_url deploy deploy/iscsi_verify_attempts deploy dhcp/dhcp_provider dhcp disk_partitioner/check_device_interval disk_partitioner @@ -269,14 +283,14 @@ oslo_messaging_rabbit/rabbit_use_ssl rabbitmq oslo_messaging_rabbit/rabbit_userid rabbitmq oslo_messaging_rabbit/rabbit_virtual_host rabbitmq oslo_messaging_rabbit/send_single_reply rabbitmq +oslo_middleware/max_request_body_size api +oslo_middleware/secure_proxy_ssl_header api oslo_policy/policy_default_rule policy oslo_policy/policy_dirs policy oslo_policy/policy_file policy oslo_versionedobjects/fatal_exception_format_errors api pxe/default_ephemeral_format pxe pxe/disk_devices pxe -pxe/http_root pxe -pxe/http_url pxe pxe/image_cache_size pxe pxe/image_cache_ttl pxe pxe/images_path pxe