knife-vrealize 1.0.0.rc1

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

@@ -0,0 +1,88 @@
+#
+# 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/helpers'
+
+class Chef
+  class Knife
+    class Cloud
+      module VraServiceHelpers
+        include Chef::Knife::Cloud::Helpers
+
+        def create_service_instance
+          Chef::Knife::Cloud::VraService.new(username: locate_config_value(:vra_username),
+                                             password: locate_config_value(:vra_password),
+                                             base_url: locate_config_value(:vra_base_url),
+                                             tenant:   locate_config_value(:vra_tenant),
+                                             verify_ssl: verify_ssl?)
+        end
+
+        def verify_ssl?
+          !locate_config_value(:vra_disable_ssl_verify)
+        end
+
+        def wait_for_request(request, wait_time=600, refresh_rate=2)
+          print 'Waiting for request to complete.'
+
+          last_status  = ''
+
+          begin
+            Timeout.timeout(wait_time) do
+              loop do
+                request.refresh
+
+                if request.completed?
+                  print "\n"
+                  break
+                end
+
+                if last_status == request.status
+                  print '.'
+                else
+                  last_status = request.status
+                  print "\n"
+                  print "Current request status: #{request.status}."
+                end
+
+                sleep refresh_rate
+              end
+            end
+          rescue Timeout::Error
+            ui.msg('')
+            ui.error("Request did not complete in #{wait_time} seconds. Check the Requests tab in the vRA UI for more information.")
+            exit 1
+          end
+        end
+
+        def validate!
+          check_for_missing_config_values!(:vra_username, :vra_password, :vra_base_url, :vra_tenant)
+        end
+
+        # rubocop:disable Style/GuardClause
+        def check_for_missing_config_values!(*keys)
+          missing = keys.select { |x| locate_config_value(x).nil? }
+
+          unless missing.empty?
+            ui.error("The following required parameters are missing: #{missing.join(', ')}")
+            exit(1)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+#
+# 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.
+#
+
+class Chef
+  class Knife
+    class Cloud
+      # rubocop:disable Style/AlignParameters
+      module VraServiceOptions
+        def self.included(includer)
+          includer.class_eval do
+            option :vra_base_url,
+              long:        '--vra-base-url API_URL',
+              description: 'URL for the vRA server'
+
+            option :vra_username,
+              long:        '--vra-username USERNAME',
+              description: 'Username to use with the vRA API'
+
+            option :vra_password,
+              long:        '--vra-password PASSWORD',
+              description: 'Password to use with the vRA API'
+
+            option :vra_disable_ssl_verify,
+              long:        '--vra-disable-ssl-verify',
+              description: 'Skip any SSL verification for the vRA API',
+              boolean:     true,
+              default:     false
+
+            option :request_refresh_rate,
+              long:        '--request-refresh-rate SECS',
+              description: 'Number of seconds to sleep between each check of the request status, defaults to 2',
+              default:     2,
+              proc:        proc { |secs| secs.to_i }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/vra_catalog_list.rb

@@ -0,0 +1,69 @@
+#
+# 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'
+require 'chef/knife/cloud/list_resource_command'
+require 'chef/knife/cloud/vra_service'
+require 'chef/knife/cloud/vra_service_helpers'
+require 'chef/knife/cloud/vra_service_options'
+
+class Chef
+  class Knife
+    class Cloud
+      class VraCatalogList < ResourceListCommand
+        include VraServiceHelpers
+        include VraServiceOptions
+
+        banner 'knife vra catalog list'
+
+        option :entitled,
+               long:        '--entitled-only',
+               description: 'only list entitled vRA catalog entries',
+               boolean:     true,
+               default:     false
+
+        def before_exec_command
+          @columns_with_info = [
+            { label: 'Catalog ID',  key: 'id' },
+            { label: 'Name',        key: 'name' },
+            { label: 'Description', key: 'description' },
+            { label: 'Status',      key: 'status', value_callback: method(:format_status_value) },
+            { label: 'Subtenant',   key: 'subtenant_name' }
+          ]
+
+          @sort_by_field = 'name'
+        end
+
+        def query_resource
+          @service.list_catalog_items(locate_config_value(:entitled))
+        end
+
+        def format_status_value(status)
+          status = status.downcase
+          if status == 'published'
+            color = :green
+          else
+            color = :red
+          end
+
+          ui.color(status, color)
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/vra_server_create.rb

