From a992c0e1caffa7bd1d552eb75d9be84965e5a66b Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Fri, 5 Dec 2014 12:41:11 +0100 Subject: [PATCH] Generated and added configuration reference tables for Ironic Change-Id: I28a79dd39b2ff7f1800b19167c1074d47cc9a913 --- doc/common/tables/ironic-agent.xml | 42 +++++ doc/common/tables/ironic-amqp.xml | 77 +++++++++ doc/common/tables/ironic-api.xml | 34 ++++ doc/common/tables/ironic-auth.xml | 26 +++ doc/common/tables/ironic-auth_token.xml | 162 ++++++++++++++++++ doc/common/tables/ironic-ca.xml | 38 ++++ doc/common/tables/ironic-common.xml | 94 ++++++++++ doc/common/tables/ironic-conductor.xml | 86 ++++++++++ doc/common/tables/ironic-console.xml | 42 +++++ doc/common/tables/ironic-database.xml | 106 ++++++++++++ doc/common/tables/ironic-debug.xml | 26 +++ doc/common/tables/ironic-dhcp.xml | 26 +++ doc/common/tables/ironic-disk_partitioner.xml | 30 ++++ doc/common/tables/ironic-glance.xml | 78 +++++++++ doc/common/tables/ironic-ilo.xml | 46 +++++ doc/common/tables/ironic-ipmi.xml | 30 ++++ doc/common/tables/ironic-logging.xml | 102 +++++++++++ doc/common/tables/ironic-neutron.xml | 34 ++++ doc/common/tables/ironic-policy.xml | 30 ++++ doc/common/tables/ironic-pxe.xml | 94 ++++++++++ doc/common/tables/ironic-qpid.xml | 66 +++++++ doc/common/tables/ironic-rabbitmq.xml | 90 ++++++++++ doc/common/tables/ironic-redis.xml | 41 +++++ doc/common/tables/ironic-rootwrap.xml | 42 +++++ doc/common/tables/ironic-rpc.xml | 50 ++++++ doc/common/tables/ironic-seamicro.xml | 30 ++++ doc/common/tables/ironic-snmp.xml | 26 +++ doc/common/tables/ironic-ssh.xml | 26 +++ doc/common/tables/ironic-swift.xml | 26 +++ doc/common/tables/ironic-zeromq.xml | 50 ++++++ doc/config-reference/bk-config-ref.xml | 2 + .../ch_baremetalconfigure.xml | 45 +++++ 32 files changed, 1697 insertions(+) create mode 100644 doc/common/tables/ironic-agent.xml create mode 100644 doc/common/tables/ironic-amqp.xml create mode 100644 doc/common/tables/ironic-api.xml create mode 100644 doc/common/tables/ironic-auth.xml create mode 100644 doc/common/tables/ironic-auth_token.xml create mode 100644 doc/common/tables/ironic-ca.xml create mode 100644 doc/common/tables/ironic-common.xml create mode 100644 doc/common/tables/ironic-conductor.xml create mode 100644 doc/common/tables/ironic-console.xml create mode 100644 doc/common/tables/ironic-database.xml create mode 100644 doc/common/tables/ironic-debug.xml create mode 100644 doc/common/tables/ironic-dhcp.xml create mode 100644 doc/common/tables/ironic-disk_partitioner.xml create mode 100644 doc/common/tables/ironic-glance.xml create mode 100644 doc/common/tables/ironic-ilo.xml create mode 100644 doc/common/tables/ironic-ipmi.xml create mode 100644 doc/common/tables/ironic-logging.xml create mode 100644 doc/common/tables/ironic-neutron.xml create mode 100644 doc/common/tables/ironic-policy.xml create mode 100644 doc/common/tables/ironic-pxe.xml create mode 100644 doc/common/tables/ironic-qpid.xml create mode 100644 doc/common/tables/ironic-rabbitmq.xml create mode 100644 doc/common/tables/ironic-redis.xml create mode 100644 doc/common/tables/ironic-rootwrap.xml create mode 100644 doc/common/tables/ironic-rpc.xml create mode 100644 doc/common/tables/ironic-seamicro.xml create mode 100644 doc/common/tables/ironic-snmp.xml create mode 100644 doc/common/tables/ironic-ssh.xml create mode 100644 doc/common/tables/ironic-swift.xml create mode 100644 doc/common/tables/ironic-zeromq.xml create mode 100644 doc/config-reference/ch_baremetalconfigure.xml diff --git a/doc/common/tables/ironic-agent.xml b/doc/common/tables/ironic-agent.xml new file mode 100644 index 0000000000..3d329dcd89 --- /dev/null +++ b/doc/common/tables/ironic-agent.xml @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of agent configuration options
Configuration option = Default valueDescription
[agent]
agent_api_version = v1(StrOpt) API version to use for communicating with the ramdisk agent.
agent_pxe_append_params = nofb nomodeset vga=normal(StrOpt) Additional append parameters for baremetal PXE boot.
agent_pxe_bootfile_name = pxelinux.0(StrOpt) Neutron bootfile DHCP parameter.
agent_pxe_config_template = $pybasedir/drivers/modules/agent_config.template(StrOpt) Template file for PXE configuration.
heartbeat_timeout = 300(IntOpt) Maximum interval (in seconds) for agent heartbeats.
+ diff --git a/doc/common/tables/ironic-amqp.xml b/doc/common/tables/ironic-amqp.xml new file mode 100644 index 0000000000..7bff22ebe6 --- /dev/null +++ b/doc/common/tables/ironic-amqp.xml @@ -0,0 +1,77 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of AMQP configuration options
Configuration option = Default valueDescription
[DEFAULT]
amqp_auto_delete = False(BoolOpt) Auto-delete queues in AMQP.
amqp_durable_queues = False(BoolOpt) Use durable queues in AMQP.
control_exchange = openstack(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
notification_driver = [](MultiStrOpt) Driver or drivers to handle sending notifications.
notification_topics = notifications(ListOpt) AMQP topic used for OpenStack notifications.
transport_url = None(StrOpt) 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.
[oslo_messaging_amqp]
allow_insecure_clients = False(BoolOpt) Accept clients using either SSL or plain TCP
broadcast_prefix = broadcast(StrOpt) address prefix used when broadcasting to all servers
container_name = None(StrOpt) Name for the AMQP container
group_request_prefix = unicast(StrOpt) address prefix when sending to any server in group
idle_timeout = 0(IntOpt) Timeout for inactive connections (in seconds)
server_request_prefix = exclusive(StrOpt) address prefix used when sending to a specific server
trace = False(BoolOpt) Debug: dump AMQP frames to stdout
+ diff --git a/doc/common/tables/ironic-api.xml b/doc/common/tables/ironic-api.xml new file mode 100644 index 0000000000..96a95ae30e --- /dev/null +++ b/doc/common/tables/ironic-api.xml @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of API configuration options
Configuration option = Default valueDescription
[api]
host_ip = 0.0.0.0(StrOpt) The listen IP for the Ironic API server.
max_limit = 1000(IntOpt) The maximum number of items returned in a single response from a collection resource.
port = 6385(IntOpt) The port for the Ironic API server.
+ diff --git a/doc/common/tables/ironic-auth.xml b/doc/common/tables/ironic-auth.xml new file mode 100644 index 0000000000..9f13e24617 --- /dev/null +++ b/doc/common/tables/ironic-auth.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + +
Description of authorization configuration options
Configuration option = Default valueDescription
[DEFAULT]
auth_strategy = keystone(StrOpt) Method to use for authentication: noauth or keystone.
+ diff --git a/doc/common/tables/ironic-auth_token.xml b/doc/common/tables/ironic-auth_token.xml new file mode 100644 index 0000000000..c6fa14a4bb --- /dev/null +++ b/doc/common/tables/ironic-auth_token.xml @@ -0,0 +1,162 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of authorization token configuration options
Configuration option = Default valueDescription
[keystone_authtoken]
admin_password = None(StrOpt) Keystone account password
admin_tenant_name = admin(StrOpt) Keystone service account tenant name to validate user tokens
admin_token = None(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead.
admin_user = None(StrOpt) Keystone account username
auth_admin_prefix = (StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
auth_host = 127.0.0.1(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
auth_port = 35357(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
auth_protocol = https(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.
auth_uri = None(StrOpt) Complete public Identity API endpoint
auth_version = None(StrOpt) API version of the admin Identity API endpoint
cache = None(StrOpt) Env key for the swift cache
cafile = None(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
certfile = None(StrOpt) Required if Keystone server requires client certificate
check_revocations_for_cached = False(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server.
delay_auth_decision = False(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components
enforce_token_bind = permissive(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
hash_algorithms = md5(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
http_connect_timeout = None(BoolOpt) Request timeout value for communicating with Identity API server.
http_request_max_retries = 3(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server.
identity_uri = None(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
include_service_catalog = True(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
insecure = False(BoolOpt) Verify HTTPS connections.
keyfile = None(StrOpt) Required if Keystone server requires client certificate
memcache_pool_conn_get_timeout = 10(IntOpt) (optional) number of seconds that an operation will wait to get a memcache client connection from the pool.
memcache_pool_dead_retry = 300(IntOpt) (optional) number of seconds memcached server is considered dead before it is tried again.
memcache_pool_maxsize = 10(IntOpt) (optional) max total number of open connections to every memcached server.
memcache_pool_socket_timeout = 3(IntOpt) (optional) socket timeout in seconds for communicating with a memcache server.
memcache_pool_unused_timeout = 60(IntOpt) (optional) number of seconds a connection to memcached is held unused in the pool before it is closed.
memcache_secret_key = None(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation.
memcache_security_strategy = None(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
memcache_use_advanced_pool = False(BoolOpt) (optional) use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.
memcached_servers = None(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
revocation_cache_time = 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.
signing_dir = None(StrOpt) Directory used to cache files related to PKI tokens
token_cache_time = 300(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.
+ diff --git a/doc/common/tables/ironic-ca.xml b/doc/common/tables/ironic-ca.xml new file mode 100644 index 0000000000..53759c45c4 --- /dev/null +++ b/doc/common/tables/ironic-ca.xml @@ -0,0 +1,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of CA and SSL configuration options
Configuration option = Default valueDescription
[oslo_messaging_amqp]
ssl_ca_file = (StrOpt) CA certificate PEM file for verifing server certificate
ssl_cert_file = (StrOpt) Identifying certificate PEM file to present to clients
ssl_key_file = (StrOpt) Private key PEM file used to sign cert_file certificate
ssl_key_password = None(StrOpt) Password for decrypting ssl_key_file (if encrypted)
+ diff --git a/doc/common/tables/ironic-common.xml b/doc/common/tables/ironic-common.xml new file mode 100644 index 0000000000..8f9503b16d --- /dev/null +++ b/doc/common/tables/ironic-common.xml @@ -0,0 +1,94 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of common configuration options
Configuration option = Default valueDescription
[DEFAULT]
bindir = /usr/local/bin(StrOpt) Directory where ironic binaries are installed.
enabled_drivers = 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.
fatal_deprecations = False(BoolOpt) Enables or disables fatal status of deprecations.
force_raw_images = True(BoolOpt) Force backing images to raw format.
hash_distribution_replicas = 1(IntOpt) [Experimental Feature] Number of hosts to map onto each hash partition. Setting this to more than one will cause additional conductor services to prepare deployment environments and potentially allow the Ironic cluster to recover more quickly if a conductor instance is terminated.
hash_partition_exponent = 5(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.
host = 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.
isolinux_bin = /usr/lib/syslinux/isolinux.bin(StrOpt) Path to isolinux binary file.
isolinux_config_template = $pybasedir/common/isolinux_config.template(StrOpt) Template file for isolinux configuration file.
memcached_servers = None(ListOpt) Memcached servers or None for in process cache.
my_ip = 10.0.0.1(StrOpt) IP address of this host.
parallel_image_downloads = False(BoolOpt) Run image downloads and raw format conversions in parallel.
periodic_interval = 60(IntOpt) Seconds between running periodic tasks.
pybasedir = /usr/lib/python/site-packages/ironic/ironic(StrOpt) Directory where the ironic python module is installed.
rootwrap_config = /etc/ironic/rootwrap.conf(StrOpt) Path to the rootwrap configuration file to use for running commands as root.
run_external_periodic_tasks = True(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?
state_path = $pybasedir(StrOpt) Top-level directory for maintaining ironic's state.
tempdir = None(StrOpt) Explicitly specify the temporary working directory.
+ diff --git a/doc/common/tables/ironic-conductor.xml b/doc/common/tables/ironic-conductor.xml new file mode 100644 index 0000000000..d6957e512e --- /dev/null +++ b/doc/common/tables/ironic-conductor.xml @@ -0,0 +1,86 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of conductor configuration options
Configuration option = Default valueDescription
[conductor]
api_url = None(StrOpt) URL of Ironic API service. If not set ironic can get the current value from the keystone service catalog.
check_provision_state_interval = 60(IntOpt) Interval between checks of provision timeouts, in seconds.
deploy_callback_timeout = 1800(IntOpt) Timeout (seconds) for waiting callback from deploy ramdisk. 0 - unlimited.
force_power_state_during_sync = True(BoolOpt) During sync_power_state, should the hardware power state be set to the state recorded in the database (True) or should the database be updated based on the hardware state (False).
heartbeat_interval = 10(IntOpt) Seconds between conductor heart beats.
heartbeat_timeout = 60(IntOpt) Maximum time (in seconds) since the last check-in of a conductor.
node_locked_retry_attempts = 3(IntOpt) Number of attempts to grab a node lock.
node_locked_retry_interval = 1(IntOpt) Seconds to sleep between node lock attempts.
periodic_max_workers = 8(IntOpt) Maximum number of worker threads that can be started simultaneously by a periodic task. Should be less than RPC thread pool size.
power_state_sync_max_retries = 3(IntOpt) During sync_power_state failures, limit the number of times Ironic should try syncing the hardware node power state with the node power state in DB
send_sensor_data = False(BoolOpt) Enable sending sensor data message via the notification bus
send_sensor_data_interval = 600(IntOpt) Seconds between conductor sending sensor data message to ceilometer via the notification bus.
send_sensor_data_types = ALL(ListOpt) List of comma separated metric types which need to be sent to Ceilometer. The default value, "ALL", is a special value meaning send all the sensor data.
sync_local_state_interval = 180(IntOpt) When conductors join or leave the cluster, existing conductors may need to update any persistent local state as nodes are moved around the cluster. This option controls how often, in seconds, each conductor will check for nodes that it should "take over". Set it to a negative value to disable the check entirely.
sync_power_state_interval = 60(IntOpt) Interval between syncing the node power state to the database, in seconds.
workers_pool_size = 100(IntOpt) The size of the workers greenthread pool.
+ diff --git a/doc/common/tables/ironic-console.xml b/doc/common/tables/ironic-console.xml new file mode 100644 index 0000000000..71e1abe45e --- /dev/null +++ b/doc/common/tables/ironic-console.xml @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of console configuration options
Configuration option = Default valueDescription
[console]
subprocess_checking_interval = 1(IntOpt) Time interval (in seconds) for checking the status of console subprocess.
subprocess_timeout = 10(IntOpt) Time (in seconds) to wait for the console subprocess to start.
terminal = shellinaboxd(StrOpt) Path to serial console terminal program
terminal_cert_dir = None(StrOpt) Directory containing the terminal SSL cert(PEM) for serial console access
terminal_pid_dir = None(StrOpt) Directory for holding terminal pid files. If not specified, the temporary directory will be used.
+ diff --git a/doc/common/tables/ironic-database.xml b/doc/common/tables/ironic-database.xml new file mode 100644 index 0000000000..f8b70ec360 --- /dev/null +++ b/doc/common/tables/ironic-database.xml @@ -0,0 +1,106 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of database configuration options
Configuration option = Default valueDescription
[database]
backend = sqlalchemy(StrOpt) The back end to use for the database.
connection = None(StrOpt) The SQLAlchemy connection string to use to connect to the database.
connection_debug = 0(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.
connection_trace = False(BoolOpt) Add Python stack traces to SQL as comment strings.
db_inc_retry_interval = True(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.
db_max_retries = 20(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.
db_max_retry_interval = 10(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.
db_retry_interval = 1(IntOpt) Seconds between database connection retries.
idle_timeout = 3600(IntOpt) Timeout before idle SQL connections are reaped.
max_overflow = None(IntOpt) If set, use this value for max_overflow with SQLAlchemy.
max_pool_size = None(IntOpt) Maximum number of SQL connections to keep open in a pool.
max_retries = 10(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
min_pool_size = 1(IntOpt) Minimum number of SQL connections to keep open in a pool.
mysql_engine = InnoDB(StrOpt) MySQL engine to use.
mysql_sql_mode = TRADITIONAL(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
pool_timeout = None(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.
retry_interval = 10(IntOpt) Interval between retries of opening a SQL connection.
slave_connection = None(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.
sqlite_db = oslo.sqlite(StrOpt) The file name to use with SQLite.
sqlite_synchronous = True(BoolOpt) If True, SQLite uses synchronous mode.
use_db_reconnect = False(BoolOpt) Enable the experimental use of database reconnect on connection lost.
+ diff --git a/doc/common/tables/ironic-debug.xml b/doc/common/tables/ironic-debug.xml new file mode 100644 index 0000000000..e956b610aa --- /dev/null +++ b/doc/common/tables/ironic-debug.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + +
Description of logging configuration options
Configuration option = Default valueDescription
[DEFAULT]
backdoor_port = None(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.
+ diff --git a/doc/common/tables/ironic-dhcp.xml b/doc/common/tables/ironic-dhcp.xml new file mode 100644 index 0000000000..8ba1868c0d --- /dev/null +++ b/doc/common/tables/ironic-dhcp.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + +
Description of DHCP configuration options
Configuration option = Default valueDescription
[dhcp]
dhcp_provider = neutron(StrOpt) DHCP provider to use. "neutron" uses Neutron, and "none" uses a no-op provider.
+ diff --git a/doc/common/tables/ironic-disk_partitioner.xml b/doc/common/tables/ironic-disk_partitioner.xml new file mode 100644 index 0000000000..82fa30a4a5 --- /dev/null +++ b/doc/common/tables/ironic-disk_partitioner.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of disk partitioner configuration options
Configuration option = Default valueDescription
[disk_partitioner]
check_device_interval = 1(IntOpt) After Ironic has completed creating the partition table, it continues to check for activity on the attached iSCSI device status at this interval prior to copying the image to the node, in seconds
check_device_max_retries = 20(IntOpt) 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.
+ diff --git a/doc/common/tables/ironic-glance.xml b/doc/common/tables/ironic-glance.xml new file mode 100644 index 0000000000..317610ebef --- /dev/null +++ b/doc/common/tables/ironic-glance.xml @@ -0,0 +1,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of glance configuration options
Configuration option = Default valueDescription
[glance]
allowed_direct_url_schemes = (ListOpt) A list of URL schemes that can be downloaded directly via the direct_url. Currently supported schemes: [file].
auth_strategy = keystone(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.
glance_api_insecure = False(BoolOpt) Allow to perform insecure SSL (https) requests to glance.
glance_api_servers = None(ListOpt) A list of the glance api servers available to ironic. Prefix with https:// for SSL-based glance API servers. Format is [hostname|IP]:port.
glance_host = $my_ip(StrOpt) Default glance hostname or IP address.
glance_num_retries = 0(IntOpt) Number of retries when downloading an image from glance.
glance_port = 9292(IntOpt) Default glance port.
glance_protocol = http(StrOpt) Default protocol to use when connecting to glance. Set to https for SSL.
swift_account = None(StrOpt) 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. For example: "AUTH_a422b2-91f3-2f46-74b7-d7c9e8958f5d30". Swift temporary URL format: "endpoint_url/api_version/account/container/object_id"
swift_api_version = v1(StrOpt) The Swift API version to create a temporary URL for. Defaults to "v1". Swift temporary URL format: "endpoint_url/api_version/account/container/object_id"
swift_container = glance(StrOpt) The Swift container Glance is configured to store its images in. Defaults to "glance", which is the default in glance-api.conf. Swift temporary URL format: "endpoint_url/api_version/account/container/object_id"
swift_endpoint_url = None(StrOpt) The "endpoint" (scheme, hostname, optional port) for the Swift URL of the form "endpoint_url/api_version/account/container/object_id". Do not include trailing "/". For example, use "https://swift.example.com". Required for temporary URLs.
swift_temp_url_duration = 1200(IntOpt) The length of time in seconds that the temporary URL will be valid for. Defaults to 20 minutes. If some deploys get a 401 response code when trying to download from the temporary URL, try raising this duration.
swift_temp_url_key = None(StrOpt) The secret token given to Swift to allow temporary URL downloads. Required for temporary URLs.
+ diff --git a/doc/common/tables/ironic-ilo.xml b/doc/common/tables/ironic-ilo.xml new file mode 100644 index 0000000000..2fab352ff0 --- /dev/null +++ b/doc/common/tables/ironic-ilo.xml @@ -0,0 +1,46 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of ILO configuration options
Configuration option = Default valueDescription
[ilo]
client_port = 443(IntOpt) Port to be used for iLO operations
client_timeout = 60(IntOpt) Timeout (in seconds) for iLO operations
power_retry = 6(IntOpt) Number of times a power operation needs to be retried
power_wait = 2(IntOpt) Amount of time in seconds to wait in between power operations
swift_ilo_container = ironic_ilo_container(StrOpt) The Swift iLO container to store data.
swift_object_expiry_timeout = 900(IntOpt) Amount of time in seconds for Swift objects to auto-expire.
+ diff --git a/doc/common/tables/ironic-ipmi.xml b/doc/common/tables/ironic-ipmi.xml new file mode 100644 index 0000000000..a2089f3c5b --- /dev/null +++ b/doc/common/tables/ironic-ipmi.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of IPMI configuration options
Configuration option = Default valueDescription
[ipmi]
min_command_interval = 5(IntOpt) Minimum time, in seconds, between IPMI operations sent to a server. There is a risk with some hardware that setting this too low may cause the BMC to crash. Recommended setting is 5 seconds.
retry_timeout = 60(IntOpt) Maximum time in seconds to retry IPMI operations.
+ diff --git a/doc/common/tables/ironic-logging.xml b/doc/common/tables/ironic-logging.xml new file mode 100644 index 0000000000..a805d87b13 --- /dev/null +++ b/doc/common/tables/ironic-logging.xml @@ -0,0 +1,102 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of logging configuration options
Configuration option = Default valueDescription
[DEFAULT]
debug = False(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).
default_log_levels = 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(ListOpt) List of logger=LEVEL pairs.
fatal_exception_format_errors = False(BoolOpt) Make exception message format errors fatal.
instance_format = "[instance: %(uuid)s] "(StrOpt) The format for an instance that is passed with the log message.
instance_uuid_format = "[instance: %(uuid)s] "(StrOpt) The format for an instance UUID that is passed with the log message.
log_config_append = 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.
log_date_format = %Y-%m-%d %H:%M:%S(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .
log_dir = None(StrOpt) (Optional) The base directory used for relative --log-file paths.
log_file = None(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.
log_format = 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.
logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s(StrOpt) Format string to use for log messages with context.
logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d(StrOpt) Data to append to log format when level is DEBUG.
logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s(StrOpt) Format string to use for log messages without context.
logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s(StrOpt) Prefix each line of exception output with this format.
publish_errors = False(BoolOpt) Enables or disables publication of error events.
syslog_log_facility = LOG_USER(StrOpt) Syslog facility to receive log lines.
use_stderr = True(BoolOpt) Log output to standard error.
use_syslog = False(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.
use_syslog_rfc_format = False(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 I, and will be removed in J.
verbose = False(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).
+ diff --git a/doc/common/tables/ironic-neutron.xml b/doc/common/tables/ironic-neutron.xml new file mode 100644 index 0000000000..876cc9e46c --- /dev/null +++ b/doc/common/tables/ironic-neutron.xml @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of neutron configuration options
Configuration option = Default valueDescription
[neutron]
auth_strategy = keystone(StrOpt) Default authentication strategy to use when connecting to neutron. Can be either "keystone" or "noauth". Running neutron in noauth mode (related to but not affected by this setting) is insecure and should only be used for testing.
url = http://$my_ip:9696(StrOpt) URL for connecting to neutron.
url_timeout = 30(IntOpt) Timeout value for connecting to neutron in seconds.
+ diff --git a/doc/common/tables/ironic-policy.xml b/doc/common/tables/ironic-policy.xml new file mode 100644 index 0000000000..400420922f --- /dev/null +++ b/doc/common/tables/ironic-policy.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of policy configuration options
Configuration option = Default valueDescription
[DEFAULT]
policy_default_rule = default(StrOpt) Rule checked when requested rule is not found.
policy_file = policy.json(StrOpt) JSON file representing policy.
+ diff --git a/doc/common/tables/ironic-pxe.xml b/doc/common/tables/ironic-pxe.xml new file mode 100644 index 0000000000..05f745e2e5 --- /dev/null +++ b/doc/common/tables/ironic-pxe.xml @@ -0,0 +1,94 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of PXE configuration options
Configuration option = Default valueDescription
[pxe]
default_ephemeral_format = ext4(StrOpt) Default file system format for ephemeral partition, if one is created.
disk_devices = cciss/c0d0,sda,hda,vda(StrOpt) The disk devices to scan while doing the deploy.
http_root = /httpboot(StrOpt) Ironic compute node's HTTP root path.
http_url = None(StrOpt) Ironic compute node's HTTP server URL. Example: http://192.1.2.3:8080
image_cache_size = 20480(IntOpt) Maximum size (in MiB) of cache for master images, including those in use.
image_cache_ttl = 10080(IntOpt) Maximum TTL (in minutes) for old master images in cache.
images_path = /var/lib/ironic/images/(StrOpt) Directory where images are stored on disk.
instance_master_path = /var/lib/ironic/master_images(StrOpt) Directory where master instance images are stored on disk.
ipxe_boot_script = $pybasedir/drivers/modules/boot.ipxe(StrOpt) The path to the main iPXE script file.
ipxe_enabled = False(BoolOpt) Enable iPXE boot.
pxe_append_params = nofb nomodeset vga=normal(StrOpt) Additional append parameters for baremetal PXE boot.
pxe_bootfile_name = pxelinux.0(StrOpt) Bootfile DHCP parameter.
pxe_config_template = $pybasedir/drivers/modules/pxe_config.template(StrOpt) Template file for PXE configuration.
tftp_master_path = /tftpboot/master_images(StrOpt) Directory where master tftp images are stored on disk.
tftp_root = /tftpboot(StrOpt) Ironic compute node's tftp root path.
tftp_server = $my_ip(StrOpt) IP address of Ironic compute node's tftp server.
uefi_pxe_bootfile_name = elilo.efi(StrOpt) Bootfile DHCP parameter for UEFI boot mode.
uefi_pxe_config_template = $pybasedir/drivers/modules/elilo_efi_pxe_config.template(StrOpt) Template file for PXE configuration for UEFI boot loader.
+ diff --git a/doc/common/tables/ironic-qpid.xml b/doc/common/tables/ironic-qpid.xml new file mode 100644 index 0000000000..145b0d9c11 --- /dev/null +++ b/doc/common/tables/ironic-qpid.xml @@ -0,0 +1,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of Qpid configuration options
Configuration option = Default valueDescription
[DEFAULT]
qpid_heartbeat = 60(IntOpt) Seconds between connection keepalive heartbeats.
qpid_hostname = localhost(StrOpt) Qpid broker hostname.
qpid_hosts = $qpid_hostname:$qpid_port(ListOpt) Qpid HA cluster host:port pairs.
qpid_password = (StrOpt) Password for Qpid connection.
qpid_port = 5672(IntOpt) Qpid broker port.
qpid_protocol = tcp(StrOpt) Transport to use, either 'tcp' or 'ssl'.
qpid_receiver_capacity = 1(IntOpt) The number of prefetched messages held by receiver.
qpid_sasl_mechanisms = (StrOpt) Space separated list of SASL mechanisms to use for auth.
qpid_tcp_nodelay = True(BoolOpt) Whether to disable the Nagle algorithm.
qpid_topology_version = 1(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.
qpid_username = (StrOpt) Username for Qpid connection.
+ diff --git a/doc/common/tables/ironic-rabbitmq.xml b/doc/common/tables/ironic-rabbitmq.xml new file mode 100644 index 0000000000..c89b1fa212 --- /dev/null +++ b/doc/common/tables/ironic-rabbitmq.xml @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of RabbitMQ configuration options
Configuration option = Default valueDescription
[DEFAULT]
kombu_reconnect_delay = 1.0(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
kombu_ssl_ca_certs = (StrOpt) SSL certification authority file (valid only if SSL enabled).
kombu_ssl_certfile = (StrOpt) SSL cert file (valid only if SSL enabled).
kombu_ssl_keyfile = (StrOpt) SSL key file (valid only if SSL enabled).
kombu_ssl_version = (StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on some distributions.
rabbit_ha_queues = False(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.
rabbit_host = localhost(StrOpt) The RabbitMQ broker address where a single node is used.
rabbit_hosts = $rabbit_host:$rabbit_port(ListOpt) RabbitMQ HA cluster host:port pairs.
rabbit_login_method = AMQPLAIN(StrOpt) The RabbitMQ login method.
rabbit_max_retries = 0(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
rabbit_password = guest(StrOpt) The RabbitMQ password.
rabbit_port = 5672(IntOpt) The RabbitMQ broker port where a single node is used.
rabbit_retry_backoff = 2(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.
rabbit_retry_interval = 1(IntOpt) How frequently to retry connecting with RabbitMQ.
rabbit_use_ssl = False(BoolOpt) Connect over SSL for RabbitMQ.
rabbit_userid = guest(StrOpt) The RabbitMQ userid.
rabbit_virtual_host = /(StrOpt) The RabbitMQ virtual host.
+ diff --git a/doc/common/tables/ironic-redis.xml b/doc/common/tables/ironic-redis.xml new file mode 100644 index 0000000000..210901c79e --- /dev/null +++ b/doc/common/tables/ironic-redis.xml @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of Redis configuration options
Configuration option = Default valueDescription
[matchmaker_redis]
host = 127.0.0.1(StrOpt) Host to locate redis.
password = None(StrOpt) Password for Redis server (optional).
port = 6379(IntOpt) Use this port to connect to redis host.
[matchmaker_ring]
ringfile = /etc/oslo/matchmaker_ring.json(StrOpt) Matchmaker ring file (JSON).
+ diff --git a/doc/common/tables/ironic-rootwrap.xml b/doc/common/tables/ironic-rootwrap.xml new file mode 100644 index 0000000000..30e8ea8736 --- /dev/null +++ b/doc/common/tables/ironic-rootwrap.xml @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of rootwrap configuration options
Configuration option = Default valueDescription
[DEFAULT]
filters_path = /etc/ironic/rootwrap.d,/usr/share/ironic/rootwrapList of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !
exec_dirs = /sbin,/usr/sbin,/bin,/usr/binList of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !
use_syslog = FalseEnable logging to syslog Default value is False
syslog_log_facility = syslogWhich syslog facility to use. Valid values include auth, authpriv, syslog, user0, user1... Default value is 'syslog'
syslog_log_level = ERRORWhich messages to log. INFO means log all usage ERROR means only log unsuccessful attempts
+ diff --git a/doc/common/tables/ironic-rpc.xml b/doc/common/tables/ironic-rpc.xml new file mode 100644 index 0000000000..10aa6008cb --- /dev/null +++ b/doc/common/tables/ironic-rpc.xml @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of RPC configuration options
Configuration option = Default valueDescription
[DEFAULT]
matchmaker_heartbeat_freq = 300(IntOpt) Heartbeat frequency.
matchmaker_heartbeat_ttl = 600(IntOpt) Heartbeat time-to-live.
rpc_backend = rabbit(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.
rpc_cast_timeout = 30(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.
rpc_conn_pool_size = 30(IntOpt) Size of RPC connection pool.
rpc_response_timeout = 60(IntOpt) Seconds to wait for a response from a call.
rpc_thread_pool_size = 64(IntOpt) Size of RPC greenthread pool.
+ diff --git a/doc/common/tables/ironic-seamicro.xml b/doc/common/tables/ironic-seamicro.xml new file mode 100644 index 0000000000..38fc3949c0 --- /dev/null +++ b/doc/common/tables/ironic-seamicro.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of SeaMicro configuration options
Configuration option = Default valueDescription
[seamicro]
action_timeout = 10(IntOpt) Seconds to wait for power action to be completed
max_retry = 3(IntOpt) Maximum retries for SeaMicro operations
+ diff --git a/doc/common/tables/ironic-snmp.xml b/doc/common/tables/ironic-snmp.xml new file mode 100644 index 0000000000..8b44361b25 --- /dev/null +++ b/doc/common/tables/ironic-snmp.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + +
Description of SNMP configuration options
Configuration option = Default valueDescription
[snmp]
power_timeout = 10(IntOpt) Seconds to wait for power action to be completed
+ diff --git a/doc/common/tables/ironic-ssh.xml b/doc/common/tables/ironic-ssh.xml new file mode 100644 index 0000000000..c30129f809 --- /dev/null +++ b/doc/common/tables/ironic-ssh.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + +
Description of SSH configuration options
Configuration option = Default valueDescription
[ssh]
libvirt_uri = qemu:///system(StrOpt) libvirt uri
+ diff --git a/doc/common/tables/ironic-swift.xml b/doc/common/tables/ironic-swift.xml new file mode 100644 index 0000000000..821d0fdcb2 --- /dev/null +++ b/doc/common/tables/ironic-swift.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + +
Description of swift configuration options
Configuration option = Default valueDescription
[swift]
swift_max_retries = 2(IntOpt) Maximum number of times to retry a Swift request, before failing.
+ diff --git a/doc/common/tables/ironic-zeromq.xml b/doc/common/tables/ironic-zeromq.xml new file mode 100644 index 0000000000..0814b91526 --- /dev/null +++ b/doc/common/tables/ironic-zeromq.xml @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of ZeroMQ configuration options
Configuration option = Default valueDescription
[DEFAULT]
rpc_zmq_bind_address = *(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.
rpc_zmq_contexts = 1(IntOpt) Number of ZeroMQ contexts, defaults to 1.
rpc_zmq_host = localhost(StrOpt) 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(StrOpt) Directory for holding IPC sockets.
rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost(StrOpt) MatchMaker driver.
rpc_zmq_port = 9501(IntOpt) ZeroMQ receiver listening port.
rpc_zmq_topic_backlog = None(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
+ diff --git a/doc/config-reference/bk-config-ref.xml b/doc/config-reference/bk-config-ref.xml index ae9d043187..60050ce3db 100644 --- a/doc/config-reference/bk-config-ref.xml +++ b/doc/config-reference/bk-config-ref.xml @@ -139,6 +139,8 @@ + + diff --git a/doc/config-reference/ch_baremetalconfigure.xml b/doc/config-reference/ch_baremetalconfigure.xml new file mode 100644 index 0000000000..81552f1794 --- /dev/null +++ b/doc/config-reference/ch_baremetalconfigure.xml @@ -0,0 +1,45 @@ + + + Bare metal + The Bare metal module is capable of managing and provisioning physical + machines. The configuration file of this module is + /etc/ironic/ironic.conf. + The following tables provide a comprehensive list of the Bare metal module + configuration options. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +