From 1f4c82ce9ea0676c4e813cc34bdb8687f63452e3 Mon Sep 17 00:00:00 2001 From: Armando Migliaccio Date: Thu, 19 May 2016 10:04:40 -0700 Subject: [PATCH] Deprecate neutron-debug We will not follow the typical deprecation cycle and thus we will not remove this in the release after the deprecation is advertised. Nonetheless we want to signal the need for a more comprehensive set of tools and APIs that will eventually make people want to move away from the limitations of neutron-debug. Closes-bug: #1583700 Change-Id: Ibe471f186b9b5c9c15c5857a35cbaca6b8d284d6 --- neutron/debug/shell.py | 4 ++++ .../notes/deprecate_neutron_debug-a578e0adfc9cff4c.yaml | 8 ++++++++ 2 files changed, 12 insertions(+) create mode 100644 releasenotes/notes/deprecate_neutron_debug-a578e0adfc9cff4c.yaml diff --git a/neutron/debug/shell.py b/neutron/debug/shell.py index 6a00071ce01..dd4d1c4858a 100644 --- a/neutron/debug/shell.py +++ b/neutron/debug/shell.py @@ -19,6 +19,7 @@ from oslo_config import cfg from oslo_utils import importutils from neutron._i18n import _ +from neutron._i18n import _LW from neutron.agent.common import config from neutron.agent.common import utils from neutron.agent.linux import interface @@ -80,6 +81,9 @@ class NeutronDebugShell(shell.NeutronShell): self.debug_agent = debug_agent.NeutronDebugAgent(cfg.CONF, client, driver) + self.log.warning(_LW('This tool is deprecated and will be removed ' + 'in the future to be replaced with a more ' + 'powerful troubleshooting toolkit.')) def main(argv=None): diff --git a/releasenotes/notes/deprecate_neutron_debug-a578e0adfc9cff4c.yaml b/releasenotes/notes/deprecate_neutron_debug-a578e0adfc9cff4c.yaml new file mode 100644 index 00000000000..bfad6f76d9d --- /dev/null +++ b/releasenotes/notes/deprecate_neutron_debug-a578e0adfc9cff4c.yaml @@ -0,0 +1,8 @@ +--- +deprecations: + + - The tool neutron-debug is now deprecated, to be replaced with a new + set of troubleshooting and diagnostic tools. There is no plan for + removal in the immediate term, and not until comparable tools will be + adequate enough to supplant neutron-debug altogether. For more information, + please see https://blueprints.launchpad.net/neutron/+spec/troubleshooting