From 307140ef61e1fbe05fa862a25d02923faf922b3a Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Mon, 3 Oct 2022 21:47:03 +0200 Subject: [PATCH] Remove parts from baseline that are included from ansible-core (and thus might change and make the tests fail). Add more formatting. (#51) --- .../collections/ns2/col/foo_become.rst | 8 +- .../collections/ns2/col/foo_connection.rst | 76 +--- .../collections/ns2/col/foo_module.rst | 4 + .../collections/ns2/col/foo_shell.rst | 348 +----------------- .../collections/ns2/col/foo_vars.rst | 57 --- .../collections/ns2/col/foo_become.rst | 8 +- .../collections/ns2/col/foo_connection.rst | 76 +--- .../collections/ns2/col/foo_module.rst | 4 + .../collections/ns2/col/foo_shell.rst | 348 +----------------- .../collections/ns2/col/foo_vars.rst | 57 --- .../collections/ns2/col/foo_become.rst | 8 +- .../collections/ns2/col/foo_connection.rst | 76 +--- .../collections/ns2/col/foo_module.rst | 4 + .../collections/ns2/col/foo_shell.rst | 348 +----------------- .../collections/ns2/col/foo_vars.rst | 57 --- .../baseline-squash-hierarchy/foo_become.rst | 8 +- .../foo_connection.rst | 76 +--- .../baseline-squash-hierarchy/foo_module.rst | 4 + .../baseline-squash-hierarchy/foo_shell.rst | 348 +----------------- .../baseline-squash-hierarchy/foo_vars.rst | 57 --- .../collections/ns2/col/foo_become.rst | 6 +- .../collections/ns2/col/foo_connection.rst | 45 +-- .../collections/ns2/col/foo_module.rst | 2 + .../collections/ns2/col/foo_shell.rst | 189 +--------- .../collections/ns2/col/foo_vars.rst | 26 -- .../ns2/col/plugins/become/foo.py | 7 +- .../ns2/col/plugins/connection/foo.py | 5 +- .../ns2/col/plugins/filter/bar.yml | 6 +- .../ns2/col/plugins/modules/foo.py | 11 +- .../ns2/col/plugins/shell/foo.py | 17 +- .../ns2/col/plugins/vars/foo.py | 2 - 31 files changed, 107 insertions(+), 2181 deletions(-) diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_become.rst b/tests/functional/baseline-default/collections/ns2/col/foo_become.rst index dfd76d68..622899e4 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_become.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_become.rst @@ -134,7 +134,11 @@ Parameters
- Bar. + Bar. \ :strong:`BAR!`\ + + Totally unrelated to \ :emphasis:`become\_user`\ . Even with \ :emphasis:`become\_user=foo`\ . + + Might not be compatible when \ :emphasis:`become\_user`\ is \ :literal:`bar`\ , though. .. raw:: html @@ -266,7 +270,7 @@ Parameters
- User you 'become' to execute the task + User you 'become' to execute the task. .. rst-class:: ansible-option-line diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_connection.rst b/tests/functional/baseline-default/collections/ns2/col/foo_connection.rst index ed6bec98..ab8b423b 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_connection.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_connection.rst @@ -51,6 +51,9 @@ ns2.col.foo connection -- Foo connection .. version_added +.. rst-class:: ansible-version-added + +New in ns2.col 1.2.0 .. contents:: :local: @@ -145,79 +148,6 @@ Parameters - Variable: delegated\_vars['ansible\_ssh\_host'] - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_connection__parameter-pipelining: - - .. rst-class:: ansible-option-title - - **pipelining** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`boolean` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Pipelining reduces the number of connection operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfers. - - This can result in a very significant performance improvement when enabled. - - However this can conflict with privilege escalation (become). For example, when using sudo operations you must first disable 'requiretty' in the sudoers file for the target hosts, which is why this feature is disabled by default. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)` - - :ansible-option-choices-entry:`true` - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entries: - - .. code-block:: - - [defaults] - pipelining = false - - - - .. code-block:: - - [connection] - pipelining = false - - - - Environment variable: ANSIBLE\_PIPELINING - - - Variable: ansible\_pipelining - - .. raw:: html
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_module.rst b/tests/functional/baseline-default/collections/ns2/col/foo_module.rst index b6e63def..a12112d7 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_module.rst @@ -142,6 +142,8 @@ Parameters A bar. + Independent from \ :emphasis:`foo`\ . + .. raw:: html @@ -249,6 +251,8 @@ Parameters Whatever. + Also required when \ :emphasis:`subfoo`\ is specified when \ :emphasis:`foo=bar`\ or \ :literal:`baz`\ . + .. raw:: html diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_shell.rst b/tests/functional/baseline-default/collections/ns2/col/foo_shell.rst index 45569346..645db732 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_shell.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_shell.rst @@ -96,224 +96,6 @@ Parameters * - Parameter - Comments - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-admin_users: - - .. rst-class:: ansible-option-title - - **admin_users** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - 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. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`["root", "toor"]` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - admin_users = root, toor - - - - Environment variable: ANSIBLE\_ADMIN\_USERS - - - Variable: ansible\_admin\_users - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-async_dir: - - .. rst-class:: ansible-option-title - - **async_dir** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Directory in which ansible will keep async job information - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`"~/.ansible\_async"` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - async_dir = ~/.ansible_async - - - - Environment variable: ANSIBLE\_ASYNC\_DIR - - - Variable: ansible\_async\_dir - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-common_remote_group: - - .. rst-class:: ansible-option-title - - **common_remote_group** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Checked when Ansible needs to execute a module as a different user. - - If setfacl and chown both fail and do not let the different user access the module's files, they will be chgrp'd to this group. - - In order for this to work, the remote\_user and become\_user must share a common group and this setting must be set to that group. - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - common_remote_group = VALUE - - - - Environment variable: ANSIBLE\_COMMON\_REMOTE\_GROUP - - - Variable: ansible\_common\_remote\_group - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-environment: - - .. rst-class:: ansible-option-title - - **environment** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - List of dictionaries of environment variables and their values to use when executing commands. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`[{}]` - - .. raw:: html - -
- * - .. raw:: html
@@ -333,6 +115,9 @@ Parameters :ansible-option-type:`string` + :ansible-option-versionadded:`added in ansible-base 2.10` + + @@ -370,133 +155,6 @@ Parameters - Variable: ansible\_remote\_tmp - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-system_tmpdirs: - - .. rst-class:: ansible-option-title - - **system_tmpdirs** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - List of valid system temporary directories on the managed machine for Ansible to validate \ :literal:`remote\_tmp`\ against, when specific permissions are needed. These must be world readable, writable, and executable. This list should only contain directories which the system administrator has pre-created with the proper ownership and permissions otherwise security issues can arise. - - When \ :literal:`remote\_tmp`\ is required to be a system temp dir and it does not match any in the list, the first one from the list will be used instead. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`["/var/tmp", "/tmp"]` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - system_tmpdirs = /var/tmp, /tmp - - - - Environment variable: ANSIBLE\_SYSTEM\_TMPDIRS - - - Variable: ansible\_system\_tmpdirs - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-world_readable_temp: - - .. rst-class:: ansible-option-title - - **world_readable_temp** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`boolean` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - This makes the temporary files created on the machine world-readable and will issue a warning instead of failing the task. - - It is useful when becoming an unprivileged user. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)` - - :ansible-option-choices-entry:`true` - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - allow_world_readable_tmpfiles = false - - - - Environment variable: ANSIBLE\_SHELL\_ALLOW\_WORLD\_READABLE\_TEMP - - - Variable: ansible\_shell\_allow\_world\_readable\_temp - - .. raw:: html
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst b/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst index a4c6b8b6..b267bd2a 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst @@ -159,63 +159,6 @@ Parameters - Environment variable: ANSIBLE\_FOO\_FILENAME\_EXT - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_vars__parameter-stage: - - .. rst-class:: ansible-option-title - - **stage** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Control when this vars plugin may be executed. - - Setting this option to \ :literal:`all`\ will run the vars plugin after importing inventory and whenever it is demanded by a task. - - Setting this option to \ :literal:`task`\ will only run the vars plugin whenever it is demanded by a task. - - Setting this option to \ :literal:`inventory`\ will only run the vars plugin after parsing inventory. - - If this option is omitted, the global \ :emphasis:`RUN\_VARS\_PLUGINS`\ configuration is used to determine when to execute the vars plugin. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-choices-entry:`"all"` - - :ansible-option-choices-entry:`"task"` - - :ansible-option-choices-entry:`"inventory"` - - .. raw:: html
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_become.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_become.rst index dfd76d68..622899e4 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_become.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_become.rst @@ -134,7 +134,11 @@ Parameters
- Bar. + Bar. \ :strong:`BAR!`\ + + Totally unrelated to \ :emphasis:`become\_user`\ . Even with \ :emphasis:`become\_user=foo`\ . + + Might not be compatible when \ :emphasis:`become\_user`\ is \ :literal:`bar`\ , though. .. raw:: html @@ -266,7 +270,7 @@ Parameters
- User you 'become' to execute the task + User you 'become' to execute the task. .. rst-class:: ansible-option-line diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_connection.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_connection.rst index ed6bec98..ab8b423b 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_connection.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_connection.rst @@ -51,6 +51,9 @@ ns2.col.foo connection -- Foo connection .. version_added +.. rst-class:: ansible-version-added + +New in ns2.col 1.2.0 .. contents:: :local: @@ -145,79 +148,6 @@ Parameters - Variable: delegated\_vars['ansible\_ssh\_host'] - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_connection__parameter-pipelining: - - .. rst-class:: ansible-option-title - - **pipelining** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`boolean` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Pipelining reduces the number of connection operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfers. - - This can result in a very significant performance improvement when enabled. - - However this can conflict with privilege escalation (become). For example, when using sudo operations you must first disable 'requiretty' in the sudoers file for the target hosts, which is why this feature is disabled by default. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)` - - :ansible-option-choices-entry:`true` - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entries: - - .. code-block:: - - [defaults] - pipelining = false - - - - .. code-block:: - - [connection] - pipelining = false - - - - Environment variable: ANSIBLE\_PIPELINING - - - Variable: ansible\_pipelining - - .. raw:: html
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst index b6e63def..a12112d7 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst @@ -142,6 +142,8 @@ Parameters A bar. + Independent from \ :emphasis:`foo`\ . + .. raw:: html @@ -249,6 +251,8 @@ Parameters Whatever. + Also required when \ :emphasis:`subfoo`\ is specified when \ :emphasis:`foo=bar`\ or \ :literal:`baz`\ . + .. raw:: html diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_shell.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_shell.rst index 45569346..645db732 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_shell.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_shell.rst @@ -96,224 +96,6 @@ Parameters * - Parameter - Comments - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-admin_users: - - .. rst-class:: ansible-option-title - - **admin_users** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - 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. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`["root", "toor"]` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - admin_users = root, toor - - - - Environment variable: ANSIBLE\_ADMIN\_USERS - - - Variable: ansible\_admin\_users - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-async_dir: - - .. rst-class:: ansible-option-title - - **async_dir** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Directory in which ansible will keep async job information - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`"~/.ansible\_async"` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - async_dir = ~/.ansible_async - - - - Environment variable: ANSIBLE\_ASYNC\_DIR - - - Variable: ansible\_async\_dir - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-common_remote_group: - - .. rst-class:: ansible-option-title - - **common_remote_group** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Checked when Ansible needs to execute a module as a different user. - - If setfacl and chown both fail and do not let the different user access the module's files, they will be chgrp'd to this group. - - In order for this to work, the remote\_user and become\_user must share a common group and this setting must be set to that group. - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - common_remote_group = VALUE - - - - Environment variable: ANSIBLE\_COMMON\_REMOTE\_GROUP - - - Variable: ansible\_common\_remote\_group - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-environment: - - .. rst-class:: ansible-option-title - - **environment** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - List of dictionaries of environment variables and their values to use when executing commands. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`[{}]` - - .. raw:: html - -
- * - .. raw:: html
@@ -333,6 +115,9 @@ Parameters :ansible-option-type:`string` + :ansible-option-versionadded:`added in ansible-base 2.10` + + @@ -370,133 +155,6 @@ Parameters - Variable: ansible\_remote\_tmp - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-system_tmpdirs: - - .. rst-class:: ansible-option-title - - **system_tmpdirs** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - List of valid system temporary directories on the managed machine for Ansible to validate \ :literal:`remote\_tmp`\ against, when specific permissions are needed. These must be world readable, writable, and executable. This list should only contain directories which the system administrator has pre-created with the proper ownership and permissions otherwise security issues can arise. - - When \ :literal:`remote\_tmp`\ is required to be a system temp dir and it does not match any in the list, the first one from the list will be used instead. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`["/var/tmp", "/tmp"]` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - system_tmpdirs = /var/tmp, /tmp - - - - Environment variable: ANSIBLE\_SYSTEM\_TMPDIRS - - - Variable: ansible\_system\_tmpdirs - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-world_readable_temp: - - .. rst-class:: ansible-option-title - - **world_readable_temp** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`boolean` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - This makes the temporary files created on the machine world-readable and will issue a warning instead of failing the task. - - It is useful when becoming an unprivileged user. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)` - - :ansible-option-choices-entry:`true` - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - allow_world_readable_tmpfiles = false - - - - Environment variable: ANSIBLE\_SHELL\_ALLOW\_WORLD\_READABLE\_TEMP - - - Variable: ansible\_shell\_allow\_world\_readable\_temp - - .. raw:: html
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_vars.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_vars.rst index a4c6b8b6..b267bd2a 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_vars.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_vars.rst @@ -159,63 +159,6 @@ Parameters - Environment variable: ANSIBLE\_FOO\_FILENAME\_EXT - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_vars__parameter-stage: - - .. rst-class:: ansible-option-title - - **stage** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Control when this vars plugin may be executed. - - Setting this option to \ :literal:`all`\ will run the vars plugin after importing inventory and whenever it is demanded by a task. - - Setting this option to \ :literal:`task`\ will only run the vars plugin whenever it is demanded by a task. - - Setting this option to \ :literal:`inventory`\ will only run the vars plugin after parsing inventory. - - If this option is omitted, the global \ :emphasis:`RUN\_VARS\_PLUGINS`\ configuration is used to determine when to execute the vars plugin. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-choices-entry:`"all"` - - :ansible-option-choices-entry:`"task"` - - :ansible-option-choices-entry:`"inventory"` - - .. raw:: html
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_become.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_become.rst index dfd76d68..622899e4 100644 --- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_become.rst +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_become.rst @@ -134,7 +134,11 @@ Parameters
- Bar. + Bar. \ :strong:`BAR!`\ + + Totally unrelated to \ :emphasis:`become\_user`\ . Even with \ :emphasis:`become\_user=foo`\ . + + Might not be compatible when \ :emphasis:`become\_user`\ is \ :literal:`bar`\ , though. .. raw:: html @@ -266,7 +270,7 @@ Parameters
- User you 'become' to execute the task + User you 'become' to execute the task. .. rst-class:: ansible-option-line diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_connection.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_connection.rst index ed6bec98..ab8b423b 100644 --- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_connection.rst +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_connection.rst @@ -51,6 +51,9 @@ ns2.col.foo connection -- Foo connection .. version_added +.. rst-class:: ansible-version-added + +New in ns2.col 1.2.0 .. contents:: :local: @@ -145,79 +148,6 @@ Parameters - Variable: delegated\_vars['ansible\_ssh\_host'] - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_connection__parameter-pipelining: - - .. rst-class:: ansible-option-title - - **pipelining** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`boolean` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Pipelining reduces the number of connection operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfers. - - This can result in a very significant performance improvement when enabled. - - However this can conflict with privilege escalation (become). For example, when using sudo operations you must first disable 'requiretty' in the sudoers file for the target hosts, which is why this feature is disabled by default. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)` - - :ansible-option-choices-entry:`true` - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entries: - - .. code-block:: - - [defaults] - pipelining = false - - - - .. code-block:: - - [connection] - pipelining = false - - - - Environment variable: ANSIBLE\_PIPELINING - - - Variable: ansible\_pipelining - - .. raw:: html
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst index b6e63def..a12112d7 100644 --- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst @@ -142,6 +142,8 @@ Parameters A bar. + Independent from \ :emphasis:`foo`\ . + .. raw:: html @@ -249,6 +251,8 @@ Parameters Whatever. + Also required when \ :emphasis:`subfoo`\ is specified when \ :emphasis:`foo=bar`\ or \ :literal:`baz`\ . + .. raw:: html diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_shell.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_shell.rst index 45569346..645db732 100644 --- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_shell.rst +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_shell.rst @@ -96,224 +96,6 @@ Parameters * - Parameter - Comments - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-admin_users: - - .. rst-class:: ansible-option-title - - **admin_users** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - 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. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`["root", "toor"]` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - admin_users = root, toor - - - - Environment variable: ANSIBLE\_ADMIN\_USERS - - - Variable: ansible\_admin\_users - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-async_dir: - - .. rst-class:: ansible-option-title - - **async_dir** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Directory in which ansible will keep async job information - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`"~/.ansible\_async"` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - async_dir = ~/.ansible_async - - - - Environment variable: ANSIBLE\_ASYNC\_DIR - - - Variable: ansible\_async\_dir - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-common_remote_group: - - .. rst-class:: ansible-option-title - - **common_remote_group** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Checked when Ansible needs to execute a module as a different user. - - If setfacl and chown both fail and do not let the different user access the module's files, they will be chgrp'd to this group. - - In order for this to work, the remote\_user and become\_user must share a common group and this setting must be set to that group. - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - common_remote_group = VALUE - - - - Environment variable: ANSIBLE\_COMMON\_REMOTE\_GROUP - - - Variable: ansible\_common\_remote\_group - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-environment: - - .. rst-class:: ansible-option-title - - **environment** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - List of dictionaries of environment variables and their values to use when executing commands. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`[{}]` - - .. raw:: html - -
- * - .. raw:: html
@@ -333,6 +115,9 @@ Parameters :ansible-option-type:`string` + :ansible-option-versionadded:`added in ansible-base 2.10` + + @@ -370,133 +155,6 @@ Parameters - Variable: ansible\_remote\_tmp - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-system_tmpdirs: - - .. rst-class:: ansible-option-title - - **system_tmpdirs** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - List of valid system temporary directories on the managed machine for Ansible to validate \ :literal:`remote\_tmp`\ against, when specific permissions are needed. These must be world readable, writable, and executable. This list should only contain directories which the system administrator has pre-created with the proper ownership and permissions otherwise security issues can arise. - - When \ :literal:`remote\_tmp`\ is required to be a system temp dir and it does not match any in the list, the first one from the list will be used instead. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`["/var/tmp", "/tmp"]` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - system_tmpdirs = /var/tmp, /tmp - - - - Environment variable: ANSIBLE\_SYSTEM\_TMPDIRS - - - Variable: ansible\_system\_tmpdirs - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-world_readable_temp: - - .. rst-class:: ansible-option-title - - **world_readable_temp** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`boolean` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - This makes the temporary files created on the machine world-readable and will issue a warning instead of failing the task. - - It is useful when becoming an unprivileged user. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)` - - :ansible-option-choices-entry:`true` - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - allow_world_readable_tmpfiles = false - - - - Environment variable: ANSIBLE\_SHELL\_ALLOW\_WORLD\_READABLE\_TEMP - - - Variable: ansible\_shell\_allow\_world\_readable\_temp - - .. raw:: html
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_vars.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_vars.rst index a4c6b8b6..b267bd2a 100644 --- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_vars.rst +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_vars.rst @@ -159,63 +159,6 @@ Parameters - Environment variable: ANSIBLE\_FOO\_FILENAME\_EXT - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_vars__parameter-stage: - - .. rst-class:: ansible-option-title - - **stage** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Control when this vars plugin may be executed. - - Setting this option to \ :literal:`all`\ will run the vars plugin after importing inventory and whenever it is demanded by a task. - - Setting this option to \ :literal:`task`\ will only run the vars plugin whenever it is demanded by a task. - - Setting this option to \ :literal:`inventory`\ will only run the vars plugin after parsing inventory. - - If this option is omitted, the global \ :emphasis:`RUN\_VARS\_PLUGINS`\ configuration is used to determine when to execute the vars plugin. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-choices-entry:`"all"` - - :ansible-option-choices-entry:`"task"` - - :ansible-option-choices-entry:`"inventory"` - - .. raw:: html
diff --git a/tests/functional/baseline-squash-hierarchy/foo_become.rst b/tests/functional/baseline-squash-hierarchy/foo_become.rst index dfd76d68..622899e4 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_become.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_become.rst @@ -134,7 +134,11 @@ Parameters
- Bar. + Bar. \ :strong:`BAR!`\ + + Totally unrelated to \ :emphasis:`become\_user`\ . Even with \ :emphasis:`become\_user=foo`\ . + + Might not be compatible when \ :emphasis:`become\_user`\ is \ :literal:`bar`\ , though. .. raw:: html @@ -266,7 +270,7 @@ Parameters
- User you 'become' to execute the task + User you 'become' to execute the task. .. rst-class:: ansible-option-line diff --git a/tests/functional/baseline-squash-hierarchy/foo_connection.rst b/tests/functional/baseline-squash-hierarchy/foo_connection.rst index ed6bec98..ab8b423b 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_connection.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_connection.rst @@ -51,6 +51,9 @@ ns2.col.foo connection -- Foo connection .. version_added +.. rst-class:: ansible-version-added + +New in ns2.col 1.2.0 .. contents:: :local: @@ -145,79 +148,6 @@ Parameters - Variable: delegated\_vars['ansible\_ssh\_host'] - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_connection__parameter-pipelining: - - .. rst-class:: ansible-option-title - - **pipelining** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`boolean` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Pipelining reduces the number of connection operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfers. - - This can result in a very significant performance improvement when enabled. - - However this can conflict with privilege escalation (become). For example, when using sudo operations you must first disable 'requiretty' in the sudoers file for the target hosts, which is why this feature is disabled by default. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)` - - :ansible-option-choices-entry:`true` - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entries: - - .. code-block:: - - [defaults] - pipelining = false - - - - .. code-block:: - - [connection] - pipelining = false - - - - Environment variable: ANSIBLE\_PIPELINING - - - Variable: ansible\_pipelining - - .. raw:: html
diff --git a/tests/functional/baseline-squash-hierarchy/foo_module.rst b/tests/functional/baseline-squash-hierarchy/foo_module.rst index b6e63def..a12112d7 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_module.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_module.rst @@ -142,6 +142,8 @@ Parameters A bar. + Independent from \ :emphasis:`foo`\ . + .. raw:: html @@ -249,6 +251,8 @@ Parameters Whatever. + Also required when \ :emphasis:`subfoo`\ is specified when \ :emphasis:`foo=bar`\ or \ :literal:`baz`\ . + .. raw:: html diff --git a/tests/functional/baseline-squash-hierarchy/foo_shell.rst b/tests/functional/baseline-squash-hierarchy/foo_shell.rst index 45569346..645db732 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_shell.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_shell.rst @@ -96,224 +96,6 @@ Parameters * - Parameter - Comments - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-admin_users: - - .. rst-class:: ansible-option-title - - **admin_users** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - 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. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`["root", "toor"]` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - admin_users = root, toor - - - - Environment variable: ANSIBLE\_ADMIN\_USERS - - - Variable: ansible\_admin\_users - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-async_dir: - - .. rst-class:: ansible-option-title - - **async_dir** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Directory in which ansible will keep async job information - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`"~/.ansible\_async"` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - async_dir = ~/.ansible_async - - - - Environment variable: ANSIBLE\_ASYNC\_DIR - - - Variable: ansible\_async\_dir - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-common_remote_group: - - .. rst-class:: ansible-option-title - - **common_remote_group** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Checked when Ansible needs to execute a module as a different user. - - If setfacl and chown both fail and do not let the different user access the module's files, they will be chgrp'd to this group. - - In order for this to work, the remote\_user and become\_user must share a common group and this setting must be set to that group. - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - common_remote_group = VALUE - - - - Environment variable: ANSIBLE\_COMMON\_REMOTE\_GROUP - - - Variable: ansible\_common\_remote\_group - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-environment: - - .. rst-class:: ansible-option-title - - **environment** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - List of dictionaries of environment variables and their values to use when executing commands. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`[{}]` - - .. raw:: html - -
- * - .. raw:: html
@@ -333,6 +115,9 @@ Parameters :ansible-option-type:`string` + :ansible-option-versionadded:`added in ansible-base 2.10` + + @@ -370,133 +155,6 @@ Parameters - Variable: ansible\_remote\_tmp - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-system_tmpdirs: - - .. rst-class:: ansible-option-title - - **system_tmpdirs** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - List of valid system temporary directories on the managed machine for Ansible to validate \ :literal:`remote\_tmp`\ against, when specific permissions are needed. These must be world readable, writable, and executable. This list should only contain directories which the system administrator has pre-created with the proper ownership and permissions otherwise security issues can arise. - - When \ :literal:`remote\_tmp`\ is required to be a system temp dir and it does not match any in the list, the first one from the list will be used instead. - - - .. rst-class:: ansible-option-line - - :ansible-option-default-bold:`Default:` :ansible-option-default:`["/var/tmp", "/tmp"]` - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - system_tmpdirs = /var/tmp, /tmp - - - - Environment variable: ANSIBLE\_SYSTEM\_TMPDIRS - - - Variable: ansible\_system\_tmpdirs - - - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_shell__parameter-world_readable_temp: - - .. rst-class:: ansible-option-title - - **world_readable_temp** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`boolean` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - This makes the temporary files created on the machine world-readable and will issue a warning instead of failing the task. - - It is useful when becoming an unprivileged user. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)` - - :ansible-option-choices-entry:`true` - - - .. rst-class:: ansible-option-line - - :ansible-option-configuration:`Configuration:` - - - INI entry: - - .. code-block:: - - [defaults] - allow_world_readable_tmpfiles = false - - - - Environment variable: ANSIBLE\_SHELL\_ALLOW\_WORLD\_READABLE\_TEMP - - - Variable: ansible\_shell\_allow\_world\_readable\_temp - - .. raw:: html
diff --git a/tests/functional/baseline-squash-hierarchy/foo_vars.rst b/tests/functional/baseline-squash-hierarchy/foo_vars.rst index a4c6b8b6..b267bd2a 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_vars.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_vars.rst @@ -159,63 +159,6 @@ Parameters - Environment variable: ANSIBLE\_FOO\_FILENAME\_EXT - .. raw:: html - -
- - * - .. raw:: html - -
-
- - .. _ansible_collections.ns2.col.foo_vars__parameter-stage: - - .. rst-class:: ansible-option-title - - **stage** - - .. raw:: html - - - - .. rst-class:: ansible-option-type-line - - :ansible-option-type:`string` - - :ansible-option-versionadded:`added in ansible-base 2.10` - - - - - - .. raw:: html - -
- - - .. raw:: html - -
- - Control when this vars plugin may be executed. - - Setting this option to \ :literal:`all`\ will run the vars plugin after importing inventory and whenever it is demanded by a task. - - Setting this option to \ :literal:`task`\ will only run the vars plugin whenever it is demanded by a task. - - Setting this option to \ :literal:`inventory`\ will only run the vars plugin after parsing inventory. - - If this option is omitted, the global \ :emphasis:`RUN\_VARS\_PLUGINS`\ configuration is used to determine when to execute the vars plugin. - - - .. rst-class:: ansible-option-line - - :ansible-option-choices:`Choices:` - - - :ansible-option-choices-entry:`"all"` - - :ansible-option-choices-entry:`"task"` - - :ansible-option-choices-entry:`"inventory"` - - .. raw:: html
diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_become.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_become.rst index 50526bed..016b7ffd 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_become.rst +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_become.rst @@ -109,7 +109,9 @@ Parameters
-

