From a8055090ae47fa0423b66cdeb6548710fe155bee Mon Sep 17 00:00:00 2001 From: Rich Megginson Date: Mon, 29 Jul 2024 16:39:01 -0600 Subject: [PATCH] docs: add module documentation for timesync_provider Automation Hub will error and not display module docs for any module if any of the docs are missing or incorrect. Since timesync_provider is a shell script, it must have a separate module doc file. Signed-off-by: Rich Megginson --- .sanity-ansible-ignore-2.10.txt | 1 + .sanity-ansible-ignore-2.11.txt | 1 + .sanity-ansible-ignore-2.12.txt | 1 + .sanity-ansible-ignore-2.13.txt | 1 + .sanity-ansible-ignore-2.14.txt | 1 + .sanity-ansible-ignore-2.15.txt | 1 + .sanity-ansible-ignore-2.16.txt | 1 + .sanity-ansible-ignore-2.17.txt | 1 + .sanity-ansible-ignore-2.9.txt | 1 + library/timesync_provider.yml | 19 +++++++++++++++++++ 10 files changed, 28 insertions(+) create mode 100644 library/timesync_provider.yml diff --git a/.sanity-ansible-ignore-2.10.txt b/.sanity-ansible-ignore-2.10.txt index e6d5e4d6..4f862b1f 100644 --- a/.sanity-ansible-ignore-2.10.txt +++ b/.sanity-ansible-ignore-2.10.txt @@ -1 +1,2 @@ plugins/modules/timesync_provider.sh shebang +plugins/modules/timesync_provider.yml validate-modules:missing-gplv3-license diff --git a/.sanity-ansible-ignore-2.11.txt b/.sanity-ansible-ignore-2.11.txt index e6d5e4d6..4f862b1f 100644 --- a/.sanity-ansible-ignore-2.11.txt +++ b/.sanity-ansible-ignore-2.11.txt @@ -1 +1,2 @@ plugins/modules/timesync_provider.sh shebang +plugins/modules/timesync_provider.yml validate-modules:missing-gplv3-license diff --git a/.sanity-ansible-ignore-2.12.txt b/.sanity-ansible-ignore-2.12.txt index e6d5e4d6..4f862b1f 100644 --- a/.sanity-ansible-ignore-2.12.txt +++ b/.sanity-ansible-ignore-2.12.txt @@ -1 +1,2 @@ plugins/modules/timesync_provider.sh shebang +plugins/modules/timesync_provider.yml validate-modules:missing-gplv3-license diff --git a/.sanity-ansible-ignore-2.13.txt b/.sanity-ansible-ignore-2.13.txt index e6d5e4d6..4f862b1f 100644 --- a/.sanity-ansible-ignore-2.13.txt +++ b/.sanity-ansible-ignore-2.13.txt @@ -1 +1,2 @@ plugins/modules/timesync_provider.sh shebang +plugins/modules/timesync_provider.yml validate-modules:missing-gplv3-license diff --git a/.sanity-ansible-ignore-2.14.txt b/.sanity-ansible-ignore-2.14.txt index 791fda1c..e8660009 100644 --- a/.sanity-ansible-ignore-2.14.txt +++ b/.sanity-ansible-ignore-2.14.txt @@ -1,3 +1,4 @@ plugins/modules/timesync_provider.sh shebang +plugins/modules/timesync_provider.yml validate-modules:missing-gplv3-license plugins/modules/timesync_provider.sh validate-modules:invalid-extension plugins/modules/timesync_provider.sh validate-modules:python-syntax-error diff --git a/.sanity-ansible-ignore-2.15.txt b/.sanity-ansible-ignore-2.15.txt index 791fda1c..e8660009 100644 --- a/.sanity-ansible-ignore-2.15.txt +++ b/.sanity-ansible-ignore-2.15.txt @@ -1,3 +1,4 @@ plugins/modules/timesync_provider.sh shebang +plugins/modules/timesync_provider.yml validate-modules:missing-gplv3-license plugins/modules/timesync_provider.sh validate-modules:invalid-extension plugins/modules/timesync_provider.sh validate-modules:python-syntax-error diff --git a/.sanity-ansible-ignore-2.16.txt b/.sanity-ansible-ignore-2.16.txt index 791fda1c..e8660009 100644 --- a/.sanity-ansible-ignore-2.16.txt +++ b/.sanity-ansible-ignore-2.16.txt @@ -1,3 +1,4 @@ plugins/modules/timesync_provider.sh shebang +plugins/modules/timesync_provider.yml validate-modules:missing-gplv3-license plugins/modules/timesync_provider.sh validate-modules:invalid-extension plugins/modules/timesync_provider.sh validate-modules:python-syntax-error diff --git a/.sanity-ansible-ignore-2.17.txt b/.sanity-ansible-ignore-2.17.txt index 7b8a3c6f..96d064d5 100644 --- a/.sanity-ansible-ignore-2.17.txt +++ b/.sanity-ansible-ignore-2.17.txt @@ -1,3 +1,4 @@ plugins/modules/timesync_provider.sh shebang +plugins/modules/timesync_provider.yml validate-modules:missing-gplv3-license plugins/modules/timesync_provider.sh validate-modules:invalid-extension plugins/modules/timesync_provider.sh validate-modules:missing-gplv3-license diff --git a/.sanity-ansible-ignore-2.9.txt b/.sanity-ansible-ignore-2.9.txt index e6d5e4d6..4f862b1f 100644 --- a/.sanity-ansible-ignore-2.9.txt +++ b/.sanity-ansible-ignore-2.9.txt @@ -1 +1,2 @@ plugins/modules/timesync_provider.sh shebang +plugins/modules/timesync_provider.yml validate-modules:missing-gplv3-license diff --git a/library/timesync_provider.yml b/library/timesync_provider.yml new file mode 100644 index 00000000..bf8f9873 --- /dev/null +++ b/library/timesync_provider.yml @@ -0,0 +1,19 @@ +DOCUMENTATION: + module: timesync_provider + short_description: Determine the timesync provider on the system + version_added: "2.14.0" + description: + - "WARNING: Do not use this module directly! It is only for role internal use." + - "Determine the timesync provider on the system and return it." + options: {} + author: + - Miroslav Lichvar (@mlichvar) +EXAMPLES: |- + - name: Determine current NTP provider + timesync_provider: +RETURN: + timesync_ntp_provider_current: + description: Name of current provider e.g. chrony or ntp + returned: success + type: str + sample: chrony