mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-03 23:14:02 -07:00
[PR #10433/69d479f0 backport][stable-11] doc style adjustments: modules [lm]* (#10438)
Some checks failed
EOL CI / EOL Sanity (Ⓐ2.16) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Has been cancelled
nox / Run extra sanity tests (push) Has been cancelled
Some checks failed
EOL CI / EOL Sanity (Ⓐ2.16) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Has been cancelled
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Has been cancelled
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Has been cancelled
nox / Run extra sanity tests (push) Has been cancelled
doc style adjustments: modules [lm]* (#10433)
* doc style adjustments: modules l*
* doc style adjustments: modules m*
* Apply suggestions from code review
* Update plugins/modules/logstash_plugin.py
---------
(cherry picked from commit 69d479f06c
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
eab6f4c6ff
commit
5c7feec6f7
33 changed files with 214 additions and 168 deletions
|
@ -129,13 +129,13 @@ options:
|
|||
archive:
|
||||
description:
|
||||
- Create an archive of a container.
|
||||
- This will create a tarball of the running container.
|
||||
- This creates a tarball of the running container.
|
||||
type: bool
|
||||
default: false
|
||||
archive_path:
|
||||
description:
|
||||
- Path the save the archived container.
|
||||
- If the path does not exist the archive method will attempt to create it.
|
||||
- If the path does not exist the archive method attempts to create it.
|
||||
type: path
|
||||
archive_compression:
|
||||
choices:
|
||||
|
@ -157,8 +157,8 @@ options:
|
|||
description:
|
||||
- Define the state of a container.
|
||||
- If you clone a container using O(clone_name) the newly cloned container created in a stopped state.
|
||||
- The running container will be stopped while the clone operation is happening and upon completion of the clone the
|
||||
original container state will be restored.
|
||||
- The running container is stopped while the clone operation is happening and upon completion of the clone the original
|
||||
container state is restored.
|
||||
type: str
|
||||
default: started
|
||||
container_config:
|
||||
|
@ -172,15 +172,15 @@ requirements:
|
|||
- 'python3-lxc # OS Package'
|
||||
notes:
|
||||
- Containers must have a unique name. If you attempt to create a container with a name that already exists in the users
|
||||
namespace the module will simply return as "unchanged".
|
||||
- The O(container_command) can be used with any state except V(absent). If used with state V(stopped) the container will
|
||||
be V(started), the command executed, and then the container V(stopped) again. Likewise if O(state=stopped) and the container
|
||||
does not exist it will be first created, V(started), the command executed, and then V(stopped). If you use a C(|) in the
|
||||
variable you can use common script formatting within the variable itself. The O(container_command) option will always
|
||||
execute as C(bash). When using O(container_command), a log file is created in the C(/tmp/) directory which contains both
|
||||
C(stdout) and C(stderr) of any command executed.
|
||||
- If O(archive=true) the system will attempt to create a compressed tarball of the running container. The O(archive) option
|
||||
supports LVM backed containers and will create a snapshot of the running container when creating the archive.
|
||||
namespace the module simply returns as "unchanged".
|
||||
- The O(container_command) can be used with any state except V(absent). If used with state V(stopped) the container is V(started),
|
||||
the command executed, and then the container V(stopped) again. Likewise if O(state=stopped) and the container does not
|
||||
exist it is first created, V(started), the command executed, and then V(stopped). If you use a C(|) in the variable you
|
||||
can use common script formatting within the variable itself. The O(container_command) option always execute as C(bash).
|
||||
When using O(container_command), a log file is created in the C(/tmp/) directory which contains both C(stdout) and C(stderr)
|
||||
of any command executed.
|
||||
- If O(archive=true) the system attempts to create a compressed tarball of the running container. The O(archive) option
|
||||
supports LVM backed containers and creates a snapshot of the running container when creating the archive.
|
||||
- If your distro does not have a package for C(python3-lxc), which is a requirement for this module, it can be installed
|
||||
from source at U(https://github.com/lxc/python3-lxc) or installed using C(pip install lxc).
|
||||
"""
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue