[Spec Lite] Deprecate metadata_encryption_key

Change-Id: I319bb35661e859618d6d5c57cc99d548c569b211
This commit is contained in:
Pranali Deore 2024-04-18 09:30:13 +00:00
parent 3bdda0e98f
commit 51fe5c962c
2 changed files with 51 additions and 3 deletions

View File

@ -0,0 +1,46 @@
..
This work is licensed under a Creative Commons Attribution 3.0 Unported
License.
http://creativecommons.org/licenses/by/3.0/legalcode
============================================
Spec Lite: Deprecate metadata_encryption_key
============================================
..
Mandatory sections
:project: glance
:problem: `metadata_encryption_key` config option and it's related
functionality was added quite a long back ago. Even though as per
the description it encrypts the location metadata, it actually
encrypts location url. It encrypts the location url only for image
upload/import/download/show APIs, doesn't encrypt url on location
APIs. If it's enabled during upgrade then it will break the
existing deployment since existing image url is not been encrypted.
It doesn't even work for location url encryption as expected since
it does not encrypts the legacy images url on start up, download
of that image fails with InvalidLocation error.
:solution: We decided to deprecate `metadata_encryption_key` config option in
this cycle and remove it in `E` (2025.1) cycle.
:impacts: None
:how: In this cycle deprecate `metadata_encryption_key` configuration
options. Remove it along with it's related functionality in next
or this cycle.
:alternatives: None
:timeline: Milestone 2
:link: None
:reviewers: abhishekk, croelandt, mrjoshi
:assignee: pdeore

View File

@ -6,8 +6,10 @@
:glob:
:maxdepth: 1
TODO: fill this in once a new approved spec is added.
2024.2 approved specs for glance:
.. toctree::
:glob:
:maxdepth: 1
glance/*