ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2026-04-01 17:30:29 +00:00
Code Packages Projects Releases Wiki Activity

Improve current_container_facts docs (#574)

Browse Source 
* 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 1cdd3e3550.

* Describe current state of return values.
This commit is contained in:
Felix Fontein 2023-02-03 17:13:31 +01:00 committed by GitHub
parent 0e1152a630
commit 421bae419d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
plugins/modules/current_container_facts.py
View File

@ -12,10 +12,10 @@ __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r'''
--- ---
module: current_container_facts 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 version_added: 1.1.0
description: 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 - 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, 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). https://github.com/ansible-collections/community.docker/issues/new?assignees=&labels=&template=bug_report.md).
@ -58,8 +58,10 @@ ansible_facts:
description: description:
- The detected container environment. - The detected container environment.
- Contains an empty string if no container was detected, or a non-empty string identifying the 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(docker) indicates that the module ran inside a regular Docker container.
- C(podman) is supported since community.docker 3.3.0. - 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 returned: always
type: str type: str
choices: choices: