knife-vrealize 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80ccc11a33732ba415414655907ca73f2b88883d
+  data.tar.gz: 5e02782345c418514fa26e2c4ac7b8aa3dceac23
+SHA512:
+  metadata.gz: c17c280205fec581d25e22102fd6386272ced79b24c1f7a168818e56c3e9dee27d7ba9efe16446d93f7f994b2de4f9b07d8f7feaf98dac599cdc0979178e3c55
+  data.tar.gz: 81aaca7c938f9da3875bff627f03362e32b7df4ee2e93c00f78167173e1525eff27241e40a0fb79db3631304cdc2b0b4dc188baf30a2a73ee833c8790d7fc6d2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/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/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+                                 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,140 @@
+# knife-vrealize
+
+This is a Knife plugin that will allow you to interact with 
+VMware vRealize products, such as vRA and vRO, from Chef's Knife command.
+
+The initial release of this plugin supports vRA.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'knife-vrealize'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install knife-vrealize
+
+... or, even better, from within ChefDK:
+
+    $ chef gem install knife-vrealize
+
+## Configuration
+
+In order to communicate with vRA, you must specify your user credentials. You can specify them in your knife.rb:
+
+```ruby
+knife[:vra_username] = 'myuser'
+knife[:vra_password] = 'mypassword'
+knife[:vra_base_url] = 'https://vra.corp.local'
+knife[:vra_tenant]   = 'mytenant'
+``` 
+
+... or you can supply them on the command-line:
+
+```
+knife vra command --vra-username myuser --vra-tenant mytenant ...
+```
+
+## Usage
+
+### knife vra catalog list
+
+Lists catalog items that can be used to submit machine requests.  By default, it will list all catalog items that your user has permission to see.  To limit it to only items to which you are entitled, supply the `--entitled` flag.
+
+```
+$ knife vra catalog list
+Catalog ID                            Name                         Description                                                Status     Subtenant
+a9cd6148-6e0b-4a80-ac47-f5255c52b43d  CentOS 6.6                   Blueprint for deploying a CentOS Linux development server  published
+5dcd1900-3b89-433d-8563-9606ae1249b8  CentOS 6.6 - business group  Blueprint for deploying a CentOS Linux development server  published  Rainpole Developers
+d29efd6b-3cd6-4f8d-b1d8-da4ddd4e52b1  WindowsServer2012            Windows Server 2012 with the latest updates and patches.   published
+```
+
+### knife vra server list
+
+Lists all machine resources that your user has permission to see.  The "resource ID" is needed for other commands, such as `knife vra server show` and `knife vra server destroy`
+
+```
+$ knife vra server list
+Resource ID                           Name        Status  Catalog Name
+2e1f6632-1613-41d1-a07c-6137c9639609  hol-dev-43  active  CentOS 6.6
+43898686-7395-468a-99b3-b0b18a8abc1b  hol-dev-44  active  CentOS 6.6
+0977f98b-d927-4e71-8b5b-b27c7deda097  hol-dev-45  active  CentOS 6.6
+```
+
+### knife vra server show RESOURCE_ID
+
+Displays additional information about an individual server, such as its IP addresses.
+
+```
+$ knife vra server show 2e1f6632-1613-41d1-a07c-6137c9639609
+Server ID: 2e1f6632-1613-41d1-a07c-6137c9639609
+Server Name: hol-dev-43
+IP Addresses: 192.168.110.203
+Status: ACTIVE
+Catalog Name: CentOS 6.6
+```
+
+### knife vra server create CATALOG_ID (options)
+
+Creates a server from a catalog blueprint.  Find the catalog ID with the `knife vra catalog list` command.  After the resource is created, knife will attempt to bootstrap it (install chef, run chef-client for the first time, etc.).
+
+Each blueprint may require different parameters to successfully complete provisioning.  See your vRA administrator with questions.  We'll do our best to give you any helpful error messages from vRA if they're available to us.
+
+Common parameters to specify are:
+
+ * `--cpus`: number of CPUs
+ * `--memory`: amount of RAM in MB
+ * `--requested-for`: vRA login that should be listed as the owner
+ * `--lease-days`: number of days for the resource lease
+ * `--notes`: any optional notes you'd like to be logged with your request
+ * `--subtenant-id`: all resources must be tied back to a Business Group, or "subtenant." If your catalog item is tied to a specific Business Group, you do not need to specify this.  However, if your catalog item is a global catalog item, then the subtenant ID is not available to us; you will need to provide it.  It usually looks like a UUID.  See your vRA administrator for assistance in determining your subtenant ID.
+ * `--ssh-password`: if a linux host, the password to use during bootstrap
+ * `--winrm-password`: if a windows host, the password to use during bootstrap
+
+```
+$ knife vra server create 5dcd1900-3b89-433d-8563-9606ae1249b8 --cpus 1 --memory 512 --requested-for devmgr@corp.local --ssh-password 'mypassword' --lease-days 5
+Catalog request d282fde8-6fd2-406c-998e-328d1b659078 submitted.
+Waiting for request to complete.
+Current request status: PENDING_PRE_APPROVAL.
+Current request status: IN_PROGRESS..
+...
+```
+
+### knife vra server delete RESOURCE_ID
+
+Deletes a server from vRA.  If you supply `--purge`, the server will also be removed from the Chef Server.
+
+```
+$ bundle exec knife vra server delete 2e1f6632-1613-41d1-a07c-6137c9639609 --purge
+Server ID: 2e1f6632-1613-41d1-a07c-6137c9639609
+Server Name: hol-dev-43
+IP Addresses: 192.168.110.203
+Status: ACTIVE
+Catalog Name: CentOS 6.6
+
+Do you really want to delete this server? (Y/N) Y
+Destroy request f2aa716b-ab24-4232-ac4a-07635a03b4d4 submitted.
+Waiting for request to complete.
+Current request status: PENDING_PRE_APPROVAL.
+Current request status: IN_PROGRESS...
+...
+```
+
+## Contributing
+
+We'd love to hear from you if you find this isn't working in your VMware vRA environment.  Please submit a GitHub issue with any problems you encounter.
+
+Additionally, contributions are welcome!  If you'd like to send up any fixes or changes:
+
+1. Fork it ( https://github.com/chef-partners/knife-vrealize/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/knife-vrealize.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'knife-vrealize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'knife-vrealize'
+  spec.version       = KnifeVrealize::VERSION
+  spec.authors       = ['Chef Partner Engineering']
+  spec.email         = ['partnereng@chef.io']
+  spec.summary       = 'Knife plugin to interact with VMware vRealize.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://gihub.com/chef-partners/knife-vrealize'
+  spec.license       = 'Apache 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'chef',         '~> 12.0'
+  spec.add_dependency 'knife-cloud',  '~> 1.2.0'
+  spec.add_dependency 'vmware-vra',   '~> 1.0.0.rc2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+end

data/lib/chef/knife/cloud/vra_service.rb

@@ -0,0 +1,140 @@
+#
+# Author:: Chef Partner Engineering (<partnereng@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'chef/knife/cloud/exceptions'
+require 'chef/knife/cloud/service'
+require 'chef/knife/cloud/helpers'
+require 'chef/knife/cloud/vra_service_helpers'
+require 'vra'
+
+class Chef
+  class Knife
+    class Cloud
+      class VraService < Service
+        include VraServiceHelpers
+        def initialize(options={})
+          super(options)
+
+          @username   = options[:username]
+          @password   = options[:password]
+          @base_url   = options[:base_url]
+          @tenant     = options[:tenant]
+          @verify_ssl = options[:verify_ssl]
+        end
+
+        def connection
+          @client ||= Vra::Client.new(
+            base_url:   @base_url,
+            username:   @username,
+            password:   @password,
+            tenant:     @tenant,
+            verify_ssl: @verify_ssl
+          )
+        end
+
+        def create_server(options={})
+          submitted_request = catalog_request(options).submit
+          ui.msg("Catalog request #{submitted_request.id} submitted.")
+          wait_for_request(submitted_request, options[:wait_time], options[:refresh_rate])
+          ui.msg("Catalog request complete.\n")
+          request_summary(submitted_request)
+
+          raise CloudExceptions::ServerCreateError, submitted_request.completion_details if submitted_request.failed?
+
+          servers = submitted_request.resources.select(&:vm?)
+          raise CloudExceptions::ServerCreateError, 'The vRA request created more than one server, but we were only expecting 1' if servers.length > 1
+          raise CloudExceptions::ServerCreateError, 'The vRA request did not create any servers' if servers.length == 0
+
+          servers.first
+        end
+
+        def delete_server(instance_id)
+          server = get_server(instance_id)
+          server_summary(server)
+          ui.msg('')
+
+          if server.status == 'DELETED'
+            ui.warn("Server is already deleted.\n")
+            return
+          end
+
+          ui.confirm('Do you really want to delete this server')
+
+          destroy_request = server.destroy
+          ui.msg("Destroy request #{destroy_request.id} submitted.")
+          wait_for_request(destroy_request)
+          ui.msg('Destroy request complete.')
+          request_summary(destroy_request)
+        end
+
+        def list_servers
+          connection.resources.all_resources.select(&:vm?)
+        end
+
+        def list_catalog_items(entitled)
+          if entitled
+            connection.catalog.entitled_items
+          else
+            connection.catalog.all_items
+          end
+        end
+
+        def get_server(instance_id)
+          connection.resources.by_id(instance_id)
+        end
+
+        def server_summary(server, _columns_with_info=nil)
+          msg_pair('Server ID', server.id)
+          msg_pair('Server Name', server.name)
+          msg_pair('IP Addresses', server.ip_addresses.nil? ? 'none' : server.ip_addresses.join(', '))
+          msg_pair('Status', server.status)
+          msg_pair('Catalog Name', server.catalog_name)
+          msg_pair('Owner IDs', server.owner_ids.empty? ? 'none' : server.owner_ids.join(', '))
+          msg_pair('Owner Names', server.owner_names.empty? ? 'none' : server.owner_names.join(', '))
+        end
+
+        def request_summary(request)
+          ui.msg('')
+          msg_pair('Request Status', request.status)
+          msg_pair('Completion State', request.completion_state)
+          msg_pair('Completion Details', request.completion_details)
+          ui.msg('')
+        end
+
+        def catalog_request(options)
+          catalog_request = connection.catalog.request(options[:catalog_id])
+
+          catalog_request.cpus          = options[:cpus]
+          catalog_request.memory        = options[:memory]
+          catalog_request.requested_for = options[:requested_for]
+          catalog_request.lease_days    = options[:lease_days]    unless options[:lease_days].nil?
+          catalog_request.notes         = options[:notes]         unless options[:notes].nil?
+          catalog_request.subtenant_id  = options[:subtenant_id]  unless options[:subtenant_id].nil?
+
+          if options[:vra_extra_params]
+            options[:vra_extra_params].each do |key, value_data|
+              catalog_request.set_parameter(key, value_data[:type], value_data[:value])
+            end
+          end
+
+          catalog_request
+        end
+      end
+    end
+  end
+end