Bar.

+

Bar. BAR!

+

Totally unrelated to become_user. Even with become_user=foo.

+

Might not be compatible when become_user is bar, though.

@@ -180,7 +182,7 @@ Parameters
-

User you 'become' to execute the task

+

User you 'become' to execute the task.

Default: "root"

Configuration:

- -
-
-

pipelining

- -

- boolean -

- -
-
-

Pipelining reduces the number of connection operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfers.

-

This can result in a very significant performance improvement when enabled.

-

However this can conflict with privilege escalation (become). For example, when using sudo operations you must first disable 'requiretty' in the sudoers file for the target hosts, which is why this feature is disabled by default.

-

Choices:

- - -

Configuration:

- -
- diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst index e4b703b0..969817d2 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst @@ -121,6 +121,7 @@ Parameters

A bar.

+

Independent from foo.

@@ -164,6 +165,7 @@ Parameters

A sub foo.

Whatever.

+

Also required when subfoo is specified when foo=bar or baz.

diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_shell.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_shell.rst index 6af3b86f..38daadaf 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_shell.rst +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_shell.rst @@ -96,121 +96,6 @@ Parameters - -
-
-

admin_users

- -

- list - / elements=string -

- -
-
-

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.

-

Default: ["root", "toor"]

-

Configuration:

- -
- - -
-
-

async_dir

- -

- string -

- -
-
-

Directory in which ansible will keep async job information

-

Default: "~/.ansible_async"

-

Configuration:

- -
- - -
-
-

common_remote_group

- -

- string -

-

added in ansible-base 2.10

- -
-
-

Checked when Ansible needs to execute a module as a different user.

-

If setfacl and chown both fail and do not let the different user access the module's files, they will be chgrp'd to this group.

-

In order for this to work, the remote_user and become_user must share a common group and this setting must be set to that group.

-

Configuration:

- -
- - -
-
-

environment

- -

- list - / elements=dictionary -

- -
-
-

List of dictionaries of environment variables and their values to use when executing commands.

-

Default: [{}]

-
-
@@ -219,6 +104,7 @@ Parameters

string

+

added in ansible-base 2.10

@@ -247,79 +133,6 @@ Parameters
- -
-
-

system_tmpdirs

- -

- list - / elements=string -

- -
-
-

List of valid system temporary directories on the managed machine for Ansible to validate remote_tmp against, when specific permissions are needed. These must be world readable, writable, and executable. This list should only contain directories which the system administrator has pre-created with the proper ownership and permissions otherwise security issues can arise.

-

When remote_tmp is required to be a system temp dir and it does not match any in the list, the first one from the list will be used instead.

