mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 19:31:26 -07:00
[PR #9421/2a2a9661 backport][stable-10] [ab]*.py: normalize docs (#9427)
[ab]*.py: normalize docs (#9421)
* [ab]*.py: normalize docs
* Update plugins/modules/atomic_image.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 2a2a9661d9
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
3db0a11148
commit
14038511a1
36 changed files with 1931 additions and 2013 deletions
|
@ -8,37 +8,37 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: atomic_host
|
||||
short_description: Manage the atomic host platform
|
||||
description:
|
||||
- Manage the atomic host platform.
|
||||
- Rebooting of Atomic host platform should be done outside this module.
|
||||
- Manage the atomic host platform.
|
||||
- Rebooting of Atomic host platform should be done outside this module.
|
||||
author:
|
||||
- Saravanan KR (@krsacme)
|
||||
- Saravanan KR (@krsacme)
|
||||
notes:
|
||||
- Host should be an atomic platform (verified by existence of '/run/ostree-booted' file).
|
||||
- Host should be an atomic platform (verified by existence of '/run/ostree-booted' file).
|
||||
- According to U(https://projectatomic.io/) the project has been sunset around 2019/2020, in favor of C(podman) and Fedora CoreOS.
|
||||
requirements:
|
||||
- atomic
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: none
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
revision:
|
||||
description:
|
||||
- The version number of the atomic host to be deployed.
|
||||
- Providing V(latest) will upgrade to the latest available version.
|
||||
default: 'latest'
|
||||
aliases: [ version ]
|
||||
type: str
|
||||
'''
|
||||
revision:
|
||||
description:
|
||||
- The version number of the atomic host to be deployed.
|
||||
- Providing V(latest) will upgrade to the latest available version.
|
||||
default: 'latest'
|
||||
aliases: [version]
|
||||
type: str
|
||||
"""
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: Upgrade the atomic host platform to the latest version (atomic host upgrade)
|
||||
community.general.atomic_host:
|
||||
revision: latest
|
||||
|
@ -46,15 +46,15 @@ EXAMPLES = r'''
|
|||
- name: Deploy a specific revision as the atomic host (atomic host deploy 23.130)
|
||||
community.general.atomic_host:
|
||||
revision: 23.130
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
msg:
|
||||
description: The command standard output
|
||||
returned: always
|
||||
type: str
|
||||
sample: 'Already on latest'
|
||||
'''
|
||||
description: The command standard output.
|
||||
returned: always
|
||||
type: str
|
||||
sample: 'Already on latest'
|
||||
"""
|
||||
import os
|
||||
import traceback
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue