From 3b1c90cd7cb51323cd325c059b8103db2e49912f Mon Sep 17 00:00:00 2001 From: John R Barker Date: Tue, 20 Feb 2018 03:30:12 +0000 Subject: [PATCH] Depreciate aos (#36029) (#36393) * Deprecate Apstra's aos_* modules These modules don't work with AOS 2.1 or higher. They will be replaced non-upstreamed modules --- changelogs/fragments/depreciate_aos.yaml | 2 ++ docs/docsite/rst/porting_guides/porting_guide_2.5.rst | 1 + .../network/aos/{aos_asn_pool.py => _aos_asn_pool.py} | 6 +++++- .../network/aos/{aos_blueprint.py => _aos_blueprint.py} | 6 +++++- .../aos/{aos_blueprint_param.py => _aos_blueprint_param.py} | 6 +++++- .../{aos_blueprint_virtnet.py => _aos_blueprint_virtnet.py} | 6 +++++- .../modules/network/aos/{aos_device.py => _aos_device.py} | 6 +++++- .../aos/{aos_external_router.py => _aos_external_router.py} | 6 +++++- .../modules/network/aos/{aos_ip_pool.py => _aos_ip_pool.py} | 6 +++++- .../aos/{aos_logical_device.py => _aos_logical_device.py} | 6 +++++- ...aos_logical_device_map.py => _aos_logical_device_map.py} | 6 +++++- .../modules/network/aos/{aos_login.py => _aos_login.py} | 6 +++++- .../network/aos/{aos_rack_type.py => _aos_rack_type.py} | 6 +++++- .../network/aos/{aos_template.py => _aos_template.py} | 6 +++++- 14 files changed, 63 insertions(+), 12 deletions(-) create mode 100644 changelogs/fragments/depreciate_aos.yaml rename lib/ansible/modules/network/aos/{aos_asn_pool.py => _aos_asn_pool.py} (97%) rename lib/ansible/modules/network/aos/{aos_blueprint.py => _aos_blueprint.py} (97%) rename lib/ansible/modules/network/aos/{aos_blueprint_param.py => _aos_blueprint_param.py} (98%) rename lib/ansible/modules/network/aos/{aos_blueprint_virtnet.py => _aos_blueprint_virtnet.py} (97%) rename lib/ansible/modules/network/aos/{aos_device.py => _aos_device.py} (96%) rename lib/ansible/modules/network/aos/{aos_external_router.py => _aos_external_router.py} (98%) rename lib/ansible/modules/network/aos/{aos_ip_pool.py => _aos_ip_pool.py} (97%) rename lib/ansible/modules/network/aos/{aos_logical_device.py => _aos_logical_device.py} (97%) rename lib/ansible/modules/network/aos/{aos_logical_device_map.py => _aos_logical_device_map.py} (97%) rename lib/ansible/modules/network/aos/{aos_login.py => _aos_login.py} (94%) rename lib/ansible/modules/network/aos/{aos_rack_type.py => _aos_rack_type.py} (97%) rename lib/ansible/modules/network/aos/{aos_template.py => _aos_template.py} (97%) diff --git a/changelogs/fragments/depreciate_aos.yaml b/changelogs/fragments/depreciate_aos.yaml new file mode 100644 index 00000000000..286eddd49d4 --- /dev/null +++ b/changelogs/fragments/depreciate_aos.yaml @@ -0,0 +1,2 @@ +deprecated_features: + - Apstra's ``aos_*`` modules are deprecated as they do not work with AOS 2.1 or higher. See new modules at `https://github.com/apstra `_. diff --git a/docs/docsite/rst/porting_guides/porting_guide_2.5.rst b/docs/docsite/rst/porting_guides/porting_guide_2.5.rst index b0c98602926..deadc9b0f6e 100644 --- a/docs/docsite/rst/porting_guides/porting_guide_2.5.rst +++ b/docs/docsite/rst/porting_guides/porting_guide_2.5.rst @@ -137,6 +137,7 @@ Deprecation notices The following modules will be removed in Ansible 2.9. Please update update your playbooks accordingly. +* Apstra's ``aos_*`` modules are deprecated as they do not work with AOS 2.1 or higher. See new modules at `https://github.com/apstra `_. * :ref:`nxos_ip_interface ` use :ref:`nxos_l3_interface ` instead. * :ref:`nxos_portchannel ` use :ref:`nxos_linkagg ` instead. * :ref:`nxos_switchport ` use :ref:`nxos_l2_interface ` instead. diff --git a/lib/ansible/modules/network/aos/aos_asn_pool.py b/lib/ansible/modules/network/aos/_aos_asn_pool.py similarity index 97% rename from lib/ansible/modules/network/aos/aos_asn_pool.py rename to lib/ansible/modules/network/aos/_aos_asn_pool.py index 1fbc9cd806a..364cbf4206b 100644 --- a/lib/ansible/modules/network/aos/aos_asn_pool.py +++ b/lib/ansible/modules/network/aos/_aos_asn_pool.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_asn_pool author: Damien Garros (@dgarros) version_added: "2.3" short_description: Manage AOS ASN Pool +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Apstra AOS ASN Pool module let you manage your ASN Pool easily. You can create and delete ASN Pool by Name, ID or by using a JSON File. This module diff --git a/lib/ansible/modules/network/aos/aos_blueprint.py b/lib/ansible/modules/network/aos/_aos_blueprint.py similarity index 97% rename from lib/ansible/modules/network/aos/aos_blueprint.py rename to lib/ansible/modules/network/aos/_aos_blueprint.py index 387e59308a0..6b593bcc0cc 100644 --- a/lib/ansible/modules/network/aos/aos_blueprint.py +++ b/lib/ansible/modules/network/aos/_aos_blueprint.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_blueprint author: jeremy@apstra.com (@jeremyschulman) version_added: "2.3" short_description: Manage AOS blueprint instance +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Apstra AOS Blueprint module let you manage your Blueprint easily. You can create create and delete Blueprint by Name or ID. You can also use it to retrieve diff --git a/lib/ansible/modules/network/aos/aos_blueprint_param.py b/lib/ansible/modules/network/aos/_aos_blueprint_param.py similarity index 98% rename from lib/ansible/modules/network/aos/aos_blueprint_param.py rename to lib/ansible/modules/network/aos/_aos_blueprint_param.py index e6a31ed9c53..4ad6c6eb52e 100644 --- a/lib/ansible/modules/network/aos/aos_blueprint_param.py +++ b/lib/ansible/modules/network/aos/_aos_blueprint_param.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_blueprint_param author: jeremy@apstra.com (@jeremyschulman) version_added: "2.3" short_description: Manage AOS blueprint parameter values +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Apstra AOS Blueprint Parameter module let you manage your Blueprint Parameter easily. You can create access, define and delete Blueprint Parameter. The list of diff --git a/lib/ansible/modules/network/aos/aos_blueprint_virtnet.py b/lib/ansible/modules/network/aos/_aos_blueprint_virtnet.py similarity index 97% rename from lib/ansible/modules/network/aos/aos_blueprint_virtnet.py rename to lib/ansible/modules/network/aos/_aos_blueprint_virtnet.py index abdb1aea505..a6992410936 100644 --- a/lib/ansible/modules/network/aos/aos_blueprint_virtnet.py +++ b/lib/ansible/modules/network/aos/_aos_blueprint_virtnet.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_blueprint_virtnet author: Damien Garros (@dgarros) version_added: "2.3" short_description: Manage AOS blueprint parameter values +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Apstra AOS Blueprint Virtual Network module let you manage your Virtual Network easily. You can create access, define and delete Virtual Network by name or by using a JSON / Yaml file. diff --git a/lib/ansible/modules/network/aos/aos_device.py b/lib/ansible/modules/network/aos/_aos_device.py similarity index 96% rename from lib/ansible/modules/network/aos/aos_device.py rename to lib/ansible/modules/network/aos/_aos_device.py index 885e505a132..f1b921812fa 100644 --- a/lib/ansible/modules/network/aos/aos_device.py +++ b/lib/ansible/modules/network/aos/_aos_device.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_device author: Damien Garros (@dgarros) version_added: "2.3" short_description: Manage Devices on AOS Server +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Apstra AOS Device module let you manage your devices in AOS easily. You can approve devices and define in which state the device should be. Currently diff --git a/lib/ansible/modules/network/aos/aos_external_router.py b/lib/ansible/modules/network/aos/_aos_external_router.py similarity index 98% rename from lib/ansible/modules/network/aos/aos_external_router.py rename to lib/ansible/modules/network/aos/_aos_external_router.py index 37bb041e11a..ffa8f0a6d9f 100644 --- a/lib/ansible/modules/network/aos/aos_external_router.py +++ b/lib/ansible/modules/network/aos/_aos_external_router.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_external_router author: Damien Garros (@dgarros) version_added: "2.3" short_description: Manage AOS External Router +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Apstra AOS External Router module let you manage your External Router easily. You can create create and delete External Router by Name, ID or by using a JSON File. This module diff --git a/lib/ansible/modules/network/aos/aos_ip_pool.py b/lib/ansible/modules/network/aos/_aos_ip_pool.py similarity index 97% rename from lib/ansible/modules/network/aos/aos_ip_pool.py rename to lib/ansible/modules/network/aos/_aos_ip_pool.py index 82fac9d8208..7bf983b5623 100644 --- a/lib/ansible/modules/network/aos/aos_ip_pool.py +++ b/lib/ansible/modules/network/aos/_aos_ip_pool.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_ip_pool author: Damien Garros (@dgarros) version_added: "2.3" short_description: Manage AOS IP Pool +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Apstra AOS Ip Pool module let you manage your IP Pool easily. You can create create and delete IP Pool by Name, ID or by using a JSON File. This module diff --git a/lib/ansible/modules/network/aos/aos_logical_device.py b/lib/ansible/modules/network/aos/_aos_logical_device.py similarity index 97% rename from lib/ansible/modules/network/aos/aos_logical_device.py rename to lib/ansible/modules/network/aos/_aos_logical_device.py index 0baaeaf2161..4a73b1ef205 100644 --- a/lib/ansible/modules/network/aos/aos_logical_device.py +++ b/lib/ansible/modules/network/aos/_aos_logical_device.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_logical_device author: Damien Garros (@dgarros) version_added: "2.3" short_description: Manage AOS Logical Device +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Apstra AOS Logical Device module let you manage your Logical Devices easily. You can create create and delete Logical Device by Name, ID or by using a JSON File. diff --git a/lib/ansible/modules/network/aos/aos_logical_device_map.py b/lib/ansible/modules/network/aos/_aos_logical_device_map.py similarity index 97% rename from lib/ansible/modules/network/aos/aos_logical_device_map.py rename to lib/ansible/modules/network/aos/_aos_logical_device_map.py index d2bc96ff1b6..c6378236ca5 100644 --- a/lib/ansible/modules/network/aos/aos_logical_device_map.py +++ b/lib/ansible/modules/network/aos/_aos_logical_device_map.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_logical_device_map author: Damien Garros (@dgarros) version_added: "2.3" short_description: Manage AOS Logical Device Map +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Apstra AOS Logical Device Map module let you manage your Logical Device Map easily. You can create create and delete Logical Device Map by Name, ID or by using a JSON File. This module diff --git a/lib/ansible/modules/network/aos/aos_login.py b/lib/ansible/modules/network/aos/_aos_login.py similarity index 94% rename from lib/ansible/modules/network/aos/aos_login.py rename to lib/ansible/modules/network/aos/_aos_login.py index c9ec46f5def..c67b3413abe 100644 --- a/lib/ansible/modules/network/aos/aos_login.py +++ b/lib/ansible/modules/network/aos/_aos_login.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_login author: jeremy@apstra.com (@jeremyschulman) version_added: "2.3" short_description: Login to AOS server for session token +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Obtain the AOS server session token by providing the required username and password credentials. Upon successful authentication, diff --git a/lib/ansible/modules/network/aos/aos_rack_type.py b/lib/ansible/modules/network/aos/_aos_rack_type.py similarity index 97% rename from lib/ansible/modules/network/aos/aos_rack_type.py rename to lib/ansible/modules/network/aos/_aos_rack_type.py index b8dea173126..01514d0e8f7 100644 --- a/lib/ansible/modules/network/aos/aos_rack_type.py +++ b/lib/ansible/modules/network/aos/_aos_rack_type.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_rack_type author: Damien Garros (@dgarros) version_added: "2.3" short_description: Manage AOS Rack Type +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Apstra AOS Rack Type module let you manage your Rack Type easily. You can create create and delete Rack Type by Name, ID or by using a JSON File. diff --git a/lib/ansible/modules/network/aos/aos_template.py b/lib/ansible/modules/network/aos/_aos_template.py similarity index 97% rename from lib/ansible/modules/network/aos/aos_template.py rename to lib/ansible/modules/network/aos/_aos_template.py index a8b0c3a6fe9..0fa7058f956 100644 --- a/lib/ansible/modules/network/aos/aos_template.py +++ b/lib/ansible/modules/network/aos/_aos_template.py @@ -19,7 +19,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} @@ -29,6 +29,10 @@ module: aos_template author: Damien Garros (@dgarros) version_added: "2.3" short_description: Manage AOS Template +deprecated: + removed_in: "2.9" + why: This module does not support AOS 2.1 or later + alternative: See new modules at U(https://www.ansible.com/ansible-apstra). description: - Apstra AOS Template module let you manage your Template easily. You can create create and delete Template by Name, ID or by using a JSON File. This module