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

Fixes for doc build errors

Browse source
This commit is contained in:
Jacob Hammons 2015-05-26 20:48:03 -06:00
parent 1fbc5b25e6
commit 0689815d0e
50 changed files with 203 additions and 155 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/_themes/saltstack2/layout.html vendored
View file

@ -53,6 +53,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '{{ url_root }}',
VERSION: '{{ release|e }}',
SEARCH_CX: '{{ search_cx }}',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }}
@ -158,8 +159,8 @@
{% if on_saltstack %}
<div class="versions">
<a id="latest" data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release_version }} </a> {% if build_type == "latest" %}<i class="glyphicon glyphicon-ok"></i>{%- endif %} |
<a id="previous" data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the previous stable release" href="/en/{{ previous_release_dir }}/">{{ previous_release_version }} </a> {% if build_type == "previous" %}<i class="glyphicon glyphicon-ok"></i>{%- endif %} |
<a id="latest" data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the latest stable release" href="/en/latest/">{{ latest_release }} </a> {% if build_type == "latest" %}<i class="glyphicon glyphicon-ok"></i>{%- endif %} |
<a id="previous" data-container="body" data-toggle="tooltip" data-placement="bottom" title="Docs for the previous stable release" href="/en/{{ previous_release_dir }}/">{{ previous_release }} </a> {% if build_type == "previous" %}<i class="glyphicon glyphicon-ok"></i>{%- endif %} |
<a id="develop" data-container="body" data-toggle="tooltip" data-placement="bottom" title="Recent doc build from the develop branch" href="/en/develop/">Develop </a> {% if build_type == "develop" %}<i class="glyphicon glyphicon-ok"></i>{%- endif %}
</div>
@ -265,13 +266,13 @@
<div class="col-sm-6">
{% if build_type == "latest" %}
<p>You are viewing docs for the latest stable release, {{ latest_release_version }}. Switch 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_version }}</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>
<p>You are viewing docs for the latest stable release, {{ latest_release }}. Switch 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>, 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 == "previous" %}
<p>You are viewing docs for the previous stable release, {{ previous_release_version }}. 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_version }}</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>
<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 == "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_version }}</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_version }}</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>, 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>
{% endif %}
<br>

19
doc/_themes/saltstack2/static/js/webhelp.min.js vendored
View file

