kitchen-vcair 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +21 -0
- data/.rubocop.yml +14 -0
- data/CHANGELOG.md +16 -0
- data/Gemfile +6 -0
- data/LICENSE.txt +201 -0
- data/README.md +188 -0
- data/examples/VIDEOS.md +57 -0
- data/examples/windows_customization.bat +53 -0
- data/kitchen-vcair.gemspec +32 -0
- data/lib/kitchen/driver/vcair.rb +359 -0
- data/lib/kitchen/driver/vcair_version.rb +25 -0
- data/spec/spec_helper.rb +17 -0
- data/spec/vcair_spec.rb +825 -0
- metadata +167 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 795c6c4ab44475c53e864812dace3e69c6177437
|
4
|
+
data.tar.gz: 776badc46e81d8e63d8b641ddeb92b9e96083403
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 9fe2794583e98129127a580ed9534d2f39d1cd3b8fbac14f87216a56af918cafc5e0f615c3df85e45f062bab92d6838953bd28cb294e2ebc59065de7d6cdb9fe
|
7
|
+
data.tar.gz: 2bf503afddd35f11b00c875ff4eff1f423dd6dcdebe677352941182a50619405bc7fa211f8b90633c12983f23593c849abe91a427d1efe5a894627cfaa804edb
|
data/.gitignore
ADDED
data/.rubocop.yml
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
Metrics/AbcSize:
|
2
|
+
Max: 50
|
3
|
+
Metrics/ClassLength:
|
4
|
+
Max: 300
|
5
|
+
Metrics/LineLength:
|
6
|
+
Max: 130
|
7
|
+
Metrics/MethodLength:
|
8
|
+
Max: 25
|
9
|
+
Style/Documentation:
|
10
|
+
Enabled: false
|
11
|
+
Style/SignalException:
|
12
|
+
Enabled: false
|
13
|
+
Style/SpaceInsideBrackets:
|
14
|
+
Enabled: false
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# kitchen-vcair Changelog
|
2
|
+
|
3
|
+
## Release: 1.0.0 / 2015-08-21
|
4
|
+
* Initial public release
|
5
|
+
* Refactor by Chef Partner Engineering to match style of other VMware plugins
|
6
|
+
* Support for vCloud Air OnDemand
|
7
|
+
|
8
|
+
## Release: 0.1.1 / 2015-06-04
|
9
|
+
* Destroy working
|
10
|
+
* Password updates
|
11
|
+
* Documentation updates
|
12
|
+
* Cleanup and refactoring
|
13
|
+
|
14
|
+
## Release: 0.1.0 / 2015-05-xx
|
15
|
+
|
16
|
+
* Initial release by Vulk.
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,188 @@
|
|
1
|
+
# kitchen-vcair
|
2
|
+
|
3
|
+
A driver to allow Test Kitchen to consume vCloud Air resources to perform testing.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'kitchen-vcair'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install kitchen-vcair
|
20
|
+
|
21
|
+
Or even better, install it via ChefDK:
|
22
|
+
|
23
|
+
$ chef gem install kitchen-vcair
|
24
|
+
|
25
|
+
## Usage
|
26
|
+
|
27
|
+
After installing the gem as described above, edit your .kitchen.yml file to set the driver to 'vcair' and supply your login credentials:
|
28
|
+
|
29
|
+
```yaml
|
30
|
+
driver:
|
31
|
+
name: vcair
|
32
|
+
vcair_username: user@domain.com
|
33
|
+
vcair_password: MyS33kretPassword
|
34
|
+
vcair_api_host: some-host.vchs.vmware.com
|
35
|
+
vcair_org: M12345678-4321
|
36
|
+
```
|
37
|
+
|
38
|
+
Additionally, the following parameters are required:
|
39
|
+
|
40
|
+
* **vdc_id** or **vdc_name**: The ID or name of the vDC in which to create your vApp/VM.
|
41
|
+
* **catalog_id** or **catalog_name**: The ID or name of the catalog that contains your image/template.
|
42
|
+
* **image_id** or **image_name**: The ID or name of the image you wish to use to create your VM.
|
43
|
+
* **network_id** or **network_name**: The ID or name of the network to which to attach to your VM.
|
44
|
+
|
45
|
+
There are a number of optional parameters you can configure as well:
|
46
|
+
|
47
|
+
* **cpus**: The number of vCPUs to configure for your VM. Default: 1
|
48
|
+
* **memory**: The amount of RAM, in MB, to configure for your VM. Default: 1024
|
49
|
+
* **vcair_api_path**: The URI path for the compute API. This needs to be set when using vCloud Air OnDemand. Default: /api
|
50
|
+
* **vm_password**: The password to set via VM customization for the root/administrator user.
|
51
|
+
* Be sure to set the same password in your `transport` section, too!
|
52
|
+
* NOTE: see the *known issues* section below regarding Windows and passwords.
|
53
|
+
|
54
|
+
All of the above settings can be set globally (in the top-level `driver` section), or can be set individually for each platform. For example, you may wish to set your vDC and network globally, but set your catalog and image for each individual platform, and increase the vCPUs/RAM assigned to your windows node:
|
55
|
+
|
56
|
+
```yaml
|
57
|
+
driver:
|
58
|
+
name: vcair
|
59
|
+
vcair_username: user@domain.com
|
60
|
+
vcair_password: MyS33kretPassword
|
61
|
+
vcair_api_host: some-host.vchs.vmware.com
|
62
|
+
vcair_org: M12345678-4321
|
63
|
+
vdc_name: MyCompany VDC 1
|
64
|
+
network_name: vdc1-default-routed
|
65
|
+
|
66
|
+
platforms:
|
67
|
+
- name: centos
|
68
|
+
driver:
|
69
|
+
catalog_name: Public Catalog
|
70
|
+
image_name: CentOS64-64BIT
|
71
|
+
- name: windows
|
72
|
+
driver:
|
73
|
+
catalog_name: Public Catalog
|
74
|
+
image_name: W2K12-STD-R2-64BIT
|
75
|
+
cpus: 2
|
76
|
+
memory: 4096
|
77
|
+
```
|
78
|
+
|
79
|
+
### vCloud Air Subscription vs. OnDemand
|
80
|
+
|
81
|
+
kitchen-vcair works as-is with vCloud Air Subscription. In vCloud Air OnDemand,
|
82
|
+
the API path is different. To use this plugin with vCloud Air OnDemand, you
|
83
|
+
will need to set the `vcair_api_path` configuration parameter to `/api/compute/api`:
|
84
|
+
|
85
|
+
```yaml
|
86
|
+
driver:
|
87
|
+
vcair_api_path: /api/compute/api
|
88
|
+
```
|
89
|
+
|
90
|
+
Also, in our testing, we found many of the VMware-provided images are missing
|
91
|
+
core configurations, such as properly-configured DNS resolvers. We strongly
|
92
|
+
recommend building your own images off the VMware-provided images with proper
|
93
|
+
configurations.
|
94
|
+
|
95
|
+
## Known Issues and Workarounds
|
96
|
+
|
97
|
+
### SSH Authentication - passwords vs. public-key
|
98
|
+
|
99
|
+
vCloud Air does not natively support deploying SSH keys to new VMs like other
|
100
|
+
cloud providers. Therefore, many of the images in the vCloud Air public catalog
|
101
|
+
only support password authentication.
|
102
|
+
|
103
|
+
#### Setting your own password
|
104
|
+
|
105
|
+
Through VM customization, vCloud Air allows you to specify a password that should
|
106
|
+
be set for the root account. You can use the `vm_password` config parameter to
|
107
|
+
specify that password:
|
108
|
+
|
109
|
+
```yaml
|
110
|
+
driver:
|
111
|
+
vm_password: mysupersecretpassword
|
112
|
+
```
|
113
|
+
|
114
|
+
... and then tell the transport to use that same password:
|
115
|
+
|
116
|
+
```yaml
|
117
|
+
transport:
|
118
|
+
password: mysupersecretpassword
|
119
|
+
```
|
120
|
+
|
121
|
+
#### Using the pre-generated password by vCloud Air
|
122
|
+
|
123
|
+
**This is not supported.** Unfortunately, a bug in Fog prevents us from
|
124
|
+
retrieving that password, and a issue/PR will be logged to address this.
|
125
|
+
|
126
|
+
### WinRM Authentication
|
127
|
+
|
128
|
+
#### Setup
|
129
|
+
|
130
|
+
Many of the images in the vCloud Air public catalog do not have WinRM enabled.
|
131
|
+
You will need to provide a customization script to enable WinRM. An example
|
132
|
+
can be found in the `examples/` directory in this repo. Note that multiple
|
133
|
+
reboots are required for the VM to become ready for Test Kitchen to use, so
|
134
|
+
the time required for a Windows VM to be ready is fairly long.
|
135
|
+
|
136
|
+
A potential workaround to this would be to create your own VM with WinRM enabled
|
137
|
+
and configured properly and publish it in your own catalog.
|
138
|
+
|
139
|
+
#### Setting your own password
|
140
|
+
|
141
|
+
The same customization function that works for Linux does not appear to work for
|
142
|
+
Windows in vCloud Air. Additionally, Windows does not appear to honor the
|
143
|
+
customization setting that disables the forced password change on first login.
|
144
|
+
|
145
|
+
Therefore, a customization script will need to be used to set your Administrator
|
146
|
+
password. See the `examples/` directory for a sample customization script that
|
147
|
+
enables WinRM and sets the Administrator password.
|
148
|
+
|
149
|
+
### NAT and Public IP Support
|
150
|
+
|
151
|
+
Unlike other cloud providers, vCloud Air does not treat public IPs as objects
|
152
|
+
that can be associated with VMs. Instead, those IPs are associated with network
|
153
|
+
objects called "gateways" which then require NAT and firewall rules to be
|
154
|
+
created. The Fog library does not support the creation of those objects.
|
155
|
+
|
156
|
+
Therefore, only routed networks are supported, and it is required that Test
|
157
|
+
Kitchen be executed on a network within vCloud Air that has access to the
|
158
|
+
destination network on which your test VMs will be deployed.
|
159
|
+
|
160
|
+
## License and Authors
|
161
|
+
|
162
|
+
Author:: Chef Partner Engineering (<partnereng@chef.io>)
|
163
|
+
|
164
|
+
Copyright:: Copyright (c) 2015 Chef Software, Inc.
|
165
|
+
|
166
|
+
License:: Apache License, Version 2.0
|
167
|
+
|
168
|
+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
169
|
+
this file except in compliance with the License. You may obtain a copy of the License at
|
170
|
+
|
171
|
+
```
|
172
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
173
|
+
```
|
174
|
+
|
175
|
+
Unless required by applicable law or agreed to in writing, software distributed under the
|
176
|
+
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
177
|
+
either express or implied. See the License for the specific language governing permissions
|
178
|
+
and limitations under the License.
|
179
|
+
|
180
|
+
## Contributing
|
181
|
+
|
182
|
+
We'd love to hear from you if this doesn't perform in the manner you expect. Please log a GitHub issue, or even better, submit a Pull Request with a fix!
|
183
|
+
|
184
|
+
1. Fork it ( https://github.com/chef-partners/kitchen-vcair/fork )
|
185
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
186
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
187
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
188
|
+
5. Create a new Pull Request
|