openstack/glance
Code Issues Proposed changes

Correct documentation related to protected properties

Browse Source 
Fixes bug 1233303

Specified conditions under which glance api will not start
successfully.

DocImpact

Change-Id: I8498e9e51f5c7e0d411379c0574c0b8e300f77c2
This commit is contained in:
iccha.sethi 2013-09-30 18:18:22 +00:00
parent 5048ceea98
commit 1b81289484
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/configuring.rst
View File

@ -1164,7 +1164,8 @@ Configuring Glance Property Protections
Access to image meta properties may be configured using a
:doc:`Property Protections Configuration file <property-protections>`. The
location for this file can be specified in the ``glance-api.conf`` config file
in the section ``[DEFAULT]``.
in the section ``[DEFAULT]``. **If an incorrect value is specified, glance api
service will not start.**
* ``property_protection_file=PATH``

7
doc/source/property-protections.rst
View File

@ -48,7 +48,9 @@ expression matching a set of properties to be protected.
Each section describes four key-value pairs, where the key is one of
``create/read/update/delete``, and the value is a comma separated list of user
roles that are permitted to perform that operation in the Glance API.
roles that are permitted to perform that operation in the Glance API. If any of
the keys are not specified, then the glance api service will not start
successfully.
The path to the file should be specified in the ``[DEFAULT]`` section of
``glance-api.conf`` as follows.
@ -58,8 +60,7 @@ The path to the file should be specified in the ``[DEFAULT]`` section of
property_protection_file=/path/to/file
If this config value is not specified, property protections are not enforced.
If the path is invalid, a **500 Internal Server Error** will be thrown on
server startup.
**If the path is invalid, glance api service will not start successfully.**
Property protections are applied in the order specified in the configuration
file. This means that if for example you specify a section with ``[.*]`` at