mirror of
https://github.com/valitydev/salt.git
synced 2024-11-08 01:18:58 +00:00
Thomas S Hatch
commit
c365444723
36
doc/conf.py
36
doc/conf.py
@ -113,11 +113,11 @@ intersphinx_mapping = {
|
||||
# -- General Configuration -----------------------------------------------------
|
||||
|
||||
project = 'Salt'
|
||||
copyright = '2013 SaltStack, Inc.'
|
||||
copyright = '2014 SaltStack, Inc.'
|
||||
|
||||
version = salt.version.__version__
|
||||
#release = '.'.join(map(str, salt.version.__version_info__))
|
||||
release = '0.17.5'
|
||||
release = '2014.1'
|
||||
|
||||
language = 'en'
|
||||
locale_dirs = [
|
||||
@ -150,7 +150,7 @@ rst_prolog = """\
|
||||
# A shortcut for linking to tickets on the GitHub issue tracker
|
||||
extlinks = {
|
||||
'blob': ('https://github.com/saltstack/salt/blob/%s/%%s' % 'develop', None),
|
||||
'download': ('https://github.com/downloads/saltstack/salt/%s', None),
|
||||
'download': ('https://cloud.github.com/downloads/saltstack/salt/%s', None),
|
||||
'issue': ('https://github.com/saltstack/salt/issues/%s', 'issue '),
|
||||
'formula': ('https://github.com/saltstack-formulas/%s', ''),
|
||||
}
|
||||
@ -218,6 +218,36 @@ latex_documents = [
|
||||
|
||||
latex_logo = '_static/saltstack_logo.png'
|
||||
|
||||
### Linkcheck options
|
||||
linkcheck_ignore = [r'http://127.0.0.1',
|
||||
r'http://salt:\d+',
|
||||
r'http://local:\d+',
|
||||
r'https://console.aws.amazon.com',
|
||||
r'http://192.168.33.10',
|
||||
r'http://domain:\d+',
|
||||
r'http://123.456.789.012:\d+',
|
||||
r'http://localhost',
|
||||
r'https://groups.google.com/forum/#!forum/salt-users',
|
||||
r'http://logstash.net/docs/latest/inputs/udp',
|
||||
r'http://logstash.net/docs/latest/inputs/zeromq',
|
||||
r'http://www.youtube.com/saltstack',
|
||||
r'http://raven.readthedocs.org',
|
||||
r'https://getsentry.com',
|
||||
r'http://salt-cloud.readthedocs.org',
|
||||
r'http://salt.readthedocs.org',
|
||||
r'http://www.pip-installer.org/',
|
||||
r'http://www.windowsazure.com/',
|
||||
r'https://github.com/watching',
|
||||
r'dash-feed://',
|
||||
r'https://github.com/saltstack/salt/',
|
||||
r'http://bootstrap.saltstack.org',
|
||||
r'media.readthedocs.org/dash/salt/latest/salt.xml',
|
||||
r'https://portal.aws.amazon.com/gp/aws/securityCredentials',
|
||||
r'https://help.github.com/articles/fork-a-repo',
|
||||
r'dash-feed://https%3A//media.readthedocs.org/dash/salt/latest/salt.xml'
|
||||
]
|
||||
|
||||
linkcheck_anchors = False
|
||||
|
||||
### Manpage options
|
||||
# One entry per manual page. List of tuples
|
||||
|
||||
@ -30,7 +30,7 @@ for orchestration, remote execution, configuration management and much more.
|
||||
.. _`ePub`: https://media.readthedocs.org/epub/salt/latest/salt.epub
|
||||
.. _`Dash Docset`: dash-feed://https%3A//media.readthedocs.org/dash/salt/latest/salt.xml
|
||||
.. _`ReadTheDocs download page`: https://readthedocs.org/projects/salt/downloads/
|
||||
.. _`SaltStack YouTube channel`: http://youtube.com/saltstack
|
||||
.. _`SaltStack YouTube channel`: http://www.youtube.com/saltstack
|
||||
|
||||
Download
|
||||
========
|
||||
|
||||
@ -161,7 +161,7 @@ function. Some examples:
|
||||
|
||||
- :blob:`pacman.py <salt/modules/pacman.py>`
|
||||
- :blob:`yumpkg.py <salt/modules/yumpkg.py>`
|
||||
- :blob:`apt.py <salt/modules/apt.py>`
|
||||
- :blob:`aptpkg.py <salt/modules/aptpkg.py>`
|
||||
|
||||
.. note::
|
||||
Modules which return a string from ``__virtual__`` that is already used by a module that
|
||||
|
||||
@ -267,7 +267,7 @@ strftime
|
||||
{{ datetime|strftime("%u") }}
|
||||
{{ "now"|strftime }}
|
||||
|
||||
.. _`builtin filters`: http://jinja.pocoo.org/docs/templates/##builtin-filters
|
||||
.. _`builtin filters`: http://jinja.pocoo.org/docs/templates/#builtin-filters
|
||||
.. _`timelib`: https://github.com/pediapress/timelib/
|
||||
|
||||
Jinja in Files
|
||||
|
||||
@ -105,4 +105,4 @@ loaded as simply ``redis``:
|
||||
return False
|
||||
return 'redis'
|
||||
|
||||
.. _`redis`: https://github.com/saltstack/salt/blob/develop/salt/returners/redis_return.py
|
||||
.. _`redis`: https://github.com/saltstack/salt/tree/develop/salt/returners/redis_return.py
|
||||
|
||||
@ -33,7 +33,7 @@ an understanding of Salt states and how to write the states is needed as well.
|
||||
.. note::
|
||||
|
||||
States are compiled and executed only on minions that have been targeted.
|
||||
To execute functions directly on masters, see `runners`_.
|
||||
To execute functions directly on masters, see :doc:`runners </topics/ref/runners>`.
|
||||
|
||||
Salt SLS System
|
||||
---------------
|
||||
@ -311,7 +311,7 @@ The output is:
|
||||
Total: 2
|
||||
|
||||
|
||||
.. _`pip`: http://pypi.python.org/pypi/pip
|
||||
.. _`pip`: https://pypi.python.org/pypi/pip
|
||||
.. _`pep8`: https://pypi.python.org/pypi/pep8
|
||||
.. _`setuptools`: https://pypi.python.org/pypi/setuptools
|
||||
.. _`runners`: /ref/runners
|
||||
|
||||
@ -17,7 +17,7 @@ illustrate:
|
||||
.. code-block:: yaml
|
||||
|
||||
/etc/salt/master: # maps to "name"
|
||||
file: # maps to State module filename e.g. https://github.com/saltstack/salt/blob/develop/salt/states/file.py
|
||||
file: # maps to State module filename e.g. https://github.com/saltstack/salt/tree/develop/salt/states/file.py
|
||||
- managed # maps to the managed function in the file State module
|
||||
- user: root # one of many options passed to the manage function
|
||||
- group: root
|
||||
|
||||
@ -424,7 +424,7 @@ Tags can be set once an instance has been launched.
|
||||
tag2: value
|
||||
|
||||
.. _`AWS documentation`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html
|
||||
.. _`AWS Spot Instances`: http://aws.amazon.com/ec2/spot-instances/
|
||||
.. _`AWS Spot Instances`: http://aws.amazon.com/ec2/purchasing-options/spot-instances/
|
||||
|
||||
Modify EC2 Tags
|
||||
===============
|
||||
@ -547,11 +547,7 @@ them have never been used, much less tested, by the Salt Stack team.
|
||||
|
||||
* `Debian`__
|
||||
|
||||
.. __: http://wiki.debian.org/Cloud/AmazonEC2Image
|
||||
|
||||
* `Gentoo`__
|
||||
|
||||
.. __: https://aws.amazon.com/amis?platform=Gentoo&selection=platform
|
||||
.. __: https://wiki.debian.org/Cloud/AmazonEC2Image
|
||||
|
||||
* `OmniOS`__
|
||||
|
||||
@ -559,7 +555,7 @@ them have never been used, much less tested, by the Salt Stack team.
|
||||
|
||||
* `All Images on Amazon`__
|
||||
|
||||
.. __: https://aws.amazon.com/amis
|
||||
.. __: https://aws.amazon.com/marketplace
|
||||
|
||||
|
||||
show_image
|
||||
|
||||
@ -31,7 +31,7 @@ imports, to decide whether to load the module. In most cases, it will return a
|
||||
filename, then that name should be returned instead of ``True``. An example of
|
||||
this may be seen in the Azure module:
|
||||
|
||||
https://github.com/saltstack/salt/blob/develop/salt/cloud/clouds/msazure.py
|
||||
https://github.com/saltstack/salt/tree/develop/salt/cloud/clouds/msazure.py
|
||||
|
||||
The get_configured_provider() Function
|
||||
--------------------------------------
|
||||
@ -57,7 +57,7 @@ created by the cloud provider, wait for it to become available, and then
|
||||
A good example to follow for writing a cloud provider module based on libcloud
|
||||
is the module provided for Linode:
|
||||
|
||||
https://github.com/saltstack/salt/blob/develop/salt/cloud/clouds/linode.py
|
||||
https://github.com/saltstack/salt/tree/develop/salt/cloud/clouds/linode.py
|
||||
|
||||
The basic flow of a ``create()`` function is as follows:
|
||||
|
||||
@ -174,7 +174,7 @@ imports should be absent from the Salt Cloud module.
|
||||
|
||||
A good example of a non-libcloud provider is the Digital Ocean module:
|
||||
|
||||
https://github.com/saltstack/salt/blob/develop/salt/cloud/clouds/digital_ocean.py
|
||||
https://github.com/saltstack/salt/tree/develop/salt/cloud/clouds/digital_ocean.py
|
||||
|
||||
The ``create()`` Function
|
||||
-------------------------
|
||||
|
||||
@ -78,7 +78,7 @@ This is currently considered to be experimental functionality, and may not work
|
||||
well with all providers. If you experience problems with Salt Cloud hanging
|
||||
after Salt is deployed, consider using Startup States instead:
|
||||
|
||||
http://docs.saltstack.org/en/latest/ref/states/startup.html
|
||||
http://docs.saltstack.com/ref/states/startup.html
|
||||
|
||||
|
||||
Skipping the Deploy Script
|
||||
|
||||
@ -26,7 +26,7 @@ Create a new `virtualenv`_:
|
||||
|
||||
virtualenv /path/to/your/virtualenv
|
||||
|
||||
.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
|
||||
.. _`virtualenv`: https://pypi.python.org/pypi/virtualenv
|
||||
|
||||
|
||||
On Arch Linux, where Python 3 is the default installation of Python, use the
|
||||
|
||||
@ -25,9 +25,9 @@ Download
|
||||
|
||||
Salt Cloud can be downloaded and install via pypi or github:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.6.0.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.6.0.tar.gz
|
||||
|
||||
https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.6.0.tar.gz
|
||||
https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.6.0.tar.gz
|
||||
|
||||
Packages are not yet available, Salt Cloud requires three dependencies, the
|
||||
salt libs, libcloud, and paramiko.
|
||||
|
||||
@ -22,9 +22,9 @@ Download
|
||||
|
||||
Salt Cloud can be downloaded and install via pypi or github:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.7.0.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.7.0.tar.gz
|
||||
|
||||
https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.7.0.tar.gz
|
||||
https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.7.0.tar.gz
|
||||
|
||||
Some packages have been made available for salt-cloud and more on on their
|
||||
way. Packages for Arch, and FreeBSD are being made available thanks to the
|
||||
@ -43,10 +43,10 @@ Rackspace Cloud
|
||||
http://www.rackspace.com/cloud/
|
||||
|
||||
Linode
|
||||
http://www.linode.com/
|
||||
https://www.linode.com/
|
||||
|
||||
Joyent
|
||||
http://joyent.com/
|
||||
http://www.joyent.com/
|
||||
|
||||
GoGrid
|
||||
http://www.gogrid.com/
|
||||
|
||||
@ -17,9 +17,9 @@ Download
|
||||
|
||||
Salt Cloud can be downloaded and install via pypi or github:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.0.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.0.tar.gz
|
||||
|
||||
https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.0.tar.gz
|
||||
https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.0.tar.gz
|
||||
|
||||
Some packages have been made available for salt-cloud and more on on their
|
||||
way. Packages for Arch, and FreeBSD are being made available thanks to the
|
||||
|
||||
@ -17,9 +17,9 @@ Download
|
||||
|
||||
Salt Cloud can be downloaded and install via pypi or github:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.1.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.1.tar.gz
|
||||
|
||||
https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.1.tar.gz
|
||||
https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.1.tar.gz
|
||||
|
||||
Some packages have been made available for salt-cloud and more on on their
|
||||
way. Packages for Arch, and FreeBSD are being made available thanks to the
|
||||
|
||||
@ -18,9 +18,9 @@ Download
|
||||
|
||||
Salt Cloud can be downloaded and install via pypi or github:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.2.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.2.tar.gz
|
||||
|
||||
https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.2.tar.gz
|
||||
https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.2.tar.gz
|
||||
|
||||
Some packages have been made available for salt-cloud and more on on their
|
||||
way. Packages for Arch, and FreeBSD are being made available thanks to the
|
||||
|
||||
@ -16,9 +16,9 @@ Download
|
||||
|
||||
Salt Cloud can be downloaded and install via pypi or github:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.3.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.3.tar.gz
|
||||
|
||||
https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.3.tar.gz
|
||||
https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.3.tar.gz
|
||||
|
||||
Some packages have been made available for salt-cloud and more on on their
|
||||
way. Packages for Arch and FreeBSD are being made available thanks to the
|
||||
|
||||
@ -16,7 +16,7 @@ Download
|
||||
|
||||
Salt Cloud can be downloaded and install via pypi:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.4.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.4.tar.gz
|
||||
|
||||
Some packages have been made available for salt-cloud and more on on their
|
||||
way. Packages for Arch and FreeBSD are being made available thanks to the
|
||||
|
||||
@ -18,7 +18,7 @@ Download
|
||||
|
||||
Salt Cloud can be downloaded and install via pypi:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.5.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.5.tar.gz
|
||||
|
||||
Some packages have been made available for salt-cloud and more on on their
|
||||
way. Packages for Arch and FreeBSD are being made available thanks to the
|
||||
|
||||
@ -16,7 +16,7 @@ Download
|
||||
|
||||
Salt Cloud can be downloaded and install via pypi:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.6.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.6.tar.gz
|
||||
|
||||
Some packages have been made available for salt-cloud and more on on their
|
||||
way. Packages for Arch and FreeBSD are being made available thanks to the
|
||||
|
||||
@ -36,7 +36,7 @@ Download
|
||||
|
||||
Salt Cloud can be downloaded and install via pypi:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.7.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.7.tar.gz
|
||||
|
||||
Some packages have been made available for salt-cloud and more on on their
|
||||
way. Packages for Arch and FreeBSD are being made available thanks to the
|
||||
|
||||
@ -18,7 +18,7 @@ Download
|
||||
|
||||
Salt Cloud can be downloaded and install via pypi:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.9.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.9.tar.gz
|
||||
|
||||
Some packages have been made available for salt-cloud and more on on their
|
||||
way. Packages for Arch and FreeBSD are being made available thanks to the
|
||||
|
||||
@ -90,7 +90,7 @@ https://www.ohloh.net/p/salt
|
||||
Other community links
|
||||
=====================
|
||||
|
||||
- `Salt Stack Inc. <http://saltstack.com>`_
|
||||
- `Salt Stack Inc. <http://www.saltstack.com>`_
|
||||
- `Subreddit <http://www.reddit.com/r/saltstack>`_
|
||||
- `Google+ <https://plus.google.com/114449193225626631691/posts>`_
|
||||
- `YouTube <http://www.youtube.com/user/SaltStack>`_
|
||||
|
||||
@ -191,7 +191,7 @@ other salt modules which needed to import :mod:`sys<python2:sys>` would have to
|
||||
also import :mod:`absolute_import<python2:__future__>`, which should be
|
||||
avoided.
|
||||
|
||||
.. _`absolute imports`: http://www.python.org/dev/peps/pep-0328/#rationale-for-absolute-imports
|
||||
.. _`absolute imports`: http://legacy.python.org/dev/peps/pep-0328/#rationale-for-absolute-imports
|
||||
|
||||
|
||||
Vertical is Better
|
||||
@ -304,6 +304,6 @@ PEP 8. Code churn is a leading source of bugs and is strongly discouraged.
|
||||
While style fixes are encouraged they should be isolated to a single file per
|
||||
commit, and the changes should be legitimate, if there are any questions about
|
||||
whether a style change is legitimate please reference this document and the
|
||||
official PEP 8 (http://www.python.org/dev/peps/pep-0008/) document before
|
||||
official PEP 8 (http://legacy.python.org/dev/peps/pep-0008/) document before
|
||||
changing code. Many claims that a change is PEP 8 have been invalid, please
|
||||
double check before committing fixes.
|
||||
|
||||
@ -114,7 +114,7 @@ Then to accept the changes and merge into the current branch:
|
||||
For more info, see `GitHub Fork a Repo Guide`_ or `Open Comparison Contributing
|
||||
Docs`_
|
||||
|
||||
.. _`GitHub Fork a Repo Guide`: http://help.github.com/fork-a-repo/
|
||||
.. _`GitHub Fork a Repo Guide`: https://help.github.com/articles/fork-a-repo
|
||||
.. _`Open Comparison Contributing Docs`: http://opencomparison.readthedocs.org/en/latest/contributing.html
|
||||
|
||||
Posting patches to the mailing list
|
||||
@ -125,7 +125,7 @@ format-patch`_ and send them to the Salt users mailing list. The contributor
|
||||
will then get credit for the patch, and the Salt community will have an archive
|
||||
of the patch and a place for discussion.
|
||||
|
||||
.. _`git format-patch`: http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html
|
||||
.. _`git format-patch`: https://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html
|
||||
|
||||
Installing Salt for development
|
||||
-------------------------------
|
||||
@ -145,7 +145,7 @@ Clone the repository using:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git remote add upstream http://github.com/saltstack/salt
|
||||
git remote add upstream https://github.com/saltstack/salt
|
||||
|
||||
Fetching tags is done with the git 'fetch' utility:
|
||||
|
||||
@ -159,7 +159,7 @@ Create a new `virtualenv`_:
|
||||
|
||||
virtualenv /path/to/your/virtualenv
|
||||
|
||||
.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
|
||||
.. _`virtualenv`: https://pypi.python.org/pypi/virtualenv
|
||||
|
||||
On Arch Linux, where Python 3 is the default installation of Python, use the
|
||||
``virtualenv2`` command instead of ``virtualenv``.
|
||||
|
||||
@ -61,7 +61,7 @@ authentication and encryption are integral to Salt. Salt takes
|
||||
advantage of communication via `msgpack`_, enabling fast and light
|
||||
network traffic.
|
||||
|
||||
.. _`ZeroMQ`: http://www.zeromq.org/
|
||||
.. _`ZeroMQ`: http://zeromq.org/
|
||||
.. _`msgpack`: http://msgpack.org/
|
||||
.. _`AES`: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
|
||||
|
||||
|
||||
@ -75,7 +75,7 @@ Salt should run on any Unix-like platform so long as the dependencies are met.
|
||||
* `YAML`_ - Python YAML bindings
|
||||
* `Jinja2`_ - parsing Salt States (configurable in the master settings)
|
||||
* `MarkupSafe`_ - Implements a XML/HTML/XHTML Markup safe string for Python
|
||||
* `apache-libcloud` - Python lib for interacting with many of the popular cloud service providers using a unified API
|
||||
* `apache-libcloud`_ - Python lib for interacting with many of the popular cloud service providers using a unified API
|
||||
|
||||
Optional Dependencies
|
||||
---------------------
|
||||
@ -85,11 +85,11 @@ Optional Dependencies
|
||||
* gcc - dynamic `Cython`_ module compiling
|
||||
|
||||
.. _`Python 2.6`: http://python.org/download/
|
||||
.. _`ZeroMQ`: http://www.zeromq.org/
|
||||
.. _`ZeroMQ`: http://zeromq.org/
|
||||
.. _`pyzmq`: https://github.com/zeromq/pyzmq
|
||||
.. _`PyCrypto`: http://www.dlitz.net/software/pycrypto/
|
||||
.. _`msgpack-python`: https://pypi.python.org/pypi/msgpack-python/0.1.12
|
||||
.. _`PyCrypto`: https://www.dlitz.net/software/pycrypto/
|
||||
.. _`M2Crypto`: http://chandlerproject.org/Projects/MeTooCrypto
|
||||
.. _`msgpack-python`: http://pypi.python.org/pypi/msgpack-python
|
||||
.. _`YAML`: http://pyyaml.org/
|
||||
.. _`Jinja2`: http://jinja.pocoo.org/
|
||||
.. _`MarkupSafe`: https://pypi.python.org/pypi/MarkupSafe
|
||||
|
||||
@ -211,7 +211,7 @@ Building the installer
|
||||
|
||||
The Salt Windows installer is built with the open-source NSIS compiler. The
|
||||
source for the installer is found in the pkg directory of the Salt repo here:
|
||||
https://github.com/saltstack/salt/blob/develop/pkg/windows/installer/Salt-Minion-Setup.nsi.
|
||||
https://github.com/saltstack/salt/tree/develop/pkg/windows/installer/Salt-Minion-Setup.nsi.
|
||||
To create the installer, extract the frozen archive from ``dist/`` into ``pkg/windows/buildenv/``
|
||||
and run NSIS.
|
||||
|
||||
@ -289,12 +289,12 @@ On windows Server 2003, you need to install optional component "wmi windows inst
|
||||
|
||||
|
||||
.. _http://csa-net.dk/salt: http://csa-net.dk/salt
|
||||
.. _vcredist_x86: http://www.microsoft.com/download/en/details.aspx?id=5582
|
||||
.. _vcredist_x64: http://www.microsoft.com/download/en/details.aspx?id=2092
|
||||
.. _vcredist_x86: http://www.microsoft.com/en-us/download/details.aspx?id=5582
|
||||
.. _vcredist_x64: http://www.microsoft.com/en-us/download/details.aspx?id=2092
|
||||
.. _msysgit: http://code.google.com/p/msysgit/downloads/list?can=3
|
||||
.. _Python 2.7: http://www.python.org/getit
|
||||
.. _Python 2.7: http://www.python.org/downloads
|
||||
.. _ez_setup.py: https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py
|
||||
.. _OpenSSL for Windows: http://www.slproweb.com/products/Win32OpenSSL.html
|
||||
.. _OpenSSL for Windows: http://slproweb.com/products/Win32OpenSSL.html
|
||||
.. _M2Crypto: http://chandlerproject.org/Projects/MeTooCrypto
|
||||
.. _pycrypto: http://www.voidspace.org.uk/python/modules.shtml#pycrypto
|
||||
.. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32
|
||||
|
||||
@ -53,7 +53,7 @@ GitHub page: |saltrepo|
|
||||
|
||||
Wiki: https://github.com/saltstack/salt/wiki
|
||||
|
||||
Arch Linux Package: https://aur.archlinux.org/packages.php?ID=47512
|
||||
Arch Linux Package: https://aur.archlinux.org/packages/salt-git/
|
||||
|
||||
I am very open to contributions, for instance I need packages for more Linux
|
||||
distributions as well as BSD packages and testers.
|
||||
|
||||
@ -56,6 +56,6 @@ Source Tarball:
|
||||
|
||||
Arch Linux Package:
|
||||
|
||||
https://aur.archlinux.org/packages.php?ID=47512
|
||||
https://aur.archlinux.org/packages/salt-git/
|
||||
|
||||
Please enjoy the latest Salt release!
|
||||
|
||||
@ -80,7 +80,7 @@ configuration file can be accessed inside of the minion modules via the __opt__
|
||||
dict.
|
||||
|
||||
Information on how to use this simple addition has been added to the wiki:
|
||||
https://github.com/thatch45/salt/wiki/Writing-Salt-Modules
|
||||
:doc:`Writing modules </ref/states/>`
|
||||
|
||||
The test module has an example of using the __opts__ dict, and how to set
|
||||
default options:
|
||||
|
||||
@ -12,7 +12,7 @@ to the salt website which is still under heavy development. The new sphinx
|
||||
documentation system has also been used to greatly clean up the salt manpages.
|
||||
The salt 7 manpage in particular now contains extensive information which was
|
||||
previously only in the wiki. The new documentation can be found at:
|
||||
http://thatch45.github.com/salt-www/
|
||||
http://docs.saltstack.com/
|
||||
We still have a lot to add, and when the domain is set up I will post another
|
||||
announcement.
|
||||
|
||||
@ -72,10 +72,6 @@ maintaining supreme usability and simplicity.
|
||||
|
||||
If you would like a more complete overview of Salt please watch the Salt
|
||||
presentation:
|
||||
Flash Video:
|
||||
http://blip.tv/thomas-s-hatch/salt-0-8-7-presentation-5180182
|
||||
OGV Video Download:
|
||||
http://blip.tv/file/get/Thatch45-Salt087Presentation416.ogv
|
||||
Slides:
|
||||
:download:`Salt.pdf`
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ The Salt source can be downloaded from the salt GitHub site:
|
||||
|
||||
Or from PyPI:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt/salt-0.8.9.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt/salt-0.8.9.tar.gz
|
||||
|
||||
Here s the md5sum:
|
||||
|
||||
@ -44,7 +44,7 @@ execute custom routines from the master.
|
||||
|
||||
Documentation for salt-run can be found here:
|
||||
|
||||
http://saltstack.org/ref/runners.html
|
||||
:doc:`Runners </ref/runners>`
|
||||
|
||||
Refined Outputters
|
||||
``````````````````
|
||||
@ -63,7 +63,7 @@ Salt modules can now call each other, the ``__salt__`` dict has been added to
|
||||
the predefined references in minion modules. This new feature is documented in
|
||||
the modules documentation:
|
||||
|
||||
http://saltstack.org/ref/modules/index.html
|
||||
:doc:`Modules </ref/modules>`
|
||||
|
||||
Watch Option Added to Salt State System
|
||||
````````````````````````````````````````
|
||||
@ -108,7 +108,7 @@ moosefs
|
||||
~~~~~~~
|
||||
|
||||
Initial support for reporting on aspects of the distributed file system,
|
||||
MooseFS. For more information on MooseFS please see: http://moosefs.org
|
||||
MooseFS. For more information on MooseFS please see: http://www.moosefs.org
|
||||
|
||||
Thanks to Joseph Hall for his work on MooseFS support.
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ The Salt source can be downloaded from the salt GitHub site:
|
||||
|
||||
Or from PyPI:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt/salt-0.9.0.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt/salt-0.9.0.tar.gz
|
||||
|
||||
Here is the md5sum:
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ The Salt source can be downloaded from the salt GitHub site:
|
||||
|
||||
Or from PyPI:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt/salt-0.9.2.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt/salt-0.9.2.tar.gz
|
||||
|
||||
For instructions on how to set up Salt please see the :ref:`installation`
|
||||
instructions.
|
||||
@ -54,7 +54,7 @@ state system is ready for early testers to start playing with. If you are
|
||||
interested in working with the state system please check out the (still very
|
||||
small) salt-states GitHub repo:
|
||||
|
||||
https://github.com/thatch45/salt-states
|
||||
https://github.com/saltstack/salt-states
|
||||
|
||||
This git repo is the active development branch for determining how a clean
|
||||
salt-state database should look and act. Since the salt state system is still
|
||||
|
||||
@ -22,7 +22,7 @@ The Salt source can be downloaded from the salt GitHub site:
|
||||
|
||||
Or from PyPI:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt/salt-0.9.3.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt/salt-0.9.3.tar.gz
|
||||
|
||||
For instructions on how to set up Salt please see the :ref:`installation`
|
||||
instructions.
|
||||
|
||||
@ -24,7 +24,7 @@ The Salt source can be downloaded from the salt GitHub site:
|
||||
|
||||
Or from PyPI:
|
||||
|
||||
http://pypi.python.org/packages/source/s/salt/salt-0.9.4.tar.gz
|
||||
https://pypi.python.org/packages/source/s/salt/salt-0.9.4.tar.gz
|
||||
|
||||
For instructions on how to set up Salt please see the :ref:`installation`
|
||||
instructions.
|
||||
|
||||
@ -254,7 +254,7 @@ FreeBSD
|
||||
|
||||
Salt on FreeBSD? There a port for that:
|
||||
|
||||
http://www.freebsd.org/cgi/cvsweb.cgi/ports/sysutils/salt/pkg-descr
|
||||
http://svnweb.freebsd.org/ports/head/sysutils/py-salt/
|
||||
|
||||
This port was developed and added by Christer Edwards. This also marks the
|
||||
first time Salt has been included in an upstream packaging system!
|
||||
|
||||
@ -204,7 +204,7 @@ PagerDuty Support
|
||||
Initial support for firing events via PagerDuty_ has been added. See the
|
||||
documentation for the :mod:`pagerduty <salt.modules.pagerduty>` module.
|
||||
|
||||
.. _PagerDuty: http://pagerduty.com
|
||||
.. _PagerDuty: http://www.pagerduty.com
|
||||
|
||||
|
||||
Virtual Terminal
|
||||
@ -231,7 +231,7 @@ don't have the horsepower or ability to handle a Python VM.
|
||||
|
||||
Proxy minions can be difficult to write, so a simple REST-based example proxy
|
||||
is included. A Python bottle-based webserver can be found at
|
||||
http://github.com/cro/salt-proxy-rest as an endpoint for this proxy.
|
||||
https://github.com/cro/salt-proxy-rest as an endpoint for this proxy.
|
||||
|
||||
This is an ALPHA-quality feature. There are a number of issues with it
|
||||
currently, mostly centering around process control, logging, and inability to
|
||||
|
||||
@ -74,9 +74,9 @@ You can see the current list of test suite images on our `docker repository`__.
|
||||
If you wish to provide your own `docker`_ container, you can submit pull
|
||||
requests against our `docker salt test containers`__ repository.
|
||||
|
||||
.. _docker: http://www.docker.io/
|
||||
.. _docker: https://www.docker.io/
|
||||
.. __: https://index.docker.io/u/salttest/
|
||||
.. __: https://github.com/saltstack/docker-salttest-containers
|
||||
.. __: https://github.com/saltstack/docker-containers
|
||||
|
||||
|
||||
=============
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
Bootstrapping Salt on Linux EC2 with Cloud-Init
|
||||
===============================================
|
||||
|
||||
`Salt <http://saltstack.org>`_ is a great tool for remote execution and
|
||||
`Salt <http://www.saltstack.com/community/>`_ is a great tool for remote execution and
|
||||
configuration management, however you will still need to bootstrap the
|
||||
daemon when spinning up a new node. One option is to create and save a
|
||||
custom `AMI`_, but this creates another resource to maintain and document.
|
||||
@ -66,7 +66,7 @@ Additional Notes
|
||||
|
||||
Sometime in the future the ppa will include and install an upstart file. In the
|
||||
meantime, you can use the bootstrap to `build one
|
||||
<https://gist.github.com/1617054>`_.
|
||||
<https://gist.github.com/rubic/1617054>`_.
|
||||
|
||||
It may also be useful to set the node's role during this phase. One option
|
||||
would be saving the node's role to a file and then using a custom Grain to
|
||||
|
||||
@ -160,7 +160,7 @@ prone to errors.
|
||||
Virtual Machine generation applications are available for many platforms:
|
||||
|
||||
vm-builder:
|
||||
http://wiki.debian.org/VMBuilder
|
||||
https://wiki.debian.org/VMBuilder
|
||||
|
||||
Once virtual machines images are available the easiest way to make them available
|
||||
to Salt Virt is to place them in the Salt file server. Just copy an image into
|
||||
@ -186,7 +186,7 @@ Fedora Linux
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Images for Fedora Linux can be found here:
|
||||
http://cloud.fedoraproject.org
|
||||
http://fedoraproject.org/en/get-fedora#clouds
|
||||
|
||||
Ubuntu Linux
|
||||
~~~~~~~~~~~~
|
||||
|
||||
@ -91,7 +91,7 @@ common locations, but your mileage may vary.
|
||||
|
||||
**Debian**
|
||||
|
||||
Follow these instructions: http://wiki.debian.org/iptables
|
||||
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``:
|
||||
|
||||
@ -336,7 +336,7 @@ provides a flexible, domain-specific language for authoring SLS data in Python.
|
||||
|
||||
.. _`Jinja2`: http://jinja.pocoo.org/
|
||||
.. _`Mako`: http://www.makotemplates.org/
|
||||
.. _`Wempy`: http://www.wempy.org/
|
||||
.. _`Wempy`: https://fossil.secution.com/u/gcw/wempy/doc/tip/README.wiki
|
||||
|
||||
.. note::
|
||||
The templating engines described above aren't just available in SLS files.
|
||||
|
||||
@ -49,7 +49,7 @@ encryption for payload communication. This means that authentication and
|
||||
encryption are also built into Salt. Salt takes advantage of communication via
|
||||
the most excellent `msgpack`_ library, enabling fast and light network traffic.
|
||||
|
||||
.. _`ZeroMQ`: http://www.zeromq.org/
|
||||
.. _`ZeroMQ`: http://zeromq.org/
|
||||
|
||||
.. _`msgpack`: http://msgpack.org/
|
||||
|
||||
|
||||
@ -65,7 +65,7 @@
|
||||
|
||||
|
||||
.. _`DSN`: http://raven.readthedocs.org/en/latest/config/index.html#the-sentry-dsn
|
||||
.. _`Sentry`: http://getsentry.com
|
||||
.. _`Sentry`: https://getsentry.com
|
||||
.. _`Raven`: http://raven.readthedocs.org
|
||||
.. _`Raven client documentation`: http://raven.readthedocs.org/en/latest/config/index.html#client-arguments
|
||||
'''
|
||||
|
||||
@ -23,7 +23,7 @@ Installation prerequisites
|
||||
|
||||
- You will need the 'docker-py' python package in your python installation
|
||||
running salt. The version of docker-py should support `version 1.6 of docker
|
||||
remote API. <https://docs.docker.io/en/latest/api/docker_remote_api_v1.6/>`_.
|
||||
remote API. <http://docs.docker.io/en/latest/reference/api/docker_remote_api_v1.6>`_.
|
||||
- For now, you need docker-py from sources:
|
||||
|
||||
https://github.com/dotcloud/docker-py
|
||||
|
||||
@ -117,7 +117,7 @@ def run(*args, **kwargs):
|
||||
subcommand. Following positional arguments should be ordered with arguments
|
||||
required by the subcommand first, followed by non-keyvalue pair options.
|
||||
Tags are specified by a tag keyword and comma separated list of values. --
|
||||
http://projects.puppetlabs.com/projects/1/wiki/Using_Tags
|
||||
http://docs.puppetlabs.com/puppet/latest/reference/lang_tags.html
|
||||
|
||||
CLI Examples:
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ Useful documentation:
|
||||
|
||||
. http://downloads.xen.org/Wiki/XenAPI/xenapi-1.0.6.pdf
|
||||
. http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/api/
|
||||
. https://github.com/xen-org/xen-api/tree/master/scripts/examples/python
|
||||
. https://github.com/xapi-project/xen-api/tree/master/scripts/examples/python
|
||||
. http://xenbits.xen.org/gitweb/?p=xen.git;a=tree;f=tools/python/xen/xm;hb=HEAD
|
||||
'''
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ Pillar need something like::
|
||||
- saltversion
|
||||
- cpuarch
|
||||
|
||||
and http://pypi.python.org/pypi/raven installed
|
||||
and https://pypi.python.org/pypi/raven installed
|
||||
|
||||
The tags list (optional) specifies grains items that will be used as sentry tags, allowing tagging of events
|
||||
in the sentry ui.
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
Manage Docker containers
|
||||
========================
|
||||
|
||||
`Docker <https://docker.io>`_
|
||||
`Docker <https://www.docker.io>`_
|
||||
is a lightweight, portable, self-sufficient software container
|
||||
wrapper. The base supported wrapper type is
|
||||
`LXC <https://en.wikipedia.org/wiki/Linux_Containers>`_,
|
||||
@ -21,7 +21,7 @@ wrapper. The base supported wrapper type is
|
||||
This state module requires
|
||||
`docker-py <https://github.com/dotcloud/docker-py>`_
|
||||
which supports `Docker Remote API version 1.6
|
||||
<https://docs.docker.io/en/latest/api/docker_remote_api_v1.6/>`_.
|
||||
<http://docs.docker.io/en/latest/reference/api/docker_remote_api_v1.6>`_.
|
||||
|
||||
Available Functions
|
||||
-------------------
|
||||
@ -221,7 +221,7 @@ def pulled(name, force=False, *args, **kwargs):
|
||||
`docker push`,
|
||||
and `docker.import_image <https://github.com/dotcloud/docker-py#api>`_
|
||||
(`docker import
|
||||
<http://docs.docker.io/en/latest/commandline/cli/#import>`_).
|
||||
<http://docs.docker.io/en/latest/reference/commandline/cli/#import>`_).
|
||||
NOTE that We added saltack a way to identify yourself via pillar,
|
||||
see in the salt.modules.dockerio execution module how to ident yourself
|
||||
via the pillar.
|
||||
|
||||
@ -188,7 +188,7 @@ def installed(name,
|
||||
them to the ``pip`` library. It's functionality duplication and it's
|
||||
more error prone.
|
||||
|
||||
.. _`virtualenv`: http://www.virtualenv.org
|
||||
.. _`virtualenv`: http://www.virtualenv.org/en/latest/
|
||||
'''
|
||||
if pip_bin and not bin_env:
|
||||
bin_env = pip_bin
|
||||
|
||||
Loading…
Reference in New Issue
Block a user