Deprecate legacy roles (#311)

* Deprecate legacy roles
* Add deprecation module

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

Author: wmudge

.ansible-lint-ignore

@@ -25,6 +25,7 @@ roles/cloudera_manager/autotls/tasks/patch_old_cm.yml command-instead-of-shell
 roles/cloudera_manager/autotls/tasks/patch_old_cm.yml fqcn[action-core]
 roles/cloudera_manager/autotls/tasks/patch_old_cm.yml jinja[spacing]
 roles/cloudera_manager/autotls/tasks/patch_old_cm.yml no-changed-when
+roles/cloudera_manager/common/defaults/main.yml var-naming[no-role-prefix]
 roles/cloudera_manager/common/handlers/main.yml fqcn[action-core]
 roles/cloudera_manager/common/handlers/main.yml name[casing]
 roles/cloudera_manager/config/defaults/main.yml var-naming[no-role-prefix]

plugins/modules/deprecation.py

@@ -0,0 +1,64 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright 2025 Cloudera, Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+DOCUMENTATION = r"""
+module: deprecation
+short_description: Display a deprecation warning
+description:
+  - Displays a standard Ansible deprecation warning
+author:
+  - "Webster Mudge (@wmudge)"
+version_added: "5.0.0"
+options:
+  msg:
+    description:
+      - 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 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""""""
+
+from ansible.module_utils.basic import AnsibleModule
+
+
+if __name__ == "__main__":
+    module = AnsibleModule(
+        argument_spec=dict(
+            msg=dict(required="True"),
+            version=dict(),
+        ),
+    )
+
+    module.deprecate(module.params.get("msg"), module.params.get("version", None))
+    module.exit_json()

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

@@ -13,6 +13,13 @@
 # limitations under the License.
 
 ---
+
+- name: Deprecation warning
+  run_once: true
+  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' }}"
   ansible.builtin.wait_for:

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

@@ -13,6 +13,13 @@
 # limitations under the License.
 
 ---
+
+- name: Deprecation warning
+  run_once: true
+  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:
     endpoint: /users/admin

roles/cloudera_manager/agent/tasks/main.yml

@@ -13,6 +13,13 @@
 # limitations under the License.
 
 ---
+
+- name: Deprecation warning
+  run_once: true
+  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:
     manager: auto

roles/cloudera_manager/agent_config/tasks/main.yml

@@ -13,6 +13,13 @@
 # limitations under the License.
 
 ---
+
+- name: Deprecation warning
+  run_once: true
+  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:
     dest: "{{ cloudera_manager_agent_config_file }}"

roles/cloudera_manager/api_client/tasks/main.yml

@@ -13,6 +13,13 @@
 # limitations under the License.
 
 ---
+
+- name: Deprecation warning
+  run_once: true
+  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 }}"
   when: cloudera_manager_url is not defined

roles/cloudera_manager/api_hosts/tasks/main.yml

@@ -13,6 +13,13 @@
 # limitations under the License.
 
 ---
+
+- name: Deprecation warning
+  run_once: true
+  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' }}"
   cloudera.cluster.cm_api:

roles/cloudera_manager/autotls/tasks/main.yml

@@ -13,6 +13,13 @@
 # limitations under the License.
 
 ---
+
+- name: Deprecation warning
+  run_once: true
+  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:
     endpoint: /cm/version

roles/cloudera_manager/cms_tls/tasks/main.yml

@@ -1,4 +1,11 @@
 ---
+
+- name: Deprecation warning
+  run_once: true
+  cloudera.cluster.deprecation:
+    msg: "Role, {{ ansible_role_name }}, is no longer supported."
+    version: 6.0.0
+
 - name: Setup TLS for Activity Monitor
   cm_api:
     method: PUT