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

Salt cloud doc updates, build errors and bug fixes

Browse source 
Refs #24309
This commit is contained in:
Jacob Hammons 2015-06-04 16:42:47 -06:00
parent cdffc02cfe
commit 1f7a13d6f9
11 changed files with 175 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/_themes/saltstack2/static/css/webhelp.min.css vendored
View file

@ -242,3 +242,8 @@ dl.function {
font-size: 14pt;
}
.intro-text {
font-size: 18pt;
line-height: 1.3;
font-weight: 300;
}

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

@ -76,6 +76,7 @@ $( document ).ready(function() {
$(function(){
$( '#sidebar-nav' ).slimScroll({
width: 'inherit',
size: '14px',
height: wheight
}).promise().done(function() {

5
doc/ref/modules/all/index.rst
View file

@ -44,6 +44,7 @@ Full list of builtin execution modules
bsd_shadow
btrfs
cassandra
cassandra_cql
chef
chocolatey
cloud
@ -55,6 +56,7 @@ Full list of builtin execution modules
cpan
cron
cyg
cytest
daemontools
darwin_sysctl
data
@ -118,6 +120,7 @@ Full list of builtin execution modules
influx
ini_manage
introspect
ipmi
ipset
iptables
jboss7
@ -155,6 +158,7 @@ Full list of builtin execution modules
mount
munin
mysql
nacl
nagios
netbsd_sysctl
netbsdservice
@ -255,6 +259,7 @@ Full list of builtin execution modules
sysmod
sysrc
system
system_profiler
systemd
test
test_virtual

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

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

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

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

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

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

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

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

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

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

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

@ -17,7 +17,6 @@ Full list of builtin pillar modules
django_orm
ec2_pillar
etcd_pillar
file_encode
file_tree
foreman
git_pillar

13
doc/topics/cloud/index.html Normal file
View file

@ -0,0 +1,13 @@
<row class="intro-row">
<div class="col-sm-4">
<div class="intro-text">Provision systems on cloud providers / hypervisors and immediately bring them under management.</div>
</div>
<div class="col-sm-8">
<div class="embed-responsive embed-responsive-4by3">
<iframe class="embed-responsive-item" src="https://www.youtube.com/embed/fs0UFjvWA_c"></iframe>
</div>
</div>
</row>

124
doc/topics/cloud/index.rst
View file

@ -4,19 +4,130 @@
Salt Cloud
==========
.. raw:: html
:file: index.html
Getting Started
===============
.. toctree::
:maxdepth: 3
Salt Cloud is built-in to Salt and is configured on and executed from your Salt Master.
Installing salt cloud <install/index>
Define a Profile
----------------
The first step is to add the credentials for your cloud provider. Credentials
and provider settings are stored in provider configuration files.
Provider configurations contain the details needed to connect, and any global options that you want set on
your cloud minions (such as the location of your Salt Master).
On your Salt Master, browse to ``/etc/salt/cloud.providers.d/`` and create a file called ``<provider>.provider.conf``,
replacing ``<provider>`` with ``ec2``, ``softlayer``, and so on. The name helps you identify the contents, and is not
important as long as the file ends in ``.conf``.
Next, browse to the :ref:`Provider specifics <cloud-provider-specifics>` and add any required settings for your
provider to this file. Here is an example for Amazon EC2:
.. code-block:: yaml
my-ec2:
provider: ec2
# Set the EC2 access credentials (see below)
#
id: 'HJGRYCILJLKJYG'
key: 'kdjgfsgm;woormgl/aserigjksjdhasdfgn'
# Make sure this key is owned by root with permissions 0400.
#
private_key: /etc/salt/my_test_key.pem
keyname: my_test_key
securitygroup: default
# Optional: Set up the location of the Salt Master
#
minion:
master: saltmaster.example.com
The required configuration varies between providers so make sure you read the provider specifics.
List Cloud Provider Options
---------------------------
You can now query the cloud provider you configured for available locations,
images, and sizes. This information is used when you set up VM profiles.
.. code-block:: bash
salt-cloud --list-locations <provider_name> # my-ec2 in the previous example
salt-cloud --list-images <provider_name>
salt-cloud --list-sizes <provider_name>
Replace ``<provider_name>`` with the name of the provider configuration you defined.
Create VM Profiles
------------------
On your Salt Master, browse to ``/etc/salt/cloud.profiles.d/`` and create a file called ``<provider>.profiles.conf``,
replacing ``<provider>`` with ``ec2``, ``softlayer``, and so on. The file must end in ``.conf``.
You can now add any custom profiles you'd like to define to this file. Here are a few examples:
.. code-block:: yaml
micro_ec2:
provider: my-ec2
image: ami-d514f291
size: t1.micro
medium_ec2:
provider: my-ec2
image: ami-d514f291
size: m3.medium
large_ec2:
provider: my-ec2
image: ami-d514f291
size: m3.large
Notice that the ``provider`` in our profile matches the provider name that we defined? That is how Salt Cloud
knows how to connect to create a VM with these attributes.
Create VMs
----------
VMs are created by calling ``salt-cloud`` with the following options:
.. code-block:: bash
salt-cloud -p <profile> <name1> <name2> ...
For example:
.. code-block:: bash
salt-cloud -p micro_ec2 minion1 minion2
Destroy VMs
-----------
Add a ``-d`` and the minion name you provided to destroy:
.. code-block:: bash
salt-cloud -d minion1 minion2
Query VMs
---------
You can view details about the VMs you've created using ``--query``:
.. code-block:: bash
salt-cloud --query
Using Salt Cloud
================
.. toctree::
:maxdepth: 3
Command Line Reference <../../ref/cli/salt-cloud>
Basic <basic>
Profiles <profiles>
Maps <map>
@ -25,9 +136,11 @@ Using Salt Cloud
Core Configuration
==================
.. toctree::
:maxdepth: 3
Installing salt cloud <install/index>
Core Configuration <config>
Windows Configuration
@ -61,8 +174,13 @@ Cloud Provider Specifics
Getting Started With SoftLayer <softlayer>
Getting Started With Vexxhost <vexxhost>
Miscellaneous Options
=====================
.. toctree::
:maxdepth: 3