diff --git a/doc/_themes/saltstack2/layout.html b/doc/_themes/saltstack2/layout.html index 8502ee0a07..a38e81f139 100644 --- a/doc/_themes/saltstack2/layout.html +++ b/doc/_themes/saltstack2/layout.html @@ -21,7 +21,7 @@ {% set script_files = [ '_static/js/core.min.js', - '_static/js/webhelp.min_v1.4.1.js', + '_static/js/webhelp.min_v1.4.2.js', ] %} {% set css_files = [ @@ -160,6 +160,12 @@ {% endif %} + {% if build_type == "inactive" and on_saltstack %} +
You are viewing docs for the previous stable release, {{ previous_release }}. Switch to docs for the latest stable release, {{ latest_release }}, or to a recent doc build from the develop branch.
+ {% elif build_type == "inactive" %} +You are viewing docs for an inactive release, {{ previous_release }}. Switch to docs for the latest stable release, {{ latest_release }}, or to a recent doc build from the develop branch.
+ {% elif build_type == "develop" %} -You are viewing docs built from a recent snapshot of the develop branch. Switch to docs for the latest stable release, {{ latest_release }}, or to docs for the previous stable release, {{ previous_release }}.
+You are viewing docs built from a recent snapshot of the develop branch. Switch to docs for the latest stable release, {{ latest_release }}.
{% endif %}x86: Salt-Minion-{release}-x86-Setup.exe - | md5
+x86: Salt-Minion-{release}-3-x86-Setup.exe + | md5
-AMD64: Salt-Minion-{release}-AMD64-Setup.exe - | md5
+AMD64: Salt-Minion-{release}-3-AMD64-Setup.exe + | md5
""".format(release=release) diff --git a/doc/glossary.rst b/doc/glossary.rst index fbc069dad0..d66ab2fe99 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -247,6 +247,7 @@ Glossary whether or not the module should be available to a minion. This function commonly contains logic to determine if all requirements for a module are available, such as external libraries. + Worker A master process which can send notices and receive replies from minions. *See also*: diff --git a/doc/ref/clouds/all/index.rst b/doc/ref/clouds/all/index.rst index 071c9be319..51008d56f3 100644 --- a/doc/ref/clouds/all/index.rst +++ b/doc/ref/clouds/all/index.rst @@ -14,7 +14,6 @@ Full list of Salt Cloud modules botocore_aws cloudstack digital_ocean - digital_ocean_v2 ec2 gce gogrid diff --git a/doc/ref/clouds/all/salt.cloud.clouds.digital_ocean_v2.rst b/doc/ref/clouds/all/salt.cloud.clouds.digital_ocean_v2.rst deleted file mode 100644 index 0c332de098..0000000000 --- a/doc/ref/clouds/all/salt.cloud.clouds.digital_ocean_v2.rst +++ /dev/null @@ -1,6 +0,0 @@ -================================== -salt.cloud.clouds.digital_ocean_v2 -================================== - -.. automodule:: salt.cloud.clouds.digital_ocean_v2 - :members: \ No newline at end of file diff --git a/doc/ref/modules/all/index.rst b/doc/ref/modules/all/index.rst index c4692e8f02..57a6cfa5c3 100644 --- a/doc/ref/modules/all/index.rst +++ b/doc/ref/modules/all/index.rst @@ -61,7 +61,6 @@ Full list of builtin execution modules cpan cron cyg - cytest daemontools darwin_pkgutil darwin_sysctl diff --git a/doc/ref/states/all/index.rst b/doc/ref/states/all/index.rst index afe0c3d918..e7012d5c75 100644 --- a/doc/ref/states/all/index.rst +++ b/doc/ref/states/all/index.rst @@ -14,7 +14,7 @@ Full list of builtin state modules alternatives apache apache_module - apt + aptpkg archive artifactory at diff --git a/doc/ref/states/all/salt.states.apt.rst b/doc/ref/states/all/salt.states.apt.rst deleted file mode 100644 index 517177db15..0000000000 --- a/doc/ref/states/all/salt.states.apt.rst +++ /dev/null @@ -1,6 +0,0 @@ -=============== -salt.states.apt -=============== - -.. automodule:: salt.states.apt - :members: \ No newline at end of file diff --git a/doc/ref/states/requisites.rst b/doc/ref/states/requisites.rst index de18e87cb2..65f1909b50 100644 --- a/doc/ref/states/requisites.rst +++ b/doc/ref/states/requisites.rst @@ -4,6 +4,8 @@ Requisites and Other Global State Arguments =========================================== +.. _requisites-fire-event: + Fire Event Notifications ======================== diff --git a/doc/topics/installation/debian.rst b/doc/topics/installation/debian.rst index 0c76a044f6..edd131b1b3 100644 --- a/doc/topics/installation/debian.rst +++ b/doc/topics/installation/debian.rst @@ -1,14 +1,46 @@ +.. _installation-debian: + =================== Debian Installation =================== -Currently the latest packages for Debian Old Stable, Stable, and -Unstable (Squeeze, Wheezy, and Sid) are published in our -(saltstack.com) Debian repository. +.. _installation-debian-repo: + +Installation from the SaltStack Repository +========================================== + +Debian 8 packages are available in the SaltStack Debian repository. + +To install using the SaltStack Debian repository: + +#. Run the following command to import the SaltStack repository key: + + .. code-block:: bash + + wget -O - https://repo.saltstack.com/apt/debian/SALTSTACK-GPG-KEY.pub | apt-key add - + +#. Add the following line to ``/etc/apt/sources.list``: + + .. code-block:: bash + + deb http://repo.saltstack.com/apt/debian jessie contrib + +#. Run ``sudo apt-get update`` + +#. Install the salt-minion, salt-master, or other Salt components: + + - ``apt-get install salt-master`` + - ``apt-get install salt-minion`` + - ``apt-get install salt-ssh`` + - ``apt-get install salt-syndic`` + - ``apt-get install salt-cloud`` Configure Apt ------------- +Currently the latest packages for Debian Old Stable, Stable, and +Unstable (Squeeze, Wheezy, and Sid) are published in our +(saltstack.com) Debian repository. Squeeze (Old Old Stable) ------------------------ diff --git a/doc/topics/installation/rhel.rst b/doc/topics/installation/rhel.rst index 84d9e3296c..d66673494e 100644 --- a/doc/topics/installation/rhel.rst +++ b/doc/topics/installation/rhel.rst @@ -1,26 +1,92 @@ +.. _installation-rhel: + ============================================================== RHEL / CentOS / Scientific Linux / Amazon Linux / Oracle Linux ============================================================== +.. _installation-rhel-repo: + +Installation from the SaltStack Repository +========================================== + +To install using the SaltStack yum repository: + +#. Run one of the following commands based on your version to import the SaltStack repository key: + + Version 7: + + .. code-block:: bash + + wget -O - rpm --import https://repo.saltstack.com/yum/rhel7/SALTSTACK-GPG-KEY.pub + + Version 6: + + .. code-block:: bash + + wget -O - rpm --import https://repo.saltstack.com/yum/rhel6/SALTSTACK-GPG-KEY.pub + + Version 5: + + .. code-block:: bash + + wget https://repo.saltstack.com/yum/rhel5/SALTSTACK-EL5-GPG-KEY.pub ; rpm --import SALTSTACK-EL5-GPG-KEY.pub ; rm -f SALTSTACK-EL5-GPG-KEY.pub + +#. Save the following file to ``/etc/yum.repos.d/saltstack.repo``: + + Versions 6 / 7: + + .. code-block:: config + + #################### + # Enable SaltStack's package repository + [saltstack-repo] + name=SaltStack repo for RHEL/CentOS $releasever + baseurl=https://repo.saltstack.com/yum/rhel$releasever + enabled=1 + gpgcheck=1 + gpgkey=https://repo.saltstack.com/yum/rhel$releasever/SALTSTACK-GPG-KEY.pub + + Version 5: + + .. code-block:: config + + #################### + # Enable SaltStack's package repository + [saltstack-repo] + name=SaltStack repo for RHEL/CentOS $releasever + baseurl=https://repo.saltstack.com/yum/rhel$releasever + enabled=1 + gpgcheck=1 + gpgkey=https://repo.saltstack.com/yum/rhel$releasever/SALTSTACK-EL5-GPG-KEY.pub + +#. Run ``sudo yum clean expire-cache`` + +#. Run ``sudo yum update`` + +#. Install the salt-minion, salt-master, or other Salt components: + + - ``yum install salt-master`` + - ``yum install salt-minion`` + - ``yum install salt-ssh`` + - ``yum install salt-syndic`` + - ``yum install salt-cloud`` + +.. note:: + EPEL support is not required when installing using the SaltStack repository + on Red Hat 6 and 7. EPEL must be enabled when installing on Red Hat 5. + Installation from Repository ============================ -.. _installation-rhel-5: - -RHEL/CentOS 5 -------------- - -Due to the removal of some of Salt's dependencies from EPEL5, we have created a -repository on `Fedora COPR`_. Moving forward, this will be the official means -of installing Salt on RHEL5-based systems. Information on how to enable this -repository can be found here__. - -.. _`Fedora COPR`: https://copr.fedoraproject.org/ -.. __: https://copr.fedoraproject.org/coprs/saltstack/salt-el5/ - RHEL/CentOS 6 and 7, Scientific Linux, etc. ------------------------------------------- +.. warning:: + Salt 2015.8 requires ``python-crypto`` 2.6.1 or higher, and ``python-tornado`` version + 4.2.1 or higher. These packages are not currently available in EPEL for + Red Hat 5 and 6. You must install these dependencies from another location + or use the SaltStack repository documented above. + Beginning with version 0.9.4, Salt has been available in `EPEL`_. It is installable using yum. Salt should work properly with all mainstream derivatives of RHEL, including CentOS, Scientific Linux, Oracle Linux and @@ -34,6 +100,18 @@ installing salt on RHEL6. .. _`EPEL`: http://fedoraproject.org/wiki/EPEL +.. _installation-rhel-5: + +RHEL/CentOS 5 +------------- + +Due to the removal of some of Salt's dependencies from EPEL5, we have created a +repository on `Fedora COPR`_. Moving forward, this will be the official means +of installing Salt on RHEL5-based systems. Information on how to enable this +repository can be found here__. + +.. _`Fedora COPR`: https://copr.fedoraproject.org/ +.. __: https://copr.fedoraproject.org/coprs/saltstack/salt-el5/ Enabling EPEL ************* diff --git a/doc/topics/installation/windows.rst b/doc/topics/installation/windows.rst index 660ccacae3..b4b9cf515f 100644 --- a/doc/topics/installation/windows.rst +++ b/doc/topics/installation/windows.rst @@ -1,3 +1,5 @@ +.. _windows: + ======= Windows ======= @@ -11,6 +13,7 @@ to control your Salt Minions on Windows. Many of the standard Salt modules have been ported to work on Windows and many of the Salt States currently work on Windows, as well. +.. _windows-installer: Windows Installer ================= @@ -46,9 +49,10 @@ Windows service. If the minion won't start, try installing the Microsoft Visual C++ 2008 x64 SP1 redistributable. Allow all Windows updates to run salt-minion smoothly. +.. _windows-installer-options: -Silent Installer option -======================= +Silent Installer Options +======================== The installer can be run silently by providing the `/S` option at the command line. The options `/master` and `/minion-name` allow for configuring the master diff --git a/doc/topics/releases/2015.8.0.rst b/doc/topics/releases/2015.8.0.rst index 7db2ac9e56..ba6343bb71 100644 --- a/doc/topics/releases/2015.8.0.rst +++ b/doc/topics/releases/2015.8.0.rst @@ -10,12 +10,23 @@ usual the release notes are not exhaustive and primarily include the most notable additions and improvements. Hundreds of bugs have been fixed and many modules have been substantially updated and added. +New SaltStack Installation Repositories +======================================= + +SaltStack now provides installation repositories for several platforms, with more to come. +See the following links for instructions: + +- :ref:`Red Hat / CentOS 5, 6, 7