diff --git a/doc/admin-guide-cloud/image/section_glance-property-protection.xml b/doc/admin-guide-cloud/image/section_glance-property-protection.xml index 9a53e9318a..b551da8ff4 100644 --- a/doc/admin-guide-cloud/image/section_glance-property-protection.xml +++ b/doc/admin-guide-cloud/image/section_glance-property-protection.xml @@ -3,31 +3,99 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="glance-property-protection"> - Image property protection - An image property is a key and value pair that is attached to - OpenStack Image Service image. - Core properties, such as the image name, are defined and set - by the cloud administrator. Additional properties, such as - licensing and billing information, are defined and set by the - cloud administrator and the image owner. + Image properties and property protection + An image property is a key and value pair that the cloud + administrator or the image owner attaches to an OpenStack Image + Service image, as follows: + + + + The cloud administrator defines core properties, such as the image + name. + + + The cloud administrator and the image owner can define + additional properties, + such as licensing and billing information. + + + The cloud administrator can configure any property as - protected, - which limits which user roles can perform CRUD operations on that - property. Protected properties are generally extra properties to - which only cloud administrators have access. + protected, which limits which policies or + user roles can perform CRUD operations on that property. Protected + properties are generally additional properties to which only cloud + administrators have access. For unprotected image properties, the cloud administrator can manage core properties and the image owner can manage additional properties. To configure property protection + To configure property protection, the cloud administrator + completes these steps: - Define roles in the policy.json - file. + Define roles or policies in the + policy.json file. To view a sample + configuration file, see policy.json. - Define which roles can manage which properties in the - /etc/glance/property-protections.conf - file. + Define which roles or policies can manage which properties + in a property protections configuration file. For + example: + [x_none_read] +create = context_is_admin +read = ! +update = ! +delete = ! + +[x_none_update] +create = context_is_admin +read = context_is_admin +update = ! +delete = context_is_admin + +[x_none_delete] +create = context_is_admin +read = context_is_admin +update = context_is_admin +delete = ! + + + A value of @ allows the + corresponding operation for a property. + + + A value of ! disallows the + corresponding operation for a property. + + + + + In the glance-api.conf file, define + the location of a property protections configuration + file: + property_protection_file = {file_name} + This file contains the rules for property protections and + the roles and policies associated with it. + By default, property protections are not enforced. + If you specify a file name value and the file is not + found, the glance-api + service does not start. + To view a sample configuration file, see glance-api.conf. + + + Optionally, in the glance-api.conf + file, specify whether roles or policies are used in the + property protections configuration file: + property_protection_rule_format = roles + The default is roles. + To view a sample configuration file, see glance-api.conf. diff --git a/doc/admin-guide-cloud/pom.xml b/doc/admin-guide-cloud/pom.xml index 9600b618f2..9fbc643e0d 100644 --- a/doc/admin-guide-cloud/pom.xml +++ b/doc/admin-guide-cloud/pom.xml @@ -70,6 +70,7 @@ http://docs.openstack.org/admin-guide-cloud/content ${basedir}/../glossary/glossary-terms.xml openstack + 0 diff --git a/doc/glossary/glossary-terms.xml b/doc/glossary/glossary-terms.xml index 7de3377742..6773c4b562 100644 --- a/doc/glossary/glossary-terms.xml +++ b/doc/glossary/glossary-terms.xml @@ -7268,12 +7268,11 @@ - A blob of data that can be specified by the user when launching - an instance. This data can be accessed by the instance through the + A blob of data that the user can specify when they launch + an instance. The instance can access this data through the metadata service or config drive. config drive - Commonly used for passing a shell script that is - executed by the instance on boot. + Commonly used to pass a shell script that the instance runs on boot. diff --git a/doc/pom.xml b/doc/pom.xml index b9d727a4ec..84ec6257ce 100644 --- a/doc/pom.xml +++ b/doc/pom.xml @@ -48,7 +48,7 @@ com.rackspace.cloud.api clouddocs-maven-plugin - 2.0.2 + 2.0.4