saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Updated latest release to 2016.3.1

Browse source 
Clean up installation instructions
code-block type updates
Add link to jinja tutorial
This commit is contained in:
Jacob Hammons 2016-06-15 11:52:02 -06:00
parent f598f96ffe
commit a4b67fd1e9
12 changed files with 79 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/conf.py
View file

@ -196,7 +196,7 @@ project = 'Salt'
copyright = '2016 SaltStack, Inc.'
version = salt.version.__version__
latest_release = '2016.3.0' # latest release
latest_release = '2016.3.1' # latest release
previous_release = '2015.8.10' # latest release from previous branch
previous_release_dir = '2015.8' # path on web server for previous branch
next_release = '' # next release
@ -272,6 +272,11 @@ rst_prolog = """\
<p>AMD64: <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-AMD64-Setup.exe"><strong>Salt-Minion-{release}-AMD64-Setup.exe</strong></a>
| <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-AMD64-Setup.exe.md5"><strong>md5</strong></a></p>
.. |osxdownload| raw:: html
<p>x86_64: <a href="https://repo.saltstack.com/osx/salt-{release}-x86_64.pkg"><strong>salt-{release}-x86_64.pkg</strong></a>
| <a href="https://repo.saltstack.com/osx/salt-{release}-x86_64.pkg.md5"><strong>md5</strong></a></p>
""".format(release=release)
# A shortcut for linking to tickets on the GitHub issue tracker

7
doc/topics/installation/debian.rst
View file

@ -21,7 +21,12 @@ Installation from the Official SaltStack Repository
Packages for Debian 8 (Jessie) and Debian 7 (Wheezy) are available in the
Official SaltStack repository.
Instructions are at http://repo.saltstack.com/#debian.
Instructions are at https://repo.saltstack.com/#debian.
.. note::
Regular security support for Debian 7 ended on April 25th 2016. As a result,
2016.3.1 and 2015.8.10 will be the last Salt releases for which Debian
7 packages are created.
.. _installation-debian-raspbian:

52
doc/topics/installation/osx.rst
View file

@ -2,29 +2,41 @@
OS X
====
Dependency Installation
-----------------------
Installation from the Official SaltStack Repository
===================================================
It should be noted that Homebrew explicitly discourages the `use of sudo`_:
**Latest stable build from the selected branch**:
|osxdownload|
Homebrew is designed to work without using sudo. You can decide to use it but we strongly recommend not to do so. If you have used sudo and run into a bug then it is likely to be the cause. Please don’t file a bug report unless you can reproduce it after reinstalling Homebrew from scratch without using sudo
The output of ``md5 <salt pkg>`` should match the contents of the
corresponding md5 file.
So when using Homebrew, if you want support from the Homebrew community, install this way:
`Earlier builds from supported branches <https://repo.saltstack.com/osx/>`__
`Archived builds from unsupported branches <https://repo.saltstack.com/osx/archive/>`__
Installation from Homebrew
==========================
.. code-block:: bash
brew install saltstack
It should be noted that Homebrew explicitly discourages the `use of sudo`_:
Homebrew is designed to work without using sudo. You can decide to use it but we strongly recommend not to do so. If you have used sudo and run into a bug then it is likely to be the cause. Please don’t file a bug report unless you can reproduce it after reinstalling Homebrew from scratch without using sudo
.. _use of sudo: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/FAQ.md#sudo
When using MacPorts, install this way:
Installation from MacPorts
==========================
.. code-block:: bash
sudo port install salt
Installation from Pip
=====================
When only using the OS X system's pip, install this way:
.. code-block:: bash
@ -32,9 +44,18 @@ When only using the OS X system's pip, install this way:
sudo pip install salt
Salt-Master Customizations
--------------------------
==========================
To run salt-master on OS X, sudo add this configuration option to the /etc/salt/master file:
To run salt-master on OS X, the root user maxfiles limit must be increased:
.. code-block:: bash
max_open_files: 8192
On versions previous to OS X 10.10 (Yosemite), increase the root user maxfiles limit:
.. code-block:: bash
sudo launchctl limit maxfiles 4096 8192
.. note::
@ -43,16 +64,6 @@ To run salt-master on OS X, the root user maxfiles limit must be increased:
Overriding these values with the setting below will cause system
instability!
.. code-block:: bash
sudo launchctl limit maxfiles 4096 8192
And sudo add this configuration option to the /etc/salt/master file:
.. code-block:: bash
max_open_files: 8192
Now the salt-master should run without errors:
.. code-block:: bash
@ -63,3 +74,4 @@ Post-installation tasks
=======================
Now go to the :doc:`Configuring Salt</ref/configuration/index>` page.

