knife-vcenter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ad1c5e3501668037f48c20ccce6dcfa6ad0183c
+  data.tar.gz: cf159caaa9acec16e26677e4caf6b1a2b6e6b0c9
+SHA512:
+  metadata.gz: c4ca2d101e8794ae23ee2b05740192c07bfa7ceb68c7b73c67b9cc3a468669182ffdbf9fcaaede9e9871e9c5187a3f6eb3dd4cc1f7d0b2074aad6451f64380f3
+  data.tar.gz: 1539395b4a15987256416e5a6ea0e50ca5903c95cfde21d72e5ded6ec6e9baefa371c9df4b9547710981241a38bb944328b34fbf60a4ed70b8a6c679b09e11f8

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,22 @@
+### Versions:
+<!--- Version of the software where you are encountering the issue --->
+<!-- You should probably update in this is not newest release.--->
+* Version of knife-vcenter:
+* Version of chef:
+
+### Platform Details
+<!--- What version of vCenter are you running? What version of ESXi are you using too?--->
+* Version of vCenter:
+* Version of ESXi:
+
+### Scenario:
+<!--- What you are trying to achieve and you can't?--->
+
+### Steps to Reproduce:
+<!--- 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?--->
+
+### Expected Result:
+<!--- What are you expecting to happen as the consequence of above reproduction steps?--->
+
+### Actual Result:
+<!--- What actually happens after the reproduction steps? Include the error output or a link to a gist if possible.--->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+### Description
+
+<!--- Describe what this change achieves--->
+
+### Issues Resolved
+
+<!--- List any existing issues this PR resolves--->
+
+### Check List
+
+- [ ] All tests pass.
+- [ ] All style checks pass.
+- [ ] Functionality includes testing.
+- [ ] Functionality has been documented in the README if applicable

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.direnv/
+.envrc
+.ruby-version
+.chef
+local/
+.vscode/

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+    - 'vendor/**/*'
+vendor/AbcSize:
+  Max: 30
+Metrics/LineLength:
+  Max: 150
+Metrics/MethodLength:
+  Max: 30
+Style/Documentation:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+Style/SpaceInsideBrackets:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+cache: bundler
+sudo: false
+
+rvm:
+  - 2.2
+  - 2.3.3
+  - 2.4.1
+
+branches:
+  only:
+  - master
+
+script:
+  - bundle exec rake style
+  - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+## [1.0.0](https://github.com/chef/knife-vcenter/tree/1.0.0) (2017-08-10)
+**Merged pull requests:**
+
+- 1.0.0 release [\#3](https://github.com/chef/knife-vcenter/pull/3) ([jjasghar](https://github.com/jjasghar))
+- Walking through the knife-vcenter code [\#2](https://github.com/chef/knife-vcenter/pull/2) ([jjasghar](https://github.com/jjasghar))
+- Useful information for public release. [\#1](https://github.com/chef/knife-vcenter/pull/1) ([jjasghar](https://github.com/jjasghar))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,209 @@
+# knife-vcenter
+
+[![Gem Version](https://badge.fury.io/rb/knife-vcenter.svg)](https://rubygems.org/gems/knife-vcenter)
+[![Build Status](https://travis-ci.org/chef/knife-vcenter.svg?branch=master)](https://travis-ci.org/chef/knife-vcenter)
+[![Dependency Status](https://gemnasium.com/chef/knife-vcenter.svg)](https://gemnasium.com/chef/knife-vcenter)
+[![Inline docs](http://inch-ci.org/github/chef/knife-vcenter.svg?branch=master)](http://inch-ci.org/github/chef/knife-vcenter)
+
+This is the official Chef Knife plugin for VMware REST API. This plugin gives knife the ability to create, bootstrap, and manage VMware vms.
+- Documentation: [https://github.com/chef/knife-vcenter/blob/master/README.md](https://github.com/chef/knife-vcenter/blob/master/README.md)
+- Source: [https://github.com/chef/knife-vcenter/tree/master](https://github.com/chef/knife-vcenter/tree/master)
+- Issues: [https://github.com/chef/knife-vcenter/issues](https://github.com/chef/knife-vcenter/issues)
+- Slack: sign up: https://code.vmware.com/slack/ slack channel: #chef
+- Mailing list: [https://discourse.chef.io/](https://discourse.chef.io/)
+
+This is a `knife` plugin that allows interaction with vSphere using the vSphere Automation SDK.
+
+Please refer to the [CHANGELOG](CHANGELOG.md) for version history and known issues.
+
+## Requirements
+
+- Chef 13.0 higher
+- Ruby 2.3.3 or higher
+
+## Installation
+
+Using [ChefDK](https://downloads.chef.io/chef-dk/), simply install the Gem:
+
+```bash
+chef gem install knife-vcenter
+```
+
+If you're using bundler, simply add Chef and knife-vcenter to your Gemfile:
+
+```ruby
+gem 'chef'
+gem 'knife-vcenter'
+```
+
+## Configuration
+
+In order to communicate with vSphere, you must specify your user credentials. You can specify them in your `knife.rb` file:
+
+```ruby
+knife[:vcenter_username] = "myuser"
+knife[:vcenter_password] = "mypassword"
+knife[:vcenter_host] = "172.16.20.2"
+knife[:vcenter_disable_ssl_verify] = true # if you want to disable SSL checking
+```
+
+or alternatively you can supply them on the command-line:
+
+```bash
+knife vcenter _command_ --vcenter-username myuser --vcanter-password mypassword
+```
+
+## Usage
+
+### knife vcenter cluster list
+
+Lists the clusters on the connected vSphere environment
+
+```
+$ knife vcenter cluster list
+ID           Name     DRS?   HA?
+domain-c123  Cluster  False  False
+```
+
+## knife vcenter datacenter list
+
+List the data centers configures in the vSPeher environment
+
+```
+$ knife vcenter datacenter list
+ID             Name
+datacenter-21  Datacenter
+```
+
+## knife vcenter host list
+
+List the hosts in the vSphere in the vSphere environment
+
+```
+$ knife vcenter host list
+ID       Name          Power State  Connection State
+host-28  172.16.20.3   POWERED_ON   CONNECTED
+host-64  172.16.20.41  POWERED_ON   CONNECTED
+host-69  172.16.20.42  POWERED_ON   CONNECTED
+host-74  172.16.20.43  POWERED_ON   CONNECTED
+host-79  172.16.20.44  POWERED_ON   CONNECTED
+```
+
+## knife vcenter vm list
+
+List out all the virtual machines that exist in the vSphere environment
+
+```
+$ knife vcenter vm list
+ID      Name                             Power State  CPU Count  RAM Size (MB)
+vm-42   alpine-docker                    POWERED_OFF  1          4,024
+vm-35   automate-ubuntu                  POWERED_OFF  1          4,096
+vm-44   chef                             POWERED_OFF  1          4,096
+vm-33   chef-automate                    POWERED_OFF  1          4,096
+vm-34   chef-buildnode                   POWERED_OFF  1          4,096
+vm-43   chef-compliance                  POWERED_OFF  1          4,096
+vm-71   CyberArk                         POWERED_OFF  1          8,192
+vm-45   jenkins                          POWERED_ON   4          8,096
+vm-36   LFS                              POWERED_OFF  2          4,096
+```
+
+## knife vcenter vm show NAME
+
+Display details about a specific virtual machine.
+
+```
+$ knife vcenter vm show chef
+ID: vm-44
+Name: chef
+Power State: POWERED_OFF
+```
+
+_The IP address of the machine is not returned yet as this requires a call to a different SDK_
+
+## knife vcenter vm clone NAME
+
+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.
+
+Parameters that are required are:
+
+ - `--targethost` - The host that the virtual machine should be created on
+ - `--folder` - Folder that machine should be stored in. This must already exist.
+ - `--datacenter` - Datacenter in the vSphere environment that controls the target host
+ - `--template` - Name of the virtual machine or template to use
+
+```
+$ 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
+Creating new machine
+Waiting for network interfaces to become available...
+ID: vm-183
+Name: example-01
+Power State: POWERED_ON
+Bootstrapping the server by using bootstrap_protocol: ssh and image_os_type: linux
+
+Waiting for sshd to host (10.0.0.167)
+...
+```
+
+## knife vcenter vm delete NAME
+
+Deletes a virtual machine from vSphere. If you supply `--purge` the machine will be removed from the Chef Server.
+
+NOTE: If the node name is different to the host name then the `-N` argument must be specified in conjunction with the `--purge` option
+
+```
+$ knife vcenter vm delete example-01 -N example-01 --purge
+Creating new machine
+Waiting for network interfaces to become available...
+ID: vm-183
+Name: example-01
+Power State: POWERED_ON
+Bootstrapping the server by using bootstrap_protocol: ssh and image_os_type: linux
+
+Waiting for sshd to host (10.0.0.167)
+WARNING: Deleted node example-01
+WARNING: Deleted client example-01
+```
+
+## Contributing
+
+For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
+
+## Development
+
+* Report issues/questions/feature requests on [GitHub Issues][issues]
+
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run the tests and rubocop, `bundle exec rake spec` and `bundle exec rake rubocop`
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+
+## License
+
+Author:: Russell Seymour ([rseymour@chef.io](mailto:rseymour@chef.io))
+
+Author:: JJ Asghar ([jj@chef.io](mailto:jj@chef.io))
+
+Copyright:: Copyright (c) 2017 Chef Software, Inc.
+
+License:: Apache License, Version 2.0
+
+```text
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```