-

Default: ["/var/tmp", "/tmp"]

-

Configuration:

- -
- - -
-
-

world_readable_temp

- -

- boolean -

-

added in ansible-base 2.10

- -
-
-

This makes the temporary files created on the machine world-readable and will issue a warning instead of failing the task.

-

It is useful when becoming an unprivileged user.

-

Choices:

- - -

Configuration:

- -
- diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_vars.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_vars.rst index 008a651d..7d7f1cf4 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_vars.rst +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_vars.rst @@ -136,32 +136,6 @@ Parameters - -
-
-

stage

- -

- string -

-

added in ansible-base 2.10

- -
-
-

Control when this vars plugin may be executed.

-

Setting this option to all will run the vars plugin after importing inventory and whenever it is demanded by a task.

-

Setting this option to task will only run the vars plugin whenever it is demanded by a task.

-

Setting this option to inventory will only run the vars plugin after parsing inventory.

-

If this option is omitted, the global RUN_VARS_PLUGINS configuration is used to determine when to execute the vars plugin.

-

Choices:

- - -
- diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/become/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/become/foo.py index 24ba061d..b281a0fc 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/become/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/become/foo.py @@ -15,7 +15,7 @@ version_added: historical options: become_user: - description: User you 'become' to execute the task + description: User you 'become' to execute the task. default: root ini: - section: privilege_escalation @@ -64,7 +64,10 @@ keyword: - name: become_exe bar: - description: Bar. + description: + - Bar. B(BAR!) + - Totally unrelated to I(become_user). Even with I(become_user=foo). + - Might not be compatible when I(become_user) is C(bar), though. type: str version_added: 1.2.0 deprecated: diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/connection/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/connection/foo.py index 7aae6a93..562ec881 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/connection/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/connection/foo.py @@ -8,11 +8,10 @@ DOCUMENTATION = ''' name: foo short_description: Foo connection + version_added: 1.2.0 description: - This is for the C(foo) connection. author: ansible (@core) - extends_documentation_fragment: - - connection_pipelining notes: - "Some note. B(Something in bold). C(And in code). I(And in italics). An URL: U(https://example.org)." - "And another one. L(A link, https://example.com)." @@ -35,4 +34,4 @@ class Connection(ConnectionBase): ''' ssh based connections ''' transport = 'ns2.col.foo' - has_pipelining = True + has_pipelining = False diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/filter/bar.yml b/tests/functional/collections/ansible_collections/ns2/col/plugins/filter/bar.yml index c573dbe6..86ca2e51 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/filter/bar.yml +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/filter/bar.yml @@ -29,9 +29,9 @@ DOCUMENTATION: type: str default: foo choices: - a: Whatever a is. - b: What is b? I don't know. - cde: This is some more unknown. + a: Whatever C(a) is. + b: What is C(b)? I don't know. + cde: This is some more unknown. There are rumors this is related to the alphabet. foo: - Our default value, the glorious C(foo). - Even has two paragraphs. diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/modules/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/modules/foo.py index 26ba7d9a..91a1ad0a 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/modules/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/modules/foo.py @@ -18,15 +18,15 @@ description: - Does some foo on the remote host. - Whether foo is magic or not has not yet been determined. -extends_documentation_fragment: - - action_common_attributes options: foo: description: The foo source. type: str required: true bar: - description: A bar. + description: + - A bar. + - Independent from I(foo). type: list elements: int aliases: @@ -40,6 +40,7 @@ description: - A sub foo. - Whatever. + - Also required when I(subfoo) is specified when I(foo=bar) or C(baz). type: str required: true @@ -48,10 +49,14 @@ attributes: check_mode: + description: Can run in check_mode and return changed status prediction without modifying target support: full diff_mode: + description: Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode support: full platform: + description: Target OS/families that can be operated against + support: N/A platforms: posix ''' diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/shell/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/shell/foo.py index 57c042d4..85d74b53 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/shell/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/shell/foo.py @@ -11,8 +11,21 @@ version_added: 1.0.0 description: - This is for the foo shell. -extends_documentation_fragment: - - shell_common +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 + version_added: '2.10' + version_added_collection: ansible.builtin ''' from ansible.plugins.shell import ShellBase diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/vars/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/vars/foo.py index eec861c8..19d4e3eb 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/vars/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/vars/foo.py @@ -28,8 +28,6 @@ section: defaults type: list elements: string - extends_documentation_fragment: - - vars_plugin_staging ''' from ansible.plugins.vars import BaseVarsPlugin