From b0d4defa3615d75bbfc9d25cb8bcd9f8b9ade017 Mon Sep 17 00:00:00 2001 From: Seth House Date: Fri, 7 Aug 2015 16:33:55 -0600 Subject: [PATCH] Add note about top-file only env assignment and the show_top() function --- doc/ref/states/top.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/ref/states/top.rst b/doc/ref/states/top.rst index 46f440c08078..f92e430c5f58 100644 --- a/doc/ref/states/top.rst +++ b/doc/ref/states/top.rst @@ -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 +` 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.