openstack/glance-specs
Code Issues Proposed changes

Deprecate allow_additional_image_properties

Browse Source 
Change-Id: I25892c3a422fab07d3974d9ad360be9a6e9be88e
This commit is contained in:
Brian Rosmaita 2019-12-16 09:41:51 -05:00
parent 8471e9c858
commit 2a863f0bca
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
specs/ussuri/approved/glance/deprecate-allow-custom-props.rst Normal file
View File

@ -0,0 +1,35 @@
..
This work is licensed under a Creative Commons Attribution 3.0 Unported
License.
http://creativecommons.org/licenses/by/3.0/legalcode
======================================================
Spec Lite: Deprecate allow_additional_image_properties
======================================================
:project: glance
:problem: The ``allow_additional_image_properties`` configuration option
was originally introduced to prevent users from flooding the
image_properties table with junk. Given that we now have the
``image_property_quota`` option,
``allow_additional_image_properties`` is unnecessary. Further,
if an operator were to set it False, all sorts of stuff would
break as multiple OpenStack services (for example, Cinder, Nova)
currently write/rely on custom image properties. Of course, in
such a case, an operator would have to change the option to
True to get everything working again; but the point is that
if this setting is always True, then it is unnecessary and
polluting the code with unnecessary branch points.
:solution: Deprecate the ``allow_additional_image_properties`` in Ussuri
scheduled for removal in the V development cycle, consistent with
the standard OpenStack deprecation policy.
:impacts: None. Operators who really want to use this option can instead
set ``image_property_quota`` to 0. ('0' means zero; a negative
value means 'unlimited' for this option.)
:assignee: rosmaita (or anyone who would like to address this low-hanging
fruit)