knife-vcenter 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 9ad1c5e3501668037f48c20ccce6dcfa6ad0183c
4
+ data.tar.gz: cf159caaa9acec16e26677e4caf6b1a2b6e6b0c9
5
+ SHA512:
6
+ metadata.gz: c4ca2d101e8794ae23ee2b05740192c07bfa7ceb68c7b73c67b9cc3a468669182ffdbf9fcaaede9e9871e9c5187a3f6eb3dd4cc1f7d0b2074aad6451f64380f3
7
+ data.tar.gz: 1539395b4a15987256416e5a6ea0e50ca5903c95cfde21d72e5ded6ec6e9baefa371c9df4b9547710981241a38bb944328b34fbf60a4ed70b8a6c679b09e11f8
@@ -0,0 +1,22 @@
1
+ ### Versions:
2
+ <!--- Version of the software where you are encountering the issue --->
3
+ <!-- You should probably update in this is not newest release.--->
4
+ * Version of knife-vcenter:
5
+ * Version of chef:
6
+
7
+ ### Platform Details
8
+ <!--- What version of vCenter are you running? What version of ESXi are you using too?--->
9
+ * Version of vCenter:
10
+ * Version of ESXi:
11
+
12
+ ### Scenario:
13
+ <!--- What you are trying to achieve and you can't?--->
14
+
15
+ ### Steps to Reproduce:
16
+ <!--- If you are filing an issue what are the things we need to do in order to repro your problem? How are you using this gem or any resources it includes?--->
17
+
18
+ ### Expected Result:
19
+ <!--- What are you expecting to happen as the consequence of above reproduction steps?--->
20
+
21
+ ### Actual Result:
22
+ <!--- What actually happens after the reproduction steps? Include the error output or a link to a gist if possible.--->
@@ -0,0 +1,14 @@
1
+ ### Description
2
+
3
+ <!--- Describe what this change achieves--->
4
+
5
+ ### Issues Resolved
6
+
7
+ <!--- List any existing issues this PR resolves--->
8
+
9
+ ### Check List
10
+
11
+ - [ ] All tests pass.
12
+ - [ ] All style checks pass.
13
+ - [ ] Functionality includes testing.
14
+ - [ ] Functionality has been documented in the README if applicable
@@ -0,0 +1,20 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.bundle
11
+ *.so
12
+ *.o
13
+ *.a
14
+ mkmf.log
15
+ .direnv/
16
+ .envrc
17
+ .ruby-version
18
+ .chef
19
+ local/
20
+ .vscode/
@@ -0,0 +1,18 @@
1
+ AllCops:
2
+ Exclude:
3
+ - 'spec/**/*'
4
+ - 'vendor/**/*'
5
+ vendor/AbcSize:
6
+ Max: 30
7
+ Metrics/LineLength:
8
+ Max: 150
9
+ Metrics/MethodLength:
10
+ Max: 30
11
+ Style/Documentation:
12
+ Enabled: false
13
+ Style/SignalException:
14
+ Enabled: false
15
+ Style/SpaceAroundEqualsInParameterDefault:
16
+ EnforcedStyle: no_space
17
+ Style/SpaceInsideBrackets:
18
+ Enabled: false
@@ -0,0 +1,16 @@
1
+ language: ruby
2
+ cache: bundler
3
+ sudo: false
4
+
5
+ rvm:
6
+ - 2.2
7
+ - 2.3.3
8
+ - 2.4.1
9
+
10
+ branches:
11
+ only:
12
+ - master
13
+
14
+ script:
15
+ - bundle exec rake style
16
+ - bundle exec rake spec
@@ -0,0 +1,12 @@
1
+ # Change Log
2
+
3
+ ## [1.0.0](https://github.com/chef/knife-vcenter/tree/1.0.0) (2017-08-10)
4
+ **Merged pull requests:**
5
+
6
+ - 1.0.0 release [\#3](https://github.com/chef/knife-vcenter/pull/3) ([jjasghar](https://github.com/jjasghar))
7
+ - Walking through the knife-vcenter code [\#2](https://github.com/chef/knife-vcenter/pull/2) ([jjasghar](https://github.com/jjasghar))
8
+ - Useful information for public release. [\#1](https://github.com/chef/knife-vcenter/pull/1) ([jjasghar](https://github.com/jjasghar))
9
+
10
+
11
+
12
+ \* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ # frozen_string_literal: true
2
+ source 'https://rubygems.org'
3
+ gemspec
@@ -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.
@@ -0,0 +1,209 @@
1
+ # knife-vcenter
2
+
3
+ [![Gem Version](https://badge.fury.io/rb/knife-vcenter.svg)](https://rubygems.org/gems/knife-vcenter)
4
+ [![Build Status](https://travis-ci.org/chef/knife-vcenter.svg?branch=master)](https://travis-ci.org/chef/knife-vcenter)
5
+ [![Dependency Status](https://gemnasium.com/chef/knife-vcenter.svg)](https://gemnasium.com/chef/knife-vcenter)
6
+ [![Inline docs](http://inch-ci.org/github/chef/knife-vcenter.svg?branch=master)](http://inch-ci.org/github/chef/knife-vcenter)
7
+
8
+ This is the official Chef Knife plugin for VMware REST API. This plugin gives knife the ability to create, bootstrap, and manage VMware vms.
9
+ - Documentation: [https://github.com/chef/knife-vcenter/blob/master/README.md](https://github.com/chef/knife-vcenter/blob/master/README.md)
10
+ - Source: [https://github.com/chef/knife-vcenter/tree/master](https://github.com/chef/knife-vcenter/tree/master)
11
+ - Issues: [https://github.com/chef/knife-vcenter/issues](https://github.com/chef/knife-vcenter/issues)
12
+ - Slack: sign up: https://code.vmware.com/slack/ slack channel: #chef
13
+ - Mailing list: [https://discourse.chef.io/](https://discourse.chef.io/)
14
+
15
+ This is a `knife` plugin that allows interaction with vSphere using the vSphere Automation SDK.
16
+
17
+ Please refer to the [CHANGELOG](CHANGELOG.md) for version history and known issues.
18
+
19
+ ## Requirements
20
+
21
+ - Chef 13.0 higher
22
+ - Ruby 2.3.3 or higher
23
+
24
+ ## Installation
25
+
26
+ Using [ChefDK](https://downloads.chef.io/chef-dk/), simply install the Gem:
27
+
28
+ ```bash
29
+ chef gem install knife-vcenter
30
+ ```
31
+
32
+ If you're using bundler, simply add Chef and knife-vcenter to your Gemfile:
33
+
34
+ ```ruby
35
+ gem 'chef'
36
+ gem 'knife-vcenter'
37
+ ```
38
+
39
+ ## Configuration
40
+
41
+ In order to communicate with vSphere, you must specify your user credentials. You can specify them in your `knife.rb` file:
42
+
43
+ ```ruby
44
+ knife[:vcenter_username] = "myuser"
45
+ knife[:vcenter_password] = "mypassword"
46
+ knife[:vcenter_host] = "172.16.20.2"
47
+ knife[:vcenter_disable_ssl_verify] = true # if you want to disable SSL checking
48
+ ```
49
+
50
+ or alternatively you can supply them on the command-line:
51
+
52
+ ```bash
53
+ knife vcenter _command_ --vcenter-username myuser --vcanter-password mypassword
54
+ ```
55
+
56
+ ## Usage
57
+
58
+ ### knife vcenter cluster list
59
+
60
+ Lists the clusters on the connected vSphere environment
61
+
62
+ ```
63
+ $ knife vcenter cluster list
64
+ ID Name DRS? HA?
65
+ domain-c123 Cluster False False
66
+ ```
67
+
68
+ ## knife vcenter datacenter list
69
+
70
+ List the data centers configures in the vSPeher environment
71
+
72
+ ```
73
+ $ knife vcenter datacenter list
74
+ ID Name
75
+ datacenter-21 Datacenter
76
+ ```
77
+
78
+ ## knife vcenter host list
79
+
80
+ List the hosts in the vSphere in the vSphere environment
81
+
82
+ ```
83
+ $ knife vcenter host list
84
+ ID Name Power State Connection State
85
+ host-28 172.16.20.3 POWERED_ON CONNECTED
86
+ host-64 172.16.20.41 POWERED_ON CONNECTED
87
+ host-69 172.16.20.42 POWERED_ON CONNECTED
88
+ host-74 172.16.20.43 POWERED_ON CONNECTED
89
+ host-79 172.16.20.44 POWERED_ON CONNECTED
90
+ ```
91
+
92
+ ## knife vcenter vm list
93
+
94
+ List out all the virtual machines that exist in the vSphere environment
95
+
96
+ ```
97
+ $ knife vcenter vm list
98
+ ID Name Power State CPU Count RAM Size (MB)
99
+ vm-42 alpine-docker POWERED_OFF 1 4,024
100
+ vm-35 automate-ubuntu POWERED_OFF 1 4,096
101
+ vm-44 chef POWERED_OFF 1 4,096
102
+ vm-33 chef-automate POWERED_OFF 1 4,096
103
+ vm-34 chef-buildnode POWERED_OFF 1 4,096
104
+ vm-43 chef-compliance POWERED_OFF 1 4,096
105
+ vm-71 CyberArk POWERED_OFF 1 8,192
106
+ vm-45 jenkins POWERED_ON 4 8,096
107
+ vm-36 LFS POWERED_OFF 2 4,096
108
+ ```
109
+
110
+ ## knife vcenter vm show NAME
111
+
112
+ Display details about a specific virtual machine.
113
+
114
+ ```
115
+ $ knife vcenter vm show chef
116
+ ID: vm-44
117
+ Name: chef
118
+ Power State: POWERED_OFF
119
+ ```
120
+
121
+ _The IP address of the machine is not returned yet as this requires a call to a different SDK_
122
+
123
+ ## knife vcenter vm clone NAME
124
+
125
+ Create a new machine by cloning an existing machine or a template. This machine will be bootstrapped by Chef, as long as all the relevant details are in the `knife.rb` file.
126
+
127
+ Parameters that are required are:
128
+
129
+ - `--targethost` - The host that the virtual machine should be created on
130
+ - `--folder` - Folder that machine should be stored in. This must already exist.
131
+ - `--datacenter` - Datacenter in the vSphere environment that controls the target host
132
+ - `--template` - Name of the virtual machine or template to use
133
+
134
+ ```
135
+ $ knife vcenter vm clone example-01 --targethost 172.16.20.3 --folder example --ssh-password P@ssw0rd! --datacenter Datacenter --template ubuntu16-template -N example-01
136
+ Creating new machine
137
+ Waiting for network interfaces to become available...
138
+ ID: vm-183
139
+ Name: example-01
140
+ Power State: POWERED_ON
141
+ Bootstrapping the server by using bootstrap_protocol: ssh and image_os_type: linux
142
+
143
+ Waiting for sshd to host (10.0.0.167)
144
+ ...
145
+ ```
146
+
147
+ ## knife vcenter vm delete NAME
148
+
149
+ Deletes a virtual machine from vSphere. If you supply `--purge` the machine will be removed from the Chef Server.
150
+
151
+ NOTE: If the node name is different to the host name then the `-N` argument must be specified in conjunction with the `--purge` option
152
+
153
+ ```
154
+ $ knife vcenter vm delete example-01 -N example-01 --purge
155
+ Creating new machine
156
+ Waiting for network interfaces to become available...
157
+ ID: vm-183
158
+ Name: example-01
159
+ Power State: POWERED_ON
160
+ Bootstrapping the server by using bootstrap_protocol: ssh and image_os_type: linux
161
+
162
+ Waiting for sshd to host (10.0.0.167)
163
+ WARNING: Deleted node example-01
164
+ WARNING: Deleted client example-01
165
+ ```
166
+
167
+ ## Contributing
168
+
169
+ For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
170
+
171
+ ## Development
172
+
173
+ * Report issues/questions/feature requests on [GitHub Issues][issues]
174
+
175
+ Pull requests are very welcome! Make sure your patches are well tested.
176
+ Ideally create a topic branch for every separate change you make. For
177
+ example:
178
+
179
+ 1. Fork the repo
180
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
181
+ 3. Run the tests and rubocop, `bundle exec rake spec` and `bundle exec rake rubocop`
182
+ 4. Commit your changes (`git commit -am 'Added some feature'`)
183
+ 5. Push to the branch (`git push origin my-new-feature`)
184
+ 6. Create new Pull Request
185
+
186
+
187
+ ## License
188
+
189
+ Author:: Russell Seymour ([rseymour@chef.io](mailto:rseymour@chef.io))
190
+
191
+ Author:: JJ Asghar ([jj@chef.io](mailto:jj@chef.io))
192
+
193
+ Copyright:: Copyright (c) 2017 Chef Software, Inc.
194
+
195
+ License:: Apache License, Version 2.0
196
+
197
+ ```text
198
+ Licensed under the Apache License, Version 2.0 (the "License");
199
+ you may not use this file except in compliance with the License.
200
+ You may obtain a copy of the License at
201
+
202
+ http://www.apache.org/licenses/LICENSE-2.0
203
+
204
+ Unless required by applicable law or agreed to in writing, software
205
+ distributed under the License is distributed on an "AS IS" BASIS,
206
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
207
+ See the License for the specific language governing permissions and
208
+ limitations under the License.
209
+ ```