4
doc/topics/installation/rhel.rst
View file

@ -18,8 +18,8 @@ Installation from the Official SaltStack Repository
Packages for Redhat, CentOS, and Amazon Linux are available in
the SaltStack Repository.
- `Red Hat / CentOS <http://repo.saltstack.com/#rhel>`_
- `Amazon Linux <http://repo.saltstack.com/#amzn>`_
- `Red Hat / CentOS <https://repo.saltstack.com/#rhel>`_
- `Amazon Linux <https://repo.saltstack.com/#amzn>`_
.. note::
As of 2015.8.0, EPEL repository is no longer required for installing on

10
doc/topics/installation/suse.rst
View file

@ -4,13 +4,13 @@
SUSE
====
Installation from the SaltStack Repository
==========================================
Installation from the Official SaltStack Repository
===================================================
Packages for SUSE 12 SP1, SUSE 12, SUSE 11, openSUSE 13 and openSUSE Leap 42.1
are available in the SaltStack Repository.
Instructions are at http://repo.saltstack.com/#suse.
Instructions are at https://repo.saltstack.com/#suse.
Installation from the SUSE Repository
=====================================
@ -18,8 +18,8 @@ Installation from the SUSE Repository
Since openSUSE 13.2, Salt 2014.1.11 is available in the primary repositories.
With the release of SUSE manager 3 a new repository setup has been created.
The new repo will by systemsmanagement:saltstack, which is the source
for newer stable packages. For backward compatibilty a linkpackage will be
created to the old devel:language:python repo.
for newer stable packages. For backward compatibilty a linkpackage will be
created to the old devel:language:python repo.
All development of suse packages will be done in systemsmanagement:saltstack:testing.
This will ensure that salt will be in mainline suse repo's, a stable release
repo and a testing repo for further enhancements.

6
doc/topics/installation/ubuntu.rst
View file

@ -9,10 +9,10 @@ Ubuntu
Installation from the Official SaltStack Repository
===================================================
Packages for Ubuntu 14 (Trusty) and Ubuntu 12 (Precise) are
available in the SaltStack repository.
Packages for Ubuntu 16 (Xenial), Ubuntu 14 (Trusty), and Ubuntu 12 (Precise)
are available in the SaltStack repository.
Instructions are at http://repo.saltstack.com/#ubuntu.
Instructions are at https://repo.saltstack.com/#ubuntu.
Installation from the Community-Maintained Repository
=====================================================

15
doc/topics/installation/windows.rst
View file

@ -6,24 +6,23 @@ Windows
Salt has full support for running the Salt Minion on Windows.
There are no plans for the foreseeable future to develop a Salt Master on
Windows. For now you must run your Salt Master on a supported operating system
to control your Salt Minions on Windows.
You must connect Windows Salt minions to a Salt master on a supported operating
system to control your Salt Minions.
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
=================
Salt Minion Windows installers can be found here. The output of `md5sum <salt
minion exe>` should match the contents of the corresponding md5 file.
Installation from the Official SaltStack Repository
===================================================
**Latest stable build from the selected branch**:
|windownload|
The output of ``md5sum <salt minion exe>`` should match the contents of the
corresponding md5 file.
`Earlier builds from supported branches <https://repo.saltstack.com/windows/>`__
`Archived builds from unsupported branches <https://repo.saltstack.com/windows/archive/>`__

