Update cluster and cluster_info results object and API

plugins/module_utils/cluster_utils.py

@@ -0,0 +1,46 @@
+# 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
+#
+#     https://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.
+
+"""
+A common functions for Cloudera Manager cluster management
+"""
+
+from ansible_collections.cloudera.cluster.plugins.module_utils.cm_utils import (
+    _parse_output,
+)
+
+from cm_client import ApiCluster
+
+
+CLUSTER_OUTPUT = [
+    "name",
+    "display_name",
+    # "full_version",
+    "maintenance_mode",
+    "maintenance_owners",
+    # "services",
+    # "parcels",
+    "entity_status",
+    "uuid",
+    # "data_context_refs",
+    "cluster_type",
+    "tags",
+]
+
+
+def parse_cluster_result(cluster: ApiCluster) -> dict:
+    # Retrieve full_version as version
+    output = dict(version=cluster.full_version)
+    output.update(_parse_output(cluster.to_dict(), CLUSTER_OUTPUT))
+    return output

plugins/module_utils/cm_utils.py

@@ -38,7 +38,6 @@
     ApiParcel,
     ApiRole,
     ApiRoleConfigGroup,
-    ApiService,
     Configuration,
 )
 from cm_client.rest import ApiException, RESTClientObject
@@ -49,23 +48,6 @@
 __credits__ = ["frisch@cloudera.com"]
 __maintainer__ = ["wmudge@cloudera.com"]
 
-
-SERVICE_OUTPUT = [
-    "client_config_staleness_status",
-    # "cluster_ref",
-    "config_staleness_status",
-    "display_name",
-    "health_checks",
-    "health_summary",
-    "maintenance_mode",
-    "maintenance_owners",
-    "name",
-    "service_state",
-    "service_version",
-    "tags",
-    "type",
-]
-
 ROLE_OUTPUT = [
     "commission_state",
     "config_staleness_status",
@@ -114,13 +96,6 @@ def _parse_output(entity: dict, filter: list) -> dict:
     return output
 
 
-def parse_service_result(service: ApiService) -> dict:
-    # Retrieve only the cluster_name
-    output = dict(cluster_name=service.cluster_ref.cluster_name)
-    output.update(_parse_output(service.to_dict(), SERVICE_OUTPUT))
-    return output
-
-
 def parse_role_result(role: ApiRole) -> dict:
     # Retrieve only the host_id, role_config_group, and service identifiers
     output = dict(

plugins/module_utils/service_utils.py

@@ -0,0 +1,46 @@
+# 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
+#
+#     https://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.
+
+"""
+A common functions for Cloudera Manager service management
+"""
+
+from ansible_collections.cloudera.cluster.plugins.module_utils.cm_utils import (
+    _parse_output,
+)
+
+from cm_client import ApiService
+
+SERVICE_OUTPUT = [
+    "client_config_staleness_status",
+    # "cluster_ref",
+    "config_staleness_status",
+    "display_name",
+    "health_checks",
+    "health_summary",
+    "maintenance_mode",
+    "maintenance_owners",
+    "name",
+    "service_state",
+    "service_version",
+    "tags",
+    "type",
+]
+
+
+def parse_service_result(service: ApiService) -> dict:
+    # Retrieve only the cluster_name
+    output = dict(cluster_name=service.cluster_ref.cluster_name)
+    output.update(_parse_output(service.to_dict(), SERVICE_OUTPUT))
+    return output