Rename warn module to deprecation and add version parameter

Signed-off-by: Webster Mudge <[email protected]>

Author: wmudge

plugins/modules/warn.py renamed to plugins/modules/deprecation.py

@@ -16,25 +16,35 @@
 # limitations under the License.
 
 DOCUMENTATION = r"""
-module: warn
-short_description: Display a warning
+module: deprecation
+short_description: Display a deprecation warning
 description:
-  - Displays a standard Ansible module warning.
+  - Displays a standard Ansible deprecation warning
 author:
   - "Webster Mudge (@wmudge)"
 version_added: "5.0.0"
 options:
   msg:
     description:
-      - The warning message.
+      - The deprecation warning message.
     type: str
     required: true
+  version:
+    description:
+      - Version details for the warning message.
+    type: str
+    required: false
 """
 
 EXAMPLES = r"""
-- name: Display a warning
-  cloudera.cluster.warn:
-    msg: This is a warning message.
+- name: Display a deprecation warning
+  cloudera.cluster.deprecation:
+    msg: A custom warning
+
+- name: Display the deprecation warning with version details
+  cloudera.cluster.deprecation:
+    msg: A custom warning with version info
+    version: "5.0.0"
 """
 
 RETURN = r""""""
@@ -46,8 +56,9 @@
     module = AnsibleModule(
         argument_spec=dict(
             msg=dict(required="True"),
+            version=dict(),
         ),
     )
 
-    module.warn(module.params["msg"])
+    module.deprecate(module.params.get("msg"), module.params.get("version", None))
     module.exit_json()

roles/cloudera_manager/admin_password/check/tasks/main.yml

@@ -15,10 +15,10 @@
 ---
 
 - name: Deprecation warning
-  when: deprecation_msg is defined
   run_once: true
-  cloudera.cluster.warn:
-    msg: "{{ deprecation_msg }}"
+  cloudera.cluster.deprecation:
+    msg: "Role, {{ ansible_role_name }}, is no longer supported."
+    version: 6.0.0
 
 - name: Wait for Cloudera Manager Port to be up
   delegate_to: "{{ groups.cloudera_manager[0] if 'cloudera_manager' in groups else 'localhost' }}"

roles/cloudera_manager/admin_password/set/tasks/main.yml

@@ -15,10 +15,10 @@
 ---
 
 - name: Deprecation warning
-  when: deprecation_msg is defined
   run_once: true
-  cloudera.cluster.warn:
-    msg: "{{ deprecation_msg }}"
+  cloudera.cluster.deprecation:
+    msg: "Role, {{ ansible_role_name }}, is no longer supported."
+    version: 6.0.0
 
 - name: Update the Cloudera Manager admin password
   cloudera.cluster.cm_api:

roles/cloudera_manager/agent/tasks/main.yml

@@ -15,10 +15,10 @@
 ---
 
 - name: Deprecation warning
-  when: deprecation_msg is defined
   run_once: true
-  cloudera.cluster.warn:
-    msg: "{{ deprecation_msg }}"
+  cloudera.cluster.deprecation:
+    msg: "Role, {{ ansible_role_name }}, is no longer supported."
+    version: 6.0.0
 
 - name: Gather the package facts
   ansible.builtin.package_facts:

roles/cloudera_manager/agent_config/tasks/main.yml

@@ -15,10 +15,10 @@
 ---
 
 - name: Deprecation warning
-  when: deprecation_msg is defined
   run_once: true
-  cloudera.cluster.warn:
-    msg: "{{ deprecation_msg }}"
+  cloudera.cluster.deprecation:
+    msg: "Role, {{ ansible_role_name }}, is no longer supported."
+    version: 6.0.0
 
 - name: Set Cloudera Manager agent 'server_host' in config.ini
   lineinfile:

roles/cloudera_manager/api_client/tasks/main.yml

@@ -15,10 +15,10 @@
 ---
 
 - name: Deprecation warning
-  when: deprecation_msg is defined
   run_once: true
-  cloudera.cluster.warn:
-    msg: "{{ deprecation_msg }}"
+  cloudera.cluster.deprecation:
+    msg: "Role, {{ ansible_role_name }}, is no longer supported."
+    version: 6.0.0
 
 - set_fact:
     cloudera_manager_url: "{{ cloudera_manager_protocol }}://{{ cloudera_manager_host }}:{{ cloudera_manager_port }}"

roles/cloudera_manager/api_hosts/tasks/main.yml

@@ -15,10 +15,10 @@
 ---
 
 - name: Deprecation warning
-  when: deprecation_msg is defined
   run_once: true
-  cloudera.cluster.warn:
-    msg: "{{ deprecation_msg }}"
+  cloudera.cluster.deprecation:
+    msg: "Role, {{ ansible_role_name }}, is no longer supported."
+    version: 6.0.0
 
 - name: Get the host identifiers and names from Cloudera Manager
   delegate_to: "{{ groups.cloudera_manager[0] if 'cloudera_manager' in groups else 'localhost' }}"

roles/cloudera_manager/autotls/tasks/main.yml

@@ -15,10 +15,10 @@
 ---
 
 - name: Deprecation warning
-  when: deprecation_msg is defined
   run_once: true
-  cloudera.cluster.warn:
-    msg: "{{ deprecation_msg }}"
+  cloudera.cluster.deprecation:
+    msg: "Role, {{ ansible_role_name }}, is no longer supported."
+    version: 6.0.0
 
 - name: Check Cloudera Manager version
   cloudera.cluster.cm_api:

roles/cloudera_manager/cms_tls/tasks/main.yml

@@ -1,10 +1,10 @@
 ---
 
 - name: Deprecation warning
-  when: deprecation_msg is defined
   run_once: true
-  cloudera.cluster.warn:
-    msg: "{{ deprecation_msg }}"
+  cloudera.cluster.deprecation:
+    msg: "Role, {{ ansible_role_name }}, is no longer supported."
+    version: 6.0.0
 
 - name: Setup TLS for Activity Monitor
   cm_api:

roles/cloudera_manager/common/defaults/main.yml

@@ -30,9 +30,3 @@ cloudera_manager_database_password: changeme
 cloudera_manager_database_port: "{{ database_type | cloudera.cluster.default_database_port }}"
 cloudera_manager_agent_lib_directory: /var/lib/cloudera-scm-agent
 cloudera_manager_cmf_java_opts_default: "-Xmx4G -XX:MaxPermSize=256m -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/tmp"
-
-deprecation_msg: |
-  This role will be removed from the collection in release 6.0.0.
-  Please refer to the collection README for details.
-  Deprecation warnings can be disabled by setting deprecation_warnings=False in
-  ansible.cfg.