From 421bae419dc3c75b520c94e72ad603b72cbe8e31 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Fri, 3 Feb 2023 17:13:31 +0100 Subject: [PATCH] Improve current_container_facts docs (#574) * Improve current_container_facts docs. * [TEMP] Run current_container_facts module in CI outside of ansible-test. * Revert "[TEMP] Run current_container_facts module in CI outside of ansible-test." This reverts commit 1cdd3e3550f7193c52b5a758ec17045c590cfaae. * Describe current state of return values. --- plugins/modules/current_container_facts.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/plugins/modules/current_container_facts.py b/plugins/modules/current_container_facts.py index 99f9b8ec..f2cde2b5 100644 --- a/plugins/modules/current_container_facts.py +++ b/plugins/modules/current_container_facts.py @@ -12,10 +12,10 @@ __metaclass__ = type DOCUMENTATION = r''' --- module: current_container_facts -short_description: Return facts about whether the module runs in a Docker container +short_description: Return facts about whether the module runs in a container version_added: 1.1.0 description: - - Return facts about whether the module runs in a Docker container. + - Return facts about whether the module runs in a Docker or podman container. - This module attempts a best-effort detection. There might be special cases where it does not work; if you encounter one, L(please file an issue, https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&template=bug_report.md). @@ -58,8 +58,10 @@ ansible_facts: description: - The detected container environment. - Contains an empty string if no container was detected, or a non-empty string identifying the container environment. - - C(github_actions) is supported since community.docker 2.4.0. - - C(podman) is supported since community.docker 3.3.0. + - C(docker) indicates that the module ran inside a regular Docker container. + - C(azure_pipelines) indicates that the module ran on Azure Pipelines. This seems to no longer be reported. + - C(github_actions) indicates that the module ran inside a Docker container on GitHub Actions. It is supported since community.docker 2.4.0. + - C(podman) indicates that the module ran inside a regular Podman container. It is supported since community.docker 3.3.0. returned: always type: str choices: