summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Moreau Simard <moi@dmsimard.com>2021-02-03 10:19:46 -0500
committerGitHub <noreply@github.com>2021-02-03 09:19:46 -0600
commitd7b562b39395e1b4d7d87de4d710613dd60ac004 (patch)
tree0191220b7dca02c43df78b3374084a1f4749501d
parentd5acbfd6e38bacd7b0a6f2eb9da326e218ce0a1f (diff)
downloadansible-d7b562b39395e1b4d7d87de4d710613dd60ac004.tar.gz
add new glossary terms for 2.10 (#71813) (#73293)
* add new terms for 2.10 Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> (cherry picked from commit 4aedd1b987150baae4b11200de916c87c53e6d30) Co-authored-by: Sandra McCann <samccann@redhat.com>
-rw-r--r--docs/docsite/rst/reference_appendices/glossary.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/docsite/rst/reference_appendices/glossary.rst b/docs/docsite/rst/reference_appendices/glossary.rst
index 6b36a7ead6..c1170c6ded 100644
--- a/docs/docsite/rst/reference_appendices/glossary.rst
+++ b/docs/docsite/rst/reference_appendices/glossary.rst
@@ -23,6 +23,15 @@ when a term comes up on the mailing list.
writing a :term:`playbook <playbooks>` and playbooks can also glue
lots of other operations together.
+ Ansible (the package)
+ A software package (Python, deb, rpm, and so on) that contains ansible-base and a select group of collections. Playbooks that worked with Ansible 2.9 should still work with the Ansible 2.10 package. See the :file:`ansible-<version>.build` file in the release-specific directory at `ansible-build-data <https://github.com/ansible-community/ansible-build-data>`_ for a list of collections included in Ansible, as well as the included ``ansible-base`` version.
+
+ ansible-base
+ New for 2.10. The installable package (RPM/Python/Deb package) generated from the `ansible/ansible repository <https://github.com/ansible/ansible>`_. Contains the command-line tools and the code for basic features and functions, such as copying module code to managed nodes. The ``ansible-base`` package includes a few modules and plugins and allows you to add others by installing collections.
+
+ Ansible Galaxy
+ An `online resource <galaxy.ansible.com>`_ for finding and sharing Ansible community content. Also, the command-line utility that lets users install individual Ansible Collections, for example`` ansible-galaxy install community.crypto``.
+
Async
Refers to a task that is configured to run in the background rather
than waiting for completion. If you have a long process that would
@@ -49,6 +58,18 @@ when a term comes up on the mailing list.
other systems). Use this to get an idea of what might happen, but do
not substitute it for a good staging environment.
+ Collection
+ A packaging format for bundling and distributing Ansible content, including plugins, roles, modules, and more. Collections release independent of other collections or ``ansible-base`` so features can be available sooner to users. Some collections are packaged with Ansible (version 2.10 or later). You can install other collections (or other versions of collections) with ``ansible-galaxy collection install <namespace.collection>``.
+
+ Collection name
+ The second part of a Fully Qualified Collection Name. The collection name divides the collection namespace and usually reflects the function of the collection content. For example, the ``cisco`` namespace might contain ``cisco.ios``, ``cisco.aci``, and ``cisco.nxos``, with content for managing the different network devices maintained by Cisco.
+
+ community.general (collection)
+ A special collection managed by the Ansible Community Team containing all the modules and plugins which shipped in Ansible 2.9 that do ont have their own dedicated Collection. See `community.general <https://galaxy.ansible.com/community/general>`_` on Galaxy.
+
+ community.network (collection)
+ Similar to ``community.general``, focusing on network content. `community.network <https://galaxy.ansible.com/community/network>`_` on Galaxy.
+
Connection Plugin
By default, Ansible talks to remote machines through pluggable
libraries. Ansible uses native OpenSSH (:term:`SSH (Native)`) or
@@ -121,6 +142,9 @@ when a term comes up on the mailing list.
forks, though if you have a lot of RAM, you can easily set this to
a value like 50 for increased parallelism.
+ Fully Qualified Collection Name (FQCN)
+ The full definition of a module, plugin, or role hosted within a collection, in the form <namespace.collection.content_name>. Allows a Playbook to refer to a specific module or plugin from a specific source in an unambiguous manner, for example, ``community.grafana.grafana_dashboard``. The FQCN is required when you want to specify the exact source of a plugin. For example, if multiple collections contain a module plugin called ``user``, the FQCN specifies which one to use for a given task. When you have multiple collections installed, the FQCN is always the explicit and authoritative indicator of which collection to search for the correct plugin for each task.
+
Gather Facts (Boolean)
:term:`Facts` are mentioned above. Sometimes when running a multi-play
:term:`playbook <playbooks>`, it is desirable to have some plays that
@@ -294,6 +318,9 @@ when a term comes up on the mailing list.
models entire IT topologies and workflows rather than looking at
configuration from a "one system at a time" perspective.
+ Namespace
+ The first part of a fully qualified collection name, the namespace usually reflects a functional content category. Example: in ``cisco.ios.ios_config``, ``cisco`` is the namespace. Namespaces are reserved and distributed by Red Hat at Red Hat's discretion. Many, but not all, namespaces will correspond with vendor names. See `Galaxy namespaces <https://galaxy.ansible.com/docs/contributing/namespaces.html#galaxy-namespaces>`_ on the Galaxy docsite for namespace requirements.
+
Notify
The act of a :term:`task <tasks>` registering a change event and
informing a :term:`handler <handlers>` task that another