Merge pull request #16494 from terminalmage/zeromq4

Add information on how to upgrade to ZeroMQ 4 in Ubuntu and RHEL/CentOS

doc/faq.rst

@@ -197,7 +197,8 @@ meantime a good way is to use the system scheduler with a short interval. The
 following example is a state that will always execute at the very end of a
 state run.
 
-For Unix machines:
+Linux/Unix
+**********
 
 .. code-block:: yaml
 
@@ -207,7 +208,22 @@ For Unix machines:
         - name: echo service salt-minion restart | at now + 1 minute
         - order: last
 
-For Windows machines:
+To ensure that **at** is installed and **atd** is running, the following states
+can be used (be sure to double-check the package name and service name for the
+distro the minion is running, in case they differ from the example below.
+
+.. code-block:: yaml
+
+    at:
+      pkg:
+        - installed
+      service:
+        - running
+        - name: atd
+        - enable: True
+
+Windows
+*******
 
 .. code-block:: yaml
 

doc/topics/installation/rhel.rst

@@ -1,6 +1,6 @@
-==========================================================================
+==============================================================
 RHEL / CentOS / Scientific Linux / Amazon Linux / Oracle Linux
-==========================================================================
+==============================================================
 
 Installation Using pip
 ======================
@@ -92,6 +92,22 @@ To install from ``epel-testing``, use the ``enablerepo`` argument for yum:
     yum --enablerepo=epel-testing install salt-minion
 
 
+ZeroMQ 4
+========
+
+We recommend using ZeroMQ 4 where available. SaltStack provides ZeroMQ 4.0.4
+and pyzmq 14.3.1 in a COPR_ repository. Instructions for adding this repository
+(as well as for upgrading ZeroMQ and pyzmq on existing minions) can be found
+here_.
+
+.. _COPR: http://copr.fedoraproject.org/
+.. _here: http://copr.fedoraproject.org/coprs/saltstack/zeromq4/
+
+If this repo is added *before* Salt is installed, then installing either
+``salt-master`` or ``salt-minion`` will automatically pull in ZeroMQ 4.0.4, and
+additional states to upgrade ZeroMQ and pyzmq are unnecessary.
+
+
 Post-installation tasks
 =======================
 

doc/topics/installation/ubuntu.rst

@@ -3,7 +3,7 @@ Ubuntu Installation
 ===================
 
 Add repository
---------------
+==============
 
 The latest packages for Ubuntu are published in the saltstack PPA. If you have 
 the ``add-apt-repository`` utility, you can add the repository and import the 
@@ -43,7 +43,7 @@ After adding the repository, update the package management database:
 
 
 Install packages
-----------------
+================
 
 Install the Salt master, minion, or syndic from the repository with the apt-get 
 command. These examples each install one daemon, but more than one package name 
@@ -63,6 +63,50 @@ may be given at a time:
 
 .. _ubuntu-config:
 
+
+ZeroMQ 4
+========
+
+We recommend using ZeroMQ 4 where available. The **chris-lea/zeromq** PPA can
+be used to provide ZeroMQ 4 on Ubuntu 12.04 LTS. Adding this PPA can be done
+with a :mod:`pkgrepo.managed <salt.states.pkgrepo.managed>` state.
+
+.. code-block:: yaml
+
+    zeromq-ppa:
+      pkgrepo.managed:
+        - ppa: chris-lea/zeromq
+
+The following states can be used to upgrade ZeroMQ and pyzmq, and then restart
+the minion:
+
+.. code-block:: yaml
+
+    update_zmq:
+      pkg:
+        - latest
+        - pkgs:
+          - zeromq
+          - python-zmq
+        - order: last
+      cmd:
+        - wait
+        - name: echo service salt-minion restart | at now + 1 minute
+        - watch:
+          - pkg: update_zmq
+
+.. note::
+
+    This example assumes that atd is installed and running, see here_ for a more
+    detailed explanation.
+
+.. _here: http://docs.saltstack.com/en/latest/faq.html#what-is-the-best-way-to-restart-a-salt-daemon-using-salt
+
+If this repo is added *before* Salt is installed, then installing either
+``salt-master`` or ``salt-minion`` will automatically pull in ZeroMQ 4.0.4, and
+additional states to upgrade ZeroMQ and pyzmq are unnecessary.
+
+
 Post-installation tasks
 =======================