mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
Doc fragments to plugins (#50172)
* promote doc_fragments into actual plugins change tests hardcoded path to doc fragments avoid sanity in fragments avoid improper testing of doc_fragments also change runner paths fix botmeta updated comment for fragments updated docs
This commit is contained in:
parent
4041f02389
commit
96b3ef5553
106 changed files with 51 additions and 31 deletions
|
@ -1,61 +0,0 @@
|
|||
# Copyright (c) 2017 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
|
||||
# common shelldocumentation fragment
|
||||
DOCUMENTATION = """
|
||||
options:
|
||||
remote_tmp:
|
||||
description:
|
||||
- Temporary directory to use on targets when executing tasks.
|
||||
default: '~/.ansible/tmp'
|
||||
env: [{name: ANSIBLE_REMOTE_TEMP}, {name: ANSIBLE_REMOTE_TMP}]
|
||||
ini:
|
||||
- section: defaults
|
||||
key: remote_tmp
|
||||
vars:
|
||||
- name: ansible_remote_tmp
|
||||
system_tmpdirs:
|
||||
description:
|
||||
- "List of valid system temporary directories for Ansible to choose when it cannot use
|
||||
``remote_tmp``, normally due to permission issues. These must be world readable, writable,
|
||||
and executable."
|
||||
default: [ /var/tmp, /tmp ]
|
||||
type: list
|
||||
env: [{name: ANSIBLE_SYSTEM_TMPDIRS}]
|
||||
ini:
|
||||
- section: defaults
|
||||
key: system_tmpdirs
|
||||
vars:
|
||||
- name: ansible_system_tmpdirs
|
||||
async_dir:
|
||||
description:
|
||||
- Directory in which ansible will keep async job information
|
||||
default: '~/.ansible_async'
|
||||
env: [{name: ANSIBLE_ASYNC_DIR}]
|
||||
ini:
|
||||
- section: defaults
|
||||
key: async_dir
|
||||
vars:
|
||||
- name: ansible_async_dir
|
||||
environment:
|
||||
type: dict
|
||||
default: {}
|
||||
description:
|
||||
- dictionary of environment variables and their values to use when executing commands.
|
||||
admin_users:
|
||||
type: list
|
||||
default: ['root', 'toor']
|
||||
description:
|
||||
- list of users to be expected to have admin privileges. This is used by the controller to
|
||||
determine how to share temporary files between the remote user and the become user.
|
||||
env:
|
||||
- name: ANSIBLE_ADMIN_USERS
|
||||
ini:
|
||||
- section: defaults
|
||||
key: admin_users
|
||||
vars:
|
||||
- name: ansible_admin_users
|
||||
"""
|
Loading…
Add table
Add a link
Reference in a new issue