valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 17:33:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #27115 from jacobhammons/release-docs

Browse Source 
Release docs
This commit is contained in:
Colton Myers 2015-09-14 16:19:18 -06:00
commit 551bbe70af
17 changed files with 199 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/_themes/saltstack2/layout.html vendored
View File

@ -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 @@
</div>
{% endif %}
{% if build_type == "inactive" and on_saltstack %}
<div id="dev-notification">
<div class="alert alert-warning dev-notification-text releaselinks" role="alert"><i class="glyphicon glyphicon-cog"></i> You are viewing docs from a branch that is no longer active. You might want to view docs for the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a> release instead.</div>
</div>
{% endif %}
{%- block document %}
<div class="body-content">
{% block body %} {% endblock %}
@ -192,8 +198,11 @@
{% elif build_type == "previous" %}
<p>You are viewing docs for the previous stable release, {{ previous_release }}. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a>, or to a recent doc build from the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Latest docs from the develop branch" href="/en/develop/">develop</a> branch.</p>
{% elif build_type == "inactive" %}
<p>You are viewing docs for an inactive release, {{ previous_release }}. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a>, or to a recent doc build from the <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Latest docs from the develop branch" href="/en/develop/">develop</a> branch.</p>
{% elif build_type == "develop" %}
<p>You are viewing docs built from a recent snapshot of the develop branch. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a>, or to docs for the previous stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the previous stable release" href="/en/{{ previous_release_dir }}/">{{ previous_release }}</a>.</p>
<p>You are viewing docs built from a recent snapshot of the develop branch. Switch to docs for the latest stable release, <a data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }}</a>.</p>
{% endif %}
<br>
@ -203,12 +212,9 @@
<div class="col-sm-6">
<a href="http://saltstack.com/saltstack-enterprise-4-0-now-with-gui/" target="_blank"><img class="nolightbox nav-banner" src="{{ pathto('_static/images/saltStack_enterprise_350x125.jpg', 1) }}"/></a>
<a href="http://saltstack.com/events/" target="_blank"><img class="nolightbox nav-banner center" src="{{ pathto('_static/images/saltStack_events_300x300.jpg', 1) }}"/></a>
<br/><br/>
<p><b>SaltStack Training</b></p>
<p><a href="http://www.saltstack.com/training/">Now offering remote attendee training!</a></p>
</div>
</div>
{% endif %}
@ -224,9 +230,9 @@
<a class="ss-logo" href="http://saltstack.com"><img width="250" height="63" class="nolightbox center" src="{{ pathto('_static/images/saltstack_logo.svg', 1) }}"></a>
{% if on_saltstack %}
<div class="versions {{ build_type }}">
<div class="releaselinks versions {{ build_type }}">
<a class="btn btn-secondary{% if build_type == "previous" %} active{% endif %}" id="previous"{% if build_type == "previous" %} title="View release notes"{% else %} title="Switch to docs for the previous stable release"{% endif %} data-container="body" data-toggle="tooltip" data-placement="bottom" href="/en/{{ previous_release_dir }}/">{{ previous_release }}{% if build_type == "previous" %} <i class="glyphicon glyphicon-ok"></i>{%- endif %}</a>
<a class="btn btn-secondary{% if build_type == "previous" or build_type == "inactive" %} active{% endif %}" id="previous"{% if build_type == "previous" or build_type == "inactive" %} title="View release notes"{% else %} title="Switch to docs for the previous stable release"{% endif %} data-container="body" data-toggle="tooltip" data-placement="bottom" href="/en/{{ previous_release_dir }}/">{{ previous_release }}{% if build_type == "previous" or build_type == "inactive" %} <i class="glyphicon glyphicon-ok"></i>{%- endif %}</a>
<a class="btn btn-secondary{% if build_type == "latest" %} active{% endif %}" id="latest"{% if build_type == "latest" %} title="View release notes"{% else %} title="Switch to docs for the latest stable release"{% endif %} data-container="body" data-toggle="tooltip" data-placement="bottom" href="/en/latest/">{{ latest_release }}{% if build_type == "latest" %} <i class="glyphicon glyphicon-ok"></i>{% endif %}</a>

BIN
doc/_themes/saltstack2/static/images/saltStack_enterprise_350x125.jpg vendored
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 22 KiB

BIN
doc/_themes/saltstack2/static/images/saltStack_events_300x300.jpg vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

4
doc/_themes/saltstack2/static/js/webhelp.min_v1.4.1.js → doc/_themes/saltstack2/static/js/webhelp.min_v1.4.2.js vendored
View File

