[config-ref] consolidate policy configurations into commons

Change-Id: I89249dac6d6cad3ef8ac5dc8481a61c3f4c5e116
Implements: blueprint config-ref-common-sections
This commit is contained in:
KATO Tomoyuki 2016-07-30 14:15:06 +09:00
parent ff5b3c311e
commit 257aca1aac
31 changed files with 45 additions and 201 deletions

View File

@ -38,7 +38,6 @@ service configuration options.
.. include:: tables/ironic-keystone.rst
.. include:: tables/ironic-logging.rst
.. include:: tables/ironic-neutron.rst
.. include:: tables/ironic-policy.rst
.. include:: tables/ironic-pxe.rst
.. include:: tables/ironic-redis.rst
.. include:: tables/ironic-rpc.rst

View File

@ -15,5 +15,6 @@ for shared service and libraries.
common-configurations/auth.rst
common-configurations/database.rst
common-configurations/logging.rst
common-configurations/policy.rst
common-configurations/rpc.rst
common-configurations/cors.rst

View File

@ -0,0 +1,8 @@
=====================
Policy configurations
=====================
The policy configuration options allow the deployer to control where
the policy files are located and the default rule to apply when policy.
.. include:: ../tables/common-policy.rst

View File

@ -26,7 +26,6 @@ service configuration options:
.. include:: tables/sahara-domain.rst
.. include:: tables/sahara-logging.rst
.. include:: tables/sahara-object_store_access.rst
.. include:: tables/sahara-policy.rst
.. include:: tables/sahara-rabbitmq.rst
.. include:: tables/sahara-redis.rst
.. include:: tables/sahara-rpc.rst

View File

@ -32,7 +32,6 @@ a comprehensive list.
.. include:: tables/glance-common.rst
.. include:: tables/glance-imagecache.rst
.. include:: tables/glance-logging.rst
.. include:: tables/glance-policy.rst
.. include:: tables/glance-profiler.rst
.. include:: tables/glance-redis.rst
.. include:: tables/glance-registry.rst

View File

@ -1,26 +0,0 @@
..
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.
.. _ceilometer-policy:
.. list-table:: Description of policy configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (String) The JSON file that defines policies.

View File

@ -80,14 +80,6 @@
- (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.
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (String) The JSON file that defines policies.
* - **[oslo_versionedobjects]**
-
* - ``fatal_exception_format_errors`` = ``False``

View File

@ -1,26 +0,0 @@
..
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.
.. _glance-policy:
.. list-table:: Description of policy configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (String) The JSON file that defines policies.

View File

@ -110,14 +110,6 @@
- (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.
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (String) The JSON file that defines policies.
* - **[oslo_versionedobjects]**
-
* - ``fatal_exception_format_errors`` = ``False``

View File

@ -1,26 +0,0 @@
..
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.
.. _ironic-policy:
.. list-table:: Description of policy configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (String) The JSON file that defines policies.

View File

@ -16,14 +16,6 @@
* - Configuration option = Default value
- Description
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (String) The JSON file that defines policies.
* - **[policy]**
-
* - ``driver`` = ``sql``

View File

@ -64,11 +64,3 @@
- (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.
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (String) The JSON file that defines policies.

View File

@ -52,11 +52,3 @@
- (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.
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (String) The JSON file that defines policies.

View File

@ -38,11 +38,3 @@
- (Boolean) Attempt to resize the filesystem by accessing the image over a block device. This is done by the host and may not be necessary if the image contains a recent version of cloud-init. Possible mechanisms require the nbd driver (for qcow and raw), or loop (for raw).
* - ``until_refresh`` = ``0``
- (Integer) Count of reservations until usage is refreshed. This defaults to 0(off) to avoid additional load but it is useful to turn on to help keep quota usage up to date and reduce the impact of out of sync usage issues.
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (String) The JSON file that defines policies.

View File

@ -1,26 +0,0 @@
..
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.
.. _sahara-policy:
.. list-table:: Description of policy configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (String) The JSON file that defines policies.

View File

@ -34,14 +34,6 @@
-
* - ``smtp_command`` = ``/usr/sbin/sendmail -t -oi``
- (String) The command of smtp to send email. The format is "command_name arg1 arg2".
* - **[oslo_policy]**
-
* - ``policy_default_rule`` = ``default``
- (String) Default rule. Enforced when a requested rule is not found.
* - ``policy_dirs`` = ``['policy.d']``
- (Multi-valued) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
* - ``policy_file`` = ``policy.json``
- (String) The JSON file that defines policies.
* - **[service_auth]**
-
* - ``admin_password`` = ``password``

View File

@ -11,7 +11,6 @@ Alarming service configuration options.
.. include:: ../tables/aodh-common.rst
.. include:: ../tables/aodh-coordination.rst
.. include:: ../tables/aodh-logging.rst
.. include:: ../tables/aodh-policy.rst
.. include:: ../tables/aodh-rabbitmq.rst
.. include:: ../tables/aodh-redis.rst
.. include:: ../tables/aodh-rpc.rst

View File

@ -23,7 +23,6 @@ configuration options.
.. include:: ../tables/ceilometer-logging.rst
.. include:: ../tables/ceilometer-magnetodb.rst
.. include:: ../tables/ceilometer-notification.rst
.. include:: ../tables/ceilometer-policy.rst
.. include:: ../tables/ceilometer-rabbitmq.rst
.. include:: ../tables/ceilometer-redis.rst
.. include:: ../tables/ceilometer-rgw.rst

View File

@ -216,8 +216,8 @@ oslo_messaging_rabbit/ssl_options rpc
oslo_messaging_rabbit/tcp_user_timeout rpc
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule policy
oslo_policy/policy_dirs policy
oslo_policy/policy_file policy
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
service_credentials/interface common
service_credentials/region_name common

View File

@ -292,9 +292,9 @@ oslo_messaging_rabbit/ssl_options rpc
oslo_messaging_rabbit/tcp_user_timeout rpc
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule policy
oslo_policy/policy_dirs policy
oslo_policy/policy_file policy
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
polling/partitioning_group_prefix common
publisher/telemetry_secret rpc
publisher_notifier/event_topic rpc

View File

@ -868,9 +868,9 @@ oslo_messaging_rabbit/ssl_options rpc
oslo_messaging_rabbit/tcp_user_timeout rpc
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule api
oslo_policy/policy_dirs api
oslo_policy/policy_file api
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
oslo_versionedobjects/fatal_exception_format_errors api
profiler/enabled profiler
profiler/hmac_keys profiler

View File

@ -358,9 +358,9 @@ oslo_messaging_rabbit/ssl_options rpc
oslo_messaging_rabbit/tcp_user_timeout rpc
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule policy
oslo_policy/policy_dirs policy
oslo_policy/policy_file policy
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
paste_deploy/config_file api
paste_deploy/flavor api
profiler/enabled profiler

View File

@ -354,9 +354,9 @@ oslo_messaging_rabbit/ssl_options rabbitmq
oslo_messaging_rabbit/tcp_user_timeout rabbitmq
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule api
oslo_policy/policy_dirs api
oslo_policy/policy_file api
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
oslo_versionedobjects/fatal_exception_format_errors api
paste_deploy/api_paste_config api
paste_deploy/flavor api

View File

@ -346,9 +346,9 @@ oslo_messaging_rabbit/ssl_options rabbitmq
oslo_messaging_rabbit/tcp_user_timeout rabbitmq
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule policy
oslo_policy/policy_dirs policy
oslo_policy/policy_file policy
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
oslo_versionedobjects/fatal_exception_format_errors api
pxe/default_ephemeral_format pxe
pxe/disk_devices pxe

View File

@ -357,9 +357,9 @@ oslo_messaging_rabbit/ssl_options rabbitmq
oslo_messaging_rabbit/tcp_user_timeout rabbitmq
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule policy
oslo_policy/policy_dirs policy
oslo_policy/policy_file policy
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
paste_deploy/config_file api
policy/driver policy
policy/list_limit policy

View File

@ -520,6 +520,6 @@ oslo_messaging_rabbit/ssl_options rabbitmq
oslo_messaging_rabbit/tcp_user_timeout rabbitmq
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule api
oslo_policy/policy_dirs api
oslo_policy/policy_file api
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable

View File

@ -475,9 +475,9 @@ oslo_messaging_rabbit/ssl_options rabbitmq
oslo_messaging_rabbit/tcp_user_timeout rabbitmq
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule api
oslo_policy/policy_dirs api
oslo_policy/policy_file api
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
oslo_versionedobjects/fatal_exception_format_errors logging
pluto/shutdown_check_back_off vpnaas_ipsec
pluto/shutdown_check_retries vpnaas_ipsec

View File

@ -703,9 +703,9 @@ oslo_messaging_rabbit/ssl_options rabbitmq
oslo_messaging_rabbit/tcp_user_timeout rabbitmq
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule policy
oslo_policy/policy_dirs policy
oslo_policy/policy_file policy
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
oslo_versionedobjects/fatal_exception_format_errors api
rdp/enabled rdp
rdp/html5_proxy_base_url rdp

View File

@ -272,9 +272,9 @@ oslo_messaging_rabbit/ssl_options rabbitmq
oslo_messaging_rabbit/tcp_user_timeout rabbitmq
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule policy
oslo_policy/policy_dirs policy
oslo_policy/policy_file policy
oslo_policy/policy_default_rule disable
oslo_policy/policy_dirs disable
oslo_policy/policy_file disable
retries/retries_number api
retries/retry_after api
service_auth/admin_password api

View File

@ -116,9 +116,9 @@ keystone_authtoken/revocation_cache_time auth_token
keystone_authtoken/signing_dir auth_token
keystone_authtoken/token_cache_time auth_token
notification/smtp_command api
oslo_policy/policy_default_rule api
oslo_policy/policy_dirs api
oslo_policy/policy_file 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