salt/doc/topics/targeting/nodegroups.rst

===========
Node groups
===========

.. glossary::

    Node group
        A predefined group of minions declared in the master configuration file
        :conf_master:`nodegroups` setting as a compound target.

Nodegroups are declared using a compound target specification. The compound
target documentation can be found :doc:`here <compound>`.

The :conf_master:`nodegroups` master config file parameter is used to define
nodegroups. Here's an example nodegroup configuration within
``/etc/salt/master``:

.. code-block:: yaml

    nodegroups:
      group1: 'L@foo.domain.com,bar.domain.com,baz.domain.com or bl*.domain.com'
      group2: 'G@os:Debian and foo.domain.com'

.. note::

    The 'L' within group1 is matching a list of minions, while the 'G' in
    group2 is matching specific grains. See the
    :doc:`compound matchers <compound>` documentation for more details.

To match a nodegroup on the CLI, use the ``-N`` command-line option:

.. code-block:: bash

    salt -N group1 test.ping

To match in your :term:`top file`, make sure to put ``- match: nodegroup`` on
the line directly following the nodegroup name.

.. code-block:: yaml

    base:
      group1:
        - match: nodegroup
        - webserver
Added and organized documents on ways of targeting minions 2012-02-20 06:28:45 +00:00			`===========`
			`Node groups`
			`===========`

			`.. glossary::`

			`Node group`
			`A predefined group of minions declared in the master configuration file`
documentation updates 2012-05-23 04:43:12 +00:00			:conf_master:`nodegroups` setting as a compound target.
Added and organized documents on ways of targeting minions 2012-02-20 06:28:45 +00:00
Fixed several minor misspellings and acronym capitalizations. 2013-03-18 19:59:27 +00:00			`Nodegroups are declared using a compound target specification. The compound`
Convert shell command examples to bash code-block This commit modifes a number of files which have command-line examples so that the code-block directive is used. This provides more visually-appealing syntax highlighting. More commits like this will follow, this commit is part of an overall documentation audit that I am performing. 2013-08-11 02:55:51 +00:00			target documentation can be found :doc:`here <compound>`.
Add a ref to compount targets 2012-08-01 17:11:40 +00:00
Convert shell command examples to bash code-block This commit modifes a number of files which have command-line examples so that the code-block directive is used. This provides more visually-appealing syntax highlighting. More commits like this will follow, this commit is part of an overall documentation audit that I am performing. 2013-08-11 02:55:51 +00:00			The :conf_master:`nodegroups` master config file parameter is used to define
Updated nodegroups with a few clarifications, updated halite docs with a new section on installing via RPM, when the .deb is done another section needs to be added. 2013-11-07 04:50:13 +00:00			`nodegroups. Here's an example nodegroup configuration within`
			``/etc/salt/master``:
Add a ref to compount targets 2012-08-01 17:11:40 +00:00
Convert shell command examples to bash code-block This commit modifes a number of files which have command-line examples so that the code-block directive is used. This provides more visually-appealing syntax highlighting. More commits like this will follow, this commit is part of an overall documentation audit that I am performing. 2013-08-11 02:55:51 +00:00			`.. code-block:: yaml`
Added and organized documents on ways of targeting minions 2012-02-20 06:28:45 +00:00
			`nodegroups:`
one_fqdn AND other_fqdn will always return empty set 2012-12-03 23:21:15 +00:00			`group1: 'L@foo.domain.com,bar.domain.com,baz.domain.com or bl*.domain.com'`
Added and organized documents on ways of targeting minions 2012-02-20 06:28:45 +00:00			`group2: 'G@os:Debian and foo.domain.com'`

Updated nodegroups with a few clarifications, updated halite docs with a new section on installing via RPM, when the .deb is done another section needs to be added. 2013-11-07 04:50:13 +00:00			`.. note::`

			`The 'L' within group1 is matching a list of minions, while the 'G' in`
			`group2 is matching specific grains. See the`
			:doc:`compound matchers <compound>` documentation for more details.

Convert shell command examples to bash code-block This commit modifes a number of files which have command-line examples so that the code-block directive is used. This provides more visually-appealing syntax highlighting. More commits like this will follow, this commit is part of an overall documentation audit that I am performing. 2013-08-11 02:55:51 +00:00			To match a nodegroup on the CLI, use the ``-N`` command-line option:

			`.. code-block:: bash`
Added and organized documents on ways of targeting minions 2012-02-20 06:28:45 +00:00
			`salt -N group1 test.ping`

Convert shell command examples to bash code-block This commit modifes a number of files which have command-line examples so that the code-block directive is used. This provides more visually-appealing syntax highlighting. More commits like this will follow, this commit is part of an overall documentation audit that I am performing. 2013-08-11 02:55:51 +00:00			To match in your :term:`top file`, make sure to put ``- match: nodegroup`` on
			`the line directly following the nodegroup name.`

			`.. code-block:: yaml`
Added and organized documents on ways of targeting minions 2012-02-20 06:28:45 +00:00
			`base:`
			`group1:`
			`- match: nodegroup`
			`- webserver`