Skip to content

Commit 0779ae1

Browse files
committed
Rename service_role and service_role_info to role and role_info
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
1 parent 4ab40f4 commit 0779ae1

File tree

5 files changed

+90
-77
lines changed

5 files changed

+90
-77
lines changed

meta/runtime.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,16 @@ action_groups:
8686
- host
8787
- host_template
8888
- parcel
89+
90+
plugin_routing:
91+
modules:
92+
service_role:
93+
redirect: cloudera.cluster.role
94+
deprecation:
95+
removal_version: "5.0.0"
96+
warning_text: Use M(cloudera.cluster.role).
97+
service_role_info:
98+
redirect: cloudera.cluster.role_info
99+
deprecation:
100+
removal_version: "5.0.0"
101+
warning_text: Use M(cloudera.cluster.role_info).

plugins/modules/service_role.py renamed to plugins/modules/role.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
# limitations under the License.
1717

1818
DOCUMENTATION = r"""
19-
module: service_role
19+
module: role
2020
short_description: Manage a service role in cluster
2121
description:
2222
- Manage a service role in a cluster.
@@ -134,12 +134,12 @@
134134
requirements:
135135
- cm-client
136136
seealso:
137-
- module: cloudera.cluster.service_role_info
137+
- module: cloudera.cluster.role_info
138138
"""
139139

140140
EXAMPLES = r"""
141141
- name: Provision a service role
142-
cloudera.cluster.service_role:
142+
cloudera.cluster.role:
143143
host: example.cloudera.com
144144
username: "jane_smith"
145145
password: "S&peR4Ec*re"
@@ -149,7 +149,7 @@
149149
cluster_hostname: worker-01.cloudera.internal
150150
151151
- name: Set a service role to maintenance mode (using role name)
152-
cloudera.cluster.service_role:
152+
cloudera.cluster.role:
153153
host: example.cloudera.com
154154
username: "jane_smith"
155155
password: "S&peR4Ec*re"
@@ -159,7 +159,7 @@
159159
maintenance: true
160160
161161
- name: Update (append) tags to a service role
162-
cloudera.cluster.service_role:
162+
cloudera.cluster.role:
163163
host: example.cloudera.com
164164
username: "jane_smith"
165165
password: "S&peR4Ec*re"
@@ -172,7 +172,7 @@
172172
tag_two: value_two
173173
174174
- name: Set (purge) tags to a service role
175-
cloudera.cluster.service_role:
175+
cloudera.cluster.role:
176176
host: example.cloudera.com
177177
username: "jane_smith"
178178
cluster: example-cluster
@@ -184,7 +184,7 @@
184184
purge: true
185185
186186
- name: Remove all tags on a service role
187-
cloudera.cluster.service_role:
187+
cloudera.cluster.role:
188188
host: example.cloudera.com
189189
username: "jane_smith"
190190
password: "S&peR4Ec*re"
@@ -196,7 +196,7 @@
196196
purge: true
197197
198198
- name: Start a service role
199-
cloudera.cluster.service_role:
199+
cloudera.cluster.role:
200200
host: example.cloudera.com
201201
username: "jane_smith"
202202
password: "S&peR4Ec*re"
@@ -207,7 +207,7 @@
207207
state: started
208208
209209
- name: Force a restart to a service role
210-
cloudera.cluster.service_role:
210+
cloudera.cluster.role:
211211
host: example.cloudera.com
212212
username: "jane_smith"
213213
password: "S&peR4Ec*re"
@@ -218,7 +218,7 @@
218218
state: restarted
219219
220220
- name: Remove a service role
221-
cloudera.cluster.service_role:
221+
cloudera.cluster.role:
222222
host: example.cloudera.com
223223
username: "jane_smith"
224224
password: "S&peR4Ec*re"
@@ -389,9 +389,9 @@
389389
)
390390

391391

392-
class ClusterServiceRole(ClouderaManagerMutableModule):
392+
class Role(ClouderaManagerMutableModule):
393393
def __init__(self, module):
394-
super(ClusterServiceRole, self).__init__(module)
394+
super(Role, self).__init__(module)
395395

396396
# Set the parameters
397397
self.cluster = self.get_param("cluster")
@@ -729,7 +729,7 @@ def main():
729729
supports_check_mode=True,
730730
)
731731

732-
result = ClusterServiceRole(module)
732+
result = Role(module)
733733

734734
output = dict(
735735
changed=result.changed,

plugins/modules/service_role_info.py renamed to plugins/modules/role_info.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
# limitations under the License.
1717

1818
DOCUMENTATION = r"""
19-
module: service_role_info
19+
module: role_info
2020
short_description: Retrieve information about the service roles of cluster
2121
description:
2222
- Gather information about one or all service roles of a CDP cluster.
@@ -85,20 +85,20 @@
8585
requirements:
8686
- cm_client
8787
seealso:
88-
- module: cloudera.cluster.service_role
88+
- module: cloudera.cluster.role
8989
"""
9090

9191
EXAMPLES = r"""
9292
- name: Gather details of the roles for the 'yarn' service
93-
cloudera.cluster.service_role_info:
93+
cloudera.cluster.role_info:
9494
host: "example.cloudera.host"
9595
username: "jane_person"
9696
password: "S&peR4Ec*re"
9797
cluster: ExampleCluster
9898
service: yarn
9999
100100
- name: Gather the details with additional healthcheck information for the roles in the 'ecs' service
101-
cloudera.cluster.service_role_info:
101+
cloudera.cluster.role_info:
102102
host: "example.cloudera.host"
103103
username: "jane_person"
104104
password: "S&peR4Ec*re"
@@ -107,7 +107,7 @@
107107
view: healthcheck
108108
109109
- name: Gather details of the 'NODEMANAGER' roles for the 'yarn' service
110-
cloudera.cluster.service_role_info:
110+
cloudera.cluster.role_info:
111111
host: "example.cloudera.host"
112112
username: "jane_person"
113113
password: "S&peR4Ec*re"
@@ -116,7 +116,7 @@
116116
type: NODEMANAGER
117117
118118
- name: Gather details of the roles for the 'yarn' service on a particular cluster host
119-
cloudera.cluster.service_role_info:
119+
cloudera.cluster.role_info:
120120
host: "example.cloudera.host"
121121
username: "jane_person"
122122
password: "S&peR4Ec*re"
@@ -269,9 +269,9 @@
269269
from cm_client.rest import ApiException
270270

271271

272-
class ClusterServiceRoleInfo(ClouderaManagerModule):
272+
class RoleInfo(ClouderaManagerModule):
273273
def __init__(self, module):
274-
super(ClusterServiceRoleInfo, self).__init__(module)
274+
super(RoleInfo, self).__init__(module)
275275

276276
# Set the parameters
277277
self.cluster = self.get_param("cluster")
@@ -367,7 +367,7 @@ def main():
367367
supports_check_mode=True,
368368
)
369369

370-
result = ClusterServiceRoleInfo(module)
370+
result = RoleInfo(module)
371371

372372
output = dict(
373373
changed=False,

0 commit comments

Comments
 (0)