From e1a58c9a3ee8a6c64dfc4c1f9139a909f77649dc Mon Sep 17 00:00:00 2001 From: venkatamahesh Date: Sat, 3 Sep 2016 20:26:57 +0530 Subject: [PATCH] [config-ref] Update trove tables Change-Id: Ia436547660b899d1393adb124a636a6cbb2e1338 --- .../source/tables/trove-amqp.rst | 2 +- .../source/tables/trove-api.rst | 6 +- .../source/tables/trove-common.rst | 36 +------- .../source/tables/trove-compute.rst | 2 +- .../source/tables/trove-db_cassandra.rst | 8 +- .../source/tables/trove-db_couchbase.rst | 4 + .../source/tables/trove-db_couchdb.rst | 4 + .../source/tables/trove-db_db2.rst | 4 + .../source/tables/trove-db_mariadb.rst | 12 ++- .../source/tables/trove-db_mongodb.rst | 4 + .../source/tables/trove-db_mysql.rst | 4 + .../source/tables/trove-db_percona.rst | 4 + .../source/tables/trove-db_postgresql.rst | 12 ++- .../source/tables/trove-db_pxc.rst | 4 + .../source/tables/trove-db_redis.rst | 4 + .../source/tables/trove-db_vertica.rst | 4 + .../source/tables/trove-debug.rst | 26 +++++- .../source/tables/trove-dns.rst | 16 ++-- .../source/tables/trove-guestagent.rst | 4 +- .../source/tables/trove-heat.rst | 2 +- .../source/tables/trove-network.rst | 2 +- .../source/tables/trove-quota.rst | 6 +- .../source/tables/trove-rabbitmq.rst | 24 ++--- .../source/tables/trove-redis.rst | 12 +-- .../source/tables/trove-rpc.rst | 44 +++++++-- .../source/tables/trove-swift.rst | 2 +- .../source/tables/trove-taskmanager.rst | 6 +- .../source/tables/trove-volume.rst | 2 +- .../source/tables/trove-zeromq.rst | 48 +++++++++- .../trove.flagmappings | 90 ++++++++++++++----- 30 files changed, 282 insertions(+), 116 deletions(-) diff --git a/doc/config-reference/source/tables/trove-amqp.rst b/doc/config-reference/source/tables/trove-amqp.rst index ba39fddfd0..6c0bd74ea7 100644 --- a/doc/config-reference/source/tables/trove-amqp.rst +++ b/doc/config-reference/source/tables/trove-amqp.rst @@ -27,4 +27,4 @@ * - ``notification_service_id`` = ``{'mongodb': 'c8c907af-7375-456f-b929-b637ff9209ee', 'percona': 'fd1723f5-68d2-409c-994f-a4a197892a17', 'mysql': '2f3ff068-2bfb-4f70-9a9d-a6bb65bc084b', 'pxc': '75a628c3-f81b-4ffb-b10a-4087c26bc854', 'db2': 'e040cd37-263d-4869-aaa6-c62aa97523b5', 'cassandra': '459a230d-4e97-4344-9067-2a54a310b0ed', 'mariadb': '7a4f82cc-10d2-4bc6-aadc-d9aacc2a3cb5', 'postgresql': 'ac277e0d-4f21-40aa-b347-1ea31e571720', 'couchbase': 'fa62fe68-74d9-4779-a24e-36f19602c415', 'couchdb': 'f0a9ab7b-66f7-4352-93d7-071521d44c7c', 'redis': 'b216ffc5-1947-456c-a4cf-70f94c05f7d0', 'vertica': 'a8d805ae-a3b2-c4fd-gb23-b62cee5201ae'}`` - (Dict) Unique ID to tag notification events. * - ``transport_url`` = ``None`` - - (String) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. + - (String) A URL representing the messaging driver to use and its full configuration. diff --git a/doc/config-reference/source/tables/trove-api.rst b/doc/config-reference/source/tables/trove-api.rst index 898e694b38..100b38aee5 100644 --- a/doc/config-reference/source/tables/trove-api.rst +++ b/doc/config-reference/source/tables/trove-api.rst @@ -57,7 +57,7 @@ * - ``trove_api_workers`` = ``None`` - (Integer) Number of workers for the API service. The default will be the number of CPUs available. * - ``trove_auth_url`` = ``http://0.0.0.0:5000/v2.0`` - - (String) Trove authentication URL. + - (Unknown) Trove authentication URL. * - ``trove_conductor_workers`` = ``None`` - (Integer) Number of workers for the Conductor service. The default will be the number of CPUs available. * - ``trove_security_group_name_prefix`` = ``SecGroup`` @@ -70,7 +70,9 @@ - (Integer) Page size for listing users. * - **[oslo_middleware]** - + * - ``enable_proxy_headers_parsing`` = ``False`` + - (Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not. * - ``max_request_body_size`` = ``114688`` - (Integer) The maximum body size for each request, in bytes. * - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto`` - - (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. + - (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy. diff --git a/doc/config-reference/source/tables/trove-common.rst b/doc/config-reference/source/tables/trove-common.rst index 99f18b2b84..d16c8276ee 100644 --- a/doc/config-reference/source/tables/trove-common.rst +++ b/doc/config-reference/source/tables/trove-common.rst @@ -26,8 +26,6 @@ - (String) The default datastore id or name to use if one is not provided by the user. If the default value is None, the field becomes required in the instance create request. * - ``default_neutron_networks`` = - (List) List of IDs for management networks which should be attached to the instance regardless of what NICs are specified in the create API call. - * - ``default_password_length`` = ``36`` - - (Integer) Character length of generated passwords. * - ``executor_thread_pool_size`` = ``64`` - (Integer) Size of executor thread pool. * - ``expected_filetype_suffixes`` = ``json`` @@ -36,11 +34,9 @@ - (String) Options to use when formatting a volume. * - ``host`` = ``0.0.0.0`` - (Unknown) Host to listen for RPC messages. - * - ``memcached_servers`` = ``None`` - - (List) Memcached servers or None for in process cache. * - ``module_aes_cbc_key`` = ``module_aes_cbc_key`` - (String) OpenSSL aes_cbc key for module encryption. - * - ``module_types`` = ``ping`` + * - ``module_types`` = ``ping, new_relic_license`` - (List) A list of module types supported. A module type corresponds to the name of a ModuleDriver. * - ``modules_page_size`` = ``20`` - (Integer) Page size for listing modules. @@ -60,33 +56,5 @@ - (String) Path which leads to datastore templates. * - ``timeout_wait_for_service`` = ``120`` - (Integer) Maximum time (in seconds) to wait for a service to become alive. - * - ``usage_timeout`` = ``900`` + * - ``usage_timeout`` = ``1800`` - (Integer) Maximum time (in seconds) to wait for a Guest to become active. - * - **[certificates]** - - - * - ``barbican_auth`` = ``barbican_acl_auth`` - - (String) Name of the Barbican authentication method to use - * - ``cert_manager_type`` = ``barbican`` - - (String) Certificate Manager plugin. Defaults to barbican. - * - **[service_auth]** - - - * - ``admin_password`` = ``password`` - - (String) The service admin password - * - ``admin_project_domain`` = ``admin`` - - (String) The admin project domain name - * - ``admin_tenant_name`` = ``admin`` - - (String) The service admin tenant name - * - ``admin_user`` = ``admin`` - - (String) The service admin user name - * - ``admin_user_domain`` = ``admin`` - - (String) The admin user domain name - * - ``auth_url`` = ``http://127.0.0.1:5000/v2.0`` - - (String) Authentication endpoint - * - ``auth_version`` = ``2`` - - (String) The auth version used to authenticate - * - ``endpoint_type`` = ``public`` - - (String) The endpoint_type to be used - * - ``region`` = ``RegionOne`` - - (String) The deployment region - * - ``service_name`` = ``lbaas`` - - (String) The name of the service diff --git a/doc/config-reference/source/tables/trove-compute.rst b/doc/config-reference/source/tables/trove-compute.rst index 7872c36fb3..2f1b222348 100644 --- a/doc/config-reference/source/tables/trove-compute.rst +++ b/doc/config-reference/source/tables/trove-compute.rst @@ -27,7 +27,7 @@ * - ``nova_compute_service_type`` = ``compute`` - (String) Service type to use when searching catalog. * - ``nova_compute_url`` = ``None`` - - (String) URL without the tenant segment. + - (Unknown) URL without the tenant segment. * - ``root_grant`` = ``ALL`` - (List) Permissions to grant to the 'root' user. * - ``root_grant_option`` = ``True`` diff --git a/doc/config-reference/source/tables/trove-db_cassandra.rst b/doc/config-reference/source/tables/trove-db_cassandra.rst index 7af97f70f1..35b14dbb67 100644 --- a/doc/config-reference/source/tables/trove-db_cassandra.rst +++ b/doc/config-reference/source/tables/trove-db_cassandra.rst @@ -28,12 +28,16 @@ - (String) Default strategy to perform backups. * - ``cluster_support`` = ``True`` - (Boolean) Enable clusters to be created and managed. + * - ``default_password_length`` = ``36`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) Device path for volume if volume support is enabled. - * - ``guest_log_exposed_logs`` = + * - ``guest_log_exposed_logs`` = ``system`` - (String) List of Guest Logs to expose for publishing. * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.cassandra.guestagent.CassandraGuestAgentStrategy`` - (String) Class that implements datastore-specific Guest Agent API logic. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``ignore_dbs`` = ``system, system_auth, system_traces`` - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``os_admin`` @@ -46,6 +50,8 @@ - (String) Namespace to load restore strategies from. * - ``root_controller`` = ``trove.extensions.cassandra.service.CassandraRootController`` - (String) Root controller implementation for Cassandra. + * - ``system_log_level`` = ``INFO`` + - (String) Cassandra log verbosity. * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.cassandra.taskmanager.CassandraTaskManagerStrategy`` - (String) Class that implements datastore-specific task manager logic. * - ``tcp_ports`` = ``7000, 7001, 7199, 9042, 9160`` diff --git a/doc/config-reference/source/tables/trove-db_couchbase.rst b/doc/config-reference/source/tables/trove-db_couchbase.rst index 62455a8a30..3192cf5d75 100644 --- a/doc/config-reference/source/tables/trove-db_couchbase.rst +++ b/doc/config-reference/source/tables/trove-db_couchbase.rst @@ -24,10 +24,14 @@ - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``CbBackup`` - (String) Default strategy to perform backups. + * - ``default_password_length`` = ``24`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) Device path for volume if volume support is enabled. * - ``guest_log_exposed_logs`` = - (String) List of Guest Logs to expose for publishing. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``mount_point`` = ``/var/lib/couchbase`` - (String) Filesystem path for mounting volumes if volume support is enabled. * - ``replication_strategy`` = ``None`` diff --git a/doc/config-reference/source/tables/trove-db_couchdb.rst b/doc/config-reference/source/tables/trove-db_couchdb.rst index 58c578242d..8ccb151ed2 100644 --- a/doc/config-reference/source/tables/trove-db_couchdb.rst +++ b/doc/config-reference/source/tables/trove-db_couchdb.rst @@ -24,10 +24,14 @@ - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``CouchDBBackup`` - (String) Default strategy to perform backups. + * - ``default_password_length`` = ``36`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) Device path for volume if volume support is enabled. * - ``guest_log_exposed_logs`` = - (String) List of Guest Logs to expose for publishing. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``ignore_dbs`` = ``_users, _replicator`` - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``os_admin, root`` diff --git a/doc/config-reference/source/tables/trove-db_db2.rst b/doc/config-reference/source/tables/trove-db_db2.rst index aaa9fd158d..a377d761bc 100644 --- a/doc/config-reference/source/tables/trove-db_db2.rst +++ b/doc/config-reference/source/tables/trove-db_db2.rst @@ -24,10 +24,14 @@ - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``DB2Backup`` - (String) Default strategy to perform backups. + * - ``default_password_length`` = ``36`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) Device path for volume if volume support is enabled. * - ``guest_log_exposed_logs`` = - (String) List of Guest Logs to expose for publishing. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``ignore_users`` = ``PUBLIC, DB2INST1`` - (List) No help text available for this option. * - ``mount_point`` = ``/home/db2inst1/db2inst1`` diff --git a/doc/config-reference/source/tables/trove-db_mariadb.rst b/doc/config-reference/source/tables/trove-db_mariadb.rst index da0fc52611..1020458ed4 100644 --- a/doc/config-reference/source/tables/trove-db_mariadb.rst +++ b/doc/config-reference/source/tables/trove-db_mariadb.rst @@ -20,14 +20,16 @@ - * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.galera_common.api.GaleraCommonAPIStrategy`` - (String) Class that implements datastore-specific API logic. - * - ``backup_incremental_strategy`` = ``{'InnoBackupEx': 'InnoBackupExIncremental'}`` + * - ``backup_incremental_strategy`` = ``{'MariaDBInnoBackupEx': 'MariaDBInnoBackupExIncremental'}`` - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental backup, the runner will use the default full backup. - * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.mysql_impl`` + * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.mariadb_impl`` - (String) Namespace to load backup strategies from. - * - ``backup_strategy`` = ``InnoBackupEx`` + * - ``backup_strategy`` = ``MariaDBInnoBackupEx`` - (String) Default strategy to perform backups. * - ``cluster_support`` = ``True`` - (Boolean) Enable clusters to be created and managed. + * - ``default_password_length`` = ``${mysql.default_password_length}`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) Device path for volume if volume support is enabled. * - ``guest_log_exposed_logs`` = ``general,slow_query`` @@ -36,6 +38,8 @@ - (Integer) The time in milliseconds that a statement must take in in order to be logged in the slow_query log. * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.galera_common.guestagent.GaleraCommonGuestAgentStrategy`` - (String) Class that implements datastore-specific Guest Agent API logic. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``os_admin, root`` @@ -48,7 +52,7 @@ - (String) Namespace to load replication strategies from. * - ``replication_strategy`` = ``MariaDBGTIDReplication`` - (String) Default strategy for replication. - * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.mysql_impl`` + * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.mariadb_impl`` - (String) Namespace to load restore strategies from. * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` - (String) Root controller implementation for mysql. diff --git a/doc/config-reference/source/tables/trove-db_mongodb.rst b/doc/config-reference/source/tables/trove-db_mongodb.rst index 5bc5b940fe..378fac1503 100644 --- a/doc/config-reference/source/tables/trove-db_mongodb.rst +++ b/doc/config-reference/source/tables/trove-db_mongodb.rst @@ -34,12 +34,16 @@ - (Boolean) Enable clusters to be created and managed. * - ``configsvr_port`` = ``27019`` - (Port number) Port for instances running as config servers. + * - ``default_password_length`` = ``36`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) Device path for volume if volume support is enabled. * - ``guest_log_exposed_logs`` = - (String) List of Guest Logs to expose for publishing. * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.mongodb.guestagent.MongoDbGuestAgentStrategy`` - (String) Class that implements datastore-specific Guest Agent API logic. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``ignore_dbs`` = ``admin, local, config`` - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``admin.os_admin, admin.root`` diff --git a/doc/config-reference/source/tables/trove-db_mysql.rst b/doc/config-reference/source/tables/trove-db_mysql.rst index e16e961a76..e11fb1a4a3 100644 --- a/doc/config-reference/source/tables/trove-db_mysql.rst +++ b/doc/config-reference/source/tables/trove-db_mysql.rst @@ -24,12 +24,16 @@ - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``InnoBackupEx`` - (String) Default strategy to perform backups. + * - ``default_password_length`` = ``36`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) Device path for volume if volume support is enabled. * - ``guest_log_exposed_logs`` = ``general,slow_query`` - (String) List of Guest Logs to expose for publishing. * - ``guest_log_long_query_time`` = ``1000`` - (Integer) The time in milliseconds that a statement must take in in order to be logged in the slow_query log. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``os_admin, root`` diff --git a/doc/config-reference/source/tables/trove-db_percona.rst b/doc/config-reference/source/tables/trove-db_percona.rst index aeccfc2ebb..b86c3d44ae 100644 --- a/doc/config-reference/source/tables/trove-db_percona.rst +++ b/doc/config-reference/source/tables/trove-db_percona.rst @@ -24,12 +24,16 @@ - (String) Namespace to load backup strategies from. * - ``backup_strategy`` = ``InnoBackupEx`` - (String) Default strategy to perform backups. + * - ``default_password_length`` = ``${mysql.default_password_length}`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) Device path for volume if volume support is enabled. * - ``guest_log_exposed_logs`` = ``general,slow_query`` - (String) List of Guest Logs to expose for publishing. * - ``guest_log_long_query_time`` = ``1000`` - (Integer) The time in milliseconds that a statement must take in in order to be logged in the slow_query log. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``os_admin, root`` diff --git a/doc/config-reference/source/tables/trove-db_postgresql.rst b/doc/config-reference/source/tables/trove-db_postgresql.rst index 7168c01646..9e26922d21 100644 --- a/doc/config-reference/source/tables/trove-db_postgresql.rst +++ b/doc/config-reference/source/tables/trove-db_postgresql.rst @@ -18,18 +18,22 @@ - Description * - **[postgresql]** - - * - ``backup_incremental_strategy`` = ``{}`` + * - ``backup_incremental_strategy`` = ``{'PgBaseBackup': 'PgBaseBackupIncremental'}`` - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup. * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.postgresql_impl`` - (String) Namespace to load backup strategies from. - * - ``backup_strategy`` = ``PgDump`` + * - ``backup_strategy`` = ``PgBaseBackup`` - (String) Default strategy to perform backups. + * - ``default_password_length`` = ``36`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) No help text available for this option. * - ``guest_log_exposed_logs`` = ``general`` - (String) List of Guest Logs to expose for publishing. * - ``guest_log_long_query_time`` = ``0`` - (Integer) The time in milliseconds that a statement must take in in order to be logged in the 'general' log. A value of '0' logs all statements, while '-1' turns off statement logging. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``ignore_dbs`` = ``postgres`` - (List) No help text available for this option. * - ``ignore_users`` = ``os_admin, postgres, root`` @@ -40,7 +44,7 @@ - (Port number) The TCP port the server listens on. * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.postgresql_impl`` - (String) Namespace to load restore strategies from. - * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController`` + * - ``root_controller`` = ``trove.extensions.postgresql.service.PostgreSQLRootController`` - (String) Root controller implementation for postgresql. * - ``root_on_create`` = ``False`` - (Boolean) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field. @@ -50,3 +54,5 @@ - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True). * - ``volume_support`` = ``True`` - (Boolean) Whether to provision a Cinder volume for datadir. + * - ``wal_archive_location`` = ``/mnt/wal_archive`` + - (String) Filesystem path storing WAL archive files when WAL-shipping based backups or replication is enabled. diff --git a/doc/config-reference/source/tables/trove-db_pxc.rst b/doc/config-reference/source/tables/trove-db_pxc.rst index 7ec5aa26c3..0bfb5e86d8 100644 --- a/doc/config-reference/source/tables/trove-db_pxc.rst +++ b/doc/config-reference/source/tables/trove-db_pxc.rst @@ -28,6 +28,8 @@ - (String) Default strategy to perform backups. * - ``cluster_support`` = ``True`` - (Boolean) Enable clusters to be created and managed. + * - ``default_password_length`` = ``${mysql.default_password_length}`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) Device path for volume if volume support is enabled. * - ``guest_log_exposed_logs`` = ``general,slow_query`` @@ -36,6 +38,8 @@ - (Integer) The time in milliseconds that a statement must take in in order to be logged in the slow_query log. * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.galera_common.guestagent.GaleraCommonGuestAgentStrategy`` - (String) Class that implements datastore-specific Guest Agent API logic. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``ignore_dbs`` = ``mysql, information_schema, performance_schema`` - (List) Databases to exclude when listing databases. * - ``ignore_users`` = ``os_admin, root, clusterrepuser`` diff --git a/doc/config-reference/source/tables/trove-db_redis.rst b/doc/config-reference/source/tables/trove-db_redis.rst index 3901aa58a8..830ab50ffc 100644 --- a/doc/config-reference/source/tables/trove-db_redis.rst +++ b/doc/config-reference/source/tables/trove-db_redis.rst @@ -28,12 +28,16 @@ - (String) Default strategy to perform backups. * - ``cluster_support`` = ``True`` - (Boolean) Enable clusters to be created and managed. + * - ``default_password_length`` = ``36`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) Device path for volume if volume support is enabled. * - ``guest_log_exposed_logs`` = - (String) List of Guest Logs to expose for publishing. * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.redis.guestagent.RedisGuestAgentStrategy`` - (String) Class that implements datastore-specific Guest Agent API logic. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``mount_point`` = ``/var/lib/redis`` - (String) Filesystem path for mounting volumes if volume support is enabled. * - ``replication_namespace`` = ``trove.guestagent.strategies.replication.experimental.redis_sync`` diff --git a/doc/config-reference/source/tables/trove-db_vertica.rst b/doc/config-reference/source/tables/trove-db_vertica.rst index 4d3130c1ef..c7c18d5574 100644 --- a/doc/config-reference/source/tables/trove-db_vertica.rst +++ b/doc/config-reference/source/tables/trove-db_vertica.rst @@ -30,12 +30,16 @@ - (Integer) Number of members in Vertica cluster. * - ``cluster_support`` = ``True`` - (Boolean) Enable clusters to be created and managed. + * - ``default_password_length`` = ``36`` + - (Integer) Character length of generated passwords. * - ``device_path`` = ``/dev/vdb`` - (String) Device path for volume if volume support is enabled. * - ``guest_log_exposed_logs`` = - (String) List of Guest Logs to expose for publishing. * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.vertica.guestagent.VerticaGuestAgentStrategy`` - (String) Class that implements datastore-specific Guest Agent API logic. + * - ``icmp`` = ``False`` + - (Boolean) Whether to permit ICMP. * - ``min_ksafety`` = ``0`` - (Integer) Minimum k-safety setting permitted for vertica clusters * - ``mount_point`` = ``/var/lib/vertica`` diff --git a/doc/config-reference/source/tables/trove-debug.rst b/doc/config-reference/source/tables/trove-debug.rst index d4d5d0bd0d..8b5e59844e 100644 --- a/doc/config-reference/source/tables/trove-debug.rst +++ b/doc/config-reference/source/tables/trove-debug.rst @@ -28,9 +28,29 @@ - (Port number) Pydev debug server port (5678 by default). * - **[profiler]** - + * - ``connection_string`` = ``messaging://`` + - (String) Connection string for a notifier backend. Default value is messaging:// which sets the notifier to oslo_messaging. + + Examples of possible values: + + * messaging://: use oslo_messaging driver for sending notifications. * - ``enabled`` = ``False`` - - (Boolean) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature). Possible values: * True: Enables the feature * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty. + - (Boolean) Enables the profiling for all services on this node. Default value is False (fully disable the profiling feature). + + Possible values: + + * True: Enables the feature + + * False: Disables the feature. The profiling cannot be started via this project operations. If the profiling is triggered by another project, this project part will be empty. * - ``hmac_keys`` = ``SECRET_KEY`` - - (String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: [,,...], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources. + - (String) Secret key(s) to use for encrypting context data for performance profiling. This string value should have the following format: [,,...], where each key is some random string. A user who triggers the profiling via the REST API has to set one of these keys in the headers of the REST API call to include profiling results of this node for this particular project. + + Both "enabled" flag and "hmac_keys" config options should be set to enable profiling. Also, to generate correct profiling information across all services at least one key needs to be consistent between OpenStack projects. This ensures it can be used from client side to generate the trace, containing information from all possible resources. * - ``trace_sqlalchemy`` = ``False`` - - (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won't be traced). Possible values: * True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that. * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way. + - (Boolean) Enables SQL requests profiling in services. Default value is False (SQL requests won't be traced). + + Possible values: + + * True: Enables SQL requests profiling. Each SQL query will be part of the trace and can the be analyzed by how much time was spent for that. + + * False: Disables SQL requests profiling. The spent time is only shown on a higher level of operations. Single SQL queries cannot be analyzed this way. diff --git a/doc/config-reference/source/tables/trove-dns.rst b/doc/config-reference/source/tables/trove-dns.rst index 9df447b735..db3bd5705e 100644 --- a/doc/config-reference/source/tables/trove-dns.rst +++ b/doc/config-reference/source/tables/trove-dns.rst @@ -20,22 +20,22 @@ - * - ``dns_account_id`` = - (String) Tenant ID for DNSaaS. - * - ``dns_auth_url`` = - - (String) Authentication URL for DNSaaS. + * - ``dns_auth_url`` = ``http://0.0.0.0`` + - (Unknown) Authentication URL for DNSaaS. * - ``dns_domain_id`` = - (String) Domain ID used for adding DNS entries. * - ``dns_domain_name`` = - (String) Domain name used for adding DNS entries. * - ``dns_driver`` = ``trove.dns.driver.DnsDriver`` - (String) Driver for DNSaaS. - * - ``dns_endpoint_url`` = ``0.0.0.0`` - - (String) Endpoint URL for DNSaaS. - * - ``dns_hostname`` = - - (String) Hostname used for adding DNS entries. + * - ``dns_endpoint_url`` = ``http://0.0.0.0`` + - (Unknown) Endpoint URL for DNSaaS. + * - ``dns_hostname`` = ``localhost`` + - (Unknown) Hostname used for adding DNS entries. * - ``dns_instance_entry_factory`` = ``trove.dns.driver.DnsInstanceEntryFactory`` - (String) Factory for adding DNS entries. - * - ``dns_management_base_url`` = - - (String) Management URL for DNSaaS. + * - ``dns_management_base_url`` = ``http://0.0.0.0`` + - (Unknown) Management URL for DNSaaS. * - ``dns_passkey`` = - (String) Passkey for DNSaaS. * - ``dns_region`` = diff --git a/doc/config-reference/source/tables/trove-guestagent.rst b/doc/config-reference/source/tables/trove-guestagent.rst index 05dad97c88..6720a93850 100644 --- a/doc/config-reference/source/tables/trove-guestagent.rst +++ b/doc/config-reference/source/tables/trove-guestagent.rst @@ -18,9 +18,9 @@ - Description * - **[DEFAULT]** - - * - ``agent_call_high_timeout`` = ``60`` + * - ``agent_call_high_timeout`` = ``600`` - (Integer) Maximum time (in seconds) to wait for Guest Agent 'slow' requests (such as restarting the database). - * - ``agent_call_low_timeout`` = ``5`` + * - ``agent_call_low_timeout`` = ``15`` - (Integer) Maximum time (in seconds) to wait for Guest Agent 'quick'requests (such as retrieving a list of users or databases). * - ``agent_heartbeat_expiry`` = ``60`` - (Integer) Time (in seconds) after which a guest is considered unreachable diff --git a/doc/config-reference/source/tables/trove-heat.rst b/doc/config-reference/source/tables/trove-heat.rst index 75c1649530..ec449632c4 100644 --- a/doc/config-reference/source/tables/trove-heat.rst +++ b/doc/config-reference/source/tables/trove-heat.rst @@ -25,4 +25,4 @@ * - ``heat_time_out`` = ``60`` - (Integer) Maximum time (in seconds) to wait for a Heat request to complete. * - ``heat_url`` = ``None`` - - (String) URL without the tenant segment. + - (Unknown) URL without the tenant segment. diff --git a/doc/config-reference/source/tables/trove-network.rst b/doc/config-reference/source/tables/trove-network.rst index 9b8c55616f..3acc360bb0 100644 --- a/doc/config-reference/source/tables/trove-network.rst +++ b/doc/config-reference/source/tables/trove-network.rst @@ -25,4 +25,4 @@ * - ``neutron_service_type`` = ``network`` - (String) Service type to use when searching catalog. * - ``neutron_url`` = ``None`` - - (String) URL without the tenant segment. + - (Unknown) URL without the tenant segment. diff --git a/doc/config-reference/source/tables/trove-quota.rst b/doc/config-reference/source/tables/trove-quota.rst index bde31d9963..937bb59702 100644 --- a/doc/config-reference/source/tables/trove-quota.rst +++ b/doc/config-reference/source/tables/trove-quota.rst @@ -18,13 +18,13 @@ - Description * - **[DEFAULT]** - - * - ``max_accepted_volume_size`` = ``5`` + * - ``max_accepted_volume_size`` = ``10`` - (Integer) Default maximum volume size (in GB) for an instance. * - ``max_backups_per_tenant`` = ``50`` - (Integer) Default maximum number of backups created by a tenant. - * - ``max_instances_per_tenant`` = ``5`` + * - ``max_instances_per_tenant`` = ``10`` - (Integer) Default maximum number of instances per tenant. - * - ``max_volumes_per_tenant`` = ``20`` + * - ``max_volumes_per_tenant`` = ``40`` - (Integer) Default maximum volume capacity (in GB) spanning across all Trove volumes per tenant. * - ``quota_driver`` = ``trove.quota.quota.DbQuotaDriver`` - (String) Default driver to use for quota checks. diff --git a/doc/config-reference/source/tables/trove-rabbitmq.rst b/doc/config-reference/source/tables/trove-rabbitmq.rst index 8215cb42b0..89c0a05860 100644 --- a/doc/config-reference/source/tables/trove-rabbitmq.rst +++ b/doc/config-reference/source/tables/trove-rabbitmq.rst @@ -24,8 +24,10 @@ - (Boolean) Use durable queues in AMQP. * - ``channel_max`` = ``None`` - (Integer) Maximum number of channels to allow + * - ``connection_factory`` = ``single`` + - (String) Connection factory implementation * - ``default_notification_exchange`` = ``${control_exchange}_notification`` - - (String) Exchange name for for sending notifications + - (String) Exchange name for sending notifications * - ``default_notification_retry_attempts`` = ``-1`` - (Integer) Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry. * - ``default_rpc_exchange`` = ``${control_exchange}_rpc`` @@ -36,7 +38,7 @@ - (Boolean) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake * - ``frame_max`` = ``None`` - (Integer) The maximum byte size for an AMQP frame - * - ``heartbeat_interval`` = ``1`` + * - ``heartbeat_interval`` = ``3`` - (Integer) How often to send heartbeats for consumer's connections * - ``heartbeat_rate`` = ``2`` - (Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat. @@ -45,7 +47,7 @@ * - ``host_connection_reconnect_delay`` = ``0.25`` - (Floating point) Set delay for reconnection to some host which has connection error * - ``kombu_compression`` = ``None`` - - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions. + - (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions. * - ``kombu_failover_strategy`` = ``round-robin`` - (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. * - ``kombu_missing_consumer_retry_timeout`` = ``60`` @@ -68,7 +70,7 @@ - (Floating point) Reconnecting retry delay in case of connectivity problem during sending notification message * - ``pool_max_overflow`` = ``0`` - (Integer) Maximum number of connections to create above `pool_max_size`. - * - ``pool_max_size`` = ``10`` + * - ``pool_max_size`` = ``30`` - (Integer) Maximum number of connections to keep queued. * - ``pool_recycle`` = ``600`` - (Integer) Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire. @@ -79,19 +81,19 @@ * - ``rabbit_ha_queues`` = ``False`` - (Boolean) Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: "rabbitmqctl set_policy HA '^(?!amq\.).*' '{"ha-mode": "all"}' " * - ``rabbit_host`` = ``localhost`` - - (String) The RabbitMQ broker address where a single node is used. + - (String) DEPRECATED: The RabbitMQ broker address where a single node is used. Replaced by [DEFAULT]/transport_url * - ``rabbit_hosts`` = ``$rabbit_host:$rabbit_port`` - - (List) RabbitMQ HA cluster host:port pairs. + - (List) DEPRECATED: RabbitMQ HA cluster host:port pairs. Replaced by [DEFAULT]/transport_url * - ``rabbit_interval_max`` = ``30`` - (Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds. * - ``rabbit_login_method`` = ``AMQPLAIN`` - (String) The RabbitMQ login method. * - ``rabbit_max_retries`` = ``0`` - - (Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). + - (Integer) DEPRECATED: Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). * - ``rabbit_password`` = ``guest`` - - (String) The RabbitMQ password. + - (String) DEPRECATED: The RabbitMQ password. Replaced by [DEFAULT]/transport_url * - ``rabbit_port`` = ``5672`` - - (Port number) The RabbitMQ broker port where a single node is used. + - (Port number) DEPRECATED: The RabbitMQ broker port where a single node is used. Replaced by [DEFAULT]/transport_url * - ``rabbit_qos_prefetch_count`` = ``0`` - (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. * - ``rabbit_retry_backoff`` = ``2`` @@ -103,9 +105,9 @@ * - ``rabbit_use_ssl`` = ``False`` - (Boolean) Connect over SSL for RabbitMQ. * - ``rabbit_userid`` = ``guest`` - - (String) The RabbitMQ userid. + - (String) DEPRECATED: The RabbitMQ userid. Replaced by [DEFAULT]/transport_url * - ``rabbit_virtual_host`` = ``/`` - - (String) The RabbitMQ virtual host. + - (String) DEPRECATED: The RabbitMQ virtual host. Replaced by [DEFAULT]/transport_url * - ``rpc_listener_prefetch_count`` = ``100`` - (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc listener. * - ``rpc_queue_expiration`` = ``60`` diff --git a/doc/config-reference/source/tables/trove-redis.rst b/doc/config-reference/source/tables/trove-redis.rst index 3a589f7f2e..7b69364ed1 100644 --- a/doc/config-reference/source/tables/trove-redis.rst +++ b/doc/config-reference/source/tables/trove-redis.rst @@ -21,16 +21,16 @@ * - ``check_timeout`` = ``20000`` - (Integer) Time in ms to wait before the transaction is killed. * - ``host`` = ``127.0.0.1`` - - (String) Host to locate redis. + - (String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url * - ``password`` = - - (String) Password for Redis server (optional). + - (String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url * - ``port`` = ``6379`` - - (Port number) Use this port to connect to redis host. + - (Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url * - ``sentinel_group_name`` = ``oslo-messaging-zeromq`` - (String) Redis replica set name. * - ``sentinel_hosts`` = - - (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] - * - ``socket_timeout`` = ``1000`` + - (List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] Replaced by [DEFAULT]/transport_url + * - ``socket_timeout`` = ``10000`` - (Integer) Timeout in ms on blocking socket operations - * - ``wait_timeout`` = ``500`` + * - ``wait_timeout`` = ``2000`` - (Integer) Time in ms to wait between connection attempts. diff --git a/doc/config-reference/source/tables/trove-rpc.rst b/doc/config-reference/source/tables/trove-rpc.rst index 02962857f4..7b3acc68d8 100644 --- a/doc/config-reference/source/tables/trove-rpc.rst +++ b/doc/config-reference/source/tables/trove-rpc.rst @@ -23,7 +23,7 @@ * - ``report_interval`` = ``30`` - (Integer) The interval (in seconds) which periodic tasks are run. * - ``rpc_backend`` = ``rabbit`` - - (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. + - (String) DEPRECATED: The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. Replaced by [DEFAULT]/transport_url * - ``rpc_cast_timeout`` = ``-1`` - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. * - ``rpc_conn_pool_size`` = ``30`` @@ -38,24 +38,54 @@ - (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 receiving events from a queue * - **[oslo_messaging_amqp]** - + * - ``addressing_mode`` = ``dynamic`` + - (String) Indicates the addressing mode used by the driver. Permitted values: 'legacy' - use legacy non-routable addressing 'routable' - use routable addresses 'dynamic' - use legacy addresses if the message bus does not support routing otherwise use routable addressing * - ``allow_insecure_clients`` = ``False`` - (Boolean) Accept clients using either SSL or plain TCP + * - ``anycast_address`` = ``anycast`` + - (String) Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers. * - ``broadcast_prefix`` = ``broadcast`` - (String) address prefix used when broadcasting to all servers + * - ``connection_retry_backoff`` = ``2`` + - (Integer) Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt. + * - ``connection_retry_interval`` = ``1`` + - (Integer) Seconds to pause before attempting to re-connect. + * - ``connection_retry_interval_max`` = ``30`` + - (Integer) Maximum limit for connection_retry_interval + connection_retry_backoff * - ``container_name`` = ``None`` - - (String) Name for the AMQP container + - (String) Name for the AMQP container. must be globally unique. Defaults to a generated UUID + * - ``default_notification_exchange`` = ``None`` + - (String) Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else 'notify' + * - ``default_notify_timeout`` = ``30`` + - (Integer) The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry. + * - ``default_reply_timeout`` = ``30`` + - (Integer) The deadline for an rpc reply message delivery. Only used when caller does not provide a timeout expiry. + * - ``default_rpc_exchange`` = ``None`` + - (String) Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else 'rpc' + * - ``default_send_timeout`` = ``30`` + - (Integer) The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry. * - ``group_request_prefix`` = ``unicast`` - (String) address prefix when sending to any server in group * - ``idle_timeout`` = ``0`` - (Integer) Timeout for inactive connections (in seconds) + * - ``link_retry_delay`` = ``10`` + - (Integer) Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error. + * - ``multicast_address`` = ``multicast`` + - (String) Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages. + * - ``notify_address_prefix`` = ``openstack.org/om/notify`` + - (String) Address prefix for all generated Notification addresses + * - ``notify_server_credit`` = ``100`` + - (Integer) Window size for incoming Notification messages * - ``password`` = - (String) Password for message broker authentication + * - ``reply_link_credit`` = ``200`` + - (Integer) Window size for incoming RPC Reply messages. + * - ``rpc_address_prefix`` = ``openstack.org/om/rpc`` + - (String) Address prefix for all generated RPC addresses + * - ``rpc_server_credit`` = ``100`` + - (Integer) Window size for incoming RPC Request messages * - ``sasl_config_dir`` = - (String) Path to directory that contains the SASL configuration * - ``sasl_config_name`` = @@ -74,6 +104,8 @@ - (String) Password for decrypting ssl_key_file (if encrypted) * - ``trace`` = ``False`` - (Boolean) Debug: dump AMQP frames to stdout + * - ``unicast_address`` = ``unicast`` + - (String) Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination. * - ``username`` = - (String) User name for message broker authentication * - **[oslo_messaging_notifications]** diff --git a/doc/config-reference/source/tables/trove-swift.rst b/doc/config-reference/source/tables/trove-swift.rst index 9b1bd888bb..c14ba6a2e8 100644 --- a/doc/config-reference/source/tables/trove-swift.rst +++ b/doc/config-reference/source/tables/trove-swift.rst @@ -23,4 +23,4 @@ * - ``swift_service_type`` = ``object-store`` - (String) Service type to use when searching catalog. * - ``swift_url`` = ``None`` - - (String) URL ending in AUTH. + - (Unknown) URL ending in ``AUTH_``. diff --git a/doc/config-reference/source/tables/trove-taskmanager.rst b/doc/config-reference/source/tables/trove-taskmanager.rst index 0066533e59..c93e8f1523 100644 --- a/doc/config-reference/source/tables/trove-taskmanager.rst +++ b/doc/config-reference/source/tables/trove-taskmanager.rst @@ -30,7 +30,7 @@ - (String) Transformer for exists notifications. * - ``reboot_time_out`` = ``120`` - (Integer) Maximum time (in seconds) to wait for a server reboot. - * - ``resize_time_out`` = ``600`` + * - ``resize_time_out`` = ``900`` - (Integer) Maximum time (in seconds) to wait for a server resize. * - ``restore_usage_timeout`` = ``36000`` - (Integer) Maximum time (in seconds) to wait for a Guest instance restored from a backup to become active. @@ -40,7 +40,7 @@ - (Integer) Maximum time (in seconds) to wait for a server delete. * - ``state_change_poll_time`` = ``3`` - (Integer) Interval between state change poll requests (seconds). - * - ``state_change_wait_time`` = ``180`` + * - ``state_change_wait_time`` = ``600`` - (Integer) Maximum time (in seconds) to wait for a state change. * - ``update_status_on_fail`` = ``True`` - (Boolean) Set the service and instance task statuses to ERROR when an instance fails to become active within the configured usage_timeout. @@ -48,7 +48,7 @@ - (Integer) Time to sleep during the check for an active Guest. * - ``use_heat`` = ``False`` - (Boolean) Use Heat for provisioning. - * - ``use_nova_server_config_drive`` = ``False`` + * - ``use_nova_server_config_drive`` = ``True`` - (Boolean) Use config drive for file injection when booting instance. * - ``use_nova_server_volume`` = ``False`` - (Boolean) Whether to provision a Cinder volume for the Nova instance. diff --git a/doc/config-reference/source/tables/trove-volume.rst b/doc/config-reference/source/tables/trove-volume.rst index 40e3ad491b..9cd14224b0 100644 --- a/doc/config-reference/source/tables/trove-volume.rst +++ b/doc/config-reference/source/tables/trove-volume.rst @@ -25,7 +25,7 @@ * - ``cinder_service_type`` = ``volumev2`` - (String) Service type to use when searching catalog. * - ``cinder_url`` = ``None`` - - (String) URL without the tenant segment. + - (Unknown) URL without the tenant segment. * - ``cinder_volume_type`` = ``None`` - (String) Volume type to use when provisioning a Cinder volume. * - ``device_path`` = ``/dev/vdb`` diff --git a/doc/config-reference/source/tables/trove-zeromq.rst b/doc/config-reference/source/tables/trove-zeromq.rst index 5b2ac809c8..0c34c0ce1c 100644 --- a/doc/config-reference/source/tables/trove-zeromq.rst +++ b/doc/config-reference/source/tables/trove-zeromq.rst @@ -22,8 +22,6 @@ - (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. * - ``rpc_zmq_bind_port_retries`` = ``100`` - (Integer) Number of retries to find free port number before fail with ZMQBindError. - * - ``rpc_zmq_concurrency`` = ``eventlet`` - - (String) Type of concurrency used. Either "native" or "eventlet" * - ``rpc_zmq_contexts`` = ``1`` - (Integer) Number of ZeroMQ contexts, defaults to 1. * - ``rpc_zmq_host`` = ``localhost`` @@ -34,11 +32,53 @@ - (String) MatchMaker driver. * - ``rpc_zmq_max_port`` = ``65536`` - (Integer) Maximal port number for random ports range. - * - ``rpc_zmq_min_port`` = ``49152`` + * - ``rpc_zmq_min_port`` = ``49153`` - (Port number) Minimal port number for random ports range. + * - ``rpc_zmq_serialization`` = ``json`` + - (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages * - ``rpc_zmq_topic_backlog`` = ``None`` - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. * - ``use_pub_sub`` = ``True`` - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. - * - ``zmq_target_expire`` = ``120`` + * - ``zmq_immediate`` = ``False`` + - (Boolean) This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it. + * - ``zmq_target_expire`` = ``300`` - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). + * - ``zmq_target_update`` = ``180`` + - (Integer) Update period in seconds of a name service record about existing target. + * - **[oslo_messaging_zmq]** + - + * - ``rpc_cast_timeout`` = ``-1`` + - (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. + * - ``rpc_poll_timeout`` = ``1`` + - (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + * - ``rpc_zmq_bind_address`` = ``*`` + - (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + * - ``rpc_zmq_bind_port_retries`` = ``100`` + - (Integer) Number of retries to find free port number before fail with ZMQBindError. + * - ``rpc_zmq_contexts`` = ``1`` + - (Integer) Number of ZeroMQ contexts, defaults to 1. + * - ``rpc_zmq_host`` = ``localhost`` + - (String) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. + * - ``rpc_zmq_ipc_dir`` = ``/var/run/openstack`` + - (String) Directory for holding IPC sockets. + * - ``rpc_zmq_matchmaker`` = ``redis`` + - (String) MatchMaker driver. + * - ``rpc_zmq_max_port`` = ``65536`` + - (Integer) Maximal port number for random ports range. + * - ``rpc_zmq_min_port`` = ``49153`` + - (Port number) Minimal port number for random ports range. + * - ``rpc_zmq_serialization`` = ``json`` + - (String) Default serialization mechanism for serializing/deserializing outgoing/incoming messages + * - ``rpc_zmq_topic_backlog`` = ``None`` + - (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + * - ``use_pub_sub`` = ``True`` + - (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. + * - ``use_router_proxy`` = ``True`` + - (Boolean) Use ROUTER remote proxy. + * - ``zmq_immediate`` = ``False`` + - (Boolean) This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it. + * - ``zmq_target_expire`` = ``300`` + - (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). + * - ``zmq_target_update`` = ``180`` + - (Integer) Update period in seconds of a name service record about existing target. diff --git a/tools/autogenerate-config-flagmappings/trove.flagmappings b/tools/autogenerate-config-flagmappings/trove.flagmappings index 368fe09f93..40d5ec2b43 100644 --- a/tools/autogenerate-config-flagmappings/trove.flagmappings +++ b/tools/autogenerate-config-flagmappings/trove.flagmappings @@ -31,6 +31,8 @@ clusters_page_size cluster conductor_manager amqp conductor_queue amqp configurations_page_size common +conn_pool_min_size disable +conn_pool_ttl disable control_exchange amqp databases_page_size common datastore_manager taskmanager @@ -40,7 +42,6 @@ debug disable default_datastore common default_log_levels disable default_neutron_networks common -default_password_length common device_path volume dns_account_id dns dns_auth_url dns @@ -99,7 +100,6 @@ max_backups_per_tenant quota max_header_line api max_instances_per_tenant quota max_volumes_per_tenant quota -memcached_servers common module_aes_cbc_key common module_types common modules_page_size common @@ -150,13 +150,13 @@ rpc_poll_timeout rpc rpc_response_timeout rpc rpc_zmq_bind_address zeromq rpc_zmq_bind_port_retries zeromq -rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq rpc_zmq_max_port zeromq rpc_zmq_min_port zeromq +rpc_zmq_serialization zeromq rpc_zmq_topic_backlog zeromq server_delete_time_out taskmanager sql_query_logging common @@ -188,6 +188,7 @@ use_heat taskmanager use_nova_server_config_drive taskmanager use_nova_server_volume taskmanager use_pub_sub zeromq +use_router_proxy disable use_stderr disable use_syslog disable users_page_size api @@ -197,27 +198,30 @@ volume_format_timeout volume volume_fstype volume volume_time_out volume watch_log_file disable +zmq_immediate zeromq zmq_target_expire zeromq +zmq_target_update zeromq cassandra/api_strategy db_cassandra cassandra/backup_incremental_strategy db_cassandra cassandra/backup_namespace db_cassandra cassandra/backup_strategy db_cassandra cassandra/cluster_support db_cassandra +cassandra/default_password_length db_cassandra cassandra/device_path db_cassandra cassandra/guest_log_exposed_logs db_cassandra cassandra/guestagent_strategy db_cassandra +cassandra/icmp db_cassandra cassandra/ignore_dbs db_cassandra cassandra/ignore_users db_cassandra cassandra/mount_point db_cassandra cassandra/replication_strategy db_cassandra cassandra/restore_namespace db_cassandra cassandra/root_controller db_cassandra +cassandra/system_log_level db_cassandra cassandra/taskmanager_strategy db_cassandra cassandra/tcp_ports db_cassandra cassandra/udp_ports db_cassandra cassandra/volume_support db_cassandra -certificates/barbican_auth common -certificates/cert_manager_type common cors/allow_credentials disable cors/allow_headers disable cors/allow_methods disable @@ -233,8 +237,10 @@ cors.subdomain/max_age disable couchbase/backup_incremental_strategy db_couchbase couchbase/backup_namespace db_couchbase couchbase/backup_strategy db_couchbase +couchbase/default_password_length db_couchbase couchbase/device_path db_couchbase couchbase/guest_log_exposed_logs db_couchbase +couchbase/icmp db_couchbase couchbase/mount_point db_couchbase couchbase/replication_strategy db_couchbase couchbase/restore_namespace db_couchbase @@ -246,8 +252,10 @@ couchbase/volume_support db_couchbase couchdb/backup_incremental_strategy db_couchdb couchdb/backup_namespace db_couchdb couchdb/backup_strategy db_couchdb +couchdb/default_password_length db_couchdb couchdb/device_path db_couchdb couchdb/guest_log_exposed_logs db_couchdb +couchdb/icmp db_couchdb couchdb/ignore_dbs db_couchdb couchdb/ignore_users db_couchdb couchdb/mount_point db_couchdb @@ -282,8 +290,10 @@ database/use_db_reconnect disable db2/backup_incremental_strategy db_db2 db2/backup_namespace db_db2 db2/backup_strategy db_db2 +db2/default_password_length db_db2 db2/device_path db_db2 db2/guest_log_exposed_logs db_db2 +db2/icmp db_db2 db2/ignore_users db_db2 db2/mount_point db_db2 db2/replication_strategy db_db2 @@ -336,10 +346,12 @@ mariadb/backup_incremental_strategy db_mariadb mariadb/backup_namespace db_mariadb mariadb/backup_strategy db_mariadb mariadb/cluster_support db_mariadb +mariadb/default_password_length db_mariadb mariadb/device_path db_mariadb mariadb/guest_log_exposed_logs db_mariadb mariadb/guest_log_long_query_time db_mariadb mariadb/guestagent_strategy db_mariadb +mariadb/icmp db_mariadb mariadb/ignore_dbs db_mariadb mariadb/ignore_users db_mariadb mariadb/min_cluster_member_count db_mariadb @@ -370,9 +382,11 @@ mongodb/backup_strategy db_mongodb mongodb/cluster_secure db_mongodb mongodb/cluster_support db_mongodb mongodb/configsvr_port db_mongodb +mongodb/default_password_length db_mongodb mongodb/device_path db_mongodb mongodb/guest_log_exposed_logs db_mongodb mongodb/guestagent_strategy db_mongodb +mongodb/icmp db_mongodb mongodb/ignore_dbs db_mongodb mongodb/ignore_users db_mongodb mongodb/mongodb_port db_mongodb @@ -389,9 +403,11 @@ mongodb/volume_support db_mongodb mysql/backup_incremental_strategy db_mysql mysql/backup_namespace db_mysql mysql/backup_strategy db_mysql +mysql/default_password_length db_mysql mysql/device_path db_mysql mysql/guest_log_exposed_logs db_mysql mysql/guest_log_long_query_time db_mysql +mysql/icmp db_mysql mysql/ignore_dbs db_mysql mysql/ignore_users db_mysql mysql/mount_point db_mysql @@ -406,13 +422,29 @@ mysql/usage_timeout db_mysql mysql/volume_support db_mysql oslo_concurrency/disable_process_locking rpc oslo_concurrency/lock_path rpc -oslo_messaging/event_stream_topic rpc +oslo_messaging_amqp/addressing_mode rpc oslo_messaging_amqp/allow_insecure_clients rpc +oslo_messaging_amqp/anycast_address rpc oslo_messaging_amqp/broadcast_prefix rpc +oslo_messaging_amqp/connection_retry_backoff rpc +oslo_messaging_amqp/connection_retry_interval rpc +oslo_messaging_amqp/connection_retry_interval_max rpc oslo_messaging_amqp/container_name rpc +oslo_messaging_amqp/default_notification_exchange rpc +oslo_messaging_amqp/default_notify_timeout rpc +oslo_messaging_amqp/default_reply_timeout rpc +oslo_messaging_amqp/default_rpc_exchange rpc +oslo_messaging_amqp/default_send_timeout rpc oslo_messaging_amqp/group_request_prefix rpc oslo_messaging_amqp/idle_timeout rpc +oslo_messaging_amqp/link_retry_delay rpc +oslo_messaging_amqp/multicast_address rpc +oslo_messaging_amqp/notify_address_prefix rpc +oslo_messaging_amqp/notify_server_credit rpc oslo_messaging_amqp/password rpc +oslo_messaging_amqp/reply_link_credit rpc +oslo_messaging_amqp/rpc_address_prefix rpc +oslo_messaging_amqp/rpc_server_credit rpc oslo_messaging_amqp/sasl_config_dir rpc oslo_messaging_amqp/sasl_config_name rpc oslo_messaging_amqp/sasl_mechanisms rpc @@ -422,6 +454,7 @@ oslo_messaging_amqp/ssl_cert_file rpc oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc +oslo_messaging_amqp/unicast_address rpc oslo_messaging_amqp/username rpc oslo_messaging_notifications/driver rpc oslo_messaging_notifications/topics rpc @@ -429,6 +462,7 @@ oslo_messaging_notifications/transport_url rpc oslo_messaging_rabbit/amqp_auto_delete rabbitmq oslo_messaging_rabbit/amqp_durable_queues rabbitmq oslo_messaging_rabbit/channel_max rabbitmq +oslo_messaging_rabbit/connection_factory rabbitmq oslo_messaging_rabbit/default_notification_exchange rabbitmq oslo_messaging_rabbit/default_notification_retry_attempts rabbitmq oslo_messaging_rabbit/default_rpc_exchange rabbitmq @@ -481,14 +515,34 @@ oslo_messaging_rabbit/socket_timeout rabbitmq oslo_messaging_rabbit/ssl rabbitmq oslo_messaging_rabbit/ssl_options rabbitmq oslo_messaging_rabbit/tcp_user_timeout rabbitmq +oslo_messaging_zmq/rpc_cast_timeout zeromq +oslo_messaging_zmq/rpc_poll_timeout zeromq +oslo_messaging_zmq/rpc_zmq_bind_address zeromq +oslo_messaging_zmq/rpc_zmq_bind_port_retries zeromq +oslo_messaging_zmq/rpc_zmq_contexts zeromq +oslo_messaging_zmq/rpc_zmq_host zeromq +oslo_messaging_zmq/rpc_zmq_ipc_dir zeromq +oslo_messaging_zmq/rpc_zmq_matchmaker zeromq +oslo_messaging_zmq/rpc_zmq_max_port zeromq +oslo_messaging_zmq/rpc_zmq_min_port zeromq +oslo_messaging_zmq/rpc_zmq_serialization zeromq +oslo_messaging_zmq/rpc_zmq_topic_backlog zeromq +oslo_messaging_zmq/use_pub_sub zeromq +oslo_messaging_zmq/use_router_proxy zeromq +oslo_messaging_zmq/zmq_immediate zeromq +oslo_messaging_zmq/zmq_target_expire zeromq +oslo_messaging_zmq/zmq_target_update zeromq +oslo_middleware/enable_proxy_headers_parsing api oslo_middleware/max_request_body_size api oslo_middleware/secure_proxy_ssl_header api percona/backup_incremental_strategy db_percona percona/backup_namespace db_percona percona/backup_strategy db_percona +percona/default_password_length db_percona percona/device_path db_percona percona/guest_log_exposed_logs db_percona percona/guest_log_long_query_time db_percona +percona/icmp db_percona percona/ignore_dbs db_percona percona/ignore_users db_percona percona/mount_point db_percona @@ -506,9 +560,11 @@ percona/volume_support db_percona postgresql/backup_incremental_strategy db_postgresql postgresql/backup_namespace db_postgresql postgresql/backup_strategy db_postgresql +postgresql/default_password_length db_postgresql postgresql/device_path db_postgresql postgresql/guest_log_exposed_logs db_postgresql postgresql/guest_log_long_query_time db_postgresql +postgresql/icmp db_postgresql postgresql/ignore_dbs db_postgresql postgresql/ignore_users db_postgresql postgresql/mount_point db_postgresql @@ -519,6 +575,8 @@ postgresql/root_on_create db_postgresql postgresql/tcp_ports db_postgresql postgresql/udp_ports db_postgresql postgresql/volume_support db_postgresql +postgresql/wal_archive_location db_postgresql +profiler/connection_string debug profiler/enabled debug profiler/hmac_keys debug profiler/trace_sqlalchemy debug @@ -527,10 +585,12 @@ pxc/backup_incremental_strategy db_pxc pxc/backup_namespace db_pxc pxc/backup_strategy db_pxc pxc/cluster_support db_pxc +pxc/default_password_length db_pxc pxc/device_path db_pxc pxc/guest_log_exposed_logs db_pxc pxc/guest_log_long_query_time db_pxc pxc/guestagent_strategy db_pxc +pxc/icmp db_pxc pxc/ignore_dbs db_pxc pxc/ignore_users db_pxc pxc/min_cluster_member_count db_pxc @@ -551,9 +611,11 @@ redis/backup_incremental_strategy db_redis redis/backup_namespace db_redis redis/backup_strategy db_redis redis/cluster_support db_redis +redis/default_password_length db_redis redis/device_path db_redis redis/guest_log_exposed_logs db_redis redis/guestagent_strategy db_redis +redis/icmp db_redis redis/mount_point db_redis redis/replication_namespace db_redis redis/replication_strategy db_redis @@ -563,32 +625,20 @@ redis/taskmanager_strategy db_redis redis/tcp_ports db_redis redis/udp_ports db_redis redis/volume_support db_redis -service_auth/admin_password common -service_auth/admin_project_domain common -service_auth/admin_tenant_name common -service_auth/admin_user common -service_auth/admin_user_domain common -service_auth/auth_url common -service_auth/auth_version common -service_auth/endpoint_type common -service_auth/region common -service_auth/service_name common upgrade_levels/conductor upgrades upgrade_levels/guestagent upgrades upgrade_levels/taskmanager upgrades -vArmour/director varmour -vArmour/director_port varmour -vArmour/password varmour -vArmour/username varmour vertica/api_strategy db_vertica vertica/backup_incremental_strategy db_vertica vertica/backup_namespace db_vertica vertica/backup_strategy db_vertica vertica/cluster_member_count db_vertica vertica/cluster_support db_vertica +vertica/default_password_length db_vertica vertica/device_path db_vertica vertica/guest_log_exposed_logs db_vertica vertica/guestagent_strategy db_vertica +vertica/icmp db_vertica vertica/min_ksafety db_vertica vertica/mount_point db_vertica vertica/readahead_size db_vertica