summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSandra McCann <samccann@redhat.com>2023-01-19 18:58:23 -0500
committerGitHub <noreply@github.com>2023-01-19 15:58:23 -0800
commita7aeb61c030b1d396c3ecd97657de2c584ee5354 (patch)
tree04bcceff7ed2657b618e4da7256417495e608267
parentb96adb8602e5309de204d12af2e3e84d225c9f98 (diff)
downloadansible-a7aeb61c030b1d396c3ecd97657de2c584ee5354.tar.gz
Backportapalooza 01 19 (#79771)
* Update authentication.rst (#79623) (cherry picked from commit e7af7532bdb1aa5ed1f10191b37b485aa5fe3bec) * Fix typo (#79641) (cherry picked from commit 8e7cc371bea876e52acd2fbccaf1cc42fe26bf24) * correct the mistake of example repeat_original (#79659) there is a little mistake ##### ISSUE TYPE - Docs Pull Request +label: docsite_pr (cherry picked from commit 6f8c1da0c805f334b8598fd2556f7ed92dc9348e) * switched reference from katacoda to instruqt (#79698) (cherry picked from commit 0fc932fda01d03ffc32c249d9ef5565851eba1f0) * contributor_path: fix typos (#79678) (cherry picked from commit fe7d488a1ba1583a89172768f8ce3382e168ed2c) * Fix broken reference to FAQ (#79621) (cherry picked from commit 602824db1d83afa4bbfc6869d5802ebf515c835d) * Docsite: add Security Automation Working Group to Communication guide (#79692) (cherry picked from commit 65efa4b97ff1c1539cdb79697cc0c85df8da6c77) * Docsite: remove dead Lockdown Working Group from Communication guide (#79693) (cherry picked from commit 55f9d7f71f8a7dc67b2dc19a2e8bad7c550003fc) * Fix `undef()` example to a valid Jinja template (#79701) (cherry picked from commit e41d2874a67ade813ffaf2ebfff67987291d53c0) * Truthy value should be one of false or true (#79730) Otherwise ansible-lint complains: https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.truthy (cherry picked from commit b756a08d891b3bb07b208ed4dea2a797bcf9ea39) * Fix regex filter docs (#79736) * Fix notes in regex_replace doc The documentation says that this maps to 'regex.replace' when it should say 're.replace'. The distinction is important because of the third-party 'regex' module that has more features than the built-in 're' module. https://pypi.org/project/regex/ * Fix notes in re.search docs The documentation says that this maps to 'regex.search' when it should say 're.search'. The distinction is important because of the third-party 'regex' module that has more features than the built-in 're' module. https://pypi.org/project/regex/ (cherry picked from commit cf50d8131f0afea38a7dd78eab14410cc580d479) * complex_data_manipulation.rst: fix typo (#79758) (cherry picked from commit b5b7f9bce2c688eed90ef36b1f6b9f2ccd424706) * Fix broken link for inventory script examples (#79762) These scripts were removed from community.general in https://github.com/ansible-collections/community.general/pull/2696 and moved to ansible-community/contrib-scripts per https://github.com/ansible-community/community-topics/issues/16#issuecomment-853317111 (cherry picked from commit 97993eeb10f1e40831920dfcdf51fe722427c60e) * communication.rst: improve (#79751) (cherry picked from commit 11a27eefa2c3a20f7709c47a61a37beb8ec2ccf5) * Fix broken docs links. (#79769) (cherry picked from commit 5d71ace5834a416948b3e62922f825d6f31993a4) Co-authored-by: Gineesh Madapparambath <net.gini@gmail.com> Co-authored-by: Kristopher Henry Kram <kristopher@kristopherkram.com> Co-authored-by: evangelionlion <546620084@qq.com> Co-authored-by: Deric Crago <deric.crago@gmail.com> Co-authored-by: Andrew Klychkov <aklychko@redhat.com> Co-authored-by: Rune Juhl Jacobsen <rune@juhljacobsen.dk> Co-authored-by: Kristian Heljas <11139388+kristianheljas@users.noreply.github.com> Co-authored-by: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com> Co-authored-by: antonc42 <antonc42@users.noreply.github.com> Co-authored-by: Kenyon Ralph <kenyon@kenyonralph.com> Co-authored-by: Matt Clay <matt@mystile.com>
-rw-r--r--docs/docsite/rst/community/communication.rst9
-rw-r--r--docs/docsite/rst/community/contributor_path.rst4
-rw-r--r--docs/docsite/rst/dev_guide/testing_running_locally.rst4
-rw-r--r--docs/docsite/rst/getting_started/index.rst2
-rw-r--r--docs/docsite/rst/installation_guide/installation_distros.rst2
-rw-r--r--docs/docsite/rst/inventory_guide/intro_dynamic_inventory.rst2
-rw-r--r--docs/docsite/rst/playbook_guide/complex_data_manipulation.rst2
-rw-r--r--docs/docsite/rst/playbook_guide/playbooks_filters.rst2
-rw-r--r--docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst2
-rw-r--r--lib/ansible/modules/systemd_service.py10
-rw-r--r--lib/ansible/plugins/doc_fragments/validate.py4
-rw-r--r--lib/ansible/plugins/filter/product.yml2
-rw-r--r--lib/ansible/plugins/filter/regex_replace.yml2
-rw-r--r--lib/ansible/plugins/filter/regex_search.yml2
14 files changed, 26 insertions, 23 deletions
diff --git a/docs/docsite/rst/community/communication.rst b/docs/docsite/rst/community/communication.rst
index 87a37e8618..1e8bc64543 100644
--- a/docs/docsite/rst/community/communication.rst
+++ b/docs/docsite/rst/community/communication.rst
@@ -22,7 +22,6 @@ Your first post to the mailing list will be moderated (to reduce spam), so pleas
* `Ansible Announce list <https://groups.google.com/forum/#!forum/ansible-announce>`_ is a read-only list that shares information about new releases of Ansible, and also rare infrequent event information, such as announcements about an upcoming AnsibleFest, which is our official conference series. Worth subscribing to!
* `Ansible AWX List <https://groups.google.com/forum/#!forum/awx-project>`_ is for `Ansible AWX <https://github.com/ansible/awx>`_
* `Ansible Development List <https://groups.google.com/forum/#!forum/ansible-devel>`_ is for questions about developing Ansible modules (mostly in Python), fixing bugs in the Ansible core code, asking about prospective feature design, or discussions about extending Ansible or features in progress.
-* `Ansible Lockdown List <https://groups.google.com/forum/#!forum/ansible-lockdown>`_ is for all things related to Ansible Lockdown projects, including DISA STIG automation and CIS Benchmarks.
* `Ansible Outreach List <https://groups.google.com/forum/#!forum/ansible-outreach>`_ help with promoting Ansible and `Ansible Meetups <https://www.meetup.com/topics/ansible/>`_
* `Ansible Project List <https://groups.google.com/forum/#!forum/ansible-project>`_ is for sharing Ansible tips, answering questions about playbooks and roles, and general user discussion.
* `Molecule Discussions <https://github.com/ansible-community/molecule/discussions>`_ is designed to aid with the development and testing of Ansible roles with Molecule.
@@ -56,7 +55,11 @@ Matrix chat supports:
* no line limits
* images
-The room links in the :ref:`general_channels` will take you directly to the relevant rooms. For more information, see the community-hosted `Matrix FAQ <https://hackmd.io/@ansible-community/community-matrix-faq>`_.
+The room links in the :ref:`general_channels` or in the :ref:`working_group_list` list will take you directly to the relevant rooms.
+
+If there is no appropriate room for your community, please create it.
+
+For more information, see the community-hosted `Matrix FAQ <https://hackmd.io/@ansible-community/community-matrix-faq>`_.
Ansible community on IRC
------------------------
@@ -104,7 +107,6 @@ Many of our community `Working Groups <https://github.com/ansible/community/wiki
- `AAP Configuration as Code <https://github.com/redhat-cop/controller_configuration/wiki/AAP-Configuration-as-Code>`_ - Matrix: `#aap_config_as_code:ansible.com <https://matrix.to/#/#aap_config_as_code:ansible.com>`_
- `Amazon (AWS) Working Group <https://github.com/ansible/community/wiki/AWS>`_ - Matrix: `#aws:ansible.com <https://matrix.to:/#/#aws:ansible.com>`_ | IRC: ``#ansible-aws``
-- `Ansible Lockdown Working Group <https://github.com/ansible/community/wiki/Lockdown>`_ (`Security playbooks/roles <https://github.com/ansible/ansible-lockdown>`_) - Matrix: `#lockdown:ansible.com <https://matrix.to:/#/#lockdown:ansible.com>`_ | IRC: ``#ansible-lockdown``
- `AWX Working Group <https://github.com/ansible/awx>`_ - Matrix: `#awx:ansible.com <https://matrix.to:/#/#awx:ansible.com>`_ | IRC: ``#ansible-awx``
- `Azure Working Group <https://github.com/ansible/community/wiki/Azure>`_ - Matrix: `#azure:ansible.com <https://matrix.to:/#/#azure:ansible.com>`_ | IRC: ``#ansible-azure``
- `Community Working Group <https://github.com/ansible/community/wiki/Community>`_ (including Meetups) - Matrix: `#community:ansible.com <https://matrix.to:/#/#community:ansible.com>`_ | IRC: ``#ansible-community``
@@ -123,6 +125,7 @@ Many of our community `Working Groups <https://github.com/ansible/community/wiki
- `Network Working Group <https://github.com/ansible/community/wiki/Network>`_ - Matrix: `#network:ansible.com <https://matrix.to:/#/#network:ansible.com>`_ | IRC: ``#ansible-network``
- `PostgreSQL Working Group <https://github.com/ansible-collections/community.postgresql/wiki/PostgreSQL-Working-Group>`_ - Matrix: `#postgresql:ansible.com <https://matrix.to:/#/#postgresql:ansible.com>`_
- `Remote Management Working Group <https://github.com/ansible/community/issues/409>`_ - Matrix: `#devel:ansible.com <https://matrix.to:/#/#devel:ansible.com>`_ | IRC: ``#ansible-devel``
+- `Security Automation Working Group <https://github.com/ansible/community/wiki/Security-Automation>`_ - Matrix: `#security-automation:ansible.com <https://matrix.to/#/#security-automation:ansible.com>`_ | IRC: ``#ansible-security``
- `Storage Working Group <https://github.com/ansible/community/wiki/Storage>`_ - Matrix: `#storage:ansible.com <https://matrix.to/#/#storage:ansible.com>`_ | IRC: ``#ansible-storage``
- `Testing Working Group <https://github.com/ansible/community/wiki/Testing>`_ - Matrix: `#devel:ansible.com <https://matrix.to:/#/#devel:ansible.com>`_ | IRC: ``#ansible-devel``
- `VMware Working Group <https://github.com/ansible/community/wiki/VMware>`_ - Matrix: `#vmware:ansible.com <https://matrix.to:/#/#vmware:ansible.com>`_ | IRC: ``#ansible-vmware``
diff --git a/docs/docsite/rst/community/contributor_path.rst b/docs/docsite/rst/community/contributor_path.rst
index 1708db3798..de59be659f 100644
--- a/docs/docsite/rst/community/contributor_path.rst
+++ b/docs/docsite/rst/community/contributor_path.rst
@@ -81,7 +81,7 @@ Become a collection maintainer
If you are a code contributor to a collection, you can get extended permissions in the repository and become a maintainer. A collection maintainer is a contributor trusted by the community who makes significant and regular contributions to the project and showed themselves as a specialist in the related area. See :ref:`maintainers` for details.
-For some collections that use the `collection bot <https://github.com/ansible-community/collection_bot>`_, such as `community.general <https://github.com/ansible-collections/community.general>`_ and `community.network <https://github.com/ansible-collections/community.network>`_, you can have different levels of access and permissions.
+For some collections that use the `collection bot <https://github.com/ansible-community/collection_bot>`_, such as `community.general <https://github.com/ansible-collections/community.general>`_ and `community.network <https://github.com/ansible-collections/community.network>`_, you can have different levels of access and permissions.
* :ref:`module_maintainers` - The stage prior to becoming a collection maintainer. The file is usually a module or plugin. File maintainers have indirect commit rights.
* supershipit permissions - Similar to being a file maintainer but the scope where a maintainer has the indirect commit is the whole repository.
@@ -103,4 +103,4 @@ To reach the status, as the current Committee members did before getting it, alo
* Subscribe to, comment on, and vote on the `Community Topics <https://github.com/ansible-community/community-topics/issues>`_.
* Propose your topics.
-* If time permits, join the `Community meetings <https://github.com/ansible/community/blob/main/meetings/README.md#schedule>`_ Note this is **NOT** a requirement.
+* If time permits, join the `Community meetings <https://github.com/ansible/community/blob/main/meetings/README.md#schedule>`_. Note this is **NOT** a requirement.
diff --git a/docs/docsite/rst/dev_guide/testing_running_locally.rst b/docs/docsite/rst/dev_guide/testing_running_locally.rst
index 0267fcdf6a..0d03189bf4 100644
--- a/docs/docsite/rst/dev_guide/testing_running_locally.rst
+++ b/docs/docsite/rst/dev_guide/testing_running_locally.rst
@@ -200,7 +200,7 @@ Configuration requirements
4. Click **Apply and restart** if changes were made.
-.. setup_instructions:
+.. _setup_instructions:
Setup instructions
""""""""""""""""""
@@ -251,7 +251,7 @@ Setup instructions
You should now be able to use ``ansible-test`` with the ``--docker`` option.
-.. linux_cgroup_configuration:
+.. _linux_cgroup_configuration:
Linux cgroup configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/docsite/rst/getting_started/index.rst b/docs/docsite/rst/getting_started/index.rst
index a1419393c1..818c7fbe37 100644
--- a/docs/docsite/rst/getting_started/index.rst
+++ b/docs/docsite/rst/getting_started/index.rst
@@ -84,7 +84,7 @@ Continue by :ref:`learning how to build an inventory<get_started_inventory>`.
`Ansible Demos <https://github.com/ansible/product-demos>`_
Demonstrations of different Ansible usecases
- `RHEL Labs <https://katacoda.com/rhel-labs>`_
+ `Ansible Labs <https://www.ansible.com/products/ansible-training>`_
Labs to provide further knowledge on different topics
`Mailing List <https://groups.google.com/group/ansible-project>`_
Questions? Help? Ideas? Stop by the list on Google Groups
diff --git a/docs/docsite/rst/installation_guide/installation_distros.rst b/docs/docsite/rst/installation_guide/installation_distros.rst
index ce07c6a70d..f7200416cb 100644
--- a/docs/docsite/rst/installation_guide/installation_distros.rst
+++ b/docs/docsite/rst/installation_guide/installation_distros.rst
@@ -104,7 +104,7 @@ You cannot use a Windows system for the Ansible control node. See :ref:`windows_
.. seealso::
- `Installing Ansible on ARch Linux <https://wiki.archlinux.org/title/Ansible#Installation>`_
+ `Installing Ansible on Arch Linux <https://wiki.archlinux.org/title/Ansible#Installation>`_
Distro-specific installation on Arch Linux
`Installing Ansible on Clear Linux <https://clearlinux.org/software/bundle/ansible>`_
Distro-specific installation on Clear Linux
diff --git a/docs/docsite/rst/inventory_guide/intro_dynamic_inventory.rst b/docs/docsite/rst/inventory_guide/intro_dynamic_inventory.rst
index 1a6113a6bf..e0d9c204f7 100644
--- a/docs/docsite/rst/inventory_guide/intro_dynamic_inventory.rst
+++ b/docs/docsite/rst/inventory_guide/intro_dynamic_inventory.rst
@@ -208,7 +208,7 @@ Note that the OpenStack dynamic inventory script will cache results to avoid rep
Other inventory scripts
=======================
-In Ansible 2.10 and later, inventory scripts moved to their associated collections. Many are now in the `community.general scripts/inventory directory <https://github.com/ansible-collections/community.general/tree/main/scripts/inventory>`_. We recommend you use :ref:`inventory_plugins` instead.
+In Ansible 2.10 and later, inventory scripts moved to their associated collections. Many are now in the `ansible-community/contrib-scripts repository <https://github.com/ansible-community/contrib-scripts/tree/main/inventory>`_. We recommend you use :ref:`inventory_plugins` instead.
.. _using_multiple_sources:
diff --git a/docs/docsite/rst/playbook_guide/complex_data_manipulation.rst b/docs/docsite/rst/playbook_guide/complex_data_manipulation.rst
index f94fb88f92..11ed3c388e 100644
--- a/docs/docsite/rst/playbook_guide/complex_data_manipulation.rst
+++ b/docs/docsite/rst/playbook_guide/complex_data_manipulation.rst
@@ -295,7 +295,7 @@ An example on how to use facts to find a host's data that meets condition X:
vars:
uptime_of_host_most_recently_rebooted: "{{ansible_play_hosts_all | map('extract', hostvars, 'ansible_uptime_seconds') | sort | first}}"
-An example to show a host uptime in days/hours/minutes/seconds (assumes facts where gathered).
+An example to show a host uptime in days/hours/minutes/seconds (assumes facts were gathered).
.. code-block:: YAML+Jinja
diff --git a/docs/docsite/rst/playbook_guide/playbooks_filters.rst b/docs/docsite/rst/playbook_guide/playbooks_filters.rst
index 6063c061ae..52fb861ac1 100644
--- a/docs/docsite/rst/playbook_guide/playbooks_filters.rst
+++ b/docs/docsite/rst/playbook_guide/playbooks_filters.rst
@@ -81,7 +81,7 @@ A convenient way of requiring a variable to be overridden is to give it an undef
.. code-block:: yaml+jinja
galaxy_url: "https://galaxy.ansible.com"
- galaxy_api_key: {{ undef(hint="You must specify your Galaxy API key") }}
+ galaxy_api_key: "{{ undef(hint='You must specify your Galaxy API key') }}"
Defining different values for true/false/null (ternary)
=======================================================
diff --git a/docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst b/docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst
index 79c55102fa..4f09cbe101 100644
--- a/docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst
+++ b/docs/docsite/rst/scenario_guides/vmware_rest_scenarios/authentication.rst
@@ -33,7 +33,7 @@ Module parameters
All the vcenter_rest modules accept the following arguments:
-- ``vcenter_host``
+- ``vcenter_hostname``
- ``vcenter_username``
- ``vcenter_password``
diff --git a/lib/ansible/modules/systemd_service.py b/lib/ansible/modules/systemd_service.py
index 4cd323b9b5..3580fa5ee4 100644
--- a/lib/ansible/modules/systemd_service.py
+++ b/lib/ansible/modules/systemd_service.py
@@ -108,7 +108,7 @@ EXAMPLES = '''
- name: Restart service cron on centos, in all cases, also issue daemon-reload to pick up config changes
ansible.builtin.systemd:
state: restarted
- daemon_reload: yes
+ daemon_reload: true
name: crond
- name: Reload service httpd, in all cases
@@ -119,22 +119,22 @@ EXAMPLES = '''
- name: Enable service httpd and ensure it is not masked
ansible.builtin.systemd:
name: httpd
- enabled: yes
+ enabled: true
masked: no
- name: Enable a timer unit for dnf-automatic
ansible.builtin.systemd:
name: dnf-automatic.timer
state: started
- enabled: yes
+ enabled: true
- name: Just force systemd to reread configs (2.4 and above)
ansible.builtin.systemd:
- daemon_reload: yes
+ daemon_reload: true
- name: Just force systemd to re-execute itself (2.8 and above)
ansible.builtin.systemd:
- daemon_reexec: yes
+ daemon_reexec: true
- name: Run a user service when XDG_RUNTIME_DIR is not set on remote login
ansible.builtin.systemd:
diff --git a/lib/ansible/plugins/doc_fragments/validate.py b/lib/ansible/plugins/doc_fragments/validate.py
index f77514d27f..ac66d2530a 100644
--- a/lib/ansible/plugins/doc_fragments/validate.py
+++ b/lib/ansible/plugins/doc_fragments/validate.py
@@ -15,7 +15,7 @@ options:
- The validation command to run before copying the updated file into the final destination.
- A temporary file path is used to validate, passed in through '%s' which must be present as in the examples below.
- Also, the command is passed securely so shell features such as expansion and pipes will not work.
- - For an example on how to handle more complex validation than what this option provides,
- see L(Complex configuration validation,https://docs.ansible.com/ansible/devel/reference_appendices/faq.html).
+ - For an example on how to handle more complex validation than what this
+ option provides, see R(handling complex validation,complex_configuration_validation).
type: str
'''
diff --git a/lib/ansible/plugins/filter/product.yml b/lib/ansible/plugins/filter/product.yml
index c558e4e426..5035522825 100644
--- a/lib/ansible/plugins/filter/product.yml
+++ b/lib/ansible/plugins/filter/product.yml
@@ -30,7 +30,7 @@ EXAMPLES: |
repeat_original: "{{ [1,2] | product(repeat=2) }}"
# repeat_product => [ [ 1, "a", 1, "a" ], [ 1, "a", 1, "b" ], [ 1, "a", 2, "a" ], [ 1, "a", 2, "b" ], [ 1, "b", 1, "a" ], [ 1, "b", 1, "b" ], [ 1, "b", 2, "a" ], [ 1, "b", 2, "b" ], [ 2, "a", 1, "a" ], [ 2, "a", 1, "b" ], [ 2, "a", 2, "a" ], [ 2, "a", 2, "b" ], [ 2, "b", 1, "a" ], [ 2, "b", 1, "b" ], [ 2, "b", 2, "a" ], [ 2, "b", 2, "b" ] ]
- repeat_product: "{{ [1,2] | product(['a', 'b']) }}"
+ repeat_product: "{{ [1,2] | product(['a', 'b'], repeat=2) }}"
# domains => [ 'example.com', 'ansible.com', 'redhat.com' ]
domains: "{{ [ 'example', 'ansible', 'redhat'] | product(['com']) | map('join', '.') }}"
diff --git a/lib/ansible/plugins/filter/regex_replace.yml b/lib/ansible/plugins/filter/regex_replace.yml
index 47c2eb3bec..0277b5605e 100644
--- a/lib/ansible/plugins/filter/regex_replace.yml
+++ b/lib/ansible/plugins/filter/regex_replace.yml
@@ -5,7 +5,7 @@ DOCUMENTATION:
description:
- Replace a substring defined by a regular expression with another defined by another regular expression based on the first match.
notes:
- - Maps to Python's C(regex.replace).
+ - Maps to Python's C(re.replace).
positional: _input, _regex_match, _regex_replace
options:
_input:
diff --git a/lib/ansible/plugins/filter/regex_search.yml b/lib/ansible/plugins/filter/regex_search.yml
index b459c93699..c61efb7623 100644
--- a/lib/ansible/plugins/filter/regex_search.yml
+++ b/lib/ansible/plugins/filter/regex_search.yml
@@ -5,7 +5,7 @@ DOCUMENTATION:
description:
- Search in a string to extract the part that matches the regular expression.
notes:
- - Maps to Python's C(regex.search).
+ - Maps to Python's C(re.search).
positional: _input, _regex
options:
_input: