Skip to content

Commit

Permalink
Add note about top-file only env assignment and the show_top() function
Browse files Browse the repository at this point in the history
  • Loading branch information
whiteinge committed Aug 7, 2015
1 parent 163f377 commit b0d4def
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/ref/states/top.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,13 @@ the state into QA by copying the state file into `/srv/salt/qa`.
Choosing an Environment to Target
=================================

The top file is used to assign a minion to an environment unless overridden
using the methods described below. The environment in the top file must match
an environment in :conf_master:`file_roots` in order for any states to be
applied to that minion. The states that will be applied to a minion in a given
environment can be viewed using the :py:func:`state.show_top
<salt.modules.state.show_top>` execution function.

Minions may be pinned to a particular environment by setting the `environment`
value in the minion configuration file. In doing so, a minion will only
request files from the environment to which it is assigned.
Expand Down

0 comments on commit b0d4def

Please sign in to comment.