summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSandra McCann <samccann@redhat.com>2022-07-21 17:01:38 -0400
committerGitHub <noreply@github.com>2022-07-21 14:01:38 -0700
commit8f96331f4c6f993e74d341b7082946c62a4c5873 (patch)
tree077803e1cbb214012cdd5cb4fd3ab0cf47f67d3c /docs
parentb6fc894010d041e11efd0956daa9e5788b9b7409 (diff)
downloadansible-8f96331f4c6f993e74d341b7082946c62a4c5873.tar.gz
Backportapalooza 07 21 (#78326)
* Update cheetsheet to fix meaning of -k (#78271) (cherry picked from commit 691dde645c6061c545695bb48798d60022ab0b93) * Add note about package managers (#78260) (cherry picked from commit fedd3869987d9b3aa123622355ae9160a5594198) * dnf: clarify comparison operators in docs (#78316) Fixes #78295 (cherry picked from commit b0a84cc9ca13b3feb0202c677a0547f9ef415f62) * Fix minor typos (#78294) Signed-off-by: Hu Shuai <hus.fnst@fujitsu.com> (cherry picked from commit fd810e88d6b7cf2c53e231a32d33be9cdd370579) * Add cli docs for interacting with gpg for collection signing (#78321) Co-authored-by: Jan-Piet Mens <jp@mens.de> Co-authored-by: Desmond Obisi <51109125+DesmondSanctity@users.noreply.github.com> Co-authored-by: Martin Krizek <martin.krizek@gmail.com> Co-authored-by: Hu Shuai <hus.fnst@fujitsu.com> Co-authored-by: Matt Martz <matt@sivel.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/docsite/rst/community/collection_contributors/collection_release_with_branches.rst2
-rw-r--r--docs/docsite/rst/community/maintainers_workflow.rst2
-rw-r--r--docs/docsite/rst/user_guide/cheatsheet.rst4
-rw-r--r--docs/docsite/rst/user_guide/collections_using.rst15
-rw-r--r--docs/docsite/rst/user_guide/intro_adhoc.rst4
5 files changed, 21 insertions, 6 deletions
diff --git a/docs/docsite/rst/community/collection_contributors/collection_release_with_branches.rst b/docs/docsite/rst/community/collection_contributors/collection_release_with_branches.rst
index b4fe739189..9cc7054fb9 100644
--- a/docs/docsite/rst/community/collection_contributors/collection_release_with_branches.rst
+++ b/docs/docsite/rst/community/collection_contributors/collection_release_with_branches.rst
@@ -203,7 +203,7 @@ Publishing the collection
* Whether to add ignore entries to the corresponding ``tests/sanity/ignore-*.txt`` file and create issues, for example for removed features in ``modules/plugins``.
Once the CI tests pass, merge the pull request. Make sure that this pull request is merged not too much later after the release
- for ``verison_added`` sanity tests not to expect the wrong version for the new feature pull request.
+ for ``version_added`` sanity tests not to expect the wrong version for the new feature pull request.
.. note::
diff --git a/docs/docsite/rst/community/maintainers_workflow.rst b/docs/docsite/rst/community/maintainers_workflow.rst
index 2e42fa6dc9..f26532cb26 100644
--- a/docs/docsite/rst/community/maintainers_workflow.rst
+++ b/docs/docsite/rst/community/maintainers_workflow.rst
@@ -52,7 +52,7 @@ Collection maintainers are responsible for releasing new versions of a collectio
#. Planning and announcement.
#. Generating a changelog.
#. Creating a release git tag and pushing it.
-#. Automaticly publishing the release tarball on `Ansible Galaxy <https://galaxy.ansible.com/>`_ through the `Zuul dashboard <https://dashboard.zuul.ansible.com/t/ansible/builds?pipeline=release>`_.
+#. Automatically publishing the release tarball on `Ansible Galaxy <https://galaxy.ansible.com/>`_ through the `Zuul dashboard <https://dashboard.zuul.ansible.com/t/ansible/builds?pipeline=release>`_.
#. Final announcement.
#. Optionally, `file a request to include a new collection into the Ansible package <https://github.com/ansible-collections/ansible-inclusion>`_.
diff --git a/docs/docsite/rst/user_guide/cheatsheet.rst b/docs/docsite/rst/user_guide/cheatsheet.rst
index 11acc85f7c..99631764f2 100644
--- a/docs/docsite/rst/user_guide/cheatsheet.rst
+++ b/docs/docsite/rst/user_guide/cheatsheet.rst
@@ -14,12 +14,12 @@ ansible-playbook
.. code-block:: bash
- ansible-playbook -i /path/to/my_inventory_file -u my_connection_user -k /path/to/my_ssh_key -f 3 -T 30 -t my_tag -m /path/to/my_modules -b -K my_playbook.yml
+ ansible-playbook -i /path/to/my_inventory_file -u my_connection_user -k -f 3 -T 30 -t my_tag -m /path/to/my_modules -b -K my_playbook.yml
Loads ``my_playbook.yml`` from the current working directory and:
- ``-i`` - uses ``my_inventory_file`` in the path provided for :ref:`inventory <intro_inventory>` to match the :ref:`pattern <intro_patterns>`.
- ``-u`` - connects :ref:`over SSH <connections>` as ``my_connection_user``.
- - ``-k`` - uses ``my_ssh_key`` in the path provided for SSH authentication.
+ - ``-k`` - asks for password which is then provided to SSH authentication.
- ``-f`` - allocates 3 :ref:`forks <playbooks_strategies>`.
- ``-T`` - sets a 30-second timeout.
- ``-t`` - runs only tasks marked with the :ref:`tag <tags>` ``my_tag``.
diff --git a/docs/docsite/rst/user_guide/collections_using.rst b/docs/docsite/rst/user_guide/collections_using.rst
index 4d97f2c4bf..1bebb1dec6 100644
--- a/docs/docsite/rst/user_guide/collections_using.rst
+++ b/docs/docsite/rst/user_guide/collections_using.rst
@@ -273,10 +273,23 @@ Verifying against ``tar.gz`` files is not supported. If your ``requirements.yml`
Signature verification
----------------------
-If a collection has been signed by the Galaxy server, the server will provide ASCII armored, detached signatures to verify the authenticity of the MANIFEST.json before using it to verify the collection's contents. You must opt into signature verification by configuring a keyring for ``ansible-galaxy`` to use and providing the path with the ``--keyring`` option.
+If a collection has been signed by the Galaxy server, the server will provide ASCII armored, detached signatures to verify the authenticity of the MANIFEST.json before using it to verify the collection's contents. You must opt into signature verification by :ref:`configuring a keyring <galaxy_gpg_keyring>` for ``ansible-galaxy``, or by providing the path with the ``--keyring`` option.
+
+To import a public key into a keyring for use with ``ansible-galaxy`` use the following step.
+
+.. code-block:: bash
+
+ gpg --import --no-default-keyring --keyring ~/.ansible/pubring.kbx my-public-key.asc
In addition to any signatures provided by the Galaxy server, signature sources can also be provided in the requirements file and on the command line. Signature sources should be URIs.
+You can manually generate detached signatures for a collection using the ``gpg`` CLI using the following step. This step assume you have generated a GPG private key, but do not cover this process.
+
+.. code-block:: bash
+
+ ansible-galaxy collection build
+ tar -Oxzf namespace-name-1.0.0.tar.gz MANIFEST.json | gpg --output namespace-name-1.0.0.asc --detach-sign --armor --local-user email@example.com -
+
Use the ``--signature`` option to verify collection name(s) provided on the CLI with an additional signature. This option can be used multiple times to provide multiple signatures.
.. code-block:: bash
diff --git a/docs/docsite/rst/user_guide/intro_adhoc.rst b/docs/docsite/rst/user_guide/intro_adhoc.rst
index a0de3fa8e8..865ffa4254 100644
--- a/docs/docsite/rst/user_guide/intro_adhoc.rst
+++ b/docs/docsite/rst/user_guide/intro_adhoc.rst
@@ -112,7 +112,9 @@ As well as delete directories (recursively) and delete files:
Managing packages
-----------------
-You might also use an ad hoc task to install, update, or remove packages on managed nodes using a package management module like yum. To ensure a package is installed without updating it:
+You might also use an ad hoc task to install, update, or remove packages on managed nodes using a package management module such as ``yum``. Package management modules support common functions to install, remove, and generally manage packages. Some specific functions for a package manager might not be present in the Ansible module since they are not part of general package management.
+
+To ensure a package is installed without updating it:
.. code-block:: bash