Merge "nova-manage: Deprecate 'shell' commands"

2017-04-25 21:18:19 +00:00
parent 550adadbbe b8ee0ca245
commit ee722915fb
3 changed files with 24 additions and 0 deletions
@@ -194,6 +194,10 @@ Nova Logs
 Nova Shell
 ~~~~~~~~~~

+.. deprecated:: 16.0.0
+
+    This will be removed in 17.0.0 (Queens)
+
 ``nova-manage shell bpython``

    Starts a new bpython shell.
@@ -118,6 +118,12 @@ def param2id(object_id):


 class ShellCommands(object):
+
+    # TODO(stephenfin): Remove this during the Queens cycle
+    description = ('DEPRECATED: The shell commands are deprecated since '
+                   'Pike as they serve no useful purpose in modern nova. '
+                   'They will be removed in an upcoming release.')
+
    def bpython(self):
        """Runs a bpython shell.

@@ -0,0 +1,14 @@
+---
+deprecations:
+  - |
+    A number of `nova-manage` commands have been deprecated. The commands,
+    along with the reasons for their deprecation, are listed below:
+
+    `shell`
+
+      This starts the Python interactive interpreter. It is a clone of the same
+      functionality found in Django's `django-manage` command. This command
+      hasn't been actively maintained in a long time and is not tested. It will
+      simply be removed.
+
+    These commands will be removed in their entirety during the Queens cycle.