Rename service_role and service_role_info modules

meta/runtime.yml

@@ -162,3 +162,14 @@ plugin_routing:
       deprecation:
         removal_version: "6.0.0"
         warning_text: Use M(cloudera.cluster.cm_resource).
+  modules:
+    service_role:
+      redirect: cloudera.cluster.role
+      deprecation:
+        removal_version: "5.0.0"
+        warning_text: Use M(cloudera.cluster.role).
+    service_role_info:
+      redirect: cloudera.cluster.role_info
+      deprecation:
+        removal_version: "5.0.0"
+        warning_text: Use M(cloudera.cluster.role_info).

plugins/modules/service_role.py → plugins/modules/role.py

@@ -16,7 +16,7 @@
 # limitations under the License.
 
 DOCUMENTATION = r"""
-module: service_role
+module: role
 short_description: Manage a service role in cluster
 description:
   - Manage a service role in a cluster.
@@ -134,12 +134,12 @@
 requirements:
   - cm-client
 seealso:
-  - module: cloudera.cluster.service_role_info
+  - module: cloudera.cluster.role_info
 """
 
 EXAMPLES = r"""
 - name: Provision a service role
-  cloudera.cluster.service_role:
+  cloudera.cluster.role:
     host: example.cloudera.com
     username: "jane_smith"
     password: "S&peR4Ec*re"
@@ -149,7 +149,7 @@
     cluster_hostname: worker-01.cloudera.internal
 
 - name: Set a service role to maintenance mode (using role name)
-  cloudera.cluster.service_role:
+  cloudera.cluster.role:
     host: example.cloudera.com
     username: "jane_smith"
     password: "S&peR4Ec*re"
@@ -159,7 +159,7 @@
     maintenance: true
 
 - name: Update (append) tags to a service role
-  cloudera.cluster.service_role:
+  cloudera.cluster.role:
     host: example.cloudera.com
     username: "jane_smith"
     password: "S&peR4Ec*re"
@@ -172,7 +172,7 @@
       tag_two: value_two
 
 - name: Set (purge) tags to a service role
-  cloudera.cluster.service_role:
+  cloudera.cluster.role:
     host: example.cloudera.com
     username: "jane_smith"
     cluster: example-cluster
@@ -184,7 +184,7 @@
     purge: true
 
 - name: Remove all tags on a service role
-  cloudera.cluster.service_role:
+  cloudera.cluster.role:
     host: example.cloudera.com
     username: "jane_smith"
     password: "S&peR4Ec*re"
@@ -196,7 +196,7 @@
     purge: true
 
 - name: Start a service role
-  cloudera.cluster.service_role:
+  cloudera.cluster.role:
     host: example.cloudera.com
     username: "jane_smith"
     password: "S&peR4Ec*re"
@@ -207,7 +207,7 @@
     state: started
 
 - name: Force a restart to a service role
-  cloudera.cluster.service_role:
+  cloudera.cluster.role:
     host: example.cloudera.com
     username: "jane_smith"
     password: "S&peR4Ec*re"
@@ -218,7 +218,7 @@
     state: restarted
 
 - name: Remove a service role
-  cloudera.cluster.service_role:
+  cloudera.cluster.role:
     host: example.cloudera.com
     username: "jane_smith"
     password: "S&peR4Ec*re"
@@ -389,9 +389,9 @@
 )
 
 
-class ClusterServiceRole(ClouderaManagerMutableModule):
+class Role(ClouderaManagerMutableModule):
     def __init__(self, module):
-        super(ClusterServiceRole, self).__init__(module)
+        super(Role, self).__init__(module)
 
         # Set the parameters
         self.cluster = self.get_param("cluster")
@@ -729,7 +729,7 @@ def main():
         supports_check_mode=True,
     )
 
-    result = ClusterServiceRole(module)
+    result = Role(module)
 
     output = dict(
         changed=result.changed,

plugins/modules/service_role_info.py → plugins/modules/role_info.py

@@ -16,7 +16,7 @@
 # limitations under the License.
 
 DOCUMENTATION = r"""
-module: service_role_info
+module: role_info
 short_description: Retrieve information about the service roles of cluster
 description:
   - Gather information about one or all service roles of a CDP cluster.
@@ -85,20 +85,20 @@
 requirements:
   - cm_client
 seealso:
-  - module: cloudera.cluster.service_role
+  - module: cloudera.cluster.role
 """
 
 EXAMPLES = r"""
 - name: Gather details of the roles for the 'yarn' service
-  cloudera.cluster.service_role_info:
+  cloudera.cluster.role_info:
     host: "example.cloudera.host"
     username: "jane_person"
     password: "S&peR4Ec*re"
     cluster: ExampleCluster
     service: yarn
 
 - name: Gather the details with additional healthcheck information for the roles in the 'ecs' service
-  cloudera.cluster.service_role_info:
+  cloudera.cluster.role_info:
     host: "example.cloudera.host"
     username: "jane_person"
     password: "S&peR4Ec*re"
@@ -107,7 +107,7 @@
     view: healthcheck
 
 - name: Gather details of the 'NODEMANAGER' roles for the 'yarn' service
-  cloudera.cluster.service_role_info:
+  cloudera.cluster.role_info:
     host: "example.cloudera.host"
     username: "jane_person"
     password: "S&peR4Ec*re"
@@ -116,7 +116,7 @@
     type: NODEMANAGER
 
 - name: Gather details of the roles for the 'yarn' service on a particular cluster host
-  cloudera.cluster.service_role_info:
+  cloudera.cluster.role_info:
     host: "example.cloudera.host"
     username: "jane_person"
     password: "S&peR4Ec*re"
@@ -269,9 +269,9 @@
 from cm_client.rest import ApiException
 
 
-class ClusterServiceRoleInfo(ClouderaManagerModule):
+class RoleInfo(ClouderaManagerModule):
     def __init__(self, module):
-        super(ClusterServiceRoleInfo, self).__init__(module)
+        super(RoleInfo, self).__init__(module)
 
         # Set the parameters
         self.cluster = self.get_param("cluster")
@@ -367,7 +367,7 @@ def main():
         supports_check_mode=True,
     )
 
-    result = ClusterServiceRoleInfo(module)
+    result = RoleInfo(module)
 
     output = dict(
         changed=False,