@@ -0,0 +1,134 @@
+#
+# 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'
+require 'chef/knife/cloud/server/create_command'
+require 'chef/knife/cloud/server/create_options'
+require 'chef/knife/cloud/vra_service'
+require 'chef/knife/cloud/vra_service_helpers'
+require 'chef/knife/cloud/vra_service_options'
+
+class Chef
+  class Knife
+    class Cloud
+      # rubocop:disable Style/BlockDelimiters
+      class VraServerCreate < ServerCreateCommand
+        include VraServiceHelpers
+        include VraServiceOptions
+        include ServerCreateOptions
+
+        banner 'knife vra server create CATALOG_ID (options)'
+
+        option :cpus,
+               long:        '--cpus NUM_CPUS',
+               description: 'Number of CPUs the server should have'
+
+        option :memory,
+               long:        '--memory RAM_IN_MB',
+               description: 'Amount of RAM, in MB, the server should have'
+
+        option :requested_for,
+               long:        '--requested-for LOGIN',
+               description: 'The login to list as the owner of this resource.  Will default to the vra_username parameter'
+
+        option :subtenant_id,
+               long:        '--subtenant-id ID',
+               description: 'The subtenant ID (a.k.a "business group") to list as the owner of this resource. ' \
+                 'Will default to the blueprint subtenant if it exists.'
+
+        option :lease_days,
+               long:        '--lease-days NUM_DAYS',
+               description: 'Number of days requested for the server lease, provided the blueprint allows this to be specified'
+
+        option :notes,
+               long:        '--notes NOTES',
+               description: 'String of text to be included in the request notes.'
+
+        option :extra_params,
+               long:        '--extra-param KEY=TYPE:VALUE',
+               description: 'Additional parameters to pass to vRA for this catalog request.  TYPE must be "string" or "integer". ' \
+                 'Can be used multiple times.',
+               default:     {},
+               proc:        proc { |param|
+                              Chef::Config[:knife][:vra_extra_params] ||= {}
+                              key, value_str = param.split('=')
+                              Chef::Config[:knife][:vra_extra_params].merge!(key => value_str)
+                            }
+
+        def validate_params!
+          super
+
+          if @name_args.empty?
+            ui.error('You must supply a Catalog ID to use for your new server.')
+            exit 1
+          end
+
+          check_for_missing_config_values!(:cpus, :memory, :requested_for)
+
+          validate_extra_params!
+        end
+
+        def before_exec_command
+          super
+
+          @create_options = {
+            catalog_id:       @name_args.first,
+            cpus:             locate_config_value(:cpus),
+            memory:           locate_config_value(:memory),
+            requested_for:    locate_config_value(:requested_for),
+            subtenant_id:     locate_config_value(:subtenant_id),
+            lease_days:       locate_config_value(:lease_days),
+            notes:            locate_config_value(:notes),
+            extra_params:     extra_params,
+            wait_time:        locate_config_value(:server_create_timeout),
+            refresh_rate:     locate_config_value(:request_refresh_rate)
+          }
+        end
+
+        def before_bootstrap
+          super
+
+          config[:chef_node_name] = locate_config_value(:chef_node_name) ? locate_config_value(:chef_node_name) : server.name
+          config[:bootstrap_ip_address] = server.ip_addresses.first
+        end
+
+        def extra_params
+          return unless Chef::Config[:knife][:vra_extra_params]
+
+          params = []
+          Chef::Config[:knife][:vra_extra_params].each do |key, value_str|
+            type, value = value_str.split(':')
+            params << { key: key, type: type, value: value }
+          end
+
+          params
+        end
+
+        def validate_extra_params!
+          return if extra_params.nil?
+
+          extra_params.each do |param|
+            raise ArgumentError, "No type and value set for extra parameter #{param[:key]}" if param[:type].nil? || param[:value].nil?
+            raise ArgumentError, "Invalid parameter type for #{param[:key]} - must be string or integer" unless
+              param[:type] == 'string' || param[:type] == 'integer'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/vra_server_delete.rb

@@ -0,0 +1,56 @@
+#
+# 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'
+require 'chef/knife/cloud/server/delete_options'
+require 'chef/knife/cloud/server/delete_command'
+require 'chef/knife/cloud/vra_service'
+require 'chef/knife/cloud/vra_service_helpers'
+require 'chef/knife/cloud/vra_service_options'
+
+class Chef
+  class Knife
+    class Cloud
+      class VraServerDelete < ServerDeleteCommand
+        include ServerDeleteOptions
+        include VraServiceHelpers
+        include VraServiceOptions
+
+        banner 'knife vra server delete RESOURCE_ID [RESOURCE_ID] (options)'
+
+        # rubocop:disable Style/GuardClause
+        def validate_params!
+          if @name_args.empty?
+            ui.error('You must supply a resource ID of a server to delete.')
+            exit(1) if @name_args.empty?
+          end
+        end
+
+        # overriding this method from knife-cloud so we can pull the machine name
+        # to pass to delete_from_chef rather than the resource ID
+        def execute_command
+          @name_args.each do |resource_id|
+            server = service.get_server(resource_id)
+            service.delete_server(resource_id)
+            delete_from_chef(server.name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/vra_server_list.rb

@@ -0,0 +1,61 @@
+#
+# 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'
+require 'chef/knife/cloud/server/list_command'
+require 'chef/knife/cloud/server/list_options'
+require 'chef/knife/cloud/vra_service'
+require 'chef/knife/cloud/vra_service_helpers'
+require 'chef/knife/cloud/vra_service_options'
+
+class Chef
+  class Knife
+    class Cloud
+      class VraServerList < ServerListCommand
+        include VraServiceHelpers
+        include VraServiceOptions
+
+        banner 'knife vra server list'
+
+        def before_exec_command
+          @columns_with_info = [
+            { label: 'Resource ID',  key: 'id' },
+            { label: 'Name',         key: 'name' },
+            { label: 'Status',       key: 'status', value_callback: method(:format_status_value) },
+            { label: 'Catalog Name', key: 'catalog_name' }
+          ]
+
+          @sort_by_field = 'name'
+        end
+
+        def format_status_value(status)
+          status = status.downcase
+          status_color = case status
+                         when 'active'
+                           :green
+                         when 'deleted'
+                           :red
+                         else
+                           :yellow
+                         end
+          ui.color(status, status_color)
+        end
+      end
+    end
+  end
+end