5
doc/topics/jinja/index.rst
View file

@ -353,8 +353,6 @@ tasks that require complex looping and logic are trivial when using Python
in a Salt execution module. Salt execution modules are easy to write and
distribute to Salt minions.
:ref:`Writing Execution Modules <writing-execution-modules>`
Functions in custom execution modules are available in the Salt execution
module dictionary just like the built-in execution modules:
@ -362,3 +360,6 @@ module dictionary just like the built-in execution modules:
{{ salt['my_custom_module.my_custom_function']() }}
- :ref:`How to Convert Jinja Logic to an Execution Module <tutorial-jinja_to_execution-module>`
- :ref:`Writing Execution Modules <writing-execution-modules>`

6
doc/topics/releases/2016.3.1.rst
View file

@ -5,6 +5,12 @@ Salt 2016.3.1 Release Notes
Version 2016.3.1 is a bugfix release for :doc:`2016.3.0
</topics/releases/2016.3.0>`.
**Final Release of Debian 7 Packages**
Regular security support for Debian 7 ended on April 25th 2016. As a result,
2016.3.1 and 2015.8.10 will be the last Salt releases for which Debian
7 packages are created.
Changes for v2016.3.0..v2016.3.1
--------------------------------

8
doc/topics/tutorials/firewall.rst
View file

@ -105,13 +105,13 @@ common locations, but your mileage may vary.
**Fedora / RHEL / CentOS**:
.. code-block:: bash
.. code-block:: text
/etc/sysconfig/iptables
**Arch Linux**:
.. code-block:: bash
.. code-block:: text
/etc/iptables/iptables.rules
@ -122,7 +122,7 @@ Follow these instructions: https://wiki.debian.org/iptables
Once you've found your firewall rules, you'll need to add the two lines below
to allow traffic on ``tcp/4505`` and ``tcp/4506``:
.. code-block:: bash
.. code-block:: text
-A INPUT -m state --state new -m tcp -p tcp --dport 4505 -j ACCEPT
-A INPUT -m state --state new -m tcp -p tcp --dport 4506 -j ACCEPT
@ -143,7 +143,7 @@ The BSD-family of operating systems uses `packet filter (pf)`_. The following
example describes the additions to ``pf.conf`` needed to access the Salt
master.
.. code-block:: bash
.. code-block:: text
pass in on $int_if proto tcp from any to $int_if port 4505
pass in on $int_if proto tcp from any to $int_if port 4506

8
doc/topics/tutorials/multimaster_pki.rst
View file

@ -117,7 +117,7 @@ debug mode.
.. code-block:: bash
$ salt-minion -l debug
salt-minion -l debug
Upon connecting to the master, the following lines should appear on the output:
@ -220,7 +220,7 @@ line in debug mode
.. code-block:: bash
$ salt-minion -l debug
salt-minion -l debug
The minion will connect to the first master from its master list
@ -306,7 +306,7 @@ That signature can be created with
.. code-block:: bash
$ salt-key --gen-signature
salt-key --gen-signature
This will create a default signature file in the master pki-directory
@ -321,7 +321,7 @@ the signature file in one call
.. code-block:: bash
$ salt-key --gen-signature --auto-create
salt-key --gen-signature --auto-create
Telling the master to use the pre-created signature is done with

2
doc/topics/tutorials/stormpath.rst
View file

@ -173,7 +173,7 @@ fields that ``stormpath.create_account`` requires, including the ``password``.
However, if a password changes for an existing account, it will NOT be updated
by this state.
.. code-block:: bash
.. code-block:: yaml
curly@example.com:
stormpath_account.present: