Improve introduction to explain the purpose of orchestration

Before diving into technical details tell the user why they want this feature.
This commit is contained in:
Ari Maniatis 2017-02-16 18:52:05 +11:00 committed by GitHub
parent 05de98e237
commit 4af0514def

View file

@ -4,10 +4,16 @@
Orchestrate Runner
==================
Orchestration is accomplished in salt primarily through the :ref:`Orchestrate
Runner <orchestrate-runner>`. Added in version 0.17.0, this Salt :ref:`Runner
<runners>` can use the full suite of :ref:`requisites` available in states,
and can also execute states/functions using salt-ssh.
Executing states or highstate on a minion is perfect when you want to ensure that
minion configured and running the way you want. Sometimes however you want to
configure a set of minions all at once.
For example, if you want to set up a load balancer in front of a cluster of web
servers you can ensure the load balancer is set up first, and then the same
matching configuration is applied consistently across the whole cluster.
Orchestration is the way to do this.
The Orchestrate Runner
----------------------
@ -35,10 +41,6 @@ application of states on different minions that must not happen simultaneously,
or for halting the state run on all minions if a minion fails one of its
states.
If you want to set up a load balancer in front of a cluster of web servers, for
example, you can ensure the load balancer is set up before the web servers or
stop the state run altogether if a minion fails to apply any states.
The ``state.sls``, ``state.highstate``, et al. functions allow you to statefully
manage each minion and the ``state.orchestrate`` runner allows you to
statefully manage your entire infrastructure.