8000 Merge pull request #8766 from techhat/clouddocs · linuxme/salt@30597f1 · GitHub
[go: up one dir, main page]

Skip to content

Commit 30597f1

Browse files
committed
Merge pull request saltstack#8766 from techhat/clouddocs
Adding getting started guides for digital ocean, gogrid and joyent
2 parents f650e28 + d17cbc8 commit 30597f1

File tree

5 files changed

+322
-3
lines changed

5 files changed

+322
-3
lines changed

doc/topics/cloud/config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -497,9 +497,9 @@ the API Access tab.
497497
.. code-block:: yaml
498498
499499
my-digitalocean-config:
500+
provider: digital_ocean
500501
client_key: wFGEwgregeqw3435gDger
501502
api_key: GDE43t43REGTrkilg43934t34qT43t4dgegerGEgg
502-
provider: digital_ocean
503503
location: New York 1
504504
505505

doc/topics/cloud/digitalocean.rst

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
=================================
2+
Getting Started With Digtal Ocean
3+
=================================
4+
5+
Digital Ocean is a public cloud provider that specializes Linux instances.
6+
7+
8+
Dependencies
9+
============
10+
The Digital Ocean driver r 10000 equires no special dependencies outside of Salt.
11+
12+
13+
Configuration
14+
=============
15+
Using Salt for Digital Ocean requires a client_key and an api_key. These can be
16+
found in the Digital Ocean web interface, in the "My Settings" section, under
17+
the API Access tab.
18+
19+
.. code-block:: yaml
20+
21+
# Note: This example is for /etc/salt/cloud.providers or any file in the
22+
# /etc/salt/cloud.providers.d/ directory.
23+
24+
my-digitalocean-config:
25+
provider: digital_ocean
26+
client_key: wFGEwgregeqw3435gDger
27+
api_key: GDE43t43REGTrkilg43934t34qT43t4dgegerGEgg
28+
location: New York 1
29+
30+
31+
Profiles
32+
========
33+
34+
Cloud Profiles
35+
~~~~~~~~~~~~~~
36+
Set up an initial profile at ``/etc/salt/cloud.profiles`` or in the
37+
``/etc/salt/cloud.profiles.d/`` directory:
38+
39+
.. code-block:: yaml
40+
41+
digitalocean-ubuntu:
42+
provider: my-digitalocean-config
43+
image: Ubuntu 12.10 x64
44+
size: 512MB
45+
location: New York 1
46+
47+
Sizes can be obtained using the ``--list-sizes`` option for the ``salt-cloud``
48+
command:
49+
50+
.. code-block:: bash
51+
52+
# salt-cloud --list-sizes my-digitalocean-config
53+
my-digitalocean-config:
54+
----------
55+
digital_ocean:
56+
----------
57+
512MB:
58+
----------
59+
cost_per_hour:
60+
0.00744
61+
cost_per_month:
62+
5.0
63+
cpu:
64+
1
65+
disk:
66+
20
67+
id:
68+
66
69+
memory:
70+
512
71+
name:
72+
512MB
73+
slug:
74+
None
75+
...SNIP...
76+
77+
Images can be obtained using the ``--list-images`` option for the ``salt-cloud``
78+
command:
79+
80+
.. code-block:: bash
81+
82+
# salt-cloud --list-images my-digitalocean-config
83+
my-digitalocean-config:
84+
----------
85+
digital_ocean:
86+
----------
87+
Arch Linux 2013.05 x64:
88+
----------
89+
distribution:
90+
Arch Linux
91+
id:
92+
350424
93+
name:
94+
Arch Linux 2013.05 x64
95+
public:
96+
True
97+
slug:
98+
None
99+
...SNIP...

doc/topics/cloud/gogrid.rst

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
===========================
2+
Getting Started With GoGrid
3+
===========================
4+
5+
GoGrid is a public cloud provider supporting Linux and Windows.
6+
7+
8+
Dependencies
9+
============
10+
The GoGrid driver for Salt Cloud requires Libcloud 0.13.2 or higher to be
11+
installed.
12+
13+
14+
Configuration
15+
=============
16+
To use Salt Cloud with GoGrid log into the GoGrid web interface and create an
17+
API key. Do this by clicking on "My Account" and then going to the API Keys
18+
tab.
19+
20+
The ``apikey`` and the ``sharedsecret`` configuration parameters need to be set
21+
in the configuration file to enable interfacing with GoGrid:
22+
23+
.. code-block:: yaml
24+
25+
# Note: This example is for /etc/salt/cloud.providers or any file in the
26+
# /etc/salt/cloud.providers.d/ directory.
27+
28+
.. code-block:: yaml
29+
30+
my-gogrid-config:
31+
provider: gogrid
32+
apikey: asdff7896asdh789
33+
sharedsecret: saltybacon
34+
35+
36+
Profiles
37+
========
38+
39+
Cloud Profiles
40+
~~~~~~~~~~~~~~
41+
Set up an initial profile at ``/etc/salt/cloud.profiles`` or in the
42+
``/etc/salt/cloud.profiles.d/`` directory:
43+
44+
.. code-block:: yaml
45+
46+
gogrid_512:
47+
provider: my-gogrid-config
48+
size: 512MB
49+
image: CentOS 6.2 (64-bit) w/ None
50+
51+
Sizes can be obtained using the ``--list-sizes`` option for the ``salt-cloud``
52+
command:
53+
54+
.. code-block:: bash
55+
56+
# salt-cloud --list-sizes my-gogrid-config
57+
my-gogrid-config:
58+
----------
59+
gogrid:
60+
----------
61+
512MB:
62+
----------
63+
bandwidth:
64+
None
65+
disk:
66+
30
67+
driver:
68+
get_uuid:
69+
id:
70+
512MB
71+
name:
72+
512MB
73+
price:
74+
0.095
75+
ram:
76+
512
77+
uuid:
78+
bde1e4d7c3a643536e42a35142c7caac34b060e9
79+
...SNIP...
80+
81+
Images can be obtained using the ``--list-images`` option for the ``salt-cloud``
82+
command:
83+
84+
.. code-block:: bash
85+
86+
# salt-cloud --list-images my-gogrid-config
87+
my-gogrid-config:
88+
----------
89+
gogrid:
90+
----------
91+
CentOS 6.4 (64-bit) w/ None:
92+
----------
93+
driver:
94+
extra:
95+
----------
96+
get_uuid:
97+
id:
98+
18094
99+
name:
100+
CentOS 6.4 (64-bit) w/ None
101+
uuid:
102+
bfd4055389919e01aa6261828a96cf54c8dcc2c4
103+
...SNIP...