@ -115,7 +115,7 @@ $( document ).ready(function() {
});
/*version page selector*/
$( 'div.versions' ).on('click', 'a', function (e) {
$( 'div.releaselinks' ).on('click', 'a', function (e) {
e.preventDefault();
var clickedVer = $(this).attr("href");
var $currentVer = $( 'div.versions' ).find( 'a.active' ).first();
@ -188,4 +188,4 @@ function resizeend() {
function last(list) {
return list[list.length - 1];
}
}

19
doc/conf.py
View File

@ -50,6 +50,7 @@ MOCK_MODULES = [
'Crypto.PublicKey',
'Crypto.Random',
'Crypto.Signature',
'Crypto.Signature.PKCS1_v1_5',
'M2Crypto',
'msgpack',
'yaml',
@ -87,6 +88,7 @@ MOCK_MODULES = [
'tornado.httpserver',
'tornado.httputil',
'tornado.ioloop',
'tornado.simple_httpclient',
'tornado.web',
'tornado.websocket',
@ -104,7 +106,6 @@ MOCK_MODULES = [
'MySQLdb.cursors',
'nagios_json',
'psutil',
'psutil.version_info',
'pycassa',
'pymongo',
'rabbitmq_server',
@ -165,7 +166,7 @@ version = salt.version.__version__
latest_release = '2015.8.0' # latest release
previous_release = '2015.5.5' # latest release from previous branch
previous_release_dir = '2015.5' # path on web server for previous branch
build_type = 'latest' # latest, previous, develop
build_type = 'latest' # latest, previous, develop, inactive
# set release to 'version' for develop so sha is used
# - otherwise -
@ -176,11 +177,11 @@ release = latest_release # version, latest_release, previous_release
# Set google custom search engine
if release == latest_release:
search_cx = '004624818632696854117:yfmprrbw3pk'
search_cx = '004624818632696854117:yfmprrbw3pk' # latest
elif release.startswith('2014.7'):
search_cx = '004624818632696854117:thhslradbru'
search_cx = '004624818632696854117:thhslradbru' # 2014.7
elif release.startswith('2015.5'):
search_cx = '004624818632696854117:ovogwef29do'
search_cx = '004624818632696854117:ovogwef29do' # 2015.5
else:
search_cx = '004624818632696854117:haj7bjntf4s' # develop
@ -228,11 +229,11 @@ rst_prolog = """\
.. _`salt-packagers`: https://groups.google.com/forum/#!forum/salt-packagers
.. |windownload| raw:: html
<p>x86: <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-x86-Setup.exe"><strong>Salt-Minion-{release}-x86-Setup.exe</strong></a>
| <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-x86-Setup.exe.md5"><strong>md5</strong></a></p>
<p>x86: <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-3-x86-Setup.exe"><strong>Salt-Minion-{release}-3-x86-Setup.exe</strong></a>
| <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-3-x86-Setup.exe.md5"><strong>md5</strong></a></p>
<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>
<p>AMD64: <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-3-AMD64-Setup.exe"><strong>Salt-Minion-{release}-3-AMD64-Setup.exe</strong></a>
| <a href="https://repo.saltstack.com/windows/Salt-Minion-{release}-3-AMD64-Setup.exe.md5"><strong>md5</strong></a></p>
""".format(release=release)

1
doc/glossary.rst
View File

@ -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*:

1
doc/ref/clouds/all/index.rst
View File

@ -14,7 +14,6 @@ Full list of Salt Cloud modules
botocore_aws
cloudstack
digital_ocean
digital_ocean_v2
ec2
gce
gogrid

6
doc/ref/clouds/all/salt.cloud.clouds.digital_ocean_v2.rst
View File

@ -1,6 +0,0 @@
==================================
salt.cloud.clouds.digital_ocean_v2
==================================
.. automodule:: salt.cloud.clouds.digital_ocean_v2
:members:

1
doc/ref/modules/all/index.rst
View File

@ -61,7 +61,6 @@ Full list of builtin execution modules
cpan
cron
cyg
cytest
daemontools
darwin_pkgutil
darwin_sysctl

2
doc/ref/states/all/index.rst
View File

@ -14,7 +14,7 @@ Full list of builtin state modules
alternatives
apache
apache_module
apt
aptpkg
archive
artifactory
at

6
doc/ref/states/all/salt.states.apt.rst
View File

@ -1,6 +0,0 @@
===============
salt.states.apt
===============
.. automodule:: salt.states.apt
:members:

2
doc/ref/states/requisites.rst
View File

@ -4,6 +4,8 @@
Requisites and Other Global State Arguments
===========================================
.. _requisites-fire-event:
Fire Event Notifications
========================

38
doc/topics/installation/debian.rst
View File

@ -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)
------------------------

104
doc/topics/installation/rhel.rst
View File

@ -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
*************

8
doc/topics/installation/windows.rst
View File

@ -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

47
doc/topics/releases/2015.8.0.rst
View File

@ -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 <installation-rhel-repo>`
- :ref:`Debian 8 <installation-debian-repo>`
- :ref:`Windows <windows-installer>`
- FreeBSD
Send Event on State Completion
==============================
A `fire_event` global state keyword argument was added that allows any state to
send an event upon completion. Useful for custom progress bars and checking in
on long state runs.
on long state runs. See :ref:`fire_event <requisites-fire-event>`.
ZeroMQ socket monitoring
========================
@ -35,7 +46,7 @@ A new :conf_master:`default_top` option was added to load the state top file
from a single, specific environment, rather than merging top data across all
environments. Additionally, new :conf_master:`top_file_merge_strategy` and
:conf_master:`env_order` options were added for more control over top file
merging.
merging. See :ref:`The Top File <states-top>`.
Tornado TCP Transport
=====================
@ -47,12 +58,12 @@ performance.
.. note::
Tornado is considered early-access in this release. The following known
Tornado is considered expiremental in this release. The following known
issues were being investigated at the time of release:
- TCP tests show
performance degredation over time (:issue:`26051`)
- TCP transport stacktrace on windows minion: Future exception was never
retrieved (:issue:`25718)
retrieved (:issue:`25718`)
- [freebsd] TCP transport not working in 2015.8.0rc3 (:issue:`26364`)
Proxy Minion Enhancements
@ -80,19 +91,16 @@ with :mod:`gitfs <salt.fileserver.gitfs>`. Support for pygit2_ has been added,
bringing with it the ability to access authenticated repositories.
Using the new features will require updates to the git ext_pillar
configuration, further details can be found :ref:`here
<git-pillar-2015-8-0-and-later>`.
configuration, further details can be found in the :ref:`pillar.git_pillar
<git-pillar-2015-8-0-and-later>` docs.
Salt Cloud Improvements
=======================
- Pricing data from several cloud providers (GCE, DigitalOcean, SoftLayer_HW, EC2)
- All cloud providers now use standardized bootstrapping code
- All cloud providers now use standardized bootstrapping code.
- Modified the Linode Salt Cloud driver to use Linode's native API instead of
depending on apache-libcloud or linode-python.
- When querying for VMs in ``digital_ocean.py``, the number of VMs to include in
a page was changed from 20 (default) to 200 to reduce the number of API calls
to Digital
Salt Cloud Changes
------------------
@ -103,9 +111,7 @@ Salt Cloud Changes
duplicate names of VMs before trying to create a new VM. Will now throw an
error similarly to other salt-cloud drivers when trying to create a VM of the
same name, even if the VM is in the ``terminated`` state.
- Modified the Linode Salt Cloud driver to use Linode's native API instead of
depending on apache-libcloud or linode-python.
- When querying for VMs in ``ditigal_ocean.py``, the number of VMs to include in
- When querying for VMs in ``digital_ocean.py``, the number of VMs to include in
a page was changed from 20 (default) to 200 to reduce the number of API calls
to Digital Ocean.Ocean.
@ -125,7 +131,7 @@ State and Execution Module Improvements
- Deprecate ``enabled`` argument in ``pkgrepo.managed`` in favor of ``disabled``.
- Archive module changes: In the ``archive.tar`` and ``archive.cmd_unzip``
module functions, remove the arbitrary prefixing of the options string with
``-``. An options string beginning with a ``--long-option``, would have
``-``. An options string beginning with a ``--long-option``, would have
uncharacteristically needed its first ``-`` removed under the former scheme.
Also, tar will parse its options differently if short options are used with or
without a preceding ``-``, so it is better to not confuse the user into
@ -138,10 +144,12 @@ State and Execution Module Improvements
Windows Improvements
====================
- Templatize Windows Software package definitions
- Added additional capabilities to the user module for windows
- Added new module for managing windows updates (win_wua)
- Turned on multi-processing by default for windows in minion conf
- Enhanced the windows minion silent installation with command line parameters
to configure the salt master and minion name. See :ref:`Silent Installer
Options <windows-installer-options>`.
- Improved user management with additional capabilities in the user module for Windows.
- Improved patch management with a new module for managing windows updates (:mod:`win_wua <modules.win_wua>`).
- Turned on multi-processing by default for windows in minion configuration.
Windows Software Repo Changes
-----------------------------
@ -190,7 +198,6 @@ seconds by specifying ``in_seconds=True``.
Other Improvements
==================
- Python 3
- Sanitize sensitive fields in http.query
- Allow authorization to be read from Django and eauth
- Add templating to SMTP returner
@ -201,6 +208,7 @@ Other Improvements
- Add end time to master job cache for jobs (optional, off by default)
- Tornado is now the default backend for http.request
- Support pillarenv selection as it's done for saltenv
- salt was updated to use python-crypto version 2.6.1, which removes the dependency on python-m2crypto.
Deprecations
============
@ -282,3 +290,4 @@ Major Bug Fixes
- Improve process management in proxy minion (:issue:`12024`)
- Proxy minion never comes up with message ' I am XXX and I am not supposed to
start any proxies.' (:issue:`25908`)
- Fixed an issue that caused an exception when using Salt mine from pillar. (:issue:`11509`)

18
salt/auth/stormpath.py
View File

@ -5,16 +5,16 @@ Provide authentication using Stormpath.
This driver requires some extra configuration beyond that which Stormpath
normally requires.
.. code-block:: yaml
.. code-block:: yaml
stormpath:
apiid: 1234567890
apikey: 1234567890/ABCDEF
# Can use an application ID
application: 6789012345
# Or can use a directory ID
directory: 3456789012
# But not both
stormpath:
apiid: 1234567890
apikey: 1234567890/ABCDEF
# Can use an application ID
application: 6789012345
# Or can use a directory ID
directory: 3456789012
# But not both
.. versionadded:: 2015.8.0
'''