ucloudstack 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/CHANGES.rdoc +68 -0
- data/LICENSE +202 -0
- data/README.rdoc +215 -0
- data/lib/chef/knife/cs_hosts.rb +83 -0
- data/lib/chef/knife/cs_network_list.rb +84 -0
- data/lib/chef/knife/cs_product_list.rb +70 -0
- data/lib/chef/knife/cs_server_create.rb +321 -0
- data/lib/chef/knife/cs_server_delete.rb +157 -0
- data/lib/chef/knife/cs_server_list.rb +92 -0
- data/lib/chef/knife/cs_server_reboot.rb +103 -0
- data/lib/chef/knife/cs_server_start.rb +103 -0
- data/lib/chef/knife/cs_server_stop.rb +114 -0
- data/lib/chef/knife/cs_service_list.rb +93 -0
- data/lib/chef/knife/cs_stack_create.rb +325 -0
- data/lib/chef/knife/cs_stack_delete.rb +88 -0
- data/lib/chef/knife/cs_template_list.rb +100 -0
- data/lib/chef/knife/cs_zone_list.rb +78 -0
- data/lib/knife-cloudstack/connection.rb +633 -0
- metadata +90 -0
data/CHANGES.rdoc
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
= Changes
|
2
|
+
|
3
|
+
== 2012-05-17 (0.0.12)
|
4
|
+
* Adding option to disable public IP allocation on server create
|
5
|
+
https://github.com/CloudStack/knife-cloudstack/pull/8
|
6
|
+
* Fix whitespace issue in network names
|
7
|
+
https://github.com/CloudStack/knife-cloudstack/pull/7
|
8
|
+
|
9
|
+
== 2011-11-03 (0.0.11)
|
10
|
+
* Added LICENSE file and licensing headers to source. No feature changes.
|
11
|
+
|
12
|
+
== 2011-10-13 (0.0.10)
|
13
|
+
* Support for multi-homed VMs: The --networks option for the <tt>server create</tt> command takes a comma-separated list
|
14
|
+
of network offering names. The created VM will have one nic per network, with nics assigned to networks in the order
|
15
|
+
specified (e.g. the first network in the list will be assigned to eth0, the second to eth1 and so on). The --networks
|
16
|
+
option replaces the --network option, which supported a single network name.
|
17
|
+
* The <tt>server list</tt> command now shows the VM 'displayname' in parentheses when the displayname is defined and is
|
18
|
+
different than the VM name.
|
19
|
+
* Public IP logic has been updated to support multi-homed VMs. It now uses the first nic attached to a network with the
|
20
|
+
'default' value set to true as the primary interface.
|
21
|
+
|
22
|
+
== 2011-08-30 (0.0.9)
|
23
|
+
* Added subcommands: <tt>server start</tt>, <tt>server stop</tt> and <tt>server reboot</tt>.
|
24
|
+
* Updated the <tt>hosts</tt> command to return short hostnames and FQDNs. Also added comments where needed so the output
|
25
|
+
can be directly pasted into /etc/hosts.
|
26
|
+
|
27
|
+
== 2011-08-06 (0.0.8)
|
28
|
+
* Changed cloudstack async command timeout from 60 to 300 seconds.
|
29
|
+
|
30
|
+
== 2011-07-21 (0.0.7)
|
31
|
+
* Fixed http_request actions in <tt>stack create</tt>.
|
32
|
+
|
33
|
+
== 2011-07-15 (0.0.6)
|
34
|
+
* The <tt>server delete</tt> command now deletes the chef node and client if their names match the fqdn of the server.
|
35
|
+
* Added the <tt>stack create</tt> and <tt>stack delete</tt> commands for bulk creation and deletion of servers using a
|
36
|
+
JSON definition file. These commands are still experimental and subject to change. See README.rdoc for details.
|
37
|
+
* Added a <tt>hosts</tt> command, which lists the public ip address and fqdn of all servers in /etc/hosts file format.
|
38
|
+
* Fixed nil reference bug in <tt>server list</tt> command.
|
39
|
+
|
40
|
+
== 2011-06-05 (0.0.5)
|
41
|
+
* Added <tt>--port-rules</tt> option to the <tt>cs server create</tt> command. It accepts a list of port forwarding
|
42
|
+
rules to be created for the server (only applies to servers on a virtual network). See 'Port forwarding rules for
|
43
|
+
virtual networks' in README.rdoc for details.
|
44
|
+
|
45
|
+
== 2011-06-01 (0.0.4)
|
46
|
+
* Fixed ssh detection bug.
|
47
|
+
|
48
|
+
== 2011-05-30 (0.0.3)
|
49
|
+
|
50
|
+
* Added support for virtual networks. A public IP address is allocated for each new server in a virtual network
|
51
|
+
and an ssh port forwarding rule is created. The IP is released when the server is destroyed as long as it doesn't
|
52
|
+
have forwarding rules for any servers other than the one being deleted.
|
53
|
+
* Default network is now detected automatically. If there is more than one network marked as 'default' for an
|
54
|
+
account, the first Direct network is preferred.
|
55
|
+
|
56
|
+
== 2011-05-22 (0.0.2)
|
57
|
+
|
58
|
+
* Added subcommands: <tt>service list</tt>, <tt>template list</tt>, <tt>network list</tt> and <tt>zone list</tt>.
|
59
|
+
* Removed -H (and --hostname) option from the <tt>cs server create</tt> command. The host name is now the first
|
60
|
+
argument to the command: <tt>knife cs server create myhostname</tt>. If a host name is not specified, CloudStack
|
61
|
+
will use an auto-generated name.
|
62
|
+
* Added --no-bootstrap option to the server create command. This prevents Chef from being installed on the new server.
|
63
|
+
* Fixed help banners (commands were shown as <tt>knife cloudstack ...</tt> instead of <tt>knife cs ...</tt>).
|
64
|
+
* Added README.rdoc.
|
65
|
+
|
66
|
+
== 2011-05-15 (0.0.1)
|
67
|
+
|
68
|
+
* Initial release
|
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.rdoc
ADDED
@@ -0,0 +1,215 @@
|
|
1
|
+
= knife-cloudstack
|
2
|
+
|
3
|
+
== DESCRIPTION:
|
4
|
+
|
5
|
+
This is the Edmunds Knife plugin for CloudStack. This plugin gives Knife the ability to create, bootstrap and manage
|
6
|
+
CloudStack instances.
|
7
|
+
|
8
|
+
== INSTALLATION:
|
9
|
+
This plugin is distributed as a Ruby Gem. To install it, run:
|
10
|
+
|
11
|
+
gem install knife-cloudstack
|
12
|
+
|
13
|
+
Depending on your system's configuration, you may need to run this command with root privileges.
|
14
|
+
|
15
|
+
== CONFIGURATION:
|
16
|
+
In order to communicate with the CloudStack API you will have to tell Knife about your CloudStack API Key, your Secret Key and the URL of the API endpoint.
|
17
|
+
The easiest way to accomplish this is to create some entries in your <tt>knife.rb</tt> file:
|
18
|
+
|
19
|
+
knife[:cloudstack_url] = "http://yourcloudstackserver.com:8080/client/api
|
20
|
+
knife[:cloudstack_api_key] = "Your CloudStack API Key"
|
21
|
+
knife[:cloudstack_secret_key] = "Your CloudStack Secret Key"
|
22
|
+
|
23
|
+
If your knife.rb file will be checked into a SCM system (ie readable by others) you may want to read the values from environment variables:
|
24
|
+
|
25
|
+
knife[:cloudstack_url] = "#{ENV['CLOUDSTACK_URL']}"
|
26
|
+
knife[:cloudstack_api_key] = "#{ENV['CLOUDSTACK_API_KEY']}"
|
27
|
+
knife[:cloudstack_secret_key] = "#{ENV['CLOUDSTACK_SECRET_KEY']}"
|
28
|
+
|
29
|
+
You also have the option of passing your CloudStack URL and API/Secret Keys into the individual knife subcommands using the <tt>-U</tt> (or <tt>--cloudstack-url</tt>),
|
30
|
+
<tt>-A</tt> (or <tt>--cloudstack-api-key </tt>) <tt>-K</tt> (or <tt>--cloudstack-secret-key</tt>) command options
|
31
|
+
# provision a new small RHEL 5.6 webserver
|
32
|
+
knife cs server create my-server -r 'role[webserver]' -S "small" -T "RHEL 5.6 Base" -A 'Your CloudStack API Key' -K "Your CloudStack Secret Key" --distro "rhel5-gems"
|
33
|
+
|
34
|
+
Additionally the following options may be set in your <tt>knife.rb</tt>:
|
35
|
+
|
36
|
+
* knife[:cloudstack_service]
|
37
|
+
* knife[:cloudstack_template]
|
38
|
+
* knife[:cloudstack_zone]
|
39
|
+
* knife[:distro]
|
40
|
+
* knife[:template_file]
|
41
|
+
|
42
|
+
|
43
|
+
== SUBCOMMANDS:
|
44
|
+
|
45
|
+
This plugin provides the following Knife subcommands. Specific command options can be found by invoking the subcommand with a <tt>--help</tt> flag
|
46
|
+
|
47
|
+
=== knife cs server create
|
48
|
+
|
49
|
+
Provisions a new server in CloudStack and then performs a Chef bootstrap (using the SSH protocol). The goal of the bootstrap is to get Chef installed on the target
|
50
|
+
system so it can run Chef Client with a Chef Server. The main assumption is a baseline OS installation exists (provided by the provisioning). It is primarily
|
51
|
+
intended for Chef Client systems that talk to a Chef server. By default the server is bootstrapped using the {ubuntu10.04-gems}[https://github.com/opscode/chef/bl
|
52
|
+
ob/master/chef/lib/chef/knife/bootstrap/ubuntu10.04-gems.erb] template. This can be overridden using the <tt>-d</tt> or <tt>--template-file</tt> command options.
|
53
|
+
|
54
|
+
By default, new servers are allocated a public IP address mapping to the CloudStack private IP address. If you do not want this behavior, pass the <tt>--no-public-ip</tt> option.
|
55
|
+
|
56
|
+
==== Port forwarding rules for virtual networks
|
57
|
+
The <tt>--port-rules</tt> option takes a comma separated list of port forwarding rules. These rules are created on the
|
58
|
+
virtual public ip address of the server. Note that this option only applies to servers using a virtual network; it is
|
59
|
+
ignored if the server's public ip address is on a direct attached network.
|
60
|
+
|
61
|
+
Port forwarding rules have the syntax <tt>PUBLIC_PORT[:PRIVATE_PORT[:PROTOCOL]]</tt>. <tt>PRIVATE_PORT</tt> and
|
62
|
+
<tt>PROTOCOL</tt> are optional. The default value of <tt>PRIVATE_PORT</tt> is <tt>PUBLIC_PORT</tt> and the default
|
63
|
+
<tt>PROTOCOL</tt> is 'TCP'.
|
64
|
+
For example, a rule to forward from public port 80 to private port 7000 would look like <tt>80:7000:TCP</tt>.
|
65
|
+
Since 'TCP' is the default protocol, the rule can be shortened to <tt>80:7000</tt>. A rule can even be shortened to a
|
66
|
+
single number when the public and private ports are the same. For example, a rule to forward from public port 25 to
|
67
|
+
private port 25 can be stated as simply <tt>25</tt>. A list of such rules for a webserver might look like
|
68
|
+
<tt>80,443</tt>.
|
69
|
+
|
70
|
+
=== knife cs server delete
|
71
|
+
|
72
|
+
Deletes an existing server in the currently configured CloudStack account. <b>PLEASE NOTE</b> - this does not delete
|
73
|
+
the associated node and client objects from the Chef server.
|
74
|
+
|
75
|
+
=== knife cs server list
|
76
|
+
|
77
|
+
Displays a list of all servers in the currently configured CloudStack account. <b>PLEASE NOTE</b> - this shows all
|
78
|
+
servers associated with the cloudstack account including servers that are not registered with a Chef server.
|
79
|
+
|
80
|
+
=== knife cs network list
|
81
|
+
Displays a list of all networks available in the currently configured CloudStack account. A network can be specified
|
82
|
+
when creating a new server by passing the network name as an argument to the -W (or --network) option of the
|
83
|
+
<tt>knife cs server create</tt> command.
|
84
|
+
|
85
|
+
=== knife cs service list
|
86
|
+
Displays a list of all service offerings available in the currently configured CloudStack account. A service offering
|
87
|
+
can be specified when creating a new server by passing the name as an argument to the -S (or --service) option of the
|
88
|
+
<tt>knife cs server create</tt> command.
|
89
|
+
|
90
|
+
=== knife cs template list
|
91
|
+
Displays a list of all templates in the currently configured CloudStack account. Featured templates are displayed by default.
|
92
|
+
Use the -F (or --filter) option to use a different filter. The allowable filter values are:
|
93
|
+
|
94
|
+
* featured - templates that are featured and are public (this is the default)
|
95
|
+
* self - templates that have been registered/created by the owner
|
96
|
+
* self-executable - templates that have been registered/created by the owner that can be used to deploy a new VM
|
97
|
+
* executable - all templates that can be used to deploy a new VM
|
98
|
+
* community - templates that are public
|
99
|
+
|
100
|
+
A template can be specified when creating a new server by passing the template name as an argument to the -T
|
101
|
+
(or --template) option of the <tt>knife cs server create</tt> command.
|
102
|
+
|
103
|
+
=== knife cs zone list
|
104
|
+
Displays a list of all zones available in the currently configured CloudStack account. A zone can be specified
|
105
|
+
when creating a new server by passing the zone name as an argument to the -Z (or --zone) option of the
|
106
|
+
<tt>knife cs server create</tt> command.
|
107
|
+
|
108
|
+
=== knife cs hosts
|
109
|
+
Convenience command that displays the public ip address and fqdn for all servers. Matches /etc/hosts file format.
|
110
|
+
|
111
|
+
=== knife cs stack create
|
112
|
+
Creates a "stack" of servers based on a JSON definition file. Simple orchestration can be performed by
|
113
|
+
specifying one or more actions to be executed after a server (or group of servers) is created.
|
114
|
+
|
115
|
+
==== Example Stack Definition File:
|
116
|
+
<tt>
|
117
|
+
{
|
118
|
+
"name": "hadoop_cluster_a",
|
119
|
+
"description": "A small hadoop cluster with hbase",
|
120
|
+
"version": "1.0",
|
121
|
+
"environment": "production",
|
122
|
+
"servers": [
|
123
|
+
{
|
124
|
+
"name": "zookeeper-a, zookeeper-b, zookeeper-c",
|
125
|
+
"description": "Zookeeper nodes",
|
126
|
+
"template": "rhel-5.6-base",
|
127
|
+
"service": "small",
|
128
|
+
"port_rules": "2181",
|
129
|
+
"run_list": "role[cluster_a], role[zookeeper_server]",
|
130
|
+
"actions": [
|
131
|
+
{ "knife_ssh": ["role:zookeeper_server", "sudo chef-client"] }
|
132
|
+
]
|
133
|
+
},
|
134
|
+
{
|
135
|
+
"name": "hadoop-master",
|
136
|
+
"description": "Hadoop master node",
|
137
|
+
"template": "rhel-5.6-base",
|
138
|
+
"service": "large",
|
139
|
+
"networks": "app-net, storage-net",
|
140
|
+
"port_rules": "50070, 50030, 60010",
|
141
|
+
"run_list": "role[cluster_a], role[hadoop_master], role[hbase_master]"
|
142
|
+
},
|
143
|
+
{
|
144
|
+
"name": "hadoop-worker-a hadoop-worker-b hadoop-worker-c",
|
145
|
+
"description": "Hadoop worker nodes",
|
146
|
+
"template": "rhel-5.6-base",
|
147
|
+
"service": "medium",
|
148
|
+
"port_rules": "50075, 50060, 60030",
|
149
|
+
"run_list": "role[cluster_a], role[hadoop_worker], role[hbase_regionserver]",
|
150
|
+
"actions": [
|
151
|
+
{ "knife_ssh": ["role:hadoop_master", "sudo chef-client"] },
|
152
|
+
{ "http_request": "http://${hadoop-master}:50070/index.jsp" }
|
153
|
+
]
|
154
|
+
}
|
155
|
+
}
|
156
|
+
</tt>
|
157
|
+
|
158
|
+
==== Stack Attributes
|
159
|
+
name:: Stack name. May be used in the future to e.g. look up a stack in a databag.
|
160
|
+
version:: Stack version. This attribute is not currently used.
|
161
|
+
environment:: Chef environment used for all servers in the stack.
|
162
|
+
servers:: List of servers to create.
|
163
|
+
|
164
|
+
==== Server Attributes
|
165
|
+
name:: The name of the new server. Specify a list of names separated by commas and/or spaces to create multiple servers.
|
166
|
+
description:: Server description.
|
167
|
+
template:: Cloudstack template name.
|
168
|
+
service:: Cloudstack service offering name.
|
169
|
+
port_rules:: Port forwarding rules for virtual networks. These are ignored when using direct or other network types.
|
170
|
+
run_list:: Chef run list.
|
171
|
+
actions:: List of actions to perform after the server (or group of servers) is created.
|
172
|
+
|
173
|
+
==== Actions
|
174
|
+
knife-ssh:: Performs a knife-ssh command. Takes the search query and the command to execute as an array of arguments.
|
175
|
+
http_request:: Performs an http request. Supports references to server names in the stack with ${server_name}.
|
176
|
+
|
177
|
+
==== Upcoming Actions
|
178
|
+
The following actions are under development:
|
179
|
+
|
180
|
+
runlist_add:: Adds an entry from the run list.
|
181
|
+
runlist_remove:: Removes an entry from the run list.
|
182
|
+
|
183
|
+
=== knife cs stack delete
|
184
|
+
Deletes all servers in the specified stack definition.
|
185
|
+
|
186
|
+
=== knife cs server start
|
187
|
+
Starts the specified virtual machine(s).
|
188
|
+
|
189
|
+
=== knife cs server stop
|
190
|
+
Stops the specified virtual machine(s). Force stop is optional.
|
191
|
+
|
192
|
+
=== knife cs server reboot
|
193
|
+
Reboots the specified virtual machines(s).
|
194
|
+
|
195
|
+
== LICENSE:
|
196
|
+
|
197
|
+
Author:: Ryan Holmes <rholmes@edmunds.com>
|
198
|
+
Author:: KC Braunschweig <kbraunschweig@edmunds.com>
|
199
|
+
Author:: John E. Vincent <lusis.org+github.com@gmail.com>
|
200
|
+
|
201
|
+
Copyright:: Copyright (c) 2011 Edmunds, Inc.
|
202
|
+
License:: Apache License, Version 2.0
|
203
|
+
|
204
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
205
|
+
you may not use this file except in compliance with the License.
|
206
|
+
You may obtain a copy of the License at
|
207
|
+
|
208
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
209
|
+
|
210
|
+
Unless required by applicable law or agreed to in writing, software
|
211
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
212
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
213
|
+
See the License for the specific language governing permissions and
|
214
|
+
limitations under the License.
|
215
|
+
|
@@ -0,0 +1,83 @@
|
|
1
|
+
#
|
2
|
+
# Author:: Ryan Holmes (<rholmes@edmunds.com>)
|
3
|
+
# Author:: KC Braunschweig (<kbraunschweig@edmunds.com>)
|
4
|
+
# Copyright:: Copyright (c) 2011 Edmunds, Inc.
|
5
|
+
# License:: Apache License, Version 2.0
|
6
|
+
#
|
7
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
16
|
+
# See the License for the specific language governing permissions and
|
17
|
+
# limitations under the License.
|
18
|
+
#
|
19
|
+
|
20
|
+
require 'chef/knife'
|
21
|
+
|
22
|
+
module KnifeCloudstack
|
23
|
+
class CsHosts < Chef::Knife
|
24
|
+
|
25
|
+
MEGABYTES = 1024 * 1024
|
26
|
+
|
27
|
+
deps do
|
28
|
+
require 'knife-cloudstack/connection'
|
29
|
+
end
|
30
|
+
|
31
|
+
banner "knife cs hosts"
|
32
|
+
|
33
|
+
option :cloudstack_url,
|
34
|
+
:short => "-U URL",
|
35
|
+
:long => "--cloudstack-url URL",
|
36
|
+
:description => "The CloudStack endpoint URL",
|
37
|
+
:proc => Proc.new { |url| Chef::Config[:knife][:cloudstack_url] = url }
|
38
|
+
|
39
|
+
option :cloudstack_api_key,
|
40
|
+
:short => "-A KEY",
|
41
|
+
:long => "--cloudstack-api-key KEY",
|
42
|
+
:description => "Your CloudStack API key",
|
43
|
+
:proc => Proc.new { |key| Chef::Config[:knife][:cloudstack_api_key] = key }
|
44
|
+
|
45
|
+
option :cloudstack_secret_key,
|
46
|
+
:short => "-K SECRET",
|
47
|
+
:long => "--cloudstack-secret-key SECRET",
|
48
|
+
:description => "Your CloudStack secret key",
|
49
|
+
:proc => Proc.new { |key| Chef::Config[:knife][:cloudstack_secret_key] = key }
|
50
|
+
|
51
|
+
def run
|
52
|
+
|
53
|
+
connection = CloudstackClient::Connection.new(
|
54
|
+
locate_config_value(:cloudstack_url),
|
55
|
+
locate_config_value(:cloudstack_api_key),
|
56
|
+
locate_config_value(:cloudstack_secret_key)
|
57
|
+
)
|
58
|
+
|
59
|
+
host_list = [
|
60
|
+
ui.color('#Public IP', :bold),
|
61
|
+
ui.color('Host', :bold),
|
62
|
+
ui.color('FQDN', :bold)
|
63
|
+
]
|
64
|
+
|
65
|
+
servers = connection.list_servers
|
66
|
+
pf_rules = connection.list_port_forwarding_rules
|
67
|
+
servers.each do |s|
|
68
|
+
host_list << (connection.get_server_public_ip(s, pf_rules) || '#')
|
69
|
+
host_list << (s['name'] || '')
|
70
|
+
host_list << (connection.get_server_fqdn(s) || '')
|
71
|
+
end
|
72
|
+
puts ui.list(host_list, :columns_across, 3)
|
73
|
+
|
74
|
+
end
|
75
|
+
|
76
|
+
|
77
|
+
def locate_config_value(key)
|
78
|
+
key = key.to_sym
|
79
|
+
Chef::Config[:knife][key] || config[key]
|
80
|
+
end
|
81
|
+
|
82
|
+
end
|
83
|
+
end
|
@@ -0,0 +1,84 @@
|
|
1
|
+
#
|
2
|
+
# Author:: Ryan Holmes (<rholmes@edmunds.com>)
|
3
|
+
# Copyright:: Copyright (c) 2011 Edmunds, Inc.
|
4
|
+
# License:: Apache License, Version 2.0
|
5
|
+
#
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
15
|
+
# See the License for the specific language governing permissions and
|
16
|
+
# limitations under the License.
|
17
|
+
#
|
18
|
+
|
19
|
+
require 'chef/knife'
|
20
|
+
|
21
|
+
module KnifeCloudstack
|
22
|
+
class CsNetworkList < Chef::Knife
|
23
|
+
|
24
|
+
deps do
|
25
|
+
require 'knife-cloudstack/connection'
|
26
|
+
end
|
27
|
+
|
28
|
+
banner "knife cs network list (options)"
|
29
|
+
|
30
|
+
option :cloudstack_url,
|
31
|
+
:short => "-U URL",
|
32
|
+
:long => "--cloudstack-url URL",
|
33
|
+
:description => "The CloudStack endpoint URL",
|
34
|
+
:proc => Proc.new { |url| Chef::Config[:knife][:cloudstack_url] = url }
|
35
|
+
|
36
|
+
option :cloudstack_api_key,
|
37
|
+
:short => "-A KEY",
|
38
|
+
:long => "--cloudstack-api-key KEY",
|
39
|
+
:description => "Your CloudStack API key",
|
40
|
+
:proc => Proc.new { |key| Chef::Config[:knife][:cloudstack_api_key] = key }
|
41
|
+
|
42
|
+
option :cloudstack_secret_key,
|
43
|
+
:short => "-K SECRET",
|
44
|
+
:long => "--cloudstack-secret-key SECRET",
|
45
|
+
:description => "Your CloudStack secret key",
|
46
|
+
:proc => Proc.new { |key| Chef::Config[:knife][:cloudstack_secret_key] = key }
|
47
|
+
|
48
|
+
def run
|
49
|
+
|
50
|
+
connection = CloudstackClient::Connection.new(
|
51
|
+
locate_config_value(:cloudstack_url),
|
52
|
+
locate_config_value(:cloudstack_api_key),
|
53
|
+
locate_config_value(:cloudstack_secret_key)
|
54
|
+
)
|
55
|
+
|
56
|
+
network_list = [
|
57
|
+
ui.color('Name', :bold),
|
58
|
+
ui.color('Type', :bold),
|
59
|
+
ui.color('Default', :bold),
|
60
|
+
ui.color('Shared', :bold),
|
61
|
+
ui.color('Gateway', :bold),
|
62
|
+
ui.color('Netmask', :bold)
|
63
|
+
]
|
64
|
+
|
65
|
+
networks = connection.list_networks
|
66
|
+
networks.each do |n|
|
67
|
+
network_list << n['name']
|
68
|
+
network_list << n['type']
|
69
|
+
network_list << n['isdefault'].to_s
|
70
|
+
network_list << n['isshared'].to_s
|
71
|
+
network_list << (n['gateway'] || '')
|
72
|
+
network_list << (n['netmask'] || '')
|
73
|
+
end
|
74
|
+
puts ui.list(network_list, :columns_across, 6)
|
75
|
+
|
76
|
+
end
|
77
|
+
|
78
|
+
def locate_config_value(key)
|
79
|
+
key = key.to_sym
|
80
|
+
Chef::Config[:knife][key] || config[key]
|
81
|
+
end
|
82
|
+
|
83
|
+
end
|
84
|
+
end
|