From 63b66953700bc04a1ad69b18e2165e47da8dcb18 Mon Sep 17 00:00:00 2001 From: venkatamahesh Date: Sat, 3 Sep 2016 20:40:40 +0530 Subject: [PATCH] [config-ref] Update zaqar tables Change-Id: Id29f17a2cd7999334db19625e492a7ad53109aa5 --- .../source/message/zaqar-authentication.rst | 1 + .../source/tables/zaqar-api.rst | 34 ++---------- .../source/tables/zaqar-transport.rst | 2 +- .../source/tables/zaqar-trustee.rst | 54 +++++++++++++++++++ .../zaqar.flagmappings | 37 ++++++------- 5 files changed, 79 insertions(+), 49 deletions(-) create mode 100644 doc/config-reference/source/tables/zaqar-trustee.rst diff --git a/doc/config-reference/source/message/zaqar-authentication.rst b/doc/config-reference/source/message/zaqar-authentication.rst index 3ee137a98e..97b50f6f39 100644 --- a/doc/config-reference/source/message/zaqar-authentication.rst +++ b/doc/config-reference/source/message/zaqar-authentication.rst @@ -39,3 +39,4 @@ Options Configure the authentication and authorization strategy through these options: .. include:: ../tables/zaqar-authentication.rst +.. include:: ../tables/zaqar-trustee.rst diff --git a/doc/config-reference/source/tables/zaqar-api.rst b/doc/config-reference/source/tables/zaqar-api.rst index 4b53475ef7..9a780c0f06 100644 --- a/doc/config-reference/source/tables/zaqar-api.rst +++ b/doc/config-reference/source/tables/zaqar-api.rst @@ -20,42 +20,16 @@ - * - ``admin_mode`` = ``False`` - (Boolean) Activate privileged endpoints. - * - ``daemon`` = ``False`` - - (Boolean) Run Zaqar server in the background. * - ``unreliable`` = ``False`` - (Boolean) Disable all reliability constraints. - * - **[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. * - **[notification]** - + * - ``max_notifier_workers`` = ``10`` + - (Integer) The max amount of the notification workers. + * - ``require_confirmation`` = ``False`` + - (Boolean) Whether the http/https/email subscription need to be confirmed before notification. * - ``smtp_command`` = ``/usr/sbin/sendmail -t -oi`` - (String) The command of smtp to send email. The format is "command_name arg1 arg2". - * - **[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 * - **[signed_url]** - * - ``secret_key`` = ``None`` diff --git a/doc/config-reference/source/tables/zaqar-transport.rst b/doc/config-reference/source/tables/zaqar-transport.rst index d3ca149f79..858c4460af 100644 --- a/doc/config-reference/source/tables/zaqar-transport.rst +++ b/doc/config-reference/source/tables/zaqar-transport.rst @@ -44,5 +44,5 @@ - (Integer) Defines the maximum number of queues per page. * - ``max_subscriptions_per_page`` = ``20`` - (Integer) Defines the maximum number of subscriptions per page. - * - ``subscriber_types`` = ``http, https, mailto`` + * - ``subscriber_types`` = ``http, https, mailto, trust+http, trust+https`` - (List) Defines supported subscriber types. diff --git a/doc/config-reference/source/tables/zaqar-trustee.rst b/doc/config-reference/source/tables/zaqar-trustee.rst new file mode 100644 index 0000000000..40a321d2b7 --- /dev/null +++ b/doc/config-reference/source/tables/zaqar-trustee.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. + +.. _zaqar-trustee: + +.. list-table:: Description of trustee configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[trustee]** + - + * - ``auth_section`` = ``None`` + - (Unknown) Config Section from which to load plugin specific options + * - ``auth_type`` = ``None`` + - (Unknown) Authentication type to load + * - ``auth_url`` = ``None`` + - (Unknown) Authentication URL + * - ``default_domain_id`` = ``None`` + - (Unknown) Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. + * - ``default_domain_name`` = ``None`` + - (Unknown) Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication. + * - ``domain_id`` = ``None`` + - (Unknown) Domain ID to scope to + * - ``domain_name`` = ``None`` + - (Unknown) Domain name to scope to + * - ``password`` = ``None`` + - (Unknown) User's password + * - ``project_domain_id`` = ``None`` + - (Unknown) Domain ID containing project + * - ``project_domain_name`` = ``None`` + - (Unknown) Domain name containing project + * - ``project_id`` = ``None`` + - (Unknown) Project ID to scope to + * - ``project_name`` = ``None`` + - (Unknown) Project name to scope to + * - ``trust_id`` = ``None`` + - (Unknown) Trust ID + * - ``user_domain_id`` = ``None`` + - (Unknown) User's domain id + * - ``user_domain_name`` = ``None`` + - (Unknown) User's domain name + * - ``user_id`` = ``None`` + - (Unknown) User id + * - ``username`` = ``None`` + - (Unknown) Username diff --git a/tools/autogenerate-config-flagmappings/zaqar.flagmappings b/tools/autogenerate-config-flagmappings/zaqar.flagmappings index 3a7c4d8bbc..6d89e8be7e 100644 --- a/tools/autogenerate-config-flagmappings/zaqar.flagmappings +++ b/tools/autogenerate-config-flagmappings/zaqar.flagmappings @@ -1,6 +1,5 @@ admin_mode api auth_strategy authentication -daemon api debug disable default_log_levels disable fatal_deprecations disable @@ -15,7 +14,6 @@ logging_debug_format_suffix disable logging_default_format_string disable logging_exception_prefix disable logging_user_identity_format disable -memcached_servers cache pooling pooling publish_errors disable syslog_log_facility disable @@ -37,8 +35,6 @@ cache/memcache_pool_unused_timeout disable cache/memcache_servers disable cache/memcache_socket_timeout disable cache/proxies disable -certificates/barbican_auth api -certificates/cert_manager_type api drivers/management_store drivers drivers/message_store drivers drivers/transport drivers @@ -115,21 +111,13 @@ keystone_authtoken/region_name disable keystone_authtoken/revocation_cache_time disable keystone_authtoken/signing_dir disable keystone_authtoken/token_cache_time disable +notification/max_notifier_workers api +notification/require_confirmation api notification/smtp_command api oslo_policy/policy_default_rule disable oslo_policy/policy_dirs disable oslo_policy/policy_file disable pooling:catalog/enable_virtual_pool pooling -service_auth/admin_password api -service_auth/admin_project_domain api -service_auth/admin_tenant_name api -service_auth/admin_user api -service_auth/admin_user_domain api -service_auth/auth_url api -service_auth/auth_version api -service_auth/endpoint_type api -service_auth/region api -service_auth/service_name api signed_url/secret_key api storage/claim_pipeline storage storage/message_pipeline storage @@ -149,7 +137,20 @@ transport/max_queue_metadata transport transport/max_queues_per_page transport transport/max_subscriptions_per_page transport transport/subscriber_types transport -vArmour/director varmour -vArmour/director_port varmour -vArmour/password varmour -vArmour/username varmour +trustee/auth_section trustee +trustee/auth_type trustee +trustee/auth_url trustee +trustee/default_domain_id trustee +trustee/default_domain_name trustee +trustee/domain_id trustee +trustee/domain_name trustee +trustee/password trustee +trustee/project_domain_id trustee +trustee/project_domain_name trustee +trustee/project_id trustee +trustee/project_name trustee +trustee/trust_id trustee +trustee/user_domain_id trustee +trustee/user_domain_name trustee +trustee/user_id trustee +trustee/username trustee