rax modules: deprecation (#5752)

* rax modules: deprecation

* add changelog fragment

* Update plugins/doc_fragments/rackspace.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* add comment go sanity ignore files

* changelog: fix typo + add rax module utils

* add module utils and doc fragment to runtime.yml

Co-authored-by: Felix Fontein <felix@fontein.de>

changelogs/fragments/5752-rax-deprecation.yml

@@ -0,0 +1,28 @@
+deprecated_features:
+  - rax_cbs_attachments - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_cbs - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_cdb_database - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_cdb - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_cdb_user - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_clb_nodes - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_clb - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_clb_ssl - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_dns - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_dns_record - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_facts - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_files_objects - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_files - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_identity - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_keypair - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_meta - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_mon_alarm - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_mon_check - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_mon_entity - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_mon_notification_plan - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_mon_notification - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_network - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_queue - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_scaling_group - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax_scaling_policy - module relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).
+  - rax module utils - module utils code relies on deprecated library ``pyrax`` and will be removed in community.general 9.0.0 (https://github.com/ansible-collections/community.general/pull/5752).

meta/runtime.yml

@@ -22,6 +22,110 @@ plugin_routing:
     nios_next_network:
       redirect: infoblox.nios_modules.nios_next_network
   modules:
+    rax_cbs_attachments:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_cbs:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_cdb_database:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_cdb_user:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_cdb:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_clb_nodes:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_clb_ssl:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_clb:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_dns_record:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_dns:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_facts:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_files_objects:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_files:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_identity:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_keypair:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_meta:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_mon_alarm:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_mon_check:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_mon_entity:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_mon_notification_plan:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_mon_notification:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_network:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_queue:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_scaling_group:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
+    rax_scaling_policy:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module relies on the deprecated package pyrax.
     database.aerospike.aerospike_migrations:
       redirect: community.general.aerospike_migrations
       deprecation:
@@ -4499,6 +4603,10 @@ plugin_routing:
           modules. This has never been supported or documented, and will stop working
           in community.general 9.0.0.
   doc_fragments:
+    rackspace:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This doc fragment is used by rax modules, that rely on the deprecated package pyrax.
     _gcp:
       redirect: community.google._gcp
     docker:
@@ -4514,6 +4622,10 @@ plugin_routing:
     postgresql:
       redirect: community.postgresql.postgresql
   module_utils:
+    rax:
+      deprecation:
+        removal_version: 9.0.0
+        warning_text: This module util relies on the deprecated package pyrax.
     docker.common:
       redirect: community.docker.common
     docker.swarm:

plugins/doc_fragments/rackspace.py

@@ -105,6 +105,10 @@ options:
       - Whether or not to require SSL validation of API endpoints.
     type: bool
     aliases: [ verify_ssl ]
+deprecated:
+  removed_in: 9.0.0
+  why: This module relies on the deprecated package pyrax.
+  alternative: Use the Openstack modules instead.
 requirements:
   - python >= 2.6
   - pyrax

tests/sanity/ignore-2.11.txt

@@ -19,9 +19,9 @@ plugins/modules/manageiq_tags.py validate-modules:parameter-state-invalid-choice
 plugins/modules/osx_defaults.py validate-modules:parameter-state-invalid-choice
 plugins/modules/parted.py validate-modules:parameter-state-invalid-choice
 plugins/modules/puppet.py validate-modules:parameter-invalid                          # invalid alias - removed in 7.0.0
-plugins/modules/rax_files_objects.py use-argspec-type-path
+plugins/modules/rax_files_objects.py use-argspec-type-path                            # module deprecated - removed in 9.0.0
-plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice
+plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice          # module deprecated - removed in 9.0.0
-plugins/modules/rax.py use-argspec-type-path # fix needed
+plugins/modules/rax.py use-argspec-type-path                                          # module deprecated - removed in 9.0.0
 plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice
 plugins/modules/xfconf.py validate-modules:return-syntax-error
 plugins/modules/yarn.py use-argspec-type-path

tests/sanity/ignore-2.12.txt

@@ -14,9 +14,9 @@ plugins/modules/manageiq_tags.py validate-modules:parameter-state-invalid-choice
 plugins/modules/osx_defaults.py validate-modules:parameter-state-invalid-choice
 plugins/modules/parted.py validate-modules:parameter-state-invalid-choice
 plugins/modules/puppet.py validate-modules:parameter-invalid                          # invalid alias - removed in 7.0.0
-plugins/modules/rax_files_objects.py use-argspec-type-path
+plugins/modules/rax_files_objects.py use-argspec-type-path                            # module deprecated - removed in 9.0.0
-plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice
+plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice          # module deprecated - removed in 9.0.0
-plugins/modules/rax.py use-argspec-type-path # fix needed
+plugins/modules/rax.py use-argspec-type-path                                          # module deprecated - removed in 9.0.0
 plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice
 plugins/modules/xfconf.py validate-modules:return-syntax-error
 plugins/modules/yarn.py use-argspec-type-path

tests/sanity/ignore-2.13.txt

@@ -14,9 +14,9 @@ plugins/modules/manageiq_tags.py validate-modules:parameter-state-invalid-choice
 plugins/modules/osx_defaults.py validate-modules:parameter-state-invalid-choice
 plugins/modules/parted.py validate-modules:parameter-state-invalid-choice
 plugins/modules/puppet.py validate-modules:parameter-invalid                          # invalid alias - removed in 7.0.0
-plugins/modules/rax_files_objects.py use-argspec-type-path
+plugins/modules/rax_files_objects.py use-argspec-type-path                            # module deprecated - removed in 9.0.0
-plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice
+plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice          # module deprecated - removed in 9.0.0
-plugins/modules/rax.py use-argspec-type-path # fix needed
+plugins/modules/rax.py use-argspec-type-path                                          # module deprecated - removed in 9.0.0
 plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice
 plugins/modules/xfconf.py validate-modules:return-syntax-error
 plugins/modules/yarn.py use-argspec-type-path

tests/sanity/ignore-2.14.txt

@@ -15,9 +15,9 @@ plugins/modules/manageiq_tags.py validate-modules:parameter-state-invalid-choice
 plugins/modules/osx_defaults.py validate-modules:parameter-state-invalid-choice
 plugins/modules/parted.py validate-modules:parameter-state-invalid-choice
 plugins/modules/puppet.py validate-modules:parameter-invalid                          # invalid alias - removed in 7.0.0
-plugins/modules/rax_files_objects.py use-argspec-type-path
+plugins/modules/rax_files_objects.py use-argspec-type-path                            # module deprecated - removed in 9.0.0
-plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice
+plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice          # module deprecated - removed in 9.0.0
-plugins/modules/rax.py use-argspec-type-path # fix needed
+plugins/modules/rax.py use-argspec-type-path                                          # module deprecated - removed in 9.0.0
 plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice
 plugins/modules/udm_user.py import-3.11  # Uses deprecated stdlib library 'crypt'
 plugins/modules/xfconf.py validate-modules:return-syntax-error

tests/sanity/ignore-2.15.txt

@@ -15,9 +15,9 @@ plugins/modules/manageiq_tags.py validate-modules:parameter-state-invalid-choice
 plugins/modules/osx_defaults.py validate-modules:parameter-state-invalid-choice
 plugins/modules/parted.py validate-modules:parameter-state-invalid-choice
 plugins/modules/puppet.py validate-modules:parameter-invalid                          # invalid alias - removed in 7.0.0
-plugins/modules/rax_files_objects.py use-argspec-type-path
+plugins/modules/rax_files_objects.py use-argspec-type-path                            # module deprecated - removed in 9.0.0
-plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice
+plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice          # module deprecated - removed in 9.0.0
-plugins/modules/rax.py use-argspec-type-path # fix needed
+plugins/modules/rax.py use-argspec-type-path                                          # module deprecated - removed in 9.0.0
 plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice
 plugins/modules/udm_user.py import-3.11  # Uses deprecated stdlib library 'crypt'
 plugins/modules/xfconf.py validate-modules:return-syntax-error