Add warning and reno for SDK

On the 2023.1 (Antelope) PTG we discussed the status of the python binding (SDK) code in python-neutronclient and decided to not allow new features to this repo (see [1]), and make users to use openstacksdk. Let's add a warning log message and a releasenote to make it visible. [1]: https://etherpad.opendev.org/p/neutron-antelope-ptg#L163 Change-Id: I03317179bd0d30a69b91eef6e451b8e40eb28191
Switch to 2023.1 Python3 unit tests and generic template name
2022-10-21 16:40:38 +02:00 · 2022-09-14 09:26:48 +00:00 · 2022-09-09 11:48:19 +00:00
7 changed files with 21 additions and 5 deletions
--- a/.gitreview
+++ b/.gitreview
@@ -2,4 +2,3 @@
 host=review.opendev.org
 port=29418
 project=openstack/python-neutronclient.git
-defaultbranch=stable/zed
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -1,7 +1,7 @@
 - project:
    templates:
      - openstack-cover-jobs
-      - openstack-python3-zed-jobs
+      - openstack-python3-jobs
      - publish-openstack-docs-pti
      - check-requirements
      - lib-forward-testing-python3
--- a/neutronclient/v2_0/client.py
+++ b/neutronclient/v2_0/client.py
@@ -250,6 +250,9 @@ class ClientBase(object):
    def __init__(self, **kwargs):
        """Initialize a new client for the Neutron v2.0 API."""
        super(ClientBase, self).__init__()
+        _logger.warning("The python binding code in neutronclient will be "
+                        "deprecated in favor of OpenstackSDK, please use "
+                        "that!")
        self.retries = kwargs.pop('retries', 0)
        self.raise_errors = kwargs.pop('raise_errors', True)
        self.httpclient = client.construct_http_client(**kwargs)
--- a/releasenotes/notes/no-new-binding-code-b03c9abbcaf2839e.yaml
+++ b/releasenotes/notes/no-new-binding-code-b03c9abbcaf2839e.yaml
@@ -0,0 +1,7 @@
+---
+prelude: >
+    Openstack community decided to use one SDK for its services, that is
+    in ``openstacksdk`` repository. To avoid duplication, sooner or later the
+    python binding code in ``python-neutronclient`` will be deprecated, and
+    ``Neutron`` team decided on the ``2023.1 (Antelope)`` PTG to not allow
+    new features\' bindings implemented here.
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,6 +6,7 @@
   :maxdepth: 1

   unreleased
+   zed
   yoga
   xena
   wallaby
--- a/releasenotes/source/zed.rst
+++ b/releasenotes/source/zed.rst
@@ -0,0 +1,6 @@
+========================
+Zed Series Release Notes
+========================
+
+.. release-notes::
+   :branch: stable/zed
--- a/tox.ini
+++ b/tox.ini
@@ -13,7 +13,7 @@ setenv = VIRTUAL_ENV={envdir}
         PYTHONWARNINGS=default::DeprecationWarning
 usedevelop = True
 install_command = pip install {opts} {packages}
-deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/zed}
+deps = -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
       -r{toxinidir}/requirements.txt
       -r{toxinidir}/test-requirements.txt
 # Delete bytecodes from normal directories before running tests.
@@ -52,7 +52,7 @@ commands =

 [testenv:docs]
 deps =
-  -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/zed}
+  -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
  -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -W -b html doc/source doc/build/html

@@ -67,7 +67,7 @@ commands =

 [testenv:releasenotes]
 deps =
-  -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/zed}
+  -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
  -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html