rax modules: deprecation notice for branch stable-6 (#5733)

* rax modules: deprecation notice for branch stable-6

* add changelog fragment

* adjust changelog message

* adjust changelog message

changelogs/fragments/5733-rax-deprecation-notice.yml

@@ -0,0 +1,27 @@
+deprecated_features:
+  - rax_cbs_attachments - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_cbs - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_cdb_database - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_cdb - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_cdb_user - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_clb_nodes - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_clb - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_clb_ssl - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_dns - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_dns_record - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_facts - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_files_objects - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_files - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_identity - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_keypair - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_meta - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_mon_alarm - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_mon_check - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_mon_entity - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_mon_notification_plan - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_mon_notification - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_network - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_queue - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_scaling_group - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).
+  - rax_scaling_policy - module relies on deprecates library ``pyrax``. Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0 (https://github.com/ansible-collections/community.general/pull/5733).

plugins/modules/rax_cbs.py

@@ -13,7 +13,9 @@ DOCUMENTATION = '''
 module: rax_cbs
 short_description: Manipulate Rackspace Cloud Block Storage Volumes
 description:
-     - Manipulate Rackspace Cloud Block Storage Volumes
+  - Manipulate Rackspace Cloud Block Storage Volumes
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   description:
     type: str

plugins/modules/rax_cbs_attachments.py

@@ -13,7 +13,9 @@ DOCUMENTATION = '''
 module: rax_cbs_attachments
 short_description: Manipulate Rackspace Cloud Block Storage Volume Attachments
 description:
-     - Manipulate Rackspace Cloud Block Storage Volume Attachments
+  - Manipulate Rackspace Cloud Block Storage Volume Attachments
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   device:
     type: str

plugins/modules/rax_cdb.py

@@ -16,6 +16,8 @@ description:
   - creates / deletes or resize a Rackspace Cloud Databases instance
     and optionally waits for it to be 'running'. The name option needs to be
     unique since it's used to identify the instance.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   name:
     type: str

plugins/modules/rax_cdb_database.py

@@ -13,6 +13,8 @@ module: rax_cdb_database
 short_description: Create / delete a database in the Cloud Databases
 description:
   - create / delete a database in the Cloud Databases.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   cdb_id:
     type: str

plugins/modules/rax_cdb_user.py

@@ -14,6 +14,8 @@ module: rax_cdb_user
 short_description: Create / delete a Rackspace Cloud Database
 description:
   - create / delete a database in the Cloud Databases.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   cdb_id:
     type: str

plugins/modules/rax_clb.py

@@ -13,7 +13,9 @@ DOCUMENTATION = '''
 module: rax_clb
 short_description: Create / delete a load balancer in Rackspace Public Cloud
 description:
-     - creates / deletes a Rackspace Public Cloud load balancer.
+  - creates / deletes a Rackspace Public Cloud load balancer.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   algorithm:
     type: str

plugins/modules/rax_clb_nodes.py

@@ -13,7 +13,9 @@ DOCUMENTATION = '''
 module: rax_clb_nodes
 short_description: Add, modify and remove nodes from a Rackspace Cloud Load Balancer
 description:
-  - Adds, modifies and removes nodes from a Rackspace Cloud Load Balancer
+  - Adds, modifies and removes nodes from a Rackspace Cloud Load Balancer.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   address:
     type: str

plugins/modules/rax_clb_ssl.py

@@ -12,7 +12,9 @@ DOCUMENTATION = '''
 module: rax_clb_ssl
 short_description: Manage SSL termination for a Rackspace Cloud Load Balancer
 description:
-- Set up, reconfigure, or remove SSL termination for an existing load balancer.
+  - Set up, reconfigure, or remove SSL termination for an existing load balancer.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   loadbalancer:
     type: str

plugins/modules/rax_dns.py

@@ -13,7 +13,9 @@ DOCUMENTATION = '''
 module: rax_dns
 short_description: Manage domains on Rackspace Cloud DNS
 description:
-     - Manage domains on Rackspace Cloud DNS
+  - Manage domains on Rackspace Cloud DNS.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   comment:
     type: str

plugins/modules/rax_dns_record.py

@@ -13,7 +13,9 @@ DOCUMENTATION = '''
 module: rax_dns_record
 short_description: Manage DNS records on Rackspace Cloud DNS
 description:
-     - Manage DNS records on Rackspace Cloud DNS
+  - Manage DNS records on Rackspace Cloud DNS.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   comment:
     type: str

plugins/modules/rax_facts.py

@@ -14,6 +14,8 @@ module: rax_facts
 short_description: Gather facts for Rackspace Cloud Servers
 description:
   - Gather facts for Rackspace Cloud Servers.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   address:
     type: str

plugins/modules/rax_files.py

@@ -13,7 +13,9 @@ DOCUMENTATION = '''
 module: rax_files
 short_description: Manipulate Rackspace Cloud Files Containers
 description:
-  - Manipulate Rackspace Cloud Files Containers
+  - Manipulate Rackspace Cloud Files Containers.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   clear_meta:
     description:

plugins/modules/rax_files_objects.py

@@ -14,6 +14,8 @@ module: rax_files_objects
 short_description: Upload, download, and delete objects in Rackspace Cloud Files
 description:
   - Upload, download, and delete objects in Rackspace Cloud Files.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   clear_meta:
     description:

plugins/modules/rax_identity.py

@@ -13,7 +13,9 @@ DOCUMENTATION = '''
 module: rax_identity
 short_description: Load Rackspace Cloud Identity
 description:
-     - Verifies Rackspace Cloud credentials and returns identity information
+  - Verifies Rackspace Cloud credentials and returns identity information.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   state:
     type: str

plugins/modules/rax_keypair.py

@@ -13,7 +13,9 @@ DOCUMENTATION = '''
 module: rax_keypair
 short_description: Create a keypair for use with Rackspace Cloud Servers
 description:
-     - Create a keypair for use with Rackspace Cloud Servers
+  - Create a keypair for use with Rackspace Cloud Servers.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   name:
     type: str

plugins/modules/rax_meta.py

@@ -13,7 +13,9 @@ DOCUMENTATION = '''
 module: rax_meta
 short_description: Manipulate metadata for Rackspace Cloud Servers
 description:
-     - Manipulate metadata for Rackspace Cloud Servers
+  - Manipulate metadata for Rackspace Cloud Servers.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   address:
     type: str

plugins/modules/rax_mon_alarm.py

@@ -13,12 +13,14 @@ DOCUMENTATION = '''
 module: rax_mon_alarm
 short_description: Create or delete a Rackspace Cloud Monitoring alarm
 description:
-- Create or delete a Rackspace Cloud Monitoring alarm that associates an
+  - Create or delete a Rackspace Cloud Monitoring alarm that associates an
-  existing rax_mon_entity, rax_mon_check, and rax_mon_notification_plan with
+    existing rax_mon_entity, rax_mon_check, and rax_mon_notification_plan with
-  criteria that specify what conditions will trigger which levels of
+    criteria that specify what conditions will trigger which levels of
-  notifications. Rackspace monitoring module flow | rax_mon_entity ->
+    notifications. Rackspace monitoring module flow | rax_mon_entity ->
-  rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan ->
+    rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan ->
-  *rax_mon_alarm*
+    *rax_mon_alarm*.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   state:
     type: str

plugins/modules/rax_mon_check.py

@@ -14,12 +14,14 @@ module: rax_mon_check
 short_description: Create or delete a Rackspace Cloud Monitoring check for an
                    existing entity.
 description:
-- Create or delete a Rackspace Cloud Monitoring check associated with an
+  - Create or delete a Rackspace Cloud Monitoring check associated with an
-  existing rax_mon_entity. A check is a specific test or measurement that is
+    existing rax_mon_entity. A check is a specific test or measurement that is
-  performed, possibly from different monitoring zones, on the systems you
+    performed, possibly from different monitoring zones, on the systems you
-  monitor. Rackspace monitoring module flow | rax_mon_entity ->
+    monitor. Rackspace monitoring module flow | rax_mon_entity ->
-  *rax_mon_check* -> rax_mon_notification -> rax_mon_notification_plan ->
+    *rax_mon_check* -> rax_mon_notification -> rax_mon_notification_plan ->
-  rax_mon_alarm
+    rax_mon_alarm
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   state:
     type: str

plugins/modules/rax_mon_entity.py

@@ -13,11 +13,13 @@ DOCUMENTATION = '''
 module: rax_mon_entity
 short_description: Create or delete a Rackspace Cloud Monitoring entity
 description:
-- Create or delete a Rackspace Cloud Monitoring entity, which represents a device
+  - Create or delete a Rackspace Cloud Monitoring entity, which represents a device
-  to monitor. Entities associate checks and alarms with a target system and
+    to monitor. Entities associate checks and alarms with a target system and
-  provide a convenient, centralized place to store IP addresses. Rackspace
+    provide a convenient, centralized place to store IP addresses. Rackspace
-  monitoring module flow | *rax_mon_entity* -> rax_mon_check ->
+    monitoring module flow | *rax_mon_entity* -> rax_mon_check ->
-  rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm
+    rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   label:
     type: str

plugins/modules/rax_mon_notification_plan.py

@@ -14,10 +14,12 @@ module: rax_mon_notification_plan
 short_description: Create or delete a Rackspace Cloud Monitoring notification
                    plan.
 description:
-- Create or delete a Rackspace Cloud Monitoring notification plan by
+  - Create or delete a Rackspace Cloud Monitoring notification plan by
-  associating existing rax_mon_notifications with severity levels. Rackspace
+    associating existing rax_mon_notifications with severity levels. Rackspace
-  monitoring module flow | rax_mon_entity -> rax_mon_check ->
+    monitoring module flow | rax_mon_entity -> rax_mon_check ->
-  rax_mon_notification -> *rax_mon_notification_plan* -> rax_mon_alarm
+    rax_mon_notification -> *rax_mon_notification_plan* -> rax_mon_alarm.
+  - This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
+  - Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
 options:
   state:
     type: str