diff --git a/doc/config-reference/source/networking/networking_options_reference.rst b/doc/config-reference/source/networking/networking_options_reference.rst index 27e187d260..47f72f306d 100644 --- a/doc/config-reference/source/networking/networking_options_reference.rst +++ b/doc/config-reference/source/networking/networking_options_reference.rst @@ -332,6 +332,23 @@ agent. .. include:: ../tables/neutron-l3_agent.rst +Load Balancing service (octavia) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Use the following options to configure the octavia service: + +.. include:: ../tables/octavia-api.rst +.. include:: ../tables/octavia-auth_token.rst +.. include:: ../tables/octavia-cache.rst +.. include:: ../tables/octavia-common.rst +.. include:: ../tables/octavia-cors.rst +.. include:: ../tables/octavia-database.rst +.. include:: ../tables/octavia-logging.rst +.. include:: ../tables/octavia-rabbitmq.rst +.. include:: ../tables/octavia-redis.rst +.. include:: ../tables/octavia-rpc.rst +.. include:: ../tables/octavia-zeromq.rst + Logging ~~~~~~~ diff --git a/doc/config-reference/source/tables/octavia-api.rst b/doc/config-reference/source/tables/octavia-api.rst new file mode 100644 index 0000000000..c7a19df8d7 --- /dev/null +++ b/doc/config-reference/source/tables/octavia-api.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. + +.. _octavia-api: + +.. list-table:: Description of API configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``pagination_max_limit`` = ``-1`` + - (String) The maximum number of items returned in a single response, value was 'infinite' or negative integer means no limit diff --git a/doc/config-reference/source/tables/octavia-auth_token.rst b/doc/config-reference/source/tables/octavia-auth_token.rst new file mode 100644 index 0000000000..220691346f --- /dev/null +++ b/doc/config-reference/source/tables/octavia-auth_token.rst @@ -0,0 +1,102 @@ +.. + 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. + +.. _octavia-auth_token: + +.. list-table:: Description of authorization token configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[keystone_authtoken]** + - + * - ``admin_password`` = ``None`` + - (String) Service user password. + * - ``admin_tenant_name`` = ``admin`` + - (String) Service tenant name. + * - ``admin_token`` = ``None`` + - (String) 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`` + - (String) Service username. + * - ``auth_admin_prefix`` = + - (String) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. + * - ``auth_host`` = ``127.0.0.1`` + - (String) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_port`` = ``35357`` + - (Integer) Port of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_protocol`` = ``https`` + - (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri. + * - ``auth_section`` = ``None`` + - (Unknown) Config Section from which to load plugin specific options + * - ``auth_type`` = ``None`` + - (Unknown) Authentication type to load + * - ``auth_uri`` = ``None`` + - (String) Complete public Identity API endpoint. + * - ``auth_version`` = ``None`` + - (String) API version of the admin Identity API endpoint. + * - ``cache`` = ``None`` + - (String) Env key for the swift cache. + * - ``cafile`` = ``None`` + - (String) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. + * - ``certfile`` = ``None`` + - (String) Required if identity server requires client certificate + * - ``check_revocations_for_cached`` = ``False`` + - (Boolean) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. + * - ``delay_auth_decision`` = ``False`` + - (Boolean) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. + * - ``enforce_token_bind`` = ``permissive`` + - (String) 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`` + - (List) 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`` + - (Integer) Request timeout value for communicating with Identity API server. + * - ``http_request_max_retries`` = ``3`` + - (Integer) How many times are we trying to reconnect when communicating with Identity API Server. + * - ``identity_uri`` = ``None`` + - (String) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ + * - ``include_service_catalog`` = ``True`` + - (Boolean) (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`` + - (Boolean) Verify HTTPS connections. + * - ``keyfile`` = ``None`` + - (String) Required if identity server requires client certificate + * - ``memcache_pool_conn_get_timeout`` = ``10`` + - (Integer) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. + * - ``memcache_pool_dead_retry`` = ``300`` + - (Integer) (Optional) Number of seconds memcached server is considered dead before it is tried again. + * - ``memcache_pool_maxsize`` = ``10`` + - (Integer) (Optional) Maximum total number of open connections to every memcached server. + * - ``memcache_pool_socket_timeout`` = ``3`` + - (Integer) (Optional) Socket timeout in seconds for communicating with a memcached server. + * - ``memcache_pool_unused_timeout`` = ``60`` + - (Integer) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. + * - ``memcache_secret_key`` = ``None`` + - (String) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. + * - ``memcache_security_strategy`` = ``None`` + - (String) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. 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`` + - (Boolean) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. + * - ``memcached_servers`` = ``None`` + - (List) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. + * - ``region_name`` = ``None`` + - (String) The region in which the identity server can be found. + * - ``revocation_cache_time`` = ``10`` + - (Integer) 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`` + - (String) Directory used to cache files related to PKI tokens. + * - ``token_cache_time`` = ``300`` + - (Integer) 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. + * - **[keystone_authtoken_v3]** + - + * - ``admin_project_domain`` = ``default`` + - (String) Admin project keystone authentication domain + * - ``admin_user_domain`` = ``default`` + - (String) Admin user keystone authentication domain diff --git a/doc/config-reference/source/tables/octavia-cache.rst b/doc/config-reference/source/tables/octavia-cache.rst new file mode 100644 index 0000000000..053f241596 --- /dev/null +++ b/doc/config-reference/source/tables/octavia-cache.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. + +.. _octavia-cache: + +.. list-table:: Description of cache configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``memcached_servers`` = ``None`` + - (List) Memcached servers or None for in process cache. diff --git a/doc/config-reference/source/tables/octavia-common.rst b/doc/config-reference/source/tables/octavia-common.rst new file mode 100644 index 0000000000..02442755a7 --- /dev/null +++ b/doc/config-reference/source/tables/octavia-common.rst @@ -0,0 +1,280 @@ +.. + 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. + +.. _octavia-common: + +.. list-table:: Description of common configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``allow_bulk`` = ``True`` + - (Boolean) Allow the usage of the bulk API + * - ``allow_pagination`` = ``False`` + - (Boolean) Allow the usage of the pagination + * - ``allow_sorting`` = ``False`` + - (Boolean) Allow the usage of the sorting + * - ``api_extensions_path`` = + - (String) The path for API extensions + * - ``api_handler`` = ``queue_producer`` + - (String) The handler that the API communicates with + * - ``api_paste_config`` = ``api-paste.ini`` + - (String) The API paste config file to use + * - ``auth_strategy`` = ``keystone`` + - (String) The type of authentication to use + * - ``bind_host`` = ``0.0.0.0`` + - (Unknown) The host IP to bind to + * - ``bind_port`` = ``9876`` + - (Unknown) The port to bind to + * - ``control_exchange`` = ``octavia`` + - (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. + * - ``debug`` = ``False`` + - (Boolean) If set to true, the logging level will be set to DEBUG instead of the default INFO 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, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN, keystoneauth=WARN, oslo.cache=INFO, dogpile.core.dogpile=INFO`` + - (List) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``executor_thread_pool_size`` = ``64`` + - (Integer) Size of executor thread pool. + * - ``fatal_deprecations`` = ``False`` + - (Boolean) Enables or disables fatal status of deprecations. + * - ``host`` = ``localhost`` + - (String) The hostname Octavia is running on + * - ``octavia_plugins`` = ``hot_plug_plugin`` + - (String) Name of the controller plugin to use + * - **[amphora_agent]** + - + * - ``agent_server_ca`` = ``/etc/octavia/certs/client_ca.pem`` + - (String) The ca which signed the client certificates + * - ``agent_server_cert`` = ``/etc/octavia/certs/server.pem`` + - (String) The server certificate for the agent.py server to use + * - ``agent_server_network_dir`` = ``/etc/network/interfaces.d/`` + - (String) The directory where new network interfaces are located + * - ``agent_server_network_file`` = ``None`` + - (String) The file where the network interfaces are located. Specifying this will override any value set for agent_server_network_dir. + * - ``amphora_id`` = ``None`` + - (String) The amphora ID. + * - **[anchor]** + - + * - ``password`` = ``simplepassword`` + - (String) Anchor password + * - ``url`` = ``http://localhost:9999/v1/sign/default`` + - (String) Anchor URL + * - ``username`` = ``myusername`` + - (String) Anchor username + * - **[certificates]** + - + * - ``barbican_auth`` = ``barbican_acl_auth`` + - (String) Name of the Barbican authentication method to use + * - ``ca_certificate`` = ``/etc/ssl/certs/ssl-cert-snakeoil.pem`` + - (String) Absolute path to the CA Certificate for signing. Defaults to env[OS_OCTAVIA_TLS_CA_CERT]. + * - ``ca_private_key`` = ``/etc/ssl/private/ssl-cert-snakeoil.key`` + - (String) Absolute path to the Private Key for signing. Defaults to env[OS_OCTAVIA_TLS_CA_KEY]. + * - ``ca_private_key_passphrase`` = ``None`` + - (String) Passphrase for the Private Key. Defaults to env[OS_OCTAVIA_CA_KEY_PASS] or None. + * - ``cert_generator`` = ``local_cert_generator`` + - (String) Name of the cert generator to use + * - ``cert_manager`` = ``barbican_cert_manager`` + - (String) Name of the cert manager to use + * - ``endpoint_type`` = ``publicURL`` + - (String) The endpoint_type to be used for barbican service. + * - ``region_name`` = ``None`` + - (String) Region in Identity service catalog to use for communication with the barbican service. + * - ``signing_digest`` = ``sha256`` + - (String) Certificate signing digest. Defaults to env[OS_OCTAVIA_CA_SIGNING_DIGEST] or "sha256". + * - ``storage_path`` = ``/var/lib/octavia/certificates/`` + - (String) Absolute path to the certificate storage directory. Defaults to env[OS_OCTAVIA_TLS_STORAGE]. + * - **[controller_worker]** + - + * - ``amp_active_retries`` = ``10`` + - (Integer) Retry attempts to wait for Amphora to become active + * - ``amp_active_wait_sec`` = ``10`` + - (Integer) Seconds to wait between checks on whether an Amphora has become active + * - ``amp_flavor_id`` = + - (String) Nova instance flavor id for the Amphora + * - ``amp_image_id`` = + - (String) DEPRECATED: Glance image id for the Amphora image to boot Superseded by amp_image_tag option. + * - ``amp_image_tag`` = + - (String) Glance image tag for the Amphora image to boot. Use this option to be able to update the image without reconfiguring Octavia. Ignored if amp_image_id is defined. + * - ``amp_network`` = + - (String) Network to attach to the Amphora + * - ``amp_secgroup_list`` = + - (List) List of security groups to attach to the Amphora + * - ``amp_ssh_access_allowed`` = ``True`` + - (Boolean) Determines whether or not to allow access to the Amphorae + * - ``amp_ssh_key_name`` = + - (String) SSH key name used to boot the Amphora + * - ``amphora_driver`` = ``amphora_noop_driver`` + - (String) Name of the amphora driver to use + * - ``cert_generator`` = ``local_cert_generator`` + - (String) Name of the cert generator to use + * - ``client_ca`` = ``/etc/octavia/certs/ca_01.pem`` + - (String) Client CA for the amphora agent to use + * - ``compute_driver`` = ``compute_noop_driver`` + - (String) Name of the compute driver to use + * - ``loadbalancer_topology`` = ``SINGLE`` + - (String) Load balancer topology configuration. SINGLE - One amphora per load balancer. ACTIVE_STANDBY - Two amphora per load balancer. + * - ``network_driver`` = ``network_noop_driver`` + - (String) Name of the network driver to use + * - ``user_data_config_drive`` = ``False`` + - (Boolean) If True, build cloud-init user-data that is passed to the config drive on Amphora boot instead of personality files. If False, utilize personality files. + * - **[glance]** + - + * - ``ca_certificates_file`` = ``None`` + - (String) CA certificates file path + * - ``endpoint`` = ``None`` + - (String) A new endpoint to override the endpoint in the keystone catalog. + * - ``endpoint_type`` = ``publicURL`` + - (String) Endpoint interface in identity service to use + * - ``insecure`` = ``False`` + - (Boolean) Disable certificate validation on SSL connections + * - ``region_name`` = ``None`` + - (String) Region in Identity service catalog to use for communication with the OpenStack services. + * - ``service_name`` = ``None`` + - (String) The name of the glance service in the keystone catalog + * - **[haproxy_amphora]** + - + * - ``base_cert_dir`` = ``/var/lib/octavia/certs`` + - (String) Base directory for cert storage. + * - ``base_path`` = ``/var/lib/octavia`` + - (String) Base directory for amphora files. + * - ``bind_host`` = ``0.0.0.0`` + - (Unknown) The host IP to bind to + * - ``bind_port`` = ``9443`` + - (Unknown) The port to bind to + * - ``client_cert`` = ``/etc/octavia/certs/client.pem`` + - (String) The client certificate to talk to the agent + * - ``connection_max_retries`` = ``300`` + - (Integer) Retry threshold for connecting to amphorae. + * - ``connection_retry_interval`` = ``5`` + - (Integer) Retry timeout between connection attempts in seconds. + * - ``haproxy_cmd`` = ``/usr/sbin/haproxy`` + - (String) The full path to haproxy + * - ``haproxy_stick_size`` = ``10k`` + - (String) Size of the HAProxy stick table. Accepts k, m, g suffixes. Example: 10k + * - ``haproxy_template`` = ``None`` + - (String) Custom haproxy template. + * - ``respawn_count`` = ``2`` + - (Integer) The respawn count for haproxy's upstart script + * - ``respawn_interval`` = ``2`` + - (Integer) The respawn interval for haproxy's upstart script + * - ``rest_request_conn_timeout`` = ``10`` + - (Floating point) The time in seconds to wait for a REST API to connect. + * - ``rest_request_read_timeout`` = ``60`` + - (Floating point) The time in seconds to wait for a REST API response. + * - ``server_ca`` = ``/etc/octavia/certs/server_ca.pem`` + - (String) The ca which signed the server certificates + * - ``use_upstart`` = ``True`` + - (Boolean) If False, use sysvinit. + * - **[health_manager]** + - + * - ``bind_ip`` = ``0.0.0.0`` + - (Unknown) IP address the controller will listen on for heart beats + * - ``bind_port`` = ``5555`` + - (Unknown) Port number the controller will listen onfor heart beats + * - ``controller_ip_port_list`` = + - (List) List of controller ip and port pairs for the heartbeat receivers. Example 127.0.0.1:5555, 192.168.0.1:5555 + * - ``event_streamer_driver`` = ``noop_event_streamer`` + - (String) Specifies which driver to use for the event_streamer for syncing the octavia and neutron_lbaas dbs. If you don't need to sync the database or are running octavia in stand alone mode use the noop_event_streamer + * - ``failover_threads`` = ``10`` + - (Integer) Number of threads performing amphora failovers. + * - ``health_check_interval`` = ``3`` + - (Integer) Sleep time between health checks in seconds. + * - ``heartbeat_interval`` = ``10`` + - (Integer) Sleep time between sending hearthbeats. + * - ``heartbeat_key`` = ``None`` + - (String) key used to validate amphora sendingthe message + * - ``heartbeat_timeout`` = ``60`` + - (Integer) Interval, in seconds, to wait before failing over an amphora. + * - ``sock_rlimit`` = ``0`` + - (Integer) sets the value of the heartbeat recv buffer + * - ``status_update_threads`` = ``50`` + - (Integer) Number of threads performing amphora status update. + * - **[house_keeping]** + - + * - ``amphora_expiry_age`` = ``604800`` + - (Integer) Amphora expiry age in seconds + * - ``cert_expiry_buffer`` = ``1209600`` + - (Integer) Seconds until certificate expiration + * - ``cert_interval`` = ``3600`` + - (Integer) Certificate check interval in seconds + * - ``cert_rotate_threads`` = ``10`` + - (Integer) Number of threads performing amphora certificate rotation + * - ``cleanup_interval`` = ``30`` + - (Integer) DB cleanup interval in seconds + * - ``spare_amphora_pool_size`` = ``0`` + - (Integer) Number of spare amphorae + * - ``spare_check_interval`` = ``30`` + - (Integer) Spare check interval in seconds + * - **[keepalived_vrrp]** + - + * - ``vrrp_advert_int`` = ``1`` + - (Integer) Amphora role and priority advertisement interval in seconds. + * - ``vrrp_check_interval`` = ``5`` + - (Integer) VRRP health check script run interval in seconds. + * - ``vrrp_fail_count`` = ``2`` + - (Integer) Number of successive failure before transition to a fail state. + * - ``vrrp_garp_refresh_count`` = ``2`` + - (Integer) Number of gratuitous ARP announcements to make on each refresh interval. + * - ``vrrp_garp_refresh_interval`` = ``5`` + - (Integer) Time in seconds between gratuitous ARP announcements from the MASTER. + * - ``vrrp_success_count`` = ``2`` + - (Integer) Number of successive failure before transition to a success state. + * - **[networking]** + - + * - ``lb_network_name`` = ``None`` + - (String) Name of amphora internal network + * - ``max_retries`` = ``15`` + - (Integer) The maximum attempts to retry an action with the networking service. + * - ``retry_interval`` = ``1`` + - (Integer) Seconds to wait before retrying an action with the networking service. + * - **[neutron]** + - + * - ``ca_certificates_file`` = ``None`` + - (String) CA certificates file path + * - ``endpoint`` = ``None`` + - (String) A new endpoint to override the endpoint in the keystone catalog. + * - ``endpoint_type`` = ``publicURL`` + - (String) Endpoint interface in identity service to use + * - ``insecure`` = ``False`` + - (Boolean) Disable certificate validation on SSL connections + * - ``region_name`` = ``None`` + - (String) Region in Identity service catalog to use for communication with the OpenStack services. + * - ``service_name`` = ``None`` + - (String) The name of the neutron service in the keystone catalog + * - **[nova]** + - + * - ``ca_certificates_file`` = ``None`` + - (String) CA certificates file path + * - ``enable_anti_affinity`` = ``False`` + - (Boolean) Flag to indicate if nova anti-affinity feature is turned on. + * - ``endpoint`` = ``None`` + - (String) A new endpoint to override the endpoint in the keystone catalog. + * - ``endpoint_type`` = ``publicURL`` + - (String) Endpoint interface in identity service to use + * - ``insecure`` = ``False`` + - (Boolean) Disable certificate validation on SSL connections + * - ``region_name`` = ``None`` + - (String) Region in Identity service catalog to use for communication with the OpenStack services. + * - ``service_name`` = ``None`` + - (String) The name of the nova service in the keystone catalog + * - **[oslo_middleware]** + - + * - ``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. + * - **[task_flow]** + - + * - ``engine`` = ``serial`` + - (String) TaskFlow engine to use + * - ``max_workers`` = ``5`` + - (Integer) The maximum number of workers diff --git a/doc/config-reference/source/tables/octavia-cors.rst b/doc/config-reference/source/tables/octavia-cors.rst new file mode 100644 index 0000000000..4b89240a53 --- /dev/null +++ b/doc/config-reference/source/tables/octavia-cors.rst @@ -0,0 +1,46 @@ +.. + 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. + +.. _octavia-cors: + +.. list-table:: Description of CORS configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[cors]** + - + * - ``allow_credentials`` = ``True`` + - (Boolean) Indicate that the actual request can include user credentials + * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (List) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (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. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (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`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (List) Indicate which header field names may be used during the actual request. + * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` + - (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. + * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` + - (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. diff --git a/doc/config-reference/source/tables/octavia-database.rst b/doc/config-reference/source/tables/octavia-database.rst new file mode 100644 index 0000000000..ad478ae6fc --- /dev/null +++ b/doc/config-reference/source/tables/octavia-database.rst @@ -0,0 +1,60 @@ +.. + 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. + +.. _octavia-database: + +.. list-table:: Description of database configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[database]** + - + * - ``backend`` = ``sqlalchemy`` + - (String) The back end to use for the database. + * - ``connection`` = ``None`` + - (String) The SQLAlchemy connection string to use to connect to the database. + * - ``connection_debug`` = ``0`` + - (Integer) Verbosity of SQL debugging information: 0=None, 100=Everything. + * - ``connection_trace`` = ``False`` + - (Boolean) Add Python stack traces to SQL as comment strings. + * - ``db_inc_retry_interval`` = ``True`` + - (Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval. + * - ``db_max_retries`` = ``20`` + - (Integer) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. + * - ``db_max_retry_interval`` = ``10`` + - (Integer) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. + * - ``db_retry_interval`` = ``1`` + - (Integer) Seconds between retries of a database transaction. + * - ``idle_timeout`` = ``3600`` + - (Integer) Timeout before idle SQL connections are reaped. + * - ``max_overflow`` = ``50`` + - (Integer) If set, use this value for max_overflow with SQLAlchemy. + * - ``max_pool_size`` = ``None`` + - (Integer) Maximum number of SQL connections to keep open in a pool. + * - ``max_retries`` = ``10`` + - (Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. + * - ``min_pool_size`` = ``1`` + - (Integer) Minimum number of SQL connections to keep open in a pool. + * - ``mysql_sql_mode`` = ``TRADITIONAL`` + - (String) 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`` + - (Integer) If set, use this value for pool_timeout with SQLAlchemy. + * - ``retry_interval`` = ``10`` + - (Integer) Interval between retries of opening a SQL connection. + * - ``slave_connection`` = ``None`` + - (String) The SQLAlchemy connection string to use to connect to the slave database. + * - ``sqlite_db`` = ``oslo.sqlite`` + - (String) The file name to use with SQLite. + * - ``sqlite_synchronous`` = ``True`` + - (Boolean) If True, SQLite uses synchronous mode. + * - ``use_db_reconnect`` = ``False`` + - (Boolean) Enable the experimental use of database reconnect on connection lost. diff --git a/doc/config-reference/source/tables/octavia-logging.rst b/doc/config-reference/source/tables/octavia-logging.rst new file mode 100644 index 0000000000..8d497c9560 --- /dev/null +++ b/doc/config-reference/source/tables/octavia-logging.rst @@ -0,0 +1,54 @@ +.. + 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. + +.. _octavia-logging: + +.. list-table:: Description of logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (String) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (String) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (String) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (String) Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (String) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (String) (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (String) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (String) Additional data to append to log message when logging level for the message is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (String) Format string to use for log messages when context is undefined. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (String) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (String) Defines the format string for %(user_identity)s that is used in logging_context_format_string. + * - ``publish_errors`` = ``False`` + - (Boolean) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (String) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (Boolean) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (Boolean) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (Boolean) DEPRECATED: If set to false, the logging level will be set to WARNING instead of the default INFO level. + * - ``watch_log_file`` = ``False`` + - (Boolean) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. diff --git a/doc/config-reference/source/tables/octavia-rabbitmq.rst b/doc/config-reference/source/tables/octavia-rabbitmq.rst new file mode 100644 index 0000000000..9ff1f675ff --- /dev/null +++ b/doc/config-reference/source/tables/octavia-rabbitmq.rst @@ -0,0 +1,132 @@ +.. + 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. + +.. _octavia-rabbitmq: + +.. list-table:: Description of RabbitMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[oslo_messaging_rabbit]** + - + * - ``amqp_auto_delete`` = ``False`` + - (Boolean) Auto-delete queues in AMQP. + * - ``amqp_durable_queues`` = ``False`` + - (Boolean) Use durable queues in AMQP. + * - ``channel_max`` = ``None`` + - (Integer) Maximum number of channels to allow + * - ``default_notification_exchange`` = ``${control_exchange}_notification`` + - (String) Exchange name for 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`` + - (String) Exchange name for sending RPC messages + * - ``default_rpc_retry_attempts`` = ``-1`` + - (Integer) Reconnecting retry count in case of connectivity problem during sending RPC message, -1 means infinite retry. If actual retry attempts in not 0 the rpc request could be processed more then one time + * - ``fake_rabbit`` = ``False`` + - (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`` + - (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. + * - ``heartbeat_timeout_threshold`` = ``60`` + - (Integer) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL + * - ``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. + * - ``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`` + - (Integer) How long to wait a missing client beforce abandoning to send it its replies. This value should not be longer than rpc_response_timeout. + * - ``kombu_reconnect_delay`` = ``1.0`` + - (Floating point) How long to wait before reconnecting in response to an AMQP consumer cancel notification. + * - ``kombu_ssl_ca_certs`` = + - (String) SSL certification authority file (valid only if SSL enabled). + * - ``kombu_ssl_certfile`` = + - (String) SSL cert file (valid only if SSL enabled). + * - ``kombu_ssl_keyfile`` = + - (String) SSL key file (valid only if SSL enabled). + * - ``kombu_ssl_version`` = + - (String) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. + * - ``notification_listener_prefetch_count`` = ``100`` + - (Integer) Max number of not acknowledged message which RabbitMQ can send to notification listener. + * - ``notification_persistence`` = ``False`` + - (Boolean) Persist notification messages. + * - ``notification_retry_delay`` = ``0.25`` + - (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`` + - (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. + * - ``pool_stale`` = ``60`` + - (Integer) Threshold at which inactive (since release) connections are considered stale in seconds or None for no staleness. Stale connections are closed on acquire. + * - ``pool_timeout`` = ``30`` + - (Integer) Default number of seconds to wait for a connections to available + * - ``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. + * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` + - (List) RabbitMQ HA cluster host:port pairs. + * - ``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). + * - ``rabbit_password`` = ``guest`` + - (String) The RabbitMQ password. + * - ``rabbit_port`` = ``5672`` + - (Unknown) The RabbitMQ broker port where a single node is used. + * - ``rabbit_qos_prefetch_count`` = ``0`` + - (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. + * - ``rabbit_retry_backoff`` = ``2`` + - (Integer) How long to backoff for between retries when connecting to RabbitMQ. + * - ``rabbit_retry_interval`` = ``1`` + - (Integer) How frequently to retry connecting with RabbitMQ. + * - ``rabbit_transient_queues_ttl`` = ``1800`` + - (Integer) Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues. + * - ``rabbit_use_ssl`` = ``False`` + - (Boolean) Connect over SSL for RabbitMQ. + * - ``rabbit_userid`` = ``guest`` + - (String) The RabbitMQ userid. + * - ``rabbit_virtual_host`` = ``/`` + - (String) The RabbitMQ virtual host. + * - ``rpc_conn_pool_size`` = ``30`` + - (Integer) Size of RPC connection pool. + * - ``rpc_listener_prefetch_count`` = ``100`` + - (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc listener. + * - ``rpc_queue_expiration`` = ``60`` + - (Integer) Time to live for rpc queues without consumers in seconds. + * - ``rpc_reply_exchange`` = ``${control_exchange}_rpc_reply`` + - (String) Exchange name for receiving RPC replies + * - ``rpc_reply_listener_prefetch_count`` = ``100`` + - (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc reply listener. + * - ``rpc_reply_retry_attempts`` = ``-1`` + - (Integer) Reconnecting retry count in case of connectivity problem during sending reply. -1 means infinite retry during rpc_timeout + * - ``rpc_reply_retry_delay`` = ``0.25`` + - (Floating point) Reconnecting retry delay in case of connectivity problem during sending reply. + * - ``rpc_retry_delay`` = ``0.25`` + - (Floating point) Reconnecting retry delay in case of connectivity problem during sending RPC message + * - ``socket_timeout`` = ``0.25`` + - (Floating point) Set socket timeout in seconds for connection's socket + * - ``ssl`` = ``None`` + - (Boolean) Enable SSL + * - ``ssl_options`` = ``None`` + - (Dict) Arguments passed to ssl.wrap_socket + * - ``tcp_user_timeout`` = ``0.25`` + - (Floating point) Set TCP_USER_TIMEOUT in seconds for connection's socket diff --git a/doc/config-reference/source/tables/octavia-redis.rst b/doc/config-reference/source/tables/octavia-redis.rst new file mode 100644 index 0000000000..d5b2be3220 --- /dev/null +++ b/doc/config-reference/source/tables/octavia-redis.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. + +.. _octavia-redis: + +.. list-table:: Description of Redis configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[matchmaker_redis]** + - + * - ``check_timeout`` = ``20000`` + - (Integer) Time in ms to wait before the transaction is killed. + * - ``host`` = ``127.0.0.1`` + - (String) Host to locate redis. + * - ``password`` = + - (String) Password for Redis server (optional). + * - ``port`` = ``6379`` + - (Unknown) Use this port to connect to redis host. + * - ``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`` + - (Integer) Timeout in ms on blocking socket operations + * - ``wait_timeout`` = ``500`` + - (Integer) Time in ms to wait between connection attempts. diff --git a/doc/config-reference/source/tables/octavia-rpc.rst b/doc/config-reference/source/tables/octavia-rpc.rst new file mode 100644 index 0000000000..25d9f163d4 --- /dev/null +++ b/doc/config-reference/source/tables/octavia-rpc.rst @@ -0,0 +1,76 @@ +.. + 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. + +.. _octavia-rpc: + +.. list-table:: Description of RPC configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``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. + * - **[oslo_concurrency]** + - + * - ``disable_process_locking`` = ``False`` + - (Boolean) Enables or disables inter-process locks. + * - ``lock_path`` = ``None`` + - (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]** + - + * - ``event_stream_topic`` = ``neutron_lbaas_event`` + - (String) topic name for communicating events through a queue + * - ``topic`` = ``None`` + - (String) No help text available for this option. + * - **[oslo_messaging_amqp]** + - + * - ``allow_insecure_clients`` = ``False`` + - (Boolean) Accept clients using either SSL or plain TCP + * - ``broadcast_prefix`` = ``broadcast`` + - (String) address prefix used when broadcasting to all servers + * - ``container_name`` = ``None`` + - (String) Name for the AMQP container + * - ``group_request_prefix`` = ``unicast`` + - (String) address prefix when sending to any server in group + * - ``idle_timeout`` = ``0`` + - (Integer) Timeout for inactive connections (in seconds) + * - ``password`` = + - (String) Password for message broker authentication + * - ``sasl_config_dir`` = + - (String) Path to directory that contains the SASL configuration + * - ``sasl_config_name`` = + - (String) Name of configuration file (without .conf suffix) + * - ``sasl_mechanisms`` = + - (String) Space separated list of acceptable SASL mechanisms + * - ``server_request_prefix`` = ``exclusive`` + - (String) address prefix used when sending to a specific server + * - ``ssl_ca_file`` = + - (String) CA certificate PEM file to verify server certificate + * - ``ssl_cert_file`` = + - (String) Identifying certificate PEM file to present to clients + * - ``ssl_key_file`` = + - (String) Private key PEM file used to sign cert_file certificate + * - ``ssl_key_password`` = ``None`` + - (String) Password for decrypting ssl_key_file (if encrypted) + * - ``trace`` = ``False`` + - (Boolean) Debug: dump AMQP frames to stdout + * - ``username`` = + - (String) User name for message broker authentication + * - **[oslo_messaging_notifications]** + - + * - ``driver`` = ``[]`` + - (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop + * - ``topics`` = ``notifications`` + - (List) AMQP topic used for OpenStack notifications. + * - ``transport_url`` = ``None`` + - (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. diff --git a/doc/config-reference/source/tables/octavia-zeromq.rst b/doc/config-reference/source/tables/octavia-zeromq.rst new file mode 100644 index 0000000000..07dc4cc5bf --- /dev/null +++ b/doc/config-reference/source/tables/octavia-zeromq.rst @@ -0,0 +1,54 @@ +.. + 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. + +.. _octavia-zeromq: + +.. list-table:: Description of ZeroMQ configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``rpc_backend`` = ``rabbit`` + - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and 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_conn_pool_size`` = ``30`` + - (Integer) Size of RPC connection pool. + * - ``rpc_poll_timeout`` = ``1`` + - (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_response_timeout`` = ``60`` + - (Integer) Seconds to wait for a response from a call. + * - ``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_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`` + - (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`` = ``49152`` + - (Unknown) Minimal port number for random ports range. + * - ``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`` + - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). diff --git a/tools/autogenerate-config-flagmappings/octavia.flagmappings b/tools/autogenerate-config-flagmappings/octavia.flagmappings new file mode 100644 index 0000000000..80d9dd68e1 --- /dev/null +++ b/tools/autogenerate-config-flagmappings/octavia.flagmappings @@ -0,0 +1,312 @@ +allow_bulk common +allow_pagination common +allow_sorting common +api_extensions_path common +api_handler common +api_paste_config common +auth_strategy common +bind_host common +bind_port common +control_exchange common +debug common +default_log_levels common +executor_thread_pool_size common +fatal_deprecations common +host common +instance_format logging +instance_uuid_format logging +log_config_append logging +log_date_format logging +log_dir logging +log_file logging +logging_context_format_string logging +logging_debug_format_suffix logging +logging_default_format_string logging +logging_exception_prefix logging +logging_user_identity_format logging +memcached_servers cache +octavia_plugins common +pagination_max_limit api +publish_errors logging +rpc_backend zeromq +rpc_cast_timeout zeromq +rpc_conn_pool_size zeromq +rpc_poll_timeout zeromq +rpc_response_timeout zeromq +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_topic_backlog zeromq +syslog_log_facility logging +transport_url rpc +use_pub_sub zeromq +use_stderr logging +use_syslog logging +verbose logging +watch_log_file logging +zmq_target_expire zeromq +amphora_agent/agent_server_ca common +amphora_agent/agent_server_cert common +amphora_agent/agent_server_network_dir common +amphora_agent/agent_server_network_file common +amphora_agent/amphora_id common +anchor/password common +anchor/url common +anchor/username common +certificates/barbican_auth common +certificates/ca_certificate common +certificates/ca_private_key common +certificates/ca_private_key_passphrase common +certificates/cert_generator common +certificates/cert_manager common +certificates/endpoint_type common +certificates/region_name common +certificates/signing_digest common +certificates/storage_path common +controller_worker/amp_active_retries common +controller_worker/amp_active_wait_sec common +controller_worker/amp_flavor_id common +controller_worker/amp_image_id common +controller_worker/amp_image_tag common +controller_worker/amp_network common +controller_worker/amp_secgroup_list common +controller_worker/amp_ssh_access_allowed common +controller_worker/amp_ssh_key_name common +controller_worker/amphora_driver common +controller_worker/cert_generator common +controller_worker/client_ca common +controller_worker/compute_driver common +controller_worker/loadbalancer_topology common +controller_worker/network_driver common +controller_worker/user_data_config_drive common +cors/allow_credentials cors +cors/allow_headers cors +cors/allow_methods cors +cors/allowed_origin cors +cors/expose_headers cors +cors/max_age cors +cors.subdomain/allow_credentials cors +cors.subdomain/allow_headers cors +cors.subdomain/allow_methods cors +cors.subdomain/allowed_origin cors +cors.subdomain/expose_headers cors +cors.subdomain/max_age cors +database/backend database +database/connection database +database/connection_debug database +database/connection_trace database +database/db_inc_retry_interval database +database/db_max_retries database +database/db_max_retry_interval database +database/db_retry_interval database +database/idle_timeout database +database/max_overflow database +database/max_pool_size database +database/max_retries database +database/min_pool_size database +database/mysql_sql_mode database +database/pool_timeout database +database/retry_interval database +database/slave_connection database +database/sqlite_db database +database/sqlite_synchronous database +database/use_db_reconnect database +glance/ca_certificates_file common +glance/endpoint common +glance/endpoint_type common +glance/insecure common +glance/region_name common +glance/service_name common +haproxy_amphora/base_cert_dir common +haproxy_amphora/base_path common +haproxy_amphora/bind_host common +haproxy_amphora/bind_port common +haproxy_amphora/client_cert common +haproxy_amphora/connection_max_retries common +haproxy_amphora/connection_retry_interval common +haproxy_amphora/haproxy_cmd common +haproxy_amphora/haproxy_stick_size common +haproxy_amphora/haproxy_template common +haproxy_amphora/respawn_count common +haproxy_amphora/respawn_interval common +haproxy_amphora/rest_request_conn_timeout common +haproxy_amphora/rest_request_read_timeout common +haproxy_amphora/server_ca common +haproxy_amphora/use_upstart common +health_manager/bind_ip common +health_manager/bind_port common +health_manager/controller_ip_port_list common +health_manager/event_streamer_driver common +health_manager/failover_threads common +health_manager/health_check_interval common +health_manager/heartbeat_interval common +health_manager/heartbeat_key common +health_manager/heartbeat_timeout common +health_manager/sock_rlimit common +health_manager/status_update_threads common +house_keeping/amphora_expiry_age common +house_keeping/cert_expiry_buffer common +house_keeping/cert_interval common +house_keeping/cert_rotate_threads common +house_keeping/cleanup_interval common +house_keeping/spare_amphora_pool_size common +house_keeping/spare_check_interval common +keepalived_vrrp/vrrp_advert_int common +keepalived_vrrp/vrrp_check_interval common +keepalived_vrrp/vrrp_fail_count common +keepalived_vrrp/vrrp_garp_refresh_count common +keepalived_vrrp/vrrp_garp_refresh_interval common +keepalived_vrrp/vrrp_success_count common +keystone_authtoken/admin_password auth_token +keystone_authtoken/admin_tenant_name auth_token +keystone_authtoken/admin_token auth_token +keystone_authtoken/admin_user auth_token +keystone_authtoken/auth_admin_prefix auth_token +keystone_authtoken/auth_host auth_token +keystone_authtoken/auth_port auth_token +keystone_authtoken/auth_protocol auth_token +keystone_authtoken/auth_section auth_token +keystone_authtoken/auth_type auth_token +keystone_authtoken/auth_uri auth_token +keystone_authtoken/auth_version auth_token +keystone_authtoken/cache auth_token +keystone_authtoken/cafile auth_token +keystone_authtoken/certfile auth_token +keystone_authtoken/check_revocations_for_cached auth_token +keystone_authtoken/delay_auth_decision auth_token +keystone_authtoken/enforce_token_bind auth_token +keystone_authtoken/hash_algorithms auth_token +keystone_authtoken/http_connect_timeout auth_token +keystone_authtoken/http_request_max_retries auth_token +keystone_authtoken/identity_uri auth_token +keystone_authtoken/include_service_catalog auth_token +keystone_authtoken/insecure auth_token +keystone_authtoken/keyfile auth_token +keystone_authtoken/memcache_pool_conn_get_timeout auth_token +keystone_authtoken/memcache_pool_dead_retry auth_token +keystone_authtoken/memcache_pool_maxsize auth_token +keystone_authtoken/memcache_pool_socket_timeout auth_token +keystone_authtoken/memcache_pool_unused_timeout auth_token +keystone_authtoken/memcache_secret_key auth_token +keystone_authtoken/memcache_security_strategy auth_token +keystone_authtoken/memcache_use_advanced_pool auth_token +keystone_authtoken/memcached_servers auth_token +keystone_authtoken/region_name auth_token +keystone_authtoken/revocation_cache_time auth_token +keystone_authtoken/signing_dir auth_token +keystone_authtoken/token_cache_time auth_token +keystone_authtoken_v3/admin_project_domain auth_token +keystone_authtoken_v3/admin_user_domain auth_token +matchmaker_redis/check_timeout redis +matchmaker_redis/host redis +matchmaker_redis/password redis +matchmaker_redis/port redis +matchmaker_redis/sentinel_group_name redis +matchmaker_redis/sentinel_hosts redis +matchmaker_redis/socket_timeout redis +matchmaker_redis/wait_timeout redis +networking/lb_network_name common +networking/max_retries common +networking/retry_interval common +neutron/ca_certificates_file common +neutron/endpoint common +neutron/endpoint_type common +neutron/insecure common +neutron/region_name common +neutron/service_name common +nova/ca_certificates_file common +nova/enable_anti_affinity common +nova/endpoint common +nova/endpoint_type common +nova/insecure common +nova/region_name common +nova/service_name common +oslo_concurrency/disable_process_locking rpc +oslo_concurrency/lock_path rpc +oslo_messaging/event_stream_topic rpc +oslo_messaging/topic rpc +oslo_messaging_amqp/allow_insecure_clients rpc +oslo_messaging_amqp/broadcast_prefix rpc +oslo_messaging_amqp/container_name rpc +oslo_messaging_amqp/group_request_prefix rpc +oslo_messaging_amqp/idle_timeout rpc +oslo_messaging_amqp/password rpc +oslo_messaging_amqp/sasl_config_dir rpc +oslo_messaging_amqp/sasl_config_name rpc +oslo_messaging_amqp/sasl_mechanisms rpc +oslo_messaging_amqp/server_request_prefix rpc +oslo_messaging_amqp/ssl_ca_file rpc +oslo_messaging_amqp/ssl_cert_file rpc +oslo_messaging_amqp/ssl_key_file rpc +oslo_messaging_amqp/ssl_key_password rpc +oslo_messaging_amqp/trace rpc +oslo_messaging_amqp/username rpc +oslo_messaging_notifications/driver rpc +oslo_messaging_notifications/topics rpc +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/default_notification_exchange rabbitmq +oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq +oslo_messaging_rabbit/default_rpc_exchange rabbitmq +oslo_messaging_rabbit/default_rpc_retry_attempts rabbitmq +oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/frame_max rabbitmq +oslo_messaging_rabbit/heartbeat_interval rabbitmq +oslo_messaging_rabbit/heartbeat_rate rabbitmq +oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/host_connection_reconnect_delay rabbitmq +oslo_messaging_rabbit/kombu_compression rabbitmq +oslo_messaging_rabbit/kombu_failover_strategy rabbitmq +oslo_messaging_rabbit/kombu_missing_consumer_retry_timeout rabbitmq +oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq +oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq +oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq +oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq +oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/notification_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/notification_persistence rabbitmq +oslo_messaging_rabbit/notification_retry_delay rabbitmq +oslo_messaging_rabbit/pool_max_overflow rabbitmq +oslo_messaging_rabbit/pool_max_size rabbitmq +oslo_messaging_rabbit/pool_recycle rabbitmq +oslo_messaging_rabbit/pool_stale rabbitmq +oslo_messaging_rabbit/pool_timeout rabbitmq +oslo_messaging_rabbit/rabbit_ha_queues rabbitmq +oslo_messaging_rabbit/rabbit_host rabbitmq +oslo_messaging_rabbit/rabbit_hosts rabbitmq +oslo_messaging_rabbit/rabbit_interval_max rabbitmq +oslo_messaging_rabbit/rabbit_login_method rabbitmq +oslo_messaging_rabbit/rabbit_max_retries rabbitmq +oslo_messaging_rabbit/rabbit_password rabbitmq +oslo_messaging_rabbit/rabbit_port rabbitmq +oslo_messaging_rabbit/rabbit_qos_prefetch_count rabbitmq +oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq +oslo_messaging_rabbit/rabbit_retry_interval rabbitmq +oslo_messaging_rabbit/rabbit_transient_queues_ttl rabbitmq +oslo_messaging_rabbit/rabbit_use_ssl rabbitmq +oslo_messaging_rabbit/rabbit_userid rabbitmq +oslo_messaging_rabbit/rabbit_virtual_host rabbitmq +oslo_messaging_rabbit/rpc_conn_pool_size rabbitmq +oslo_messaging_rabbit/rpc_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_queue_expiration rabbitmq +oslo_messaging_rabbit/rpc_reply_exchange rabbitmq +oslo_messaging_rabbit/rpc_reply_listener_prefetch_count rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_attempts rabbitmq +oslo_messaging_rabbit/rpc_reply_retry_delay rabbitmq +oslo_messaging_rabbit/rpc_retry_delay rabbitmq +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_middleware/max_request_body_size common +oslo_middleware/secure_proxy_ssl_header common +task_flow/engine common +task_flow/max_workers common diff --git a/tools/autogenerate-config-flagmappings/shared.headers b/tools/autogenerate-config-flagmappings/shared.headers index 066bd062b8..124fbab9c0 100644 --- a/tools/autogenerate-config-flagmappings/shared.headers +++ b/tools/autogenerate-config-flagmappings/shared.headers @@ -4,6 +4,7 @@ api API auth authorization auth_token authorization token ca CA and SSL +cache cache cinder cinder clients clients common common