mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
Merge pull request #8360 from whiteinge/salt-cloud-docs-merge
Salt cloud docs merge
This commit is contained in:
Thomas S Hatch
commit
db5340e502
39 changed files with 71 additions and 4820 deletions
|
|
@ -228,6 +228,7 @@ man_pages = [
|
|||
('ref/cli/salt-syndic', 'salt-syndic', 'salt-syndic Documentation', authors, 1),
|
||||
('ref/cli/salt-run', 'salt-run', 'salt-run Documentation', authors, 1),
|
||||
('ref/cli/salt-ssh', 'salt-ssh', 'salt-ssh Documentation', authors, 1),
|
||||
('ref/cli/salt-cloud', 'salt-cloud', 'Salt Cloud Command', authors, 1),
|
||||
]
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -25,6 +25,7 @@ Full Table of Contents
|
|||
topics/projects/index
|
||||
topics/event/index
|
||||
topics/mine/*
|
||||
topics/cloud/index
|
||||
topics/virt/*
|
||||
topics/ssh/*
|
||||
topics/tests/*
|
||||
|
|
@ -75,5 +76,6 @@ Full Table of Contents
|
|||
ref/cli/salt-run
|
||||
ref/cli/salt-ssh
|
||||
ref/cli/salt-syndic
|
||||
ref/cli/salt-cloud
|
||||
|
||||
topics/releases/index
|
||||
|
|
|
|||
|
|
@ -174,6 +174,10 @@ Miscellaneous topics
|
|||
|
||||
Salt is many splendid things.
|
||||
|
||||
:doc:`Salt Cloud <topics/cloud/index>`
|
||||
Salt Cloud is a public cloud provisioning tool that integrates Salt with
|
||||
many cloud providers.
|
||||
|
||||
:doc:`File Server <ref/file_server/index>`
|
||||
Salt can easily and quickly transfer files (in fact, that's how Salt
|
||||
States work). Even under heavy load, files are chunked and served.
|
||||
|
|
|
|||
|
|
@ -352,7 +352,7 @@ its size to 100G by using the following configuration.
|
|||
|
||||
Tags can be set once an instance has been launched.
|
||||
|
||||
.. code.block:: yaml
|
||||
.. code-block:: yaml
|
||||
|
||||
my-ec2-config:
|
||||
tag:
|
||||
|
|
@ -428,33 +428,23 @@ are provided here as a reference for those who are interested, and contain no
|
|||
warranty (express or implied) from anyone affiliated with Salt Stack. Most of
|
||||
them have never been used, much less tested, by the Salt Stack team.
|
||||
|
||||
* `Arch Linux`__
|
||||
.. __: https://wiki.archlinux.org/index.php/Arch_Linux_AMIs_for_Amazon_Web_Services
|
||||
* `Arch Linux <https://wiki.archlinux.org/index.php/Arch_Linux_AMIs_for_Amazon_Web_Services>`_
|
||||
|
||||
* `FreeBSD`__
|
||||
.. __: http://www.daemonology.net/freebsd-on-ec2/
|
||||
* `FreeBSD <http://www.daemonology.net/freebsd-on-ec2/>`_
|
||||
|
||||
* `Fedora`__
|
||||
.. __: https://fedoraproject.org/wiki/Cloud_images
|
||||
* `Fedora <https://fedoraproject.org/wiki/Cloud_images>`_
|
||||
|
||||
* `CentOS`__
|
||||
.. __: http://wiki.centos.org/Cloud/AWS
|
||||
* `CentOS <http://wiki.centos.org/Cloud/AWS>`_
|
||||
|
||||
* `Ubuntu`__
|
||||
.. __: http://cloud-images.ubuntu.com/locator/ec2/
|
||||
* `Ubuntu <http://cloud-images.ubuntu.com/locator/ec2/>`_
|
||||
|
||||
* `Debian`__
|
||||
.. __: http://wiki.debian.org/Cloud/AmazonEC2Image
|
||||
* `Debian <http://wiki.debian.org/Cloud/AmazonEC2Image>`_
|
||||
|
||||
* `Gentoo`__
|
||||
.. __: https://aws.amazon.com/amis?platform=Gentoo&selection=platform
|
||||
* `Gentoo <https://aws.amazon.com/amis?platform=Gentoo&selection=platform>`_
|
||||
|
||||
* `OmniOS`__
|
||||
.. __: http://omnios.omniti.com/wiki.php/Installation#IntheCloud
|
||||
|
||||
* `All Images on Amazon`__
|
||||
.. __: https://aws.amazon.com/amis
|
||||
* `OmniOS <http://omnios.omniti.com/wiki.php/Installation#IntheCloud>`_
|
||||
|
||||
* `All Images on Amazon <https://aws.amazon.com/amis>`_
|
||||
|
||||
show_image
|
||||
==========
|
||||
|
|
@ -1,10 +1,14 @@
|
|||
:orphan:
|
||||
|
||||
.. _contents:
|
||||
|
||||
Salt Cloud Documentation
|
||||
========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:glob:
|
||||
:hidden:
|
||||
|
||||
*
|
||||
install/index
|
||||
|
||||
Salt cloud is a public cloud provisioning tool. Salt cloud is made to integrate
|
||||
Salt into cloud providers in a clean way so that minions on public cloud
|
||||
systems can be quickly and easily modeled and provisioned.
|
||||
|
|
@ -23,15 +27,15 @@ cloud management platform and can be used to manage non Salt centric clouds.
|
|||
Getting Started
|
||||
===============
|
||||
|
||||
* :doc:`Installing salt cloud <topics/install/index>`
|
||||
* :doc:`Installing salt cloud <install/index>`
|
||||
|
||||
Some quick guides covering getting started with Amazon AWS, Rackspace, and
|
||||
Parallels.
|
||||
|
||||
* :doc:`Getting Started With AWS <topics/aws>`
|
||||
* :doc:`Getting Started With Rackspace <topics/rackspace>`
|
||||
* :doc:`Getting Started With Parallels <topics/parallels>`
|
||||
* :doc:`Getting Started With SoftLayer <topics/softlayer>`
|
||||
* :doc:`Getting Started With AWS <aws>`
|
||||
* :doc:`Getting Started With Rackspace <rackspace>`
|
||||
* :doc:`Getting Started With Parallels <parallels>`
|
||||
* :doc:`Getting Started With SoftLayer <softlayer>`
|
||||
|
||||
Core Configuration
|
||||
==================
|
||||
|
|
@ -40,7 +44,7 @@ The core configuration of Salt cloud is handled in the cloud configuration
|
|||
file. This file is comprised of global configurations for interfacing with
|
||||
cloud providers.
|
||||
|
||||
* :doc:`Core Configuration <topics/config>`
|
||||
* :doc:`Core Configuration <config>`
|
||||
|
||||
Windows Configuration
|
||||
=====================
|
||||
|
|
@ -49,7 +53,7 @@ Salt Cloud may be used to spin up a Windows minion, and then install the Salt
|
|||
Minion client on that instance. At this time, Salt Cloud itself still needs to
|
||||
be run from a Linux or Unix machine.
|
||||
|
||||
* :doc:`Windows Configuration <topics/windows>`
|
||||
* :doc:`Windows Configuration <windows>`
|
||||
|
||||
Using Salt Cloud
|
||||
================
|
||||
|
|
@ -58,23 +62,23 @@ Salt cloud works via profiles and maps. Simple profiles for cloud VMs are
|
|||
defined and can be used directly, or a map can be defined specifying
|
||||
a large group of virtual machines to create.
|
||||
|
||||
* :doc:`Profiles <topics/profiles>`
|
||||
* :doc:`Maps <topics/map>`
|
||||
* :doc:`Profiles <profiles>`
|
||||
* :doc:`Maps <map>`
|
||||
|
||||
Once a VM has been deployed, a number of actions may be available to perform
|
||||
on it, depending on the specific cloud provider.
|
||||
|
||||
* :doc:`Actions <topics/action>`
|
||||
* :doc:`Actions <action>`
|
||||
|
||||
Depending on your cloud provider, a number of functions may also be available
|
||||
which do not require a VM to be specified.
|
||||
|
||||
* :doc:`Functions <topics/function>`
|
||||
* :doc:`Functions <function>`
|
||||
|
||||
Miscellaneous Options
|
||||
=====================
|
||||
|
||||
* :doc:`Miscellaneous <topics/misc>`
|
||||
* :doc:`Miscellaneous <misc>`
|
||||
|
||||
Extending Salt Cloud
|
||||
====================
|
||||
|
|
@ -83,8 +87,8 @@ Salt cloud extensions work in a way similar to Salt modules. Therefore
|
|||
extending Salt cloud to manage more public cloud providers and operating
|
||||
systems is easy.
|
||||
|
||||
* :doc:`Adding Cloud Providers <topics/cloud>`
|
||||
* :doc:`Adding OS Support <topics/deploy>`
|
||||
* :doc:`Adding Cloud Providers <cloud>`
|
||||
* :doc:`Adding OS Support <deploy>`
|
||||
|
||||
Feature Comparison
|
||||
==================
|
||||
|
|
@ -92,16 +96,20 @@ Feature Comparison
|
|||
A table is available which compares various features available across all
|
||||
supported cloud providers.
|
||||
|
||||
* :doc:`Features <topics/features>`
|
||||
* :doc:`Features <features>`
|
||||
|
||||
Releases
|
||||
========
|
||||
Legacy Releases
|
||||
===============
|
||||
|
||||
* :doc:`Release Notes <topics/releases/index>`
|
||||
.. versionchanged:: Hydrogen
|
||||
Release notes will be part of Salt's main release notes starting with
|
||||
Salt's Hydrogen release.
|
||||
|
||||
* :doc:`Legacy Release Notes <releases/index>`
|
||||
|
||||
Reference
|
||||
=========
|
||||
|
||||
* :doc:`Command-line interface <ref/cli/salt-cloud>`
|
||||
* :doc:`Command-line interface </ref/cli/salt-cloud>`
|
||||
|
||||
* :doc:`Full table of contents </contents>`
|
||||
15
doc/topics/cloud/releases/index.rst
Normal file
15
doc/topics/cloud/releases/index.rst
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
:orphan:
|
||||
|
||||
===============================
|
||||
Legacy salt-cloud Release Notes
|
||||
===============================
|
||||
|
||||
.. versionchanged:: Hydrogen
|
||||
As of Salt's Hydrogen release salt-cloud is part of mainline Salt. Future
|
||||
salt-cloud release notes will be included in Salt's regular release notes.
|
||||
|
||||
.. releasestree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
*
|
||||
|
|
@ -340,7 +340,7 @@ The following actions are currently supported by the SoftLayer Salt Cloud
|
|||
driver.
|
||||
|
||||
show_instance
|
||||
-------------
|
||||
~~~~~~~~~~~~~
|
||||
This action is a thin wrapper around `--full-query`, which displays details on a
|
||||
single instance only. In an environment with several machines, this will save a
|
||||
user from having to sort through all instance data, just to examine a single
|
||||
|
|
@ -357,7 +357,7 @@ The following functions are currently supported by the SoftLayer Salt Cloud
|
|||
driver.
|
||||
|
||||
list_vlans
|
||||
----------
|
||||
~~~~~~~~~~
|
||||
This function lists all VLANs associated with the account, and all known data
|
||||
from the SoftLayer API concerning those VLANs.
|
||||
|
||||
|
|
@ -370,7 +370,7 @@ The `id` returned in this list is necessary for the `vlan` option when creating
|
|||
an instance.
|
||||
|
||||
list_custom_images
|
||||
------------------
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
This function lists any custom templates associated with the account, that can
|
||||
be used to create a new instance.
|
||||
|
||||
|
|
@ -15,19 +15,15 @@ own `smbclient` package, depending on the distribution. `winexe` is less
|
|||
commonly available in distribution-specific repositories. However, it is
|
||||
currently being built for various distributions in 3rd party channels:
|
||||
|
||||
* `RPMs at pbone.net`__
|
||||
.. __: http://rpm.pbone.net/index.php3?stat=3&search=winexe
|
||||
* `RPMs at pbone.net <http://rpm.pbone.net/index.php3?stat=3&search=winexe>`_
|
||||
|
||||
* `OpenSuse Build Service`__
|
||||
.. __: http://software.opensuse.org/package/winexe
|
||||
* `OpenSuse Build Service <http://software.opensuse.org/package/winexe>`_
|
||||
|
||||
Additionally, a copy of the Salt Minion Windows installer must be present on
|
||||
the system on which Salt Cloud is running. This installer may be downloaded
|
||||
from saltstack.com:
|
||||
|
||||
* `SaltStack Download Area`__
|
||||
.. __: http://saltstack.com/downloads/
|
||||
|
||||
* `SaltStack Download Area <http://saltstack.com/downloads/>`_
|
||||
|
||||
Firewall Settings
|
||||
=================
|
||||
|
|
@ -7,3 +7,5 @@ Release notes and upgrade instructions
|
|||
:glob:
|
||||
|
||||
*
|
||||
|
||||
.. seealso:: :doc:`Legacy salt-cloud release docs <../cloud/releases/index>`
|
||||
|
|
|
|||
|
|
@ -1,153 +0,0 @@
|
|||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = _build
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
|
||||
clean:
|
||||
-rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/salt-cloud.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/salt-cloud.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/salt-cloud"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/salt-cloud"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
|
@ -1,366 +0,0 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# salt-cloud documentation build configuration file, created by
|
||||
# sphinx-quickstart2 on Sat Jun 23 01:57:46 2012.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys, os
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
from sphinx.directives import TocTree
|
||||
|
||||
|
||||
class Mock(object):
|
||||
'''
|
||||
Mock out specified imports
|
||||
|
||||
This allows autodoc to do it's thing without having oodles of req'd
|
||||
installed libs. This doesn't work with ``import *`` imports.
|
||||
|
||||
http://read-the-docs.readthedocs.org/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
|
||||
'''
|
||||
def __init__(self, *args, **kwargs):
|
||||
pass
|
||||
|
||||
def __call__(self, *args, **kwargs):
|
||||
return Mock()
|
||||
|
||||
@classmethod
|
||||
def __getattr__(self, name):
|
||||
if name in ('__file__', '__path__'):
|
||||
return '/dev/null'
|
||||
elif name[0] == name[0].upper():
|
||||
return type(name, (), {})
|
||||
else:
|
||||
return Mock()
|
||||
|
||||
MOCK_MODULES = [
|
||||
'salt',
|
||||
'salt.client',
|
||||
'salt.config',
|
||||
'salt.crypt',
|
||||
'salt.exceptions',
|
||||
'salt.loader',
|
||||
'salt.utils',
|
||||
'salt.utils.event',
|
||||
'salt.utils.verify',
|
||||
'yaml',
|
||||
]
|
||||
|
||||
for mod_name in MOCK_MODULES:
|
||||
sys.modules[mod_name] = Mock()
|
||||
|
||||
docs_basepath = os.path.abspath(os.path.dirname(__file__))
|
||||
addtl_paths = (
|
||||
os.pardir, # saltcloud (for autodoc)
|
||||
'_ext', # custom Sphinx extensions
|
||||
)
|
||||
|
||||
for path in addtl_paths:
|
||||
sys.path.insert(0, os.path.abspath(os.path.join(docs_basepath, path)))
|
||||
|
||||
from saltcloud.version import __version__
|
||||
|
||||
# -- General configuration -----------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'salt-cloud'
|
||||
copyright = u'2012 - 2013, Salt Stack, Inc.'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = __version__
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = version
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = ['_build']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
|
||||
# -- Options for HTML output ---------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'default'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'salt-clouddoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output --------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||
latex_documents = [
|
||||
('index', 'salt-cloud.tex', u'salt-cloud Documentation',
|
||||
u'Thomas S Hatch', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output --------------------------------------------
|
||||
|
||||
### Manpage options
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
authors = [
|
||||
'Thomas S. Hatch <thatch@saltstack.com> and many others, please see the Authors file',
|
||||
]
|
||||
|
||||
man_pages = [
|
||||
('ref/cli/salt-cloud', 'salt-cloud', 'Salt Cloud Command', authors, 1),
|
||||
('contents', 'salt-cloud', 'Salt Cloud Documentation', authors, 7),
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output ------------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'salt-cloud', u'salt-cloud Documentation',
|
||||
u'Thomas S Hatch', 'salt-cloud', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
|
||||
# -- Options for Epub output ---------------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
epub_title = u'salt-cloud'
|
||||
epub_author = u'Thomas S Hatch'
|
||||
epub_publisher = u'Thomas S Hatch'
|
||||
epub_copyright = u'2012, Thomas S Hatch'
|
||||
|
||||
# The language of the text. It defaults to the language option
|
||||
# or en if the language is not set.
|
||||
#epub_language = ''
|
||||
|
||||
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||||
#epub_scheme = ''
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#epub_uid = ''
|
||||
|
||||
# A tuple containing the cover image and cover page html template filenames.
|
||||
#epub_cover = ()
|
||||
|
||||
# HTML files that should be inserted before the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_pre_files = []
|
||||
|
||||
# HTML files shat should be inserted after the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_post_files = []
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
#epub_exclude_files = []
|
||||
|
||||
# The depth of the table of contents in toc.ncx.
|
||||
#epub_tocdepth = 3
|
||||
|
||||
# Allow duplicate toc entries.
|
||||
#epub_tocdup = True
|
||||
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
intersphinx_mapping = {'http://docs.python.org/': None}
|
||||
|
||||
def _normalize_version(args):
|
||||
_, path = args
|
||||
return '.'.join([x.zfill(4) for x in (path.split('/')[-1].split('.'))])
|
||||
|
||||
|
||||
class ReleasesTree(TocTree):
|
||||
option_spec = dict(TocTree.option_spec)
|
||||
|
||||
def run(self):
|
||||
rst = super(ReleasesTree, self).run()
|
||||
entries = rst[0][0]['entries'][:]
|
||||
entries.sort(key=_normalize_version, reverse=True)
|
||||
rst[0][0]['entries'][:] = entries
|
||||
return rst
|
||||
|
||||
def setup(app):
|
||||
app.add_directive('releasestree', ReleasesTree)
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
============================
|
||||
Salt Cloud Table of Contents
|
||||
============================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:glob:
|
||||
|
||||
topics/profiles
|
||||
topics/map
|
||||
topics/cloud
|
||||
topics/deploy
|
||||
topics/config
|
||||
topics/action
|
||||
topics/function
|
||||
topics/misc
|
||||
|
||||
ref/cli/salt-cloud
|
||||
|
||||
topics/releases/index
|
||||
|
|
@ -1,218 +0,0 @@
|
|||
.TH "SALT-CLOUD" "1" "June 22, 2013" "0.8.9" "salt-cloud"
|
||||
.SH NAME
|
||||
salt-cloud \- Salt Cloud Command
|
||||
.
|
||||
.nr rst2man-indent-level 0
|
||||
.
|
||||
.de1 rstReportMargin
|
||||
\\$1 \\n[an-margin]
|
||||
level \\n[rst2man-indent-level]
|
||||
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
-
|
||||
\\n[rst2man-indent0]
|
||||
\\n[rst2man-indent1]
|
||||
\\n[rst2man-indent2]
|
||||
..
|
||||
.de1 INDENT
|
||||
.\" .rstReportMargin pre:
|
||||
. RS \\$1
|
||||
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
||||
. nr rst2man-indent-level +1
|
||||
.\" .rstReportMargin post:
|
||||
..
|
||||
.de UNINDENT
|
||||
. RE
|
||||
.\" indent \\n[an-margin]
|
||||
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.nr rst2man-indent-level -1
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.sp
|
||||
Provision virtual machines in the cloud with Salt
|
||||
.SH SYNOPSIS
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
salt\-cloud \-m /etc/salt/cloud.map
|
||||
|
||||
salt\-cloud \-p PROFILE NAME
|
||||
|
||||
salt\-cloud \-p PROFILE NAME1 NAME2 NAME3 NAME4 NAME5 NAME6
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH DESCRIPTION
|
||||
.sp
|
||||
Salt Cloud is the system used to provision virtual machines on various public
|
||||
clouds via a cleanly controlled profile and mapping system.
|
||||
.SH OPTIONS
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-h, \-\-help
|
||||
Print a usage message briefly summarizing these command\-line options.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-p PROFILE, \-\-profile=PROFILE
|
||||
Select a single profile to build the named cloud VMs from. The profile
|
||||
must be defined in the specified profiles file.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-m MAP, \-\-map=MAP
|
||||
Specify a map file to use. If used without any other options, this option
|
||||
will ensure that all of the mapped VMs are created. If the named VM
|
||||
already exists then it will be skipped.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-H, \-\-hard
|
||||
When specifying a map file, the default behavior is to ensure that all of
|
||||
the VMs specified in the map file are created. If the \-\-hard option is
|
||||
set, then any VMs that exist on configured cloud providers that are
|
||||
not specified in the map file will be destroyed. Be advised that this can
|
||||
be a destructive operation and should be used with care.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-d, \-\-destroy
|
||||
Pass in the name(s) of VMs to destroy, salt\-cloud will search the
|
||||
configured cloud providers for the specified names and destroy the
|
||||
VMs. Be advised that this is a destructive operation and should be used
|
||||
with care. Can be used in conjunction with the \-m option to specify a map
|
||||
of VMs to be deleted.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-P, \-\-parallel
|
||||
Normally when building many cloud VMs they are executed serially. The \-P
|
||||
option will run each cloud vm build in a separate process allowing for
|
||||
large groups of VMs to be build at once.
|
||||
.sp
|
||||
Be advised that some cloud provider\(aqs systems don\(aqt seem to be well suited
|
||||
for this influx of vm creation. When creating large groups of VMs watch the
|
||||
cloud provider carefully.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-Q, \-\-query
|
||||
Execute a query and print out information about all cloud VMs. Can be used
|
||||
in conjunction with \-m to display only information about the specified map.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-F, \-\-full\-query
|
||||
Execute a query and print out all available information about all cloud VMs.
|
||||
Can be used in conjunction with \-m to display only information about the
|
||||
specified map.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-S, \-\-select\-query
|
||||
Execute a query and print out selected information about all cloud VMs.
|
||||
Can be used in conjunction with \-m to display only information about the
|
||||
specified map.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-list\-images
|
||||
Display a list of images available in configured cloud providers.
|
||||
Pass the cloud provider that available images are desired on, aka
|
||||
"linode", or pass "all" to list images for all configured cloud providers.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-list\-sizes
|
||||
Display a list of sizes available in configured cloud providers. Pass the
|
||||
cloud provider that available sizes are desired on, aka "aws", or pass
|
||||
"all" to list sizes for all configured cloud providers
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-C CLOUD_CONFIG, \-\-cloud\-config=CLOUD_CONFIG
|
||||
Specify an alternative location for the salt cloud configuration file.
|
||||
Default location is /etc/salt/cloud.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-M MASTER_CONFIG, \-\-master\-config=MASTER_CONFIG
|
||||
Specify an alternative location for the salt master configuration file.
|
||||
The salt master configuration file is used to determine how to handle the
|
||||
minion RSA keys. Default location is /etc/salt/master.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-V VM_CONFIG, \-\-profiles=VM_CONFIG, \-\-vm_config=VM_CONFIG
|
||||
Specify an alternative location for the salt cloud profiles file.
|
||||
Default location is /etc/salt/cloud.profiles.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-raw\-out
|
||||
Print the output from the salt command in raw python
|
||||
form, this is suitable for re\-reading the output into
|
||||
an executing python script with eval.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-text\-out
|
||||
Print the output from the salt command in the same form the shell would.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-yaml\-out
|
||||
Print the output from the salt command in yaml.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-json\-out
|
||||
Print the output from the salt command in json.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-no\-color
|
||||
Disable all colored output.
|
||||
.UNINDENT
|
||||
.SH EXAMPLES
|
||||
.sp
|
||||
To create 4 VMs named web1, web2, db1 and db2 from specified profiles:
|
||||
.sp
|
||||
# salt\-cloud \-p fedora_rackspace web1 web2 db1 db2
|
||||
.sp
|
||||
To read in a map file and create all VMs specified therein:
|
||||
.sp
|
||||
# salt\-cloud \-m /path/to/cloud.map
|
||||
.sp
|
||||
To read in a map file and create all VMs specified therein in parallel:
|
||||
.sp
|
||||
# salt\-cloud \-m /path/to/cloud.map \-P
|
||||
.sp
|
||||
To delete any VMs specified in the map file:
|
||||
.sp
|
||||
# salt\-cloud \-m /path/to/cloud.map \-d
|
||||
.sp
|
||||
To delete any VMs NOT specified in the map file:
|
||||
.sp
|
||||
# salt\-cloud \-m /path/to/cloud.map \-H
|
||||
.sp
|
||||
To display the status of all VMs specified in the map file:
|
||||
.sp
|
||||
# salt\-cloud \-m /path/to/cloud.map \-Q
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIsalt\-cloud(7)\fP
|
||||
\fIsalt(7)\fP
|
||||
\fIsalt\-master(1)\fP
|
||||
\fIsalt\-minion(1)\fP
|
||||
.SH AUTHOR
|
||||
Thomas S. Hatch <thatch@saltstack.com> and many others, please see the Authors file
|
||||
.SH COPYRIGHT
|
||||
2012 - 2013, Salt Stack, Inc.
|
||||
.\" Generated by docutils manpage writer.
|
||||
.
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,9 +0,0 @@
|
|||
======================================
|
||||
Release notes and upgrade instructions
|
||||
======================================
|
||||
|
||||
.. releasestree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
*
|
||||
Loading…
Add table
Reference in a new issue