vmware-vra 1.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 4c44d1d09f07fe9362fd1ee9525a39a128612e60
4
+ data.tar.gz: 6d006f1b9ca2462fd5610ac5a7c2ab2499d65ffd
5
+ SHA512:
6
+ metadata.gz: 91503ac793261088fbf81b35397d4862bdf3fc2ff07e6faecbf53a9bfd534e7d45f87b17412c0f30d6758828cb1a1dd5ef58ed75c371b35edb7c4ade8e270e6f
7
+ data.tar.gz: 2baebf8a4899ebd3d916f3ee2ebbc0eb0bd7e5932760f5fb34c59a304c1e616ca3945e0e4f2f2c65d682b833df9838b542b51cd6df3ca98e40ee50a94778d31d
data/.gitignore ADDED
@@ -0,0 +1,15 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /examples/
8
+ /pkg/
9
+ /spec/reports/
10
+ /tmp/
11
+ *.bundle
12
+ *.so
13
+ *.o
14
+ *.a
15
+ mkmf.log
data/.rubocop.yml ADDED
@@ -0,0 +1,14 @@
1
+ Metrics/AbcSize:
2
+ Max: 30
3
+ Metrics/LineLength:
4
+ Max: 150
5
+ Metrics/MethodLength:
6
+ Max: 30
7
+ Style/Documentation:
8
+ Enabled: false
9
+ Style/SignalException:
10
+ Enabled: false
11
+ Style/SpaceAroundEqualsInParameterDefault:
12
+ EnforcedStyle: no_space
13
+ Style/SpaceInsideBrackets:
14
+ Enabled: false
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in vmware-vra-gem.gemspec
4
+ gemspec
data/LICENSE.txt 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 2015 Chef Software, Inc.
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.md ADDED
@@ -0,0 +1,199 @@
1
+ # VMware vRA Gem
2
+
3
+ Client gem for interacting with VMware's vRealize Automation application.
4
+
5
+ Not all vRA functionality is included in this gem; only API calls necessary
6
+ to interact with the catalog, requests, and existing items is included.
7
+
8
+ The primary goal of this gem is to provide a reusable set of methods in order
9
+ to create Chef plugins for knife, test-kitchen, and provisioning.
10
+
11
+ ## Installation
12
+
13
+ Add this line to your application's Gemfile:
14
+
15
+ ```ruby
16
+ gem 'vmware-vra'
17
+ ```
18
+
19
+ And then execute:
20
+
21
+ $ bundle
22
+
23
+ Or install it yourself as:
24
+
25
+ $ gem install vmware-vra
26
+
27
+ ## Usage
28
+
29
+ First, load in the gem.
30
+
31
+ ```
32
+ require 'vra'
33
+ => true
34
+ ```
35
+
36
+ Then, set up your client object. You will need to know your tenant ID from your vRA administrator.
37
+
38
+ ```
39
+ vra = Vra::Client.new(username: 'devmgr@corp.local', password: 'mypassword', tenant: 'mytenant', base_url: 'https://vra.corp.local', verify_ssl: true)
40
+ => #<Vra::Client:0x000000034c0df8 ... >
41
+ ```
42
+
43
+ To list all items in the catalog:
44
+
45
+ ```
46
+ vra.catalog.all_items
47
+ => [{"@type"=>"CatalogItem", "id"=>"a9cd6148-6e0b-4a80-ac47-f5255c52b43d", "version"=>2, "name"=>"CentOS 6.6", "description"=>"Blueprint for deploying a CentOS Linux development server", ... }]
48
+ ```
49
+
50
+ To only list the items in the catalog for which you are entitled to request:
51
+
52
+ ```
53
+ vra.catalog.entitled_items
54
+ => [{"@type"=>"ConsumerEntitledCatalogItem", "catalogItem"=>{"id"=>"d29efd6b-3cd6-4f8d-b1d8-da4ddd4e52b1", "version"=>2, "name"=>"WindowsServer2012", "description"=>"Windows Server 2012", ... }]
55
+ ```
56
+
57
+ When you are ready to request an item from the catalog, create a new catalog request object:
58
+
59
+ ```
60
+ catalog_request = vra.catalog.request('a9cd6148-6e0b-4a80-ac47-f5255c52b43d', cpus: 1, memory: 512, requested_for: 'devmgr@corp.local', lease_days: 30)
61
+ => #<Vra::CatalogRequest:0x00000003477c20 ... >
62
+ ```
63
+
64
+ vRA requires your sub-tenant (a.k.a. "business group") to be specified when requesting an item from the catalog. If the catalog item you are requesting is specifically created for a given business group, the gem will use that ID automatically without you needing to specify it.
65
+
66
+ However, if there is no sub-tenant ID available for us to use, you will receive an error when you submit:
67
+
68
+ ```
69
+ request = catalog_request.submit
70
+ ArgumentError: Unable to submit request, required param(s) missing => subtenant_id
71
+ from /home/aleff/vmware-vra/lib/vra/catalog_request.rb:42:in `validate_params!'
72
+ from /home/aleff/vmware-vra/lib/vra/catalog_request.rb:99:in `submit'
73
+ from (irb):4
74
+ from /opt/chefdk/embedded/bin/irb:11:in `<main>'
75
+
76
+ ```
77
+
78
+ In this case, you will need to supply the sub-tenant ID manually:
79
+
80
+ ```
81
+ catalog_request.subtenant_id = '5327ddd3-1a4e-4663-9e9d-63db86ffc8af'
82
+ => "5327ddd3-1a4e-4663-9e9d-63db86ffc8af"
83
+ ```
84
+
85
+ If your catalog blueprint item requires additional parameters to successfully submit your request, you may add them:
86
+
87
+ ```
88
+ catalog_request.set_parameter('my_parameter', 'string', 'my value')
89
+ ```
90
+
91
+ Now, submit your request! The client will return a new "Request" object you can use to query for status.
92
+
93
+ ```
94
+ request = catalog_request.submit
95
+ => #<Vra::Request:0x000000027caea0 ... >
96
+
97
+ request.status
98
+ => "IN_PROGRESS"
99
+ ```
100
+
101
+ You can easily refresh your request object to get the latest status:
102
+
103
+ ```
104
+ request.refresh && request.status
105
+ => "SUCCESSFUL"
106
+
107
+ request.completion_state
108
+ => "SUCCESSFUL"
109
+
110
+ request.completion_details
111
+ => "Request succeeded. Created hol-dev-32."
112
+ ```
113
+
114
+ You can also save the request ID for later, and create a new request object at your leisure to follow-up on your request:
115
+
116
+ ```
117
+ request.id
118
+ => "aed22465-02db-481d-b55a-cefe216096a2"
119
+
120
+ new_request = vra.requests.by_id('aed22465-02db-481d-b55a-cefe216096a2')
121
+ => #<Vra::Request:0x0000000564ac30 ... >
122
+
123
+ new_request.status
124
+ => "SUCCESSFUL"
125
+ ```
126
+
127
+ When the request is successful, you can query the resources created as the result of your request. Assuming that the catalog item blueprint we requested only creates a single VM, we can get that resource and learn more information about it:
128
+
129
+ ```
130
+ resource = request.resources.first
131
+ => #<Vra::Resource:0x00000006772e68 ... >
132
+
133
+ resource.network_interfaces
134
+ => [{"NETWORK_ADDRESS"=>"192.168.110.203", "NETWORK_MAC_ADDRESS"=>"00:50:56:ae:1d:c7", "NETWORK_NAME"=>"vxw-dvs-35-virtualwire-2-sid-5000-Edge_Transport"}]
135
+
136
+ resource.ip_addresses
137
+ => ["192.168.110.203"]
138
+
139
+ resource.name
140
+ => "hol-dev-32"
141
+ ```
142
+
143
+ And just like requests, you can save the resource ID and query it again later:
144
+
145
+ ```
146
+ resource.id
147
+ => "331fd10b-f2a2-40ae-86bc-1255c1ee9a6d"
148
+
149
+ new_resource = vra.resources.by_id('331fd10b-f2a2-40ae-86bc-1255c1ee9a6d')
150
+ => #<Vra::Resource:0x000000067c13b0 ... >
151
+
152
+ new_resource.name
153
+ => "hol-dev-32"
154
+ ```
155
+
156
+ When you no longer need the VM, you can destroy it, which returns another request object you can query for status:
157
+
158
+ ```
159
+ destroy_req = resource.destroy
160
+ => #<Vra::Request:0x00000006ea90d8 ... >
161
+
162
+ destroy_req.status
163
+ => "SUCCESSFUL"
164
+ ```
165
+
166
+ You can also list all resources and requests you have permission to see with these methods:
167
+
168
+ ```
169
+ vra.resources.all_resources
170
+ vra.requests.all_requests
171
+ ```
172
+
173
+ ## License and Authors
174
+
175
+ Author:: Chef Partner Engineering (<partnereng@chef.io>)
176
+
177
+ Copyright:: Copyright (c) 2015 Chef Software, Inc.
178
+
179
+ License:: Apache License, Version 2.0
180
+
181
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
182
+ this file except in compliance with the License. You may obtain a copy of the License at
183
+
184
+ ```
185
+ http://www.apache.org/licenses/LICENSE-2.0
186
+ ```
187
+
188
+ Unless required by applicable law or agreed to in writing, software distributed under the
189
+ License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
190
+ either express or implied. See the License for the specific language governing permissions
191
+ and limitations under the License.
192
+
193
+ ## Contributing
194
+
195
+ 1. Fork it ( https://github.com/[my-github-username]/vmware-vra-gem/fork )
196
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
197
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
198
+ 4. Push to the branch (`git push origin my-new-feature`)
199
+ 5. Create a new Pull Request