openstack/nova
Code Issues Proposed changes

Deprecate CONF.api.allow_instance_snapshots

Browse Source 
The introduction of this option predates Gerrit [1]. It is
not used consistently, since it's not used for createBackup
or shelve APIs which also create snapshots. And it's not
discoverable.

We need to deprecate this option and anyone that cares to
disable snapshots needs to do it via policy.

[1] 9633e9877c

Change-Id: I321c04376d86ddb1bb3c8f1fa938a7b424e658d0
This commit is contained in:
Matt Riedemann 2017-04-09 21:09:59 -04:00
parent 002594c211
commit 43fe032a15
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
nova/conf/api.py
View File

@ -259,6 +259,14 @@ allow_instance_snapshots_opts = [
cfg.BoolOpt("allow_instance_snapshots",
default=True,
deprecated_group="DEFAULT",
deprecated_for_removal=True,
deprecated_since="16.0.0",
deprecated_reason="This option disables the createImage server action "
"API in a non-discoverable way and is thus a "
"barrier to interoperability. Also, it is not used "
"for other APIs that create snapshots like shelve "
"or createBackup. Disabling snapshots should be "
"done via policy if so desired.",
help="""
Operators can turn off the ability for a user to take snapshots of their
instances by setting this option to False. When disabled, any attempt to

7
releasenotes/notes/deprecate-allow_instance_snapshots-c63c45856c902e1e.yaml Normal file
View File

@ -0,0 +1,7 @@
---
deprecations:
- |
The ``[api]/allow_instance_snapshots`` configuration option is now
deprecated for removal. To disable snapshots in the ``createImage`` server
action API, change the ``os_compute_api:servers:create_image`` and
``os_compute_api:servers:create_image:allow_volume_backed`` policies.