Add cluster service and related resource modules

docsbuild/cloudera.css

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2024 Cloudera, Inc.
+ * 
+ * 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.
+ */
+

plugins/doc_fragments/cm_options.py

@@ -91,4 +91,14 @@ class ModuleDocFragment(object):
             type: str
             required: False
             default: ClouderaFoundry
+            aliases:
+                - user_agent
+        proxy_server:
+            description:
+                - Set the HTTP/S proxy server when interacting with the CM API endpoint.
+            type: str
+            required: False
+            aliases:
+                - proxy
+                - http_proxy
     """

plugins/doc_fragments/message.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright 2024 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.
+
+class ModuleDocFragment(object):
+    DOCUMENTATION = r'''
+    options:
+        message:
+            description:
+                - Message to log for any changes to the entity.
+            type: str
+            required: False
+            default: "Managed by Ansible"
+            aliases:
+                - msg
+    '''

plugins/doc_fragments/purge.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright 2024 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.
+
+class ModuleDocFragment(object):
+    DOCUMENTATION = r'''
+    options:
+        purge:
+            description:
+                - Set all parameters to either their default or declared values.
+            type: bool
+            required: False
+            default: False
+    '''

plugins/lookup/cm_service.py

@@ -12,10 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from __future__ import (absolute_import, division, print_function)
+from __future__ import absolute_import, division, print_function
+
 __metaclass__ = type
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
     lookup: cm_service
     author: Webster Mudge (@wmudge) <wmudge@cloudera.com>
     short_description: Get the details for a service on a CDP Datahub cluster
@@ -83,35 +84,46 @@
             description: Value to return if no service is found on the cluster.
             type: any
         version:
-            description: Version number of the Cloudera Manager API.
+            description: Version of the Cloudera Manager API.
             type: string
-            default: v40
         agent_header:
             description: Header string to identify the connection.
             type: string
             default: cm_service     
     notes:
         - Requires C(cm_client).
-'''
+"""
 
-from ansible_collections.cloudera.cluster.plugins.module_utils.cm_controller_utils import ClouderaManagerLookupBase
+from ansible_collections.cloudera.cluster.plugins.module_utils.cm_controller_utils import (
+    ClouderaManagerLookupBase,
+)
 
 
 class LookupModule(ClouderaManagerLookupBase):
     def run(self, terms, variables=None, **kwargs):
         self.set_options(var_options=variables, direct=kwargs)
-        
+
         self.initialize_client()
-        all_services = {service['type']:service for service in self.get("%s/clusters/%s/services" % (self.get_option('version'), self.get_option('cluster')))}
-
+        all_services = {
+            service["type"]: service
+            for service in self.get(
+                "/%s/clusters/%s/services"
+                % (self.get_option("version"), self.get_option("cluster"))
+            )
+        }
+
         results = []
         for term in LookupModule._flatten(terms):
             if term in all_services:
-                results.append(all_services[term] if self.get_option('detailed') else all_services[term]['name'])
+                results.append(
+                    all_services[term]
+                    if self.get_option("detailed")
+                    else all_services[term]["name"]
+                )
             else:
-                if self.get_option('default') is not None:
-                    results.append(self.get_option('default'))
-                elif self.get_option('detailed'):
+                if self.get_option("default") is not None:
+                    results.append(self.get_option("default"))
+                elif self.get_option("detailed"):
                     results.append({})
                 else:
                     results.append("")

plugins/module_utils/cm_controller_utils.py

@@ -66,7 +66,7 @@ def initialize_client(self):
 
         # If provided a CM API endpoint URL, use it directly
         if self.get_option("endpoint"):
-            config.host = self.get_option("endpoint")
+            config.host = str(self.get_option("endpoint")).strip("/ ")
         # Otherwise, run discovery on missing parts
         else:
             config.host = self._discover_endpoint(config)