diff --git a/glance/common/config.py b/glance/common/config.py index 316874fc44..78313ddeb7 100644 --- a/glance/common/config.py +++ b/glance/common/config.py @@ -491,6 +491,16 @@ Related options: """)), 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, help=_(""" AES key for encrypting store location metadata. diff --git a/releasenotes/notes/deprecate_metadata_encryption_key_option-8c6076ca6e361f92.yaml b/releasenotes/notes/deprecate_metadata_encryption_key_option-8c6076ca6e361f92.yaml new file mode 100644 index 0000000000..4006b2a751 --- /dev/null +++ b/releasenotes/notes/deprecate_metadata_encryption_key_option-8c6076ca6e361f92.yaml @@ -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. +