diff --git a/docsbuild/build.sh b/docsbuild/build.sh index 9b4d18b4..9e627287 100755 --- a/docsbuild/build.sh +++ b/docsbuild/build.sh @@ -8,7 +8,7 @@ pushd "$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" trap "{ popd; }" EXIT # Create collection documentation into temporary directory -rm -rf temp-rst +rm -rf temp-rst rst build mkdir -p temp-rst chmod og-w temp-rst # antsibull-docs wants that directory only readable by itself antsibull-docs \ diff --git a/plugins/modules/cm_config.py b/plugins/modules/cm_config.py index 7d9ca44b..f26b60e5 100644 --- a/plugins/modules/cm_config.py +++ b/plugins/modules/cm_config.py @@ -45,6 +45,7 @@ aliases: - params extends_documentation_fragment: + - ansible.builtin.action_common_attributes - cloudera.cluster.cm_options - cloudera.cluster.cm_endpoint - cloudera.cluster.purge @@ -54,6 +55,8 @@ support: full diff_mode: support: full + platform: + platforms: all """ EXAMPLES = r""" diff --git a/plugins/modules/cm_license.py b/plugins/modules/cm_license.py index 4aca0bdc..63423d8f 100644 --- a/plugins/modules/cm_license.py +++ b/plugins/modules/cm_license.py @@ -64,19 +64,19 @@ returned: optional expiration: description: Expiration date of the license - type: date + type: str returned: optional features: - description: List of features within the license + description: List of features within the license type: list returned: optional deactivation_date: description: Date until license is valid - type: date + type: str returned: optional start_date: - description: License activation date - type: date + description: License activation date + type: str returned: optional """ diff --git a/plugins/modules/cm_license_info.py b/plugins/modules/cm_license_info.py index 3e3fdaf4..a909c85d 100644 --- a/plugins/modules/cm_license_info.py +++ b/plugins/modules/cm_license_info.py @@ -62,7 +62,7 @@ returned: optional expiration: description: Expiration date of the license - type: date + type: str returned: optional features: description: List of features within the license @@ -70,11 +70,11 @@ returned: optional deactivation_date: description: Date until license is valid - type: date + type: str returned: optional start_date: description: License activation date - type: date + type: str returned: optional """ diff --git a/plugins/modules/cm_trial_license.py b/plugins/modules/cm_trial_license.py index 71f1e3b1..6988d0b2 100644 --- a/plugins/modules/cm_trial_license.py +++ b/plugins/modules/cm_trial_license.py @@ -64,7 +64,7 @@ returned: optional expiration: description: Expiration date of trial license - type: date + type: str returned: optional features: description: List of features within the trial license @@ -72,11 +72,11 @@ returned: optional deactivation_date: description: Date until trial is active - type: date + type: str returned: optional start_date: description: trial activation date - type: date + type: str returned: optional """ diff --git a/plugins/modules/host.py b/plugins/modules/host.py index 218109b5..b9278de2 100644 --- a/plugins/modules/host.py +++ b/plugins/modules/host.py @@ -71,9 +71,17 @@ - 'attached' - 'detached' required: False +extends_documentation_fragment: + - ansible.builtin.action_common_attributes + - cloudera.cluster.cm_options + - cloudera.cluster.cm_endpoint attributes: check_mode: support: full + diff_mode: + support: none + platform: + platforms: all """ EXAMPLES = r""" diff --git a/plugins/modules/parcel.py b/plugins/modules/parcel.py index 206837e8..fc537a44 100644 --- a/plugins/modules/parcel.py +++ b/plugins/modules/parcel.py @@ -41,7 +41,7 @@ author: - "Ronald Suplina (@rsuplina)" requirements: - - cm_client + - cm-client options: cluster_name: description: @@ -71,6 +71,17 @@ - 'present' - 'absent' required: False +extends_documentation_fragment: + - ansible.builtin.action_common_attributes + - cloudera.cluster.cm_options + - cloudera.cluster.cm_endpoint +attributes: + check_mode: + support: full + diff_mode: + support: full + platform: + platforms: all """ EXAMPLES = r""" @@ -105,7 +116,7 @@ parcel_version: "1.5.1-b626-ecs-1.5.1-b626.p0.42068229" state: "absent" -- name: Undistribute the parcel on a specified cluster +- name: Undistribute the parcel on a specified cluster (if "distributed" or "activated") cloudera.cluster.parcel: host: example.cloudera.com username: "jane_smith" @@ -113,7 +124,7 @@ cluster_name: "Example_Cluster" product: "ECS" parcel_version: "1.5.1-b626-ecs-1.5.1-b626.p0.42068229" - state: "downloaded" # Assuming the current state is "distributed" or "activated" + state: "downloaded" # Assuming the current state as stated above """ @@ -124,7 +135,7 @@ type: dict contains: product: - product: The name of the product. + description: The name of the product. type: str returned: always version: diff --git a/plugins/modules/parcel_info.py b/plugins/modules/parcel_info.py index b421ef92..ddc9f574 100644 --- a/plugins/modules/parcel_info.py +++ b/plugins/modules/parcel_info.py @@ -80,11 +80,11 @@ elements: dict contains: product: - product: The name of the product. + description: The name of the product. type: str returned: always version: - description: The version of the product + description: The version of the product. type: str returned: always stage: @@ -92,11 +92,13 @@ type: str returned: always state: - description: The state of the parcel. This shows the progress of state transitions and if there were any errors. + description: + - The state of the parcel. + - Shows the progress of state transitions and reports any errors. type: dict returned: always clusterRef: - description: A reference to the enclosing cluster. + description: A reference to the enclosing cluster. type: dict returned: always displayName: diff --git a/plugins/modules/service.py b/plugins/modules/service.py index e81a348f..e0423b91 100644 --- a/plugins/modules/service.py +++ b/plugins/modules/service.py @@ -44,7 +44,7 @@ author: - "Webster Mudge (@wmudge)" requirements: - - cm_client + - cm-client options: cluster: description: @@ -101,6 +101,7 @@ - started - stopped extends_documentation_fragment: + - ansible.builtin.action_common_attributes - cloudera.cluster.cm_options - cloudera.cluster.cm_endpoint attributes: @@ -108,6 +109,8 @@ support: full diff_mode: support: full + platform: + platforms: all """ EXAMPLES = r""" diff --git a/plugins/modules/service_config.py b/plugins/modules/service_config.py index 943c97ea..e0a35a19 100644 --- a/plugins/modules/service_config.py +++ b/plugins/modules/service_config.py @@ -44,7 +44,7 @@ author: - "Webster Mudge (@wmudge)" requirements: - - cm_client + - cm-client options: cluster: description: @@ -78,6 +78,7 @@ - summary - full extends_documentation_fragment: + - ansible.builtin.action_common_attributes - cloudera.cluster.cm_options - cloudera.cluster.cm_endpoint - cloudera.cluster.purge @@ -87,10 +88,11 @@ support: full diff_mode: support: full + platform: + platforms: all """ EXAMPLES = r""" ---- - name: Update (append) several service-wide parameters cloudera.cluster.service_config: host: example.cloudera.com @@ -136,7 +138,6 @@ """ RETURN = r""" ---- config: description: Service-wide configuration details about a cluster service. type: list diff --git a/plugins/modules/service_role.py b/plugins/modules/service_role.py index f4d29949..f9bed4a1 100644 --- a/plugins/modules/service_role.py +++ b/plugins/modules/service_role.py @@ -49,7 +49,7 @@ author: - "Webster Mudge (@wmudge)" requirements: - - cm_client + - cm-client options: cluster: description: @@ -122,6 +122,7 @@ - started - stopped extends_documentation_fragment: + - ansible.builtin.action_common_attributes - cloudera.cluster.cm_options - cloudera.cluster.cm_endpoint attributes: @@ -129,6 +130,8 @@ support: full diff_mode: support: full + platform: + platforms: all """ EXAMPLES = r""" diff --git a/plugins/modules/service_role_config.py b/plugins/modules/service_role_config.py index 9cc27ae1..741d4fd7 100644 --- a/plugins/modules/service_role_config.py +++ b/plugins/modules/service_role_config.py @@ -45,7 +45,7 @@ author: - "Webster Mudge (@wmudge)" requirements: - - cm_client + - cm-client options: cluster: description: @@ -84,6 +84,7 @@ type: bool default: False extends_documentation_fragment: + - ansible.builtin.action_common_attributes - cloudera.cluster.cm_options - cloudera.cluster.cm_endpoint - cloudera.cluster.purge @@ -93,6 +94,8 @@ support: full diff_mode: support: full + platform: + platforms: all """ EXAMPLES = r""" diff --git a/plugins/modules/service_role_config_group.py b/plugins/modules/service_role_config_group.py index 60e77366..5d1f4449 100644 --- a/plugins/modules/service_role_config_group.py +++ b/plugins/modules/service_role_config_group.py @@ -44,7 +44,7 @@ author: - "Webster Mudge (@wmudge)" requirements: - - cm_client + - cm-client options: cluster: description: @@ -102,7 +102,7 @@ description: - The presence or absence of the role config group. - On I(state=absent), any associated role will be moved to the service's default group, i.e. the C(base) role config group. - - NOTE: you cannot remove a C(base) role config group. + - "NOTE: you cannot remove a C(base) role config group." type: str required: False choices: @@ -110,6 +110,7 @@ - absent default: present extends_documentation_fragment: + - ansible.builtin.action_common_attributes - cloudera.cluster.cm_options - cloudera.cluster.cm_endpoint - cloudera.cluster.message @@ -118,6 +119,8 @@ support: full diff_mode: support: full + platform: + platforms: all """ EXAMPLES = r""" diff --git a/plugins/modules/service_role_config_group_config.py b/plugins/modules/service_role_config_group_config.py index b496f5de..733f5f1c 100644 --- a/plugins/modules/service_role_config_group_config.py +++ b/plugins/modules/service_role_config_group_config.py @@ -45,7 +45,7 @@ author: - "Webster Mudge (@wmudge)" requirements: - - cm_client + - cm-client options: cluster: description: @@ -86,6 +86,7 @@ - summary - full extends_documentation_fragment: + - ansible.builtin.action_common_attributes - cloudera.cluster.cm_options - cloudera.cluster.cm_endpoint - cloudera.cluster.purge @@ -95,6 +96,8 @@ support: full diff_mode: support: full + platform: + platforms: all """ EXAMPLES = r"""