@ -140,9 +140,14 @@ $( document ).ready(function() {
$( '#search-form' ).find( 'input' ).keypress(function(e) {
if(e.which == 13) {
var cx = '004624818632696854117:yfmprrbw3pk&q=';
'find which search instance to use'
if (DOCUMENTATION_OPTIONS.SEARCH_CX) {
cx = DOCUMENTATION_OPTIONS.SEARCH_CX;
}
var searchterm = encodeURIComponent($(this).val());
$(this).val("");
window.location.href = 'https://www.google.com/cse?cx=004624818632696854117:yfmprrbw3pk&q=' + searchterm;
window.location.href = 'https://www.google.com/cse?cx=' + cx + '&q=' + searchterm;
}
});
@ -152,7 +157,6 @@ $( document ).ready(function() {
$( '#wrapper' ).toggleClass( 'toggled' );
});
}); // $.document.ready
//refresh on window resize
@ -160,10 +164,13 @@ var rtime = new Date(1, 1, 2000, 12,00,00);
var timeout = false;
var delta = 200;
$(window).resize(function() {
rtime = new Date();
if (timeout === false) {
timeout = true;
setTimeout(resizeend, delta);
if (!$( '#menu-toggle' ).is(":visible")) {
rtime = new Date();
if (timeout === false) {
timeout = true;
setTimeout(resizeend, delta);
}
}
});

35
doc/conf.py
View file

@ -44,6 +44,7 @@ class Mock(object):
MOCK_MODULES = [
# salt core
'Crypto',
'Crypto.Signature',
'Crypto.Cipher',
'Crypto.Hash',
'Crypto.PublicKey',
@ -102,6 +103,7 @@ MOCK_MODULES = [
'rabbitmq_server',
'redis',
'requests',
'requests.exceptions',
'rpm',
'rpmUtils',
'rpmUtils.arch',
@ -153,8 +155,25 @@ project = 'Salt'
copyright = '2015 SaltStack, Inc.'
version = salt.version.__version__
#release = '.'.join(map(str, salt.version.__version_info__))
release = '2015.5.0' # also update release versions in 'html_context'
latest_release = '2015.5.0' # latest release
previous_release = '2014.7.6' # latest release from previous branch
previous_release_dir = '2014.7' # path on web server for previous branch
build_type = 'latest' # latest, previous, develop
# set release to 'version' for develop so sha is used
# - otherwise -
# set release to 'latest_release' or 'previous_release'
release = latest_release # version, latest_release, previous_release
# Set google custom search engine
if release == latest_release:
search_cx = '004624818632696854117:yfmprrbw3pk'
elif release.startswith('2014.7'):
search_cx = '004624818632696854117:thhslradbru'
else:
search_cx = '004624818632696854117:haj7bjntf4s' # develop
needs_sphinx = '1.3'
@ -193,11 +212,12 @@ autosummary_generate = True
# Define a substitution for linking to the latest release tarball
rst_prolog = """\
.. |current_release_doc| replace:: :doc:`/topics/releases/{release}`
.. |saltrepo| replace:: https://github.com/saltstack/salt
.. _`salt-users`: https://groups.google.com/forum/#!forum/salt-users
.. _`salt-announce`: https://groups.google.com/forum/#!forum/salt-announce
.. _`salt-packagers`: https://groups.google.com/forum/#!forum/salt-packagers
"""
""".format(release=latest_release)
# A shortcut for linking to tickets on the GitHub issue tracker
extlinks = {
@ -266,10 +286,11 @@ html_context = {
'github_base': 'https://github.com/saltstack/salt',
'github_issues': 'https://github.com/saltstack/salt/issues',
'github_downloads': 'https://github.com/saltstack/salt/downloads',
'latest_release_version': '2015.5.0',
'previous_release_version': '2014.7.6',
'previous_release_dir': '2014.7',
'build_type': 'latest', #latest, previous, develop
'latest_release': latest_release,
'previous_release': previous_release,
'previous_release_dir': previous_release_dir,
'search_cx': search_cx,
'build_type': build_type,
}
html_use_index = True

6
doc/contents.rst
View file

@ -14,9 +14,15 @@ Salt Table of Contents
topics/reactor/index
topics/mine/index
topics/eauth/index
topics/eauth/access_control
topics/jobs/index
topics/jobs/job_cache
topics/sdb/index
topics/event/index
topics/beacons/index
topics/ext_processes/index
topics/topology/index
topics/transports/raet/index
topics/windows/index
topics/cloud/index
topics/netapi/index

2
doc/index.rst
View file

@ -280,4 +280,4 @@ More information about the project
The SaltStack security disclosure policy
.. _`salt-contrib`: https://github.com/saltstack/salt-contrib
.. _`salt-states`: https://github.com/saltstack/salt-states
.. _`salt-states`: https://github.com/saltstack/salt-states

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

@ -21,7 +21,6 @@ Full list of Salt Cloud modules
joyent
libcloud_aws
linode
linodepy
lxc
msazure
nova

6
doc/ref/clouds/all/salt.cloud.clouds.linodepy.rst
View file

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

6
doc/ref/modules/all/salt.modules.hipchat.rst Normal file
View file

@ -0,0 +1,6 @@
====================
salt.modules.hipchat
====================
.. automodule:: salt.modules.hipchat
:members:

6
doc/ref/modules/all/salt.modules.random_org.rst Normal file
View file

@ -0,0 +1,6 @@
=======================
salt.modules.random_org
=======================
.. automodule:: salt.modules.random_org
:members:

6
doc/ref/pillar/all/salt.pillar.file_encode.rst
View file

@ -1,6 +0,0 @@
=======================
salt.pillar.file_encode
=======================
.. automodule:: salt.pillar.file_encode
:members:

6
doc/ref/returners/all/salt.returners.hipchat_return.rst Normal file
View file

@ -0,0 +1,6 @@
=============================
salt.returners.hipchat_return
=============================
.. automodule:: salt.returners.hipchat_return
:members:

6
doc/ref/returners/all/salt.returners.slack_returner.rst Normal file
View file

@ -0,0 +1,6 @@
=============================
salt.returners.slack_returner
=============================
.. automodule:: salt.returners.slack_returner
:members:

2
doc/topics/cloud/config.rst
View file

@ -472,7 +472,7 @@ And in the map file:
.. note::
In the cloud profile that uses this provider configuration, the syntax for the
``provider`` required field would be ``provdier: devhost10-lxc`.
``provider`` required field would be ``provider: devhost10-lxc``.
.. _config_saltify:

6
doc/topics/cloud/function.rst
View file

@ -16,9 +16,9 @@ provider, that provider must be specified.
There are three universal salt-cloud functions that are extremely useful for
gathering information about instances on a provider basis:
*``list_nodes``: Returns some general information about the instances for the given provider.
*``list_nodes_full``: Returns all information about the instances for the given provider.
*``list_nodes_select``: Returns select information about the instances for the given provider.
* ``list_nodes``: Returns some general information about the instances for the given provider.
* ``list_nodes_full``: Returns all information about the instances for the given provider.
* ``list_nodes_select``: Returns select information about the instances for the given provider.
.. code-block:: bash

2
doc/topics/cloud/windows.rst
View file

@ -52,7 +52,7 @@ If supported by the cloud provider, a PowerShell script may be used to open up
this port automatically, using the cloud provider's `userdata`. The following
script would open up port 445, and apply the changes:
.. code-block:: other
.. code-block:: powershell
<powershell>
New-NetFirewallRule -Name "SMB445" -DisplayName "SMB445" -Protocol TCP -LocalPort 445

4
doc/topics/development/contributing.rst
View file

@ -87,8 +87,8 @@ Fork a Repo Guide_>`_ and is well worth reading.
# modified: path/to/file2
If you get stuck `there are many introductory Git resources on
help.github.com <Git resources_>`_.
If you get stuck, there are many introductory Git resources on
http://help.github.com.
#. Push your locally-committed changes to your GitHub fork,

5
doc/topics/development/raet/index.rst
View file

@ -1,8 +1,11 @@
raet
====
# RAET
# Reliable Asynchronous Event Transport Protocol
.. seealso:: :ref:`RAET Overview <raet>`
Protocol
--------
@ -266,4 +269,4 @@ Receiver Side:
Duplicate detection save transaction id duplicate detection timeout
Request resend of missing packet in sequence
Sequence reordering with escrow timeout wait escrow before requesting resend
Unsegmentation (request resends of missing segment)
Unsegmentation (request resends of missing segment)

4
doc/topics/ext_processes/index.rst
View file

@ -15,7 +15,7 @@ Processes started in this way will be restarted if they die and will be
killed when the Salt Master is shut down.
Example Configureation
Example Configuration
======================
Processes are declared in the master config file with the `ext_processes`
@ -56,4 +56,4 @@ Example Process Class
while True:
self.event.fire_event({'iteration': i}, 'ext_processes/test{0}')
time.sleep(60)
time.sleep(60)

4
doc/topics/releases/2014.7.5.rst
View file

@ -2,7 +2,7 @@
Salt 2014.7.5 Release Notes
===========================
:release: TBA
:release: 2015-04-16
Version 2014.7.5 is a bugfix release for :doc:`2014.7.0
</topics/releases/2014.7.0>`.
@ -19,7 +19,7 @@ Changes:
- Fixed malformed locale string in localmod module
- Fixed checking of available version of package when accept_keywords were changed
- Fixed bug to make git.latest work with empty repositories
- Added **kwargs to service.mod_watch which removes warnings about `enable` and `__reqs__` not being supported by the function
- Added \*\*kwargs to service.mod_watch which removes warnings about `enable` and `__reqs__` not being supported by the function
- Improved state comments to not grow so quickly on failed requisites
- Added force argument to service to trigger force_reload
- Fixed bug to andle pkgrepo keyids that have been converted to int

60
doc/topics/releases/2015.5.1.rst
View file

@ -14,117 +14,103 @@ Changes:
Extended Changelog Courtesy of Todd Stansell (https://github.com/tjstansell/salt-changelogs):
- **PR** `#23989`_: (*rallytime*) Backport `#23980`_ to 2015.5
**PR** `#23989`_: (*rallytime*) Backport `#23980`_ to 2015.5
@ *2015-05-20T19:33:41Z*
- **PR** `#23980`_: (*iggy*) template: jinja2 -> jinja
| refs: `#23989`_
* **PR** `#23980`_: (*iggy*) template: jinja2 -> jinja | refs: `#23989`_
* 117ecb1 Merge pull request `#23989`_ from rallytime/`bp-23980`_
* 8f8557c template: jinja2 -> jinja
- **PR** `#23988`_: (*rallytime*) Backport `#23977`_ to 2015.5
**PR** `#23988`_: (*rallytime*) Backport `#23977`_ to 2015.5
@ *2015-05-20T19:13:36Z*
- **PR** `#23977`_: (*ionutbalutoiu*) Fixed glance image_create
| refs: `#23988`_
* **PR** `#23977`_: (*ionutbalutoiu*) Fixed glance image_create | refs: `#23988`_
* d4f1ba0 Merge pull request `#23988`_ from rallytime/`bp-23977`_
* 46fc7c6 Fixed glance image_create
- **PR** `#23986`_: (*basepi*) [2015.5] Merge forward from 2014.7 to 2015.5
**PR** `#23986`_: (*basepi*) [2015.5] Merge forward from 2014.7 to 2015.5
@ *2015-05-20T18:41:33Z*
- **PR** `#23965`_: (*hvnsweeting*) handle all exceptions gitpython can raise
* **PR** `#23965`_: (*hvnsweeting*) handle all exceptions gitpython can raise
* 9566e7d Merge pull request `#23986`_ from basepi/merge-forward-2015.5
* 0b78156 Merge remote-tracking branch 'upstream/2014.7' into merge-forward-2015.5
* 314e4db Merge pull request `#23965`_ from hvnsweeting/20147-fix-gitfs-gitpython-exception
* 2576301 handle all exception gitpython can raise
* 314e4db Merge pull request `#23965`_ from hvnsweeting/20147-fix-gitfs-gitpython-exception
* 2576301 handle all exception gitpython can raise
- **PR** `#23985`_: (*UtahDave*) Add 2014.7.5-2 and 2015.5.0-2 Windows installer download links
**PR** `#23985`_: (*UtahDave*) Add 2014.7.5-2 and 2015.5.0-2 Windows installer download links
@ *2015-05-20T18:32:44Z*
* 9d1130e Merge pull request `#23985`_ from UtahDave/2015.5local
* 10338d0 Add links to Windows 2015.5.0-2 install downloads
* b84f975 updated Windows 2014.7.5-2 installer download link
- **PR** `#23983`_: (*rallytime*) Versionadded tags for https_user and https_pass args new in 2015.5.0
**PR** `#23983`_: (*rallytime*) Versionadded tags for https_user and https_pass args new in 2015.5.0
@ *2015-05-20T18:05:27Z*
* ca7729d Merge pull request `#23983`_ from rallytime/versionadded_git_options
* 14eae22 Versionadded tags for https_user and https_pass args new in 2015.5.0
- **PR** `#23970`_: (*jayeshka*) adding system unit test case
**PR** `#23970`_: (*jayeshka*) adding system unit test case
@ *2015-05-20T17:12:57Z*
* b06df57 Merge pull request `#23970`_ from jayeshka/system-unit-test
* 89eb008 adding system unit test case
- **PR** `#23967`_: (*jayeshka*) adding states/memcached unit test case
**PR** `#23967`_: (*jayeshka*) adding states/memcached unit test case
@ *2015-05-20T17:12:26Z*
* 38d5f75 Merge pull request `#23967`_ from jayeshka/memcached-states-unit-test
* 8ef9240 adding states/memcached unit test case
- **PR** `#23966`_: (*jayeshka*) adding states/modjk unit test case
**PR** `#23966`_: (*jayeshka*) adding states/modjk unit test case
@ *2015-05-20T17:11:48Z*
* 868e807 Merge pull request `#23966`_ from jayeshka/modjk-states-unit-test
* 422a964 adding states/modjk unit test case
- **PR** `#23942`_: (*jacobhammons*) Updates to sphinx saltstack2 doc theme
**PR** `#23942`_: (*jacobhammons*) Updates to sphinx saltstack2 doc theme
@ *2015-05-20T15:43:54Z*
* 6316490 Merge pull request `#23942`_ from jacobhammons/2015.5
* 31023c8 Updates to sphinx saltstack2 doc theme
- **PR** `#23874`_: (*joejulian*) Validate keyword arguments to be valid
**PR** `#23874`_: (*joejulian*) Validate keyword arguments to be valid
@ *2015-05-20T04:53:40Z*
- **ISSUE** `#23872`_: (*joejulian*) create_ca_signed_cert can error if dereferenced dict is used for args
| refs: `#23874`_
* **ISSUE** `#23872`_: (*joejulian*) create_ca_signed_cert can error if dereferenced dict is used for args | refs: `#23874`_
* 587957b Merge pull request `#23874`_ from joejulian/2015.5_tls_validate_kwargs
* 30102ac Fix py3 and ordering inconsistency problems.
* 493f7ad Validate keyword arguments to be valid
- **PR** `#23960`_: (*rallytime*) Backport `#22114`_ to 2015.5
**PR** `#23960`_: (*rallytime*) Backport `#22114`_ to 2015.5
@ *2015-05-20T04:37:09Z*
- **PR** `#22114`_: (*dmyerscough*) Fixing KeyError when there are no additional pages
| refs: `#23960`_
* **PR** `#22114`_: (*dmyerscough*) Fixing KeyError when there are no additional pages | refs: `#23960`_
* 00c5c22 Merge pull request `#23960`_ from rallytime/`bp-22114`_
* f3e1d63 Catch KeyError
* 306b1ea Fixing KeyError
* 6b2cda2 Fix PEP8 complaint
* 239e50f Fixing KeyError when there are no additional pages
- **PR** `#23961`_: (*rallytime*) Backport `#23944`_ to 2015.5
**PR** `#23961`_: (*rallytime*) Backport `#23944`_ to 2015.5
@ *2015-05-20T04:35:41Z*
- **PR** `#23944`_: (*ryan-lane*) Add missing loginclass argument to _changes call
| refs: `#23961`_
* **PR** `#23944`_: (*ryan-lane*) Add missing loginclass argument to _changes call | refs: `#23961`_
* 4648b46 Merge pull request `#23961`_ from rallytime/`bp-23944`_
* 970d19a Add missing loginclass argument to _changes call
- **PR** `#23948`_: (*jfindlay*) augeas.change state now returns changes as a dict
**PR** `#23948`_: (*jfindlay*) augeas.change state now returns changes as a dict
@ *2015-05-20T04:00:10Z*
* 0cb5cd3 Merge pull request `#23948`_ from jfindlay/augeas_changes
* f09b80a augeas.change state now returns changes as a dict
- **PR** `#23957`_: (*rallytime*) Backport `#23951`_ to 2015.5
**PR** `#23957`_: (*rallytime*) Backport `#23951`_ to 2015.5
@ *2015-05-20T03:04:24Z*
- **PR** `#23951`_: (*ryan-lane*) Do not check perms in file.copy if preserve
| refs: `#23957`_
* **PR** `#23951`_: (*ryan-lane*) Do not check perms in file.copy if preserve | refs: `#23957`_
* 2d185f7 Merge pull request `#23957`_ from rallytime/`bp-23951`_
* 996b431 Update file.py
* 85d461f Do not check perms in file.copy if preserve
- **PR** `#23956`_: (*rallytime*) Backport `#23906`_ to 2015.5

10
doc/topics/releases/index.rst
View file

@ -5,13 +5,10 @@ Release notes
See the :doc:`version numbers</topics/releases/version_numbers>` page for more
information about the version numbering scheme.
Latest Branch Release
Latest Stable Release
=====================
.. releasestree::
:maxdepth: 1
2014.7.6
|current_release_doc|
Previous Releases
=================
@ -20,10 +17,11 @@ Previous Releases
:maxdepth: 1
:glob:
2015.5.*
2014.7.*
2014.1.*
0.*
.. seealso:: :doc:`Legacy salt-cloud release docs <../cloud/releases/index>`
.. seealso:: :doc:`Legacy salt-api release docs <saltapi/index>`
.. seealso:: :doc:`Legacy salt-api release docs <saltapi/index>`

2
doc/topics/topology/syndic.rst
View file

@ -91,7 +91,7 @@ Syndic and the CLI
In order for the high-level master to return information from minions that are
below the syndic(s), the CLI requires a short wait time in order to allow the
syndic(s) to gather responses from their minions. This value is defined in the
``syndic_wait` and has a default of five seconds.
``syndic_wait`` and has a default of five seconds.
While it is possible to run a syndic without a minion installed on the same machine,
it is recommended, for a faster CLI response time, to do so. Without a minion

7
doc/topics/transports/raet/index.rst
View file

@ -1,3 +1,5 @@
.. _raet:
==================
The RAET Transport
==================
@ -135,3 +137,8 @@ externally developed cryptography system.
For more information on libsodium and CurveCP please see:
http://doc.libsodium.org/
http://curvecp.org/
Programming Intro
=================
:ref:`Raet Programming Introduction <raet-programming>`

2
doc/topics/transports/raet/programming_intro.rst
View file

@ -1,3 +1,5 @@
.. _raet_programming:
=========================
Intro to RAET Programming
=========================

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

@ -424,7 +424,7 @@ master, each configured git remote will be searched.
Branches, Environments, and Top Files
====================================
=====================================
When using the gitfs backend, branches, and tags will be mapped to environments
using the branch/tag name as an identifier.

4
doc/topics/tutorials/index.rst
View file

@ -48,6 +48,8 @@ Advanced Topics
gitfs
walkthrough_macosx
writing_tests
http
lxc
Salt Virt
==========
@ -68,4 +70,4 @@ Using Salt at scale
.. toctree::
:maxdepth: 2
intro_scale
intro_scale

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

@ -467,7 +467,7 @@ times to call shell commands to gather data.
Introducing the Python, PyDSL, and the Pyobjects Renderers
---------------------------------------------------------
----------------------------------------------------------
Sometimes the chosen default renderer might not have enough logical power to
accomplish the needed task. When this happens, the Python renderer can be

6
salt/client/ssh/client.py
View file

@ -14,7 +14,7 @@ class SSHClient(object):
'''
Create a client object for executing routines via the salt-ssh backend
.. versionaddedd:: 2015.2
.. versionadded:: 2015.5
'''
def __init__(self,
c_path=os.path.join(syspaths.CONFIG_DIR, 'master'),
@ -68,7 +68,7 @@ class SSHClient(object):
Execute a single command via the salt-ssh subsystem and return a
generator
.. versionaddedd:: 2015.2
.. versionadded:: 2015.5
'''
ssh = self._prep_ssh(
tgt,
@ -94,7 +94,7 @@ class SSHClient(object):
Execute a single command via the salt-ssh subsystem and return all
routines at once
.. versionaddedd:: 2015.2
.. versionadded:: 2015.5
'''
ssh = self._prep_ssh(
tgt,

2
salt/cloud/clouds/linode.py
View file

@ -8,7 +8,9 @@ The Linode cloud module is used to control access to the Linode VPS system
Use of this module only requires the ``apikey`` parameter.
:depends: linode-python >= 1.1.1
OR
:depends: apache-libcloud >= 0.13.2
.. note::

4
salt/modules/boto_dynamodb.py
View file

@ -13,6 +13,8 @@ Connection module for Amazon DynamoDB
If IAM roles are not used you need to specify them either in a pillar or
in the minion's config file::
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
@ -23,7 +25,7 @@ Connection module for Amazon DynamoDB
If a region is not specified, the default is us-east-1.
It's also possible to specify key, keyid and region via a profile, either
as a passed in dict, or as a string to pull from pillars or minion config:
as a passed in dict, or as a string to pull from pillars or minion config::
myprofile:
keyid: GKTADJGHEIQSXMKKRBJ08H

2
salt/modules/cmdmod.py
View file

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
'''
A module for shelling out
A module for shelling out.
Keep in mind that this module is insecure, in that it can give whomever has
access to the master root execution access to all salt minions.

34
salt/modules/firewalld.py
View file

@ -143,14 +143,14 @@ def new_zone(zone, restart=True):
CLI Example:
.. code-block::
.. code-block:: bash
salt '*' firewalld.new_zone my_zone
By default firewalld will be reloaded. However, to avoid reloading
you need to specify the restart as False
.. code-block::
.. code-block:: bash
salt '*' firewalld.new_zone my_zone False
'''
@ -171,14 +171,14 @@ def delete_zone(zone, restart=True):
CLI Example:
.. code-block::
.. code-block:: bash
salt '*' firewalld.delete_zone my_zone
By default firewalld will be reloaded. However, to avoid reloading
you need to specify the restart as False
.. code-block::
.. code-block:: bash
salt '*' firewalld.delete_zone my_zone False
'''
@ -199,7 +199,7 @@ def set_default_zone(zone):
CLI Example:
.. code-block::
.. code-block:: bash
salt '*' firewalld.set_default_zone damian
'''
@ -212,14 +212,14 @@ def new_service(name, restart=True):
CLI Example:
.. code-block::
.. code-block:: bash
salt '*' firewalld.new_service my_service
By default firewalld will be reloaded. However, to avoid reloading
you need to specify the restart as False
.. code-block::
.. code-block:: bash
salt '*' firewalld.new_service my_service False
'''
@ -240,14 +240,14 @@ def delete_service(name, restart=True):
CLI Example:
.. code-block::
.. code-block:: bash
salt '*' firewalld.delete_service my_service
By default firewalld will be reloaded. However, to avoid reloading
you need to specify the restart as False
.. code-block::
.. code-block:: bash
salt '*' firewalld.delete_service my_service False
'''
@ -268,13 +268,13 @@ def list_all(zone=None):
CLI Example:
.. code-block::
.. code-block:: bash
salt '*' firewalld.list_all
List a specific zone
.. code-block::
.. code-block:: bash
salt '*' firewalld.list_all my_zone
'''
@ -307,13 +307,13 @@ def list_services(zone=None):
CLI Example:
.. code-block::
.. code-block:: bash
salt '*' firewalld.list_services
List a specific zone
.. code-block::
.. code-block:: bash
salt '*' firewalld.list_services my_zone
'''
@ -331,13 +331,13 @@ def add_service(name, zone=None, permanent=True):
CLI Example:
.. code-block::
.. code-block:: bash
salt '*' firewalld.add_service ssh
To assign a service to a specific zone
.. code-block::
.. code-block:: bash
salt '*' firewalld.add_service ssh my_zone
'''
@ -359,13 +359,13 @@ def remove_service(name, zone=None, permanent=True):
CLI Example:
.. code-block::
.. code-block:: bash
salt '*' firewalld.remove_service ssh
To remove a service from a specific zone
.. code-block::
.. code-block:: bash
salt '*' firewalld.remove_service ssh dmz
'''

1
salt/modules/gpg.py
View file

@ -6,7 +6,6 @@ from keyservers. Sign, encrypt and sign & encrypt text and files.
.. versionadded:: 2015.5.0
.. note::
The ``python-gnupg`` library and gpg binary are
required to be installed.

4
salt/modules/http.py
View file

@ -15,7 +15,7 @@ def query(url, **kwargs):
'''
Query a resource, and decode the return data
.. versionaddedd:: 2015.2
.. versionadded:: 2015.5.0
CLI Example:
@ -34,7 +34,7 @@ def update_ca_bundle(target=None, source=None, merge_files=None):
'''
Update the local CA bundle file from a URL
.. versionaddedd:: 2015.2
.. versionadded:: 2015.5.0
CLI Example:

4
salt/modules/ilo.py
View file

@ -100,7 +100,7 @@ def set_http_port(port=80):
CLI Example:
.. code-block::
.. code-block:: bash
salt '*' ilo.set_http_port 8080
'''
@ -586,7 +586,7 @@ def configure_snmp(community, snmp_port=161, snmp_trapport=161):
CLI Example:
.. code-bash::
.. code-block:: bash
salt '*' ilo.configure_snmp [COMMUNITY STRING] [SNMP PORT] [SNMP TRAP PORT]
'''

1
salt/modules/puppet.py
View file

@ -237,6 +237,7 @@ def disable(message=None):
salt '*' puppet.disable
salt '*' puppet.disable 'disabled for a good reason'
'''
_check_puppet()

3
salt/modules/tls.py
View file

@ -759,7 +759,6 @@ def create_ca_signed_cert(ca_name,
The CN *must* match an existing CSR generated by create_csr. If it
does not, this method does nothing.
ca_name
name of the CA
CN
@ -777,7 +776,7 @@ def create_ca_signed_cert(ca_name,
.. versionadded:: 2015.5.1
**extensions
extensions
X509 V3 certificate extension
Writes out a Certificate (CERT). If the file already

4
salt/netapi/rest_cherrypy/app.py
View file

@ -17,8 +17,8 @@ A REST API for Salt
<acl-eauth>` system which requires additional configuration not described
here.
Example production-ready configuration; add to the Salt master config file
and restart the ``salt-master`` and ``salt-api`` daemons:
Example production-ready configuration; add to the Salt master config file
and restart the ``salt-master`` and ``salt-api`` daemons:
.. code-block:: yaml

6
salt/output/compact.py
View file

@ -1,12 +1,10 @@
# -*- coding: utf-8 -*-
'''
Display compact output data structure
=================================
=====================================
Example output::
'saltdev': {'test_|-always-passes_|-foo_|-succeed_without_changes': {'comment': 'Success!', 'name': 'foo', 'start_time': '05:16:26.111814', 'result': True, 'duration': 1, '__run_num__': 0, 'changes': {}}, 'test_|-my-custom-combo_|-foo_|-configurable_test_state': {'comment': 'bar.baz', 'name': 'foo', 'start_time': '05:16:26.117177', 'result': False, 'duration': 1, '__run_num__': 4, 'changes': {'testing': {'new': 'Something pretended to change', 'old': 'Unchanged'}}}, 'test_|-always-fails_|-foo_|-fail_without_changes': {'comment': 'Failure!', 'name': 'foo', 'start_time': '05:16:26.113124', 'result': False, 'duration': 1, '__run_num__': 1, 'changes': {}}, 'test_|-always-changes-and-succeeds_|-foo_|-succeed_with_changes': {'comment': 'Success!', 'name': 'foo', 'start_time': '05:16:26.114570', 'result': True, 'duration': 0, '__run_num__': 2, 'changes': {'testing': {'new': 'Something pretended to change', 'old': 'Unchanged'}}}, 'test_|-always-changes-and-fails_|-foo_|-fail_with_changes': {'comment': 'Failure!', 'name': 'foo', 'start_time': '05:16:26.115561', 'result': False, 'duration': 1, '__run_num__': 3, 'changes': {'testing': {'new': 'Something pretended to change', 'old': 'Unchanged'}}}}}
{'myminion': {'foo': {'list': ['Hello', 'World'], 'bar': 'baz', 'dictionary': {'abc': 123, 'def': 456}}}}
'saltdev': {'test_|-always-passes_|-foo_|-succeed_without_changes': {'comment': 'Success!', 'name': 'foo', 'start_time': '05:16:26.111814', 'result': True, 'duration': 1, '__run_num__': 0, 'changes': {}}, 'test_|-my-custom-combo_|-foo_|-configurable_test_state': {'comment': 'bar.baz', 'name': 'foo', 'start_time': '05:16:26.117177', 'result': False, 'duration': 1, '__run_num__': 4, 'changes': {'testing': {'new': 'Something pretended to change', 'old': 'Unchanged'}}}, 'test_|-always-fails_|-foo_|-fail_without_changes': {'comment': 'Failure!', 'name': 'foo', 'start_time': '05:16:26.113124', 'result': False, 'duration': 1, '__run_num__': 1, 'changes': {}}, 'test_|-always-changes-and-succeeds_|-foo_|-succeed_with_changes': {'comment': 'Success!', 'name': 'foo', 'start_time': '05:16:26.114570', 'result': True, 'duration': 0, '__run_num__': 2, 'changes': {'testing': {'new': 'Something pretended to change', 'old': 'Unchanged'}}}, 'test_|-always-changes-and-fails_|-foo_|-fail_with_changes': {'comment': 'Failure!', 'name': 'foo', 'start_time': '05:16:26.115561', 'result': False, 'duration': 1, '__run_num__': 3, 'changes': {'testing': {'new': 'Something pretended to change', 'old': 'Unchanged'}}}}}{'myminion': {'foo': {'list': ['Hello', 'World'], 'bar': 'baz', 'dictionary': {'abc': 123, 'def': 456}}}}
'''
from __future__ import absolute_import

2
salt/returners/mongo_future_return.py
View file

@ -9,7 +9,7 @@ This returner will send data from the minions to a MongoDB server. To
configure the settings for your MongoDB server, add the following lines
to the minion config files:
.. cod-block:: yaml
.. code-block:: yaml
mongo.db: <database name>
mongo.host: <server ip address>

4
salt/runners/nacl.py
View file

@ -9,14 +9,14 @@ share your pillar data with others that you trust. I dont advise making your pil
regardless if they are encrypted or not.
The following configurations can be defined in the master config
so your users can create encrypted passwords using the runner nacl.
so your users can create encrypted passwords using the runner nacl::
cat /etc/salt/master.d/nacl.conf
nacl.config:
key: None
keyfile: /root/.nacl
Now with the config in the master you can use the runner nacl like:
Now with the config in the master you can use the runner nacl like::
salt-run nacl.enc 'data'

2
salt/sdb/sqlite3.py
View file

@ -26,7 +26,7 @@ values (defaults to ``sdb``). The database and table will be created if they
do not exist.
Advanced Usage:
==============
===============
Instead of a table name, it is possible to provide custom SQL statements to
create the table(s) and get and set values.

2
salt/states/boto_dynamodb.py
View file

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
'''
Manage DynamoDB Tables
=================
======================
.. versionadded:: 2015.5.0

2
salt/states/boto_elb.py
View file

@ -10,7 +10,7 @@ services, and so may incur charges.
This module uses ``boto``, which can be installed via package, or pip.
This module accepts explicit elb credentials but can also utilize
IAM roles assigned to the instance through Instance Profiles. Dynamic
IAM roles assigned to the instance through Instance Profiles. Dynamic
credentials are then automatically obtained from AWS API and no further
configuration is necessary. More information available `here
<http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html>`_.

2
salt/states/drac.py
View file

@ -27,7 +27,7 @@ Ensure the user damian does not exist
Ensure DRAC network is in a consistent state
.. code-bock:: yaml
.. code-block:: yaml
my_network:
drac.network:

2
salt/states/file.py
View file

@ -2391,7 +2391,7 @@ def replace(name,
Filesystem path to the file to be edited.
pattern
Python's `regular expression search<https://docs.python.org/2/library/re.html>`_.
Python's `regular expression search <https://docs.python.org/2/library/re.html>`_.
repl
The replacement text.

24
salt/states/linux_acl.py
View file

@ -5,22 +5,22 @@ Linux File Access Control Lists
Ensure a Linux ACL is present
.. code-block:: yaml
root:
acl.present:
- name: /root
- acl_type: users
- acl_name: damian
- perms: rwx
root:
acl.present:
- name: /root
- acl_type: users
- acl_name: damian
- perms: rwx
Ensure a Linux ACL does not exist
.. code-block:: yaml
root:
acl.absent:
- name: /root
- acl_type: user
- acl_name: damian
- perms: rwx
root:
acl.absent:
- name: /root
- acl_type: user
- acl_name: damian
- perms: rwx
'''
# Import salt libs

1
salt/states/slack.py
View file

@ -17,6 +17,7 @@ This state is useful for sending messages to Slack during state runs.
- api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
The api key can be specified in the master or minion configuration like below:
.. code-block:: yaml
slack:

16
salt/states/win_servermanager.py
View file

@ -75,17 +75,21 @@ def removed(name):
Remove the windows feature
name:
short name of the feature (the right column in win_servermanager.list_available)
Note:
Some features require a reboot after uninstallation. If so the feature will not be completly uninstalled until
Some features require a reboot after uninstallation. If so the feature will not be completly uninstalled until
the server is restarted.
Example:
Run ``salt MinionName win_servermanager.list_installed`` to get a list of all features installed. Use the top
Run ``salt MinionName win_servermanager.list_installed`` to get a list of all features installed. Use the top
name listed for each feature, not the indented one. Do not use the role or feature names mentioned in the
PKGMGR documentation.
.. code-block:: yaml
ISWebserverRole:
win_servermanager.removed:
- name: Web-Server
.. code-block:: yaml
ISWebserverRole:
win_servermanager.removed:
- name: Web-Server
'''
ret = {'name': name,
'result': True,

4
salt/wheel/config.py
View file

@ -47,7 +47,6 @@ def update_config(file_name, yaml_contents):
Update master config with
``yaml_contents``.
Writes ``yaml_contents`` to a file named
``file_name.conf`` under the folder
specified by ``default_include``.
@ -56,8 +55,7 @@ def update_config(file_name, yaml_contents):
http://docs.saltstack.com/en/latest/ref/configuration/master.html#include-configuration
for more information.
Example low data
Example low data::
data = {
'username': 'salt',
'password': 'salt',