openstack/glance
Code Issues Proposed changes

Merge "Deprecate the "metadata_encryption_key" option"

Browse Source
This commit is contained in:
Zuul 2024-08-01 17:42:46 +00:00 committed by Gerrit Code Review
commit b957e7a68c
2 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
glance/common/config.py
View File

@ -491,6 +491,16 @@ Related options:
""")), """)),
cfg.StrOpt('metadata_encryption_key', cfg.StrOpt('metadata_encryption_key',
deprecated_for_removal=True,
deprecated_since="Dalmatian",
deprecated_reason=_("""
This option doesnt serves the purpose of encryption of location metadata,
whereas it encrypts location url only for specific APIs. Also if enabled
this during an upgrade may disrupt existing deployments, as it does not
support/provide db upgrade script to encrypt existing location URLs.
Moreover, its functionality for encrypting location URLs is inconsistent
which is resulting in download failures.
"""),
secret=True, secret=True,
help=_(""" help=_("""
AES key for encrypting store location metadata. AES key for encrypting store location metadata.

15
releasenotes/notes/deprecate_metadata_encryption_key_option-8c6076ca6e361f92.yaml Normal file
View File

@ -0,0 +1,15 @@
---
deprecations:
- |
The Glance API configuration options ``metadata_encryption_key`` is
deprecated in this release and is subject to removal at the beginning
of the `F` (2025.2) development cycle.
The `metadata_encryption_key` and it's related functioanlity don't
serve the purpose of encryption of location metadata, whereas it encrypts
location url only for specific APIs. Also if enabled this during an
upgrade, may disrupt existing deployments, as it does not support/provide
db upgrade script to encrypt existing location URLs. Moreover, its
functionality for encrypting location URLs is inconsistent which
resulting in download failures.