summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSandra McCann <samccann@redhat.com>2022-12-06 17:00:27 -0500
committerGitHub <noreply@github.com>2022-12-06 14:00:27 -0800
commit53da28da6a6a9ef10a2df31971db43525df5dcf4 (patch)
tree42e5188062ea6a7de2cbddcd7bba4fa585e84ae9
parent8befa158d1ef6de35a1695878424ad7c5dd83131 (diff)
downloadansible-53da28da6a6a9ef10a2df31971db43525df5dcf4.tar.gz
Backportapalooza 12 01 (#79514)
* docs - make the existence of 'trivial' changelog entries easier to find (#79440) (cherry picked from commit 3cc95d1f126e239aa0e357c0060b18a8c4946e7a) * Add comma (#79480) (cherry picked from commit 3a6b6370add78cf08463a8db69d0337534d6840a) * Fix lists styling (#79481) (cherry picked from commit 3723c426d2f12b8ba6adde6c06302a4dc8851126) * add ansible-galaxy cli documentation for parallel execution (#79433) * add ansible-galaxy cli documentation for parallel execution Co-authored-by: saranti <tsarantis@proton.me> * Update lib/ansible/cli/galaxy.py * Update lib/ansible/cli/galaxy.py Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua> Co-authored-by: saranti <tsarantis@proton.me> Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua> (cherry picked from commit 01ff57bdff35e0e97b16caa2c420fe01039d13e1) Co-authored-by: Mark Chappell <mchappel@redhat.com> Co-authored-by: Waleed Mortaja <27075022+WaleedMortaja@users.noreply.github.com> Co-authored-by: Sloane Hertel <19572925+s-hertel@users.noreply.github.com>
-rw-r--r--docs/docsite/rst/community/collection_development_process.rst11
-rw-r--r--docs/docsite/rst/getting_started/get_started_inventory.rst2
-rw-r--r--docs/docsite/rst/inventory_guide/intro_inventory.rst10
-rwxr-xr-xlib/ansible/cli/galaxy.py6
4 files changed, 24 insertions, 5 deletions
diff --git a/docs/docsite/rst/community/collection_development_process.rst b/docs/docsite/rst/community/collection_development_process.rst
index 2da3964925..3c2f609cce 100644
--- a/docs/docsite/rst/community/collection_development_process.rst
+++ b/docs/docsite/rst/community/collection_development_process.rst
@@ -151,10 +151,19 @@ A single changelog fragment may contain multiple sections but most will only con
- idrac_user - module may error out with the message ``unable to perform the import or export operation`` because there are pending attribute changes or a configuration job is in progress. Wait for the job to complete and run the task again.(https://github.com/dell/dellemc-openmanage-ansible-modules/pull/303).
+**trivial**
+ Changes where a formal release changelog entry isn't required. ``trivial`` changelog fragments are excluded from the published changelog output and may be used for changes such as housekeeping, documentation and test only changes.
+ You can use ``trivial`` for collections that require a changelog fragment for each pull request.
+
+ .. code-block:: yaml
+
+ trivial:
+ - aws_ec2 - fix broken integration test (https://github.com/ansible-collections/amazon.aws/pull/1269).
+
Each changelog entry must contain a link to its issue between parentheses at the end. If there is no corresponding issue, the entry must contain a link to the PR itself.
-Most changelog entries are ``bugfixes`` or ``minor_changes``. You can also use ``trivial`` for any collection that requires a changelog fragment for each pull request. ``trivial`` changelog fragments are excluded from the changelog output.
+Most changelog entries are ``bugfixes`` or ``minor_changes``.
Changelog fragment entry format
diff --git a/docs/docsite/rst/getting_started/get_started_inventory.rst b/docs/docsite/rst/getting_started/get_started_inventory.rst
index 1e21f0469e..8df7330207 100644
--- a/docs/docsite/rst/getting_started/get_started_inventory.rst
+++ b/docs/docsite/rst/getting_started/get_started_inventory.rst
@@ -14,7 +14,7 @@ Now let's create an inventory file that you can add to source control for flexib
.. note::
Inventory files can be in ``INI`` or ``YAML`` format.
- For demonstration purposes this section uses ``YAML`` format only.
+ For demonstration purposes, this section uses ``YAML`` format only.
Complete the following steps:
diff --git a/docs/docsite/rst/inventory_guide/intro_inventory.rst b/docs/docsite/rst/inventory_guide/intro_inventory.rst
index 6bc052c4ea..3fd6782dbd 100644
--- a/docs/docsite/rst/inventory_guide/intro_inventory.rst
+++ b/docs/docsite/rst/inventory_guide/intro_inventory.rst
@@ -128,6 +128,7 @@ Grouping groups: parent/child group relationships
You can create parent/child relationships among groups. Parent groups are also known as nested groups or groups of groups. For example, if all your production hosts are already in groups such as ``atlanta_prod`` and ``denver_prod``, you can create a ``production`` group that includes those smaller groups. This approach reduces maintenance because you can add or remove hosts from the parent group by editing the child groups.
To create parent/child relationships for groups:
+
* in INI format, use the ``:children`` suffix
* in YAML format, use the ``children:`` entry
@@ -292,7 +293,9 @@ We document adding variables in the main inventory file for simplicity. However,
Assigning a variable to one machine: host variables
===================================================
-You can easily assign a variable to a single host, then use it later in playbooks. You can do this directly in your inventory file. In INI:
+You can easily assign a variable to a single host, then use it later in playbooks. You can do this directly in your inventory file.
+
+In INI:
.. code-block:: text
@@ -376,7 +379,9 @@ Consider using YAML format for inventory sources to avoid confusion on the actua
Assigning a variable to many machines: group variables
======================================================
-If all hosts in a group share a variable value, you can apply that variable to an entire group at once. In INI:
+If all hosts in a group share a variable value, you can apply that variable to an entire group at once.
+
+In INI:
.. code-block:: text
@@ -545,6 +550,7 @@ When using multiple inventory sources, keep in mind that any variable conflicts
to the rules described in :ref:`how_we_merge` and :ref:`ansible_variable_precedence`. You can control the merging order of variables in inventory sources to get the variable value you need.
When you pass multiple inventory sources at the command line, Ansible merges variables in the order you pass those parameters. If ``[all:vars]`` in staging inventory defines ``myvar = 1`` and production inventory defines ``myvar = 2``, then:
+
* Pass ``-i staging -i production`` to run the playbook with ``myvar = 2``.
* Pass ``-i production -i staging`` to run the playbook with ``myvar = 1``.
diff --git a/lib/ansible/cli/galaxy.py b/lib/ansible/cli/galaxy.py
index f4148d924d..bc691b2859 100755
--- a/lib/ansible/cli/galaxy.py
+++ b/lib/ansible/cli/galaxy.py
@@ -197,7 +197,11 @@ class RoleDistributionServer:
class GalaxyCLI(CLI):
- '''command to manage Ansible roles in shared repositories, the default of which is Ansible Galaxy *https://galaxy.ansible.com*.'''
+ '''Command to manage Ansible roles and collections.
+
+ None of the CLI tools are designed to run concurrently with themselves.
+ Use an external scheduler and/or locking to ensure there are no clashing operations.
+ '''
name = 'ansible-galaxy'