diff --git a/doc/topics/releases/0.9.0.rst b/doc/topics/releases/0.9.0.rst index cff82bb15f..c96e05551c 100644 --- a/doc/topics/releases/0.9.0.rst +++ b/doc/topics/releases/0.9.0.rst @@ -33,12 +33,10 @@ New Features Salt Syndic ``````````` -The new Syndic interface allows a master to be commanded via another higher -level salt master. This is a powerful solution allowing a master control +The new :doc:`Syndic interface ` allows a master to be commanded via another higher +level salt master. This is a powerful solution allowing a master control structure to exist, allowing salt to scale to much larger levels then before. -http://saltstack.org/ref/syndic.html - Peer Communication `````````````````` @@ -48,10 +46,8 @@ to act as a communication channel between minions and as a general infrastructure message bus. Peer communication is turned off by default but can be enabled via the ``peer`` -option in the master configuration file. Documentation on the new peer -interface can be found here: - -http://saltstack.org/ref/peer.html +option in the master configuration file. Documentation on the new :doc:`Peer +interface `. Easily Extensible API ````````````````````` @@ -126,4 +122,3 @@ publish ~~~~~~~ Used by the peer interface to allow minions to make publications - diff --git a/doc/topics/ssh/index.rst b/doc/topics/ssh/index.rst index c125a16209..57bd5ab718 100644 --- a/doc/topics/ssh/index.rst +++ b/doc/topics/ssh/index.rst @@ -12,10 +12,10 @@ Master. The Salt SSH system does not supercede the standard Salt communication systems, it simply offers an SSH based alternative that does not require - ZeroMQ and a remote agent. Since all communication with Salt SSH is - executed via SSH it is SUBSTANTIALLY slower than standard Salt with ZeroMQ. + ZeroMQ and a remote agent. Be aware that since all communication with Salt SSH is + executed via SSH it is substantially slower than standard Salt with ZeroMQ. -Salt SSH is VERY easy to use, simply set up a basic `roster` file of the +Salt SSH is very easy to use, simply set up a basic `roster` file of the systems to connect to and run ``salt-ssh`` commands in a similar way as standard ``salt`` commands. @@ -26,7 +26,7 @@ The roster system in Salt allows for remote minions to be easily defined. .. note:: - The roster system is fully documented here: + See the :doc:`Roster documentation ` for more details. Simply create the roster file, the default location is `/etc/salt/roster`: @@ -34,15 +34,16 @@ Simply create the roster file, the default location is `/etc/salt/roster`: web1: 192.168.42.1 -This is a VERY simple roster file where a Salt ID is being assigned to an ip +This is a very basic roster file where a Salt ID is being assigned to an IP address. A more elaborate roster can be created: .. code-block:: yaml web1: - host: 192.168.42.1 # The ip addr or dns hostname - user: fred # Remote executions will be executed as user fred - passwd: foobarbaz # The password to use for login, if omited keys are used + host: 192.168.42.1 # The IP addr or DNS hostname + user: fred # Remote executions will be executed as user fred + passwd: foobarbaz # The password to use for login, if omitted, keys are used + sudo: True # Whether to sudo to root, not enabled by default web2: host: 192.168.42.2 diff --git a/doc/topics/ssh/roster.rst b/doc/topics/ssh/roster.rst index af21375b13..bb95da04ae 100644 --- a/doc/topics/ssh/roster.rst +++ b/doc/topics/ssh/roster.rst @@ -2,7 +2,7 @@ Salt Rosters ============ -Salt rosters are plugabble systems added in Salt 0.17.0 to facilitate the +Salt rosters are plugable systems added in Salt 0.17.0 to facilitate the ``salt-ssh`` system. The roster system was created because ``salt-ssh`` needs a means to identify which systems need to be targetted for execution.