doc/topics/cloud/index.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,16 @@ Getting Started
2929

3030
* :doc:`Installing salt cloud <install/index>`
3131

32-
Some quick guides covering getting started with Amazon AWS, Google Compute
33-
Engine, Parallels, Rackspace, and Softlayer.
32+
Some quick guides covering getting started with Amazon EC2, Digital Ocean,
33+
GoGrid, Google Compute Engine, Linode, Joyent, Parallels, Rackspace, and
34+
SoftLayer.
3435

3536
* :doc:`Getting Started With AWS/EC2 <aws>`
37+
* :doc:`Getting Started With Digital Ocean <digitalocean>`
38+
* :doc:`Getting Started With GoGrid <gogrid>`
3639
* :doc:`Getting Started With Google Compute Engine <gce>`
3740
* :doc:`Getting Started With Linode <linode>`
41+
* :doc:`Getting Started With Joyent <joyent>`
3842
* :doc:`Getting Started With Parallels <parallels>`
3943
* :doc:`Getting Started With Rackspace <rackspace>`
4044
* :doc:`Getting Started With SoftLayer <softlayer>`

doc/topics/cloud/joyent.rst

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
===========================
2+
Getting Started With Joyent
3+
===========================
4+
5+
Joyent is a public cloud provider supporting SmartOS, Linux, FreeBSD and
6+
Windows.
7+
8+
9+
Dependencies
10+
============
11+
The Joyent driver for Salt Cloud requires Libcloud 0.13.2 or higher to be
12+
installed.
13+
14+
15+
Configuration
16+
=============
17+
The Joyent cloud requires three configuration parameters. The user name and
18+
password that are used to log into the Joyent system, and the location of the
19+
private ssh key associated with the Joyent account. The ssh key is needed to
20+
send the provisioning commands up to the freshly created virtual machine.
21+
22+
.. code-block:: yaml
23+
24+
# Note: This example is for /etc/salt/cloud.providers or any file in the
25+
# /etc/salt/cloud.providers.d/ directory.
26+
27+
.. code-block:: yaml
28+
29+
my-joyent-config:
30+
provider: joyent
31+
user: fred
32+
password: saltybacon
33+
private_key: /root/joyent.pem
34+
35+
36+
Profiles
37+
========
38+
39+
Cloud Profiles
40+
~~~~~~~~~~~~~~
41+
Set up an initial profile at ``/etc/salt/cloud.profiles`` or in the
42+
``/etc/salt/cloud.profiles.d/`` directory:
43+
44+
.. code-block:: yaml
45+
46+
joyent_512
47+
provider: my-joyent-config
48+
size: Extra Small 512 MB
49+
image: Arch Linux 2013.06
50+
51+
Sizes can be obtained using the ``--list-sizes`` option for the ``salt-cloud``
52+
command:
53+
54+
.. code-block:: bash
55+
56+
# salt-cloud --list-sizes my-joyent-config
57+
my-joyent-config:
58+
----------
59+
joyent:
60+
----------
61+
Extra Small 512 MB:
62+
----------
63+
default:
64+
false
65+
disk:
66+
15360
67+
id:
68+
Extra Small 512 MB
69+
memory:
70+
512
71+
name:
72+
Extra Small 512 MB
73+
swap:
74+
1024
75+
vcpus:
76+
1
77+
...SNIP...
78+
79+
Images can be obtained using the ``--list-images`` option for the ``salt-cloud``
80+
command:
81+
82+
.. code-block:: bash
83+
84+
# salt-cloud --list-images my-joyent-config
85+
my-joyent-config:
86+
----------
87+
joyent:
88+
----------
89+
base:
90+
----------
91+
description:
92+
A 32-bit SmartOS image with just essential packages
93+
installed. Ideal for users who are comfortable with setting
94+
up their own environment and tools.
95+
disabled:
96+
False
97+
files:
98+
----------
99+
- compression:
100+
bzip2
101+
- sha1:
102+
40cdc6457c237cf6306103c74b5f45f5bf2d9bbe
103+
- size:
104+
82492182
105+
name:
106+
base
107+
os:
108+
smartos
109+
owner:
110+
352971aa-31ba-496c-9ade-a379feaecd52
111+
public:
112+
True
113+
...SNIP...

0 commit comments

Comments
 (0)
0