From 74220a0627def39728f68d91972d8a112501ceee Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Thu, 23 Jun 2016 19:53:23 +0900 Subject: [PATCH] [config-ref] add glance sample files backport: mitaka Change-Id: I13c29edc7eb7edbac342ee358274ccad5c084190 Partial-Bug: #1594632 --- .../image-service/glance-api-paste.ini.rst | 12 +++ .../source/image-service/glance-api.conf.rst | 12 +++ .../image-service/glance-cache.conf.rst | 10 ++ .../image-service/glance-manage.conf.rst | 17 ++++ .../glance-registry-paste.ini.rst | 10 ++ .../image-service/glance-registry.conf.rst | 12 +++ .../image-service/glance-scrubber.conf.rst | 11 +++ .../image-service/glance-swift.conf.rst | 7 ++ .../image-service/ovf-metadata.json.rst | 7 ++ .../source/image-service/policy.json.rst | 10 ++ .../property-protections-policies.conf.rst | 7 ++ .../property-protections-roles.conf.rst | 7 ++ .../sample-configuration-files.rst | 95 +++---------------- 13 files changed, 135 insertions(+), 82 deletions(-) create mode 100644 doc/config-reference/source/image-service/glance-api-paste.ini.rst create mode 100644 doc/config-reference/source/image-service/glance-api.conf.rst create mode 100644 doc/config-reference/source/image-service/glance-cache.conf.rst create mode 100644 doc/config-reference/source/image-service/glance-manage.conf.rst create mode 100644 doc/config-reference/source/image-service/glance-registry-paste.ini.rst create mode 100644 doc/config-reference/source/image-service/glance-registry.conf.rst create mode 100644 doc/config-reference/source/image-service/glance-scrubber.conf.rst create mode 100644 doc/config-reference/source/image-service/glance-swift.conf.rst create mode 100644 doc/config-reference/source/image-service/ovf-metadata.json.rst create mode 100644 doc/config-reference/source/image-service/policy.json.rst create mode 100644 doc/config-reference/source/image-service/property-protections-policies.conf.rst create mode 100644 doc/config-reference/source/image-service/property-protections-roles.conf.rst diff --git a/doc/config-reference/source/image-service/glance-api-paste.ini.rst b/doc/config-reference/source/image-service/glance-api-paste.ini.rst new file mode 100644 index 0000000000..f6b6a28af6 --- /dev/null +++ b/doc/config-reference/source/image-service/glance-api-paste.ini.rst @@ -0,0 +1,12 @@ +==================== +glance-api-paste.ini +==================== + +Configuration for the Image service's API middleware pipeline is found in the +``glance-api-paste.ini`` file. + +You should not need to modify this file. + +.. remote-code-block:: ini + + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api-paste.ini?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/glance-api.conf.rst b/doc/config-reference/source/image-service/glance-api.conf.rst new file mode 100644 index 0000000000..5239fa9f5f --- /dev/null +++ b/doc/config-reference/source/image-service/glance-api.conf.rst @@ -0,0 +1,12 @@ +=============== +glance-api.conf +=============== + +The configuration file for the Image service API is found in the +``glance-api.conf`` file. + +This file must be modified after installation. + +.. remote-code-block:: ini + + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api.conf?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/glance-cache.conf.rst b/doc/config-reference/source/image-service/glance-cache.conf.rst new file mode 100644 index 0000000000..62b26dddf4 --- /dev/null +++ b/doc/config-reference/source/image-service/glance-cache.conf.rst @@ -0,0 +1,10 @@ +================= +glance-cache.conf +================= + +The configuration options for an optional local image cache +are found in the ``glance-cache.conf`` file. + +.. remote-code-block:: ini + + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-cache.conf?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/glance-manage.conf.rst b/doc/config-reference/source/image-service/glance-manage.conf.rst new file mode 100644 index 0000000000..9a5f630dc5 --- /dev/null +++ b/doc/config-reference/source/image-service/glance-manage.conf.rst @@ -0,0 +1,17 @@ +================== +glance-manage.conf +================== + +The Image service's custom logging options are found in the +``glance-manage.conf`` file. + +.. note:: + + Options set in ``glance-manage.conf`` will override options of the same + section and name set in ``glance-registry.conf`` and ``glance-api.conf``. + Similarly, options in ``glance-api.conf`` will override options set in + ``glance-registry.conf``. + +.. remote-code-block:: ini + + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-manage.conf?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/glance-registry-paste.ini.rst b/doc/config-reference/source/image-service/glance-registry-paste.ini.rst new file mode 100644 index 0000000000..03357bb5cf --- /dev/null +++ b/doc/config-reference/source/image-service/glance-registry-paste.ini.rst @@ -0,0 +1,10 @@ +========================= +glance-registry-paste.ini +========================= + +The Image service's middleware pipeline for its registry is found in the +``glance-registry-paste.ini`` file. + +.. remote-code-block:: ini + + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry-paste.ini?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/glance-registry.conf.rst b/doc/config-reference/source/image-service/glance-registry.conf.rst new file mode 100644 index 0000000000..414de2ab1c --- /dev/null +++ b/doc/config-reference/source/image-service/glance-registry.conf.rst @@ -0,0 +1,12 @@ +==================== +glance-registry.conf +==================== + +Configuration for the Image service's registry, which stores the metadata about +images, is found in the ``glance-registry.conf`` file. + +This file must be modified after installation. + +.. remote-code-block:: ini + + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry.conf?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/glance-scrubber.conf.rst b/doc/config-reference/source/image-service/glance-scrubber.conf.rst new file mode 100644 index 0000000000..d84c8a0e10 --- /dev/null +++ b/doc/config-reference/source/image-service/glance-scrubber.conf.rst @@ -0,0 +1,11 @@ +==================== +glance-scrubber.conf +==================== + +``glance-scrubber`` is a utility for the Image service that cleans up images +that have been deleted; its configuration is stored in the +``glance-scrubber.conf`` file. + +.. remote-code-block:: ini + + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-scrubber.conf?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/glance-swift.conf.rst b/doc/config-reference/source/image-service/glance-swift.conf.rst new file mode 100644 index 0000000000..e01107e3b4 --- /dev/null +++ b/doc/config-reference/source/image-service/glance-swift.conf.rst @@ -0,0 +1,7 @@ +================= +glance-swift.conf +================= + +.. remote-code-block:: ini + + https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-swift.conf.sample?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/ovf-metadata.json.rst b/doc/config-reference/source/image-service/ovf-metadata.json.rst new file mode 100644 index 0000000000..f143deb083 --- /dev/null +++ b/doc/config-reference/source/image-service/ovf-metadata.json.rst @@ -0,0 +1,7 @@ +================= +ovf-metadata.json +================= + +.. remote-code-block:: json + + https://git.openstack.org/cgit/openstack/glance/plain/etc/ovf-metadata.json.sample?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/policy.json.rst b/doc/config-reference/source/image-service/policy.json.rst new file mode 100644 index 0000000000..9def43e923 --- /dev/null +++ b/doc/config-reference/source/image-service/policy.json.rst @@ -0,0 +1,10 @@ +=========== +policy.json +=========== + +The ``/etc/glance/policy.json`` file defines additional access controls that +apply to the Image service. + +.. remote-code-block:: json + + https://git.openstack.org/cgit/openstack/glance/plain/etc/policy.json?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/property-protections-policies.conf.rst b/doc/config-reference/source/image-service/property-protections-policies.conf.rst new file mode 100644 index 0000000000..43f5b02597 --- /dev/null +++ b/doc/config-reference/source/image-service/property-protections-policies.conf.rst @@ -0,0 +1,7 @@ +================================== +property-protections-policies.conf +================================== + +.. remote-code-block:: ini + + https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-policies.conf.sample?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/property-protections-roles.conf.rst b/doc/config-reference/source/image-service/property-protections-roles.conf.rst new file mode 100644 index 0000000000..8017b9d41c --- /dev/null +++ b/doc/config-reference/source/image-service/property-protections-roles.conf.rst @@ -0,0 +1,7 @@ +=============================== +property-protections-roles.conf +=============================== + +.. remote-code-block:: ini + + https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-roles.conf.sample?h=stable/mitaka diff --git a/doc/config-reference/source/image-service/sample-configuration-files.rst b/doc/config-reference/source/image-service/sample-configuration-files.rst index 20d699073c..e6a26321c0 100644 --- a/doc/config-reference/source/image-service/sample-configuration-files.rst +++ b/doc/config-reference/source/image-service/sample-configuration-files.rst @@ -5,86 +5,17 @@ Image service sample configuration files You can find the files that are described in this section in the ``/etc/glance/`` directory. -glance-api.conf -~~~~~~~~~~~~~~~ +.. toctree:: -The configuration file for the Image service API is found in the -``glance-api.conf`` file. - -This file must be modified after installation. - -.. remote-code-block:: ini - - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api.conf?h=stable/mitaka - -glance-registry.conf -~~~~~~~~~~~~~~~~~~~~ - -Configuration for the Image service's registry, which stores the metadata about -images, is found in the ``glance-registry.conf`` file. - -This file must be modified after installation. - -.. remote-code-block:: ini - - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry.conf?h=stable/mitaka - -glance-api-paste.ini -~~~~~~~~~~~~~~~~~~~~ - -Configuration for the Image service's API middleware pipeline is found in the -``glance-api-paste.ini`` file. - -You should not need to modify this file. - -.. remote-code-block:: ini - - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api-paste.ini?h=stable/mitaka - -glance-manage.conf -~~~~~~~~~~~~~~~~~~ - -The Image service's custom logging options are found in the -``glance-manage.conf`` file. - -.. note:: - - Options set in ``glance-manage.conf`` will override options of the same - section and name set in ``glance-registry.conf`` and ``glance-api.conf``. - Similarly, options in ``glance-api.conf`` will override options set in - ``glance-registry.conf``. - -.. remote-code-block:: ini - - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-manage.conf?h=stable/mitaka - -glance-registry-paste.ini -~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Image service's middleware pipeline for its registry is found in the -``glance-registry-paste.ini`` file. - -.. remote-code-block:: ini - - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry-paste.ini?h=stable/mitaka - -glance-scrubber.conf -~~~~~~~~~~~~~~~~~~~~ - -``glance-scrubber`` is a utility for the Image service that cleans up images -that have been deleted; its configuration is stored in the -``glance-scrubber.conf`` file. - -.. remote-code-block:: ini - - https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-scrubber.conf?h=stable/mitaka - -policy.json -~~~~~~~~~~~ - -The ``/etc/glance/policy.json`` file defines additional access controls that -apply to the Image service. - -.. remote-code-block:: json - - https://git.openstack.org/cgit/openstack/glance/plain/etc/policy.json?h=stable/mitaka + glance-api.conf.rst + glance-api-paste.ini.rst + glance-cache.conf.rst + glance-manage.conf.rst + glance-registry.conf.rst + glance-registry-paste.ini.rst + glance-scrubber.conf.rst + glance-swift.conf.rst + ovf-metadata.json.rst + policy.json.rst + property-protections-policies.conf.rst + property-protections-roles.conf.rst