From 01149a570c2ba785e85cf8b3d555a0a66f37df47 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Sun, 3 Jul 2016 00:00:31 +0900 Subject: [PATCH] [config-ref] add CORS configuration into common Change-Id: I627e312aa69fafaf0622a9315f832eea5513af59 Implements: blueprint config-ref-common-sections --- .../source/block-storage/volume-misc.rst | 1 - .../source/common-configurations.rst | 1 + .../source/common-configurations/cors.rst | 13 ++++++ .../source/compute/config-options.rst | 1 - .../source/data-processing-service.rst | 1 - .../source/identity/options.rst | 1 - doc/config-reference/source/image-service.rst | 1 - .../source/networking/lbaas.rst | 1 - .../networking_options_reference.rst | 7 --- .../source/object-storage.rst | 1 - .../source/object-storage/cors.rst | 13 ------ doc/config-reference/source/orchestration.rst | 1 - .../source/shared-file-systems/misc.rst | 1 - .../source/tables/aodh-cors.rst | 46 ------------------- .../source/tables/ceilometer-cors.rst | 46 ------------------- .../source/tables/cinder-cors.rst | 46 ------------------- .../{glance-cors.rst => common-cors.rst} | 2 +- .../source/tables/heat-cors.rst | 46 ------------------- .../source/tables/ironic-api.rst | 28 ----------- .../source/tables/keystone-cors.rst | 46 ------------------- .../source/tables/manila-cors.rst | 46 ------------------- .../source/tables/neutron-cors.rst | 46 ------------------- .../source/tables/nova-cors.rst | 46 ------------------- .../source/tables/octavia-cors.rst | 46 ------------------- .../source/tables/sahara-cors.rst | 46 ------------------- .../source/tables/trove-cors.rst | 46 ------------------- .../alarming_service_config_opts.rst | 1 - .../telemetry_service_config_opts.rst | 1 - 28 files changed, 15 insertions(+), 566 deletions(-) create mode 100644 doc/config-reference/source/common-configurations/cors.rst delete mode 100644 doc/config-reference/source/object-storage/cors.rst delete mode 100644 doc/config-reference/source/tables/aodh-cors.rst delete mode 100644 doc/config-reference/source/tables/ceilometer-cors.rst delete mode 100644 doc/config-reference/source/tables/cinder-cors.rst rename doc/config-reference/source/tables/{glance-cors.rst => common-cors.rst} (99%) delete mode 100644 doc/config-reference/source/tables/heat-cors.rst delete mode 100644 doc/config-reference/source/tables/keystone-cors.rst delete mode 100644 doc/config-reference/source/tables/manila-cors.rst delete mode 100644 doc/config-reference/source/tables/neutron-cors.rst delete mode 100644 doc/config-reference/source/tables/nova-cors.rst delete mode 100644 doc/config-reference/source/tables/octavia-cors.rst delete mode 100644 doc/config-reference/source/tables/sahara-cors.rst delete mode 100644 doc/config-reference/source/tables/trove-cors.rst diff --git a/doc/config-reference/source/block-storage/volume-misc.rst b/doc/config-reference/source/block-storage/volume-misc.rst index 852562d718..4ab13fa91b 100644 --- a/doc/config-reference/source/block-storage/volume-misc.rst +++ b/doc/config-reference/source/block-storage/volume-misc.rst @@ -13,7 +13,6 @@ These options can also be set in the ``cinder.conf`` file. .. include:: ../tables/cinder-common.rst .. include:: ../tables/cinder-compute.rst .. include:: ../tables/cinder-coordination.rst -.. include:: ../tables/cinder-cors.rst .. include:: ../tables/cinder-database.rst .. include:: ../tables/cinder-debug.rst .. include:: ../tables/cinder-drbd.rst diff --git a/doc/config-reference/source/common-configurations.rst b/doc/config-reference/source/common-configurations.rst index 4ca835c54a..4dffbc9f1b 100644 --- a/doc/config-reference/source/common-configurations.rst +++ b/doc/config-reference/source/common-configurations.rst @@ -14,3 +14,4 @@ for shared service and libraries. common-configurations/logging.rst common-configurations/rpc.rst + common-configurations/cors.rst diff --git a/doc/config-reference/source/common-configurations/cors.rst b/doc/config-reference/source/common-configurations/cors.rst new file mode 100644 index 0000000000..1d099130f1 --- /dev/null +++ b/doc/config-reference/source/common-configurations/cors.rst @@ -0,0 +1,13 @@ +============================= +Cross-origin resource sharing +============================= + +Cross-Origin Resource Sharing (CORS) is a mechanism that allows code running in +a browser (JavaScript for example) to make requests to a domain, other than the +one it was originated from. OpenStack services support CORS requests. + +For more information, see `Cross-project features +`__ +in OpenStack Administrator Guide. + +.. include:: ../tables/common-cors.rst diff --git a/doc/config-reference/source/compute/config-options.rst b/doc/config-reference/source/compute/config-options.rst index a4bdc70189..930f75f41c 100644 --- a/doc/config-reference/source/compute/config-options.rst +++ b/doc/config-reference/source/compute/config-options.rst @@ -20,7 +20,6 @@ OpenStack Compute service, run .. include:: ../tables/nova-conductor.rst .. include:: ../tables/nova-configdrive.rst .. include:: ../tables/nova-console.rst -.. include:: ../tables/nova-cors.rst .. include:: ../tables/nova-database.rst .. include:: ../tables/nova-debug.rst .. include:: ../tables/nova-ephemeral_storage_encryption.rst diff --git a/doc/config-reference/source/data-processing-service.rst b/doc/config-reference/source/data-processing-service.rst index 63d2cf475c..d66820a64c 100644 --- a/doc/config-reference/source/data-processing-service.rst +++ b/doc/config-reference/source/data-processing-service.rst @@ -17,7 +17,6 @@ service configuration options: .. include:: tables/sahara-auth_token.rst .. include:: tables/sahara-clients.rst .. include:: tables/sahara-common.rst -.. include:: tables/sahara-cors.rst .. include:: tables/sahara-database.rst .. include:: tables/sahara-domain.rst .. include:: tables/sahara-logging.rst diff --git a/doc/config-reference/source/identity/options.rst b/doc/config-reference/source/identity/options.rst index 76d80245cf..df307a24cf 100644 --- a/doc/config-reference/source/identity/options.rst +++ b/doc/config-reference/source/identity/options.rst @@ -14,7 +14,6 @@ service options. .. include:: ../tables/keystone-ca.rst .. include:: ../tables/keystone-catalog.rst .. include:: ../tables/keystone-common.rst -.. include:: ../tables/keystone-cors.rst .. include:: ../tables/keystone-credential.rst .. include:: ../tables/keystone-database.rst .. include:: ../tables/keystone-debug.rst diff --git a/doc/config-reference/source/image-service.rst b/doc/config-reference/source/image-service.rst index 1dda942823..9862f85671 100644 --- a/doc/config-reference/source/image-service.rst +++ b/doc/config-reference/source/image-service.rst @@ -24,7 +24,6 @@ a comprehensive list. .. include:: tables/glance-auth_token.rst .. include:: tables/glance-common.rst -.. include:: tables/glance-cors.rst .. include:: tables/glance-database.rst .. include:: tables/glance-imagecache.rst .. include:: tables/glance-logging.rst diff --git a/doc/config-reference/source/networking/lbaas.rst b/doc/config-reference/source/networking/lbaas.rst index d51227144c..afe7ee759a 100644 --- a/doc/config-reference/source/networking/lbaas.rst +++ b/doc/config-reference/source/networking/lbaas.rst @@ -26,7 +26,6 @@ Use the following options to configure the octavia service. .. include:: ../tables/octavia-auth_token.rst .. include:: ../tables/octavia-cache.rst .. include:: ../tables/octavia-common.rst -.. include:: ../tables/octavia-cors.rst .. include:: ../tables/octavia-database.rst .. include:: ../tables/octavia-logging.rst .. include:: ../tables/octavia-rabbitmq.rst diff --git a/doc/config-reference/source/networking/networking_options_reference.rst b/doc/config-reference/source/networking/networking_options_reference.rst index b0d8d0bdf0..ef7c1260ca 100644 --- a/doc/config-reference/source/networking/networking_options_reference.rst +++ b/doc/config-reference/source/networking/networking_options_reference.rst @@ -180,13 +180,6 @@ Use the following options to alter Compute-related settings. .. include:: ../tables/neutron-compute.rst -CORS -~~~~ - -Use the following options to alter CORS-related settings. - -.. include:: ../tables/neutron-cors.rst - Database ~~~~~~~~ diff --git a/doc/config-reference/source/object-storage.rst b/doc/config-reference/source/object-storage.rst index dadd3e06ce..7449a67773 100644 --- a/doc/config-reference/source/object-storage.rst +++ b/doc/config-reference/source/object-storage.rst @@ -10,7 +10,6 @@ Object Storage service object-storage/configure.rst object-storage/features.rst object-storage/configure-s3.rst - object-storage/cors.rst object-storage/listendpoints.rst object-storage/logs.rst tables/conf-changes/swift.rst diff --git a/doc/config-reference/source/object-storage/cors.rst b/doc/config-reference/source/object-storage/cors.rst deleted file mode 100644 index 738d7181ee..0000000000 --- a/doc/config-reference/source/object-storage/cors.rst +++ /dev/null @@ -1,13 +0,0 @@ -============================= -Cross-origin resource sharing -============================= - -Cross-Origin Resource Sharing (CORS) is a mechanism that allows code running in -a browser (JavaScript for example) to make requests to a domain, other than the -one it was originated from. OpenStack Object Storage supports CORS requests to -containers and objects within the containers using metadata held on the -container. - -In addition to the metadata on containers, you can use the -``cors_allow_origin`` option in the ``proxy-server.conf`` file to set a list of -hosts that are included with any CORS request by default. diff --git a/doc/config-reference/source/orchestration.rst b/doc/config-reference/source/orchestration.rst index 94510d6b8b..c051a3b620 100644 --- a/doc/config-reference/source/orchestration.rst +++ b/doc/config-reference/source/orchestration.rst @@ -23,7 +23,6 @@ configuration options: .. include:: tables/heat-auth_token.rst .. include:: tables/heat-common.rst -.. include:: tables/heat-cors.rst .. include:: tables/heat-crypt.rst .. include:: tables/heat-database.rst .. include:: tables/heat-loadbalancer.rst diff --git a/doc/config-reference/source/shared-file-systems/misc.rst b/doc/config-reference/source/shared-file-systems/misc.rst index 74c02a27ab..5911d82881 100644 --- a/doc/config-reference/source/shared-file-systems/misc.rst +++ b/doc/config-reference/source/shared-file-systems/misc.rst @@ -10,7 +10,6 @@ These options can also be set in the ``manila.conf`` file. .. include:: ../tables/manila-ca.rst .. include:: ../tables/manila-common.rst .. include:: ../tables/manila-compute.rst -.. include:: ../tables/manila-cors.rst .. include:: ../tables/manila-database.rst .. include:: ../tables/manila-ganesha.rst .. include:: ../tables/manila-hnas.rst diff --git a/doc/config-reference/source/tables/aodh-cors.rst b/doc/config-reference/source/tables/aodh-cors.rst deleted file mode 100644 index add4015426..0000000000 --- a/doc/config-reference/source/tables/aodh-cors.rst +++ /dev/null @@ -1,46 +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. - -.. _aodh-cors: - -.. list-table:: Description of CORS configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. diff --git a/doc/config-reference/source/tables/ceilometer-cors.rst b/doc/config-reference/source/tables/ceilometer-cors.rst deleted file mode 100644 index 14922c9a58..0000000000 --- a/doc/config-reference/source/tables/ceilometer-cors.rst +++ /dev/null @@ -1,46 +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-cors: - -.. list-table:: Description of CORS configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. diff --git a/doc/config-reference/source/tables/cinder-cors.rst b/doc/config-reference/source/tables/cinder-cors.rst deleted file mode 100644 index c885a8fe4a..0000000000 --- a/doc/config-reference/source/tables/cinder-cors.rst +++ /dev/null @@ -1,46 +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. - -.. _cinder-cors: - -.. list-table:: Description of CORS configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. diff --git a/doc/config-reference/source/tables/glance-cors.rst b/doc/config-reference/source/tables/common-cors.rst similarity index 99% rename from doc/config-reference/source/tables/glance-cors.rst rename to doc/config-reference/source/tables/common-cors.rst index 52c526ed38..c9eece7570 100644 --- a/doc/config-reference/source/tables/glance-cors.rst +++ b/doc/config-reference/source/tables/common-cors.rst @@ -8,7 +8,7 @@ autogenerate-config-doc tool from the openstack-doc-tools repository, or ask for help on the documentation mailing list, IRC channel or meeting. -.. _glance-cors: +.. _common-cors: .. list-table:: Description of CORS configuration options :header-rows: 1 diff --git a/doc/config-reference/source/tables/heat-cors.rst b/doc/config-reference/source/tables/heat-cors.rst deleted file mode 100644 index 029fe558de..0000000000 --- a/doc/config-reference/source/tables/heat-cors.rst +++ /dev/null @@ -1,46 +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. - -.. _heat-cors: - -.. list-table:: Description of CORS configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. diff --git a/doc/config-reference/source/tables/ironic-api.rst b/doc/config-reference/source/tables/ironic-api.rst index 686e20e79d..3af39d65a7 100644 --- a/doc/config-reference/source/tables/ironic-api.rst +++ b/doc/config-reference/source/tables/ironic-api.rst @@ -30,34 +30,6 @@ - (Unknown) The TCP port on which ironic-api listens. * - ``public_endpoint`` = ``None`` - (String) Public URL to use when building the links to the API resources (for example, "https://ironic.rocks:6384"). If None the links will be built using the request's host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy's URL. Defaults to None. - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. * - **[oslo_middleware]** - * - ``max_request_body_size`` = ``114688`` diff --git a/doc/config-reference/source/tables/keystone-cors.rst b/doc/config-reference/source/tables/keystone-cors.rst deleted file mode 100644 index 04939d3607..0000000000 --- a/doc/config-reference/source/tables/keystone-cors.rst +++ /dev/null @@ -1,46 +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. - -.. _keystone-cors: - -.. list-table:: Description of CORS configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. diff --git a/doc/config-reference/source/tables/manila-cors.rst b/doc/config-reference/source/tables/manila-cors.rst deleted file mode 100644 index bf4f1b4117..0000000000 --- a/doc/config-reference/source/tables/manila-cors.rst +++ /dev/null @@ -1,46 +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. - -.. _manila-cors: - -.. list-table:: Description of CORS configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. diff --git a/doc/config-reference/source/tables/neutron-cors.rst b/doc/config-reference/source/tables/neutron-cors.rst deleted file mode 100644 index 8d58a57f36..0000000000 --- a/doc/config-reference/source/tables/neutron-cors.rst +++ /dev/null @@ -1,46 +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. - -.. _neutron-cors: - -.. list-table:: Description of CORS configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. diff --git a/doc/config-reference/source/tables/nova-cors.rst b/doc/config-reference/source/tables/nova-cors.rst deleted file mode 100644 index 1905a77f86..0000000000 --- a/doc/config-reference/source/tables/nova-cors.rst +++ /dev/null @@ -1,46 +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. - -.. _nova-cors: - -.. list-table:: Description of CORS configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. diff --git a/doc/config-reference/source/tables/octavia-cors.rst b/doc/config-reference/source/tables/octavia-cors.rst deleted file mode 100644 index 4b89240a53..0000000000 --- a/doc/config-reference/source/tables/octavia-cors.rst +++ /dev/null @@ -1,46 +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. - -.. _octavia-cors: - -.. list-table:: Description of CORS configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. diff --git a/doc/config-reference/source/tables/sahara-cors.rst b/doc/config-reference/source/tables/sahara-cors.rst deleted file mode 100644 index 4e7bd69cf9..0000000000 --- a/doc/config-reference/source/tables/sahara-cors.rst +++ /dev/null @@ -1,46 +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-cors: - -.. list-table:: Description of CORS configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. diff --git a/doc/config-reference/source/tables/trove-cors.rst b/doc/config-reference/source/tables/trove-cors.rst deleted file mode 100644 index b5b7ea3a72..0000000000 --- a/doc/config-reference/source/tables/trove-cors.rst +++ /dev/null @@ -1,46 +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. - -.. _trove-cors: - -.. list-table:: Description of CORS configuration options - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - **[cors]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. - * - **[cors.subdomain]** - - - * - ``allow_credentials`` = ``True`` - - (Boolean) Indicate that the actual request can include user credentials - * - ``allow_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which header field names may be used during the actual request. - * - ``allow_methods`` = ``GET, POST, PUT, DELETE, OPTIONS`` - - (List) Indicate which methods can be used during the actual request. - * - ``allowed_origin`` = ``None`` - - (List) Indicate whether this resource may be shared with the domain received in the requests "origin" header. - * - ``expose_headers`` = ``Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma`` - - (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. - * - ``max_age`` = ``3600`` - - (Integer) Maximum cache age of CORS preflight requests. diff --git a/doc/config-reference/source/telemetry/alarming_service_config_opts.rst b/doc/config-reference/source/telemetry/alarming_service_config_opts.rst index 29469d8a3a..b733b887ce 100644 --- a/doc/config-reference/source/telemetry/alarming_service_config_opts.rst +++ b/doc/config-reference/source/telemetry/alarming_service_config_opts.rst @@ -10,7 +10,6 @@ Alarming service configuration options. .. include:: ../tables/aodh-auth_token.rst .. include:: ../tables/aodh-common.rst .. include:: ../tables/aodh-coordination.rst -.. include:: ../tables/aodh-cors.rst .. include:: ../tables/aodh-database.rst .. include:: ../tables/aodh-logging.rst .. include:: ../tables/aodh-policy.rst diff --git a/doc/config-reference/source/telemetry/telemetry_service_config_opts.rst b/doc/config-reference/source/telemetry/telemetry_service_config_opts.rst index 3fe6a9364a..cffc71865c 100644 --- a/doc/config-reference/source/telemetry/telemetry_service_config_opts.rst +++ b/doc/config-reference/source/telemetry/telemetry_service_config_opts.rst @@ -11,7 +11,6 @@ configuration options. .. include:: ../tables/ceilometer-auth_token.rst .. include:: ../tables/ceilometer-collector.rst .. include:: ../tables/ceilometer-common.rst -.. include:: ../tables/ceilometer-cors.rst .. include:: ../tables/ceilometer-database.rst .. include:: ../tables/ceilometer-debug.rst .. include:: ../tables/ceilometer-dispatcher_gnocchi.rst