chef-provisioning-oneview 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d3cd5a3b65cb69035f944b55366db63824b0a98
-  data.tar.gz: 094924c5feaea2aef5283e5a2b09a57a15d852c2
+  metadata.gz: 11de8d1ced349e47d834f7027c6fe84a67d625c6
+  data.tar.gz: 29db709224300d4b08603b4b6f000ef7d938468a
 SHA512:
-  metadata.gz: 0d867cc5a82453fca8430a2ad7a772d1fc286c85dd54595144bd47cbe65e46205bbd74a8fe6307aa71a36ca3757bec04d3a4bfb765a4314a04aca8bf055dd218
-  data.tar.gz: 492474abfa48306e3376377698abfb92e386ec3571253c0d8be3aad724aaeb46f978f0bd49f35a66646ae06455bc13a1a1265d900c0913fd6b50515d2ada6107
+  metadata.gz: 17c2c3f0a1dfa71dddb30d57792a395f064a458e2017205a36769c9006cae60a043b3074a15fcb5c6bb77b6af4f9496697036775c709bac5f7e391274b9b8ff1
+  data.tar.gz: 673f473fd1cdeedc70c859b8f932dfcada3d6dbbcad415399eec091dbc2d8ea6a03122e8a6b245e936ca8198dc7f310500ee76e6572ba6e653f1fb5026f0d7ba

data/README.md

@@ -1,6 +1,6 @@
 # chef-provisioning-oneview
-Chef Provisioning driver for HPE OneView
 
+Chef Provisioning driver for HPE OneView
 
 [![Build Status](https://travis-ci.org/HewlettPackard/chef-provisioning-oneview.svg?branch=master)](https://travis-ci.org/HewlettPackard/chef-provisioning-oneview)
 [![Gem Version](https://badge.fury.io/rb/chef-provisioning-oneview.svg)](https://badge.fury.io/rb/chef-provisioning-oneview)
@@ -8,40 +8,65 @@ Chef Provisioning driver for HPE OneView
 Questions or comments? Join the Gitter room  [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/HewlettPackard/chef-provisioning-oneview?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 
-Currently supports:
+Verified on (may support other versions too, but no guarantees):
 - OneView v1.2.0 - 2.0.0
 - ICsp v7.4.0 - 7.5.0
 
 # Installation
 
-- This program is meant to run inside the chef-client, so to install it, add the following to a Chef recipe and run it:
+- This program is meant to run inside the chef-client. To install it, add the following to a Chef recipe and run it:
+
   ```ruby
   chef_gem 'chef-provisioning-oneview'
   ```
-  
-- To install it on your system Ruby for development purposes:
-  - Install Ruby and the `ruby-devel` or `ruby-dev` package for your system.
-    
-  - Option 1: Require the gem in your Gemfile: `gem 'chef-provisioning-oneview'`, then run `$ bundle install`
-  - Option 2: Run the command: `$ gem install chef-provisioning-oneview`
 
 
-# Prerequisites
-- Set up your `knife.rb` file with the information the driver needs to connect to OneView and Insight Control Server Provisioning
+# Credentials & Configuration
+
+There are a few different ways to provide credentials and configuration for this driver.
+
+- In a recipe using the `with_driver` method:
+  
+  ```ruby
+  # The basic usage is:
+  # with_driver canonical_url, driver_options
+  
+  with_driver 'oneview:https://oneview.example.com', {
+    oneview: {
+      url: 'https://oneview2.example.com' # Will be overridden by the canonical url above
+      user: 'Administrator',
+      password: 'secret123',
+      token: 'token123', # Optional. Use EITHER this or the username & password
+      ssl_enabled: true, # Optional. Defaults to true
+      timeout: 10 # Optional. In seconds
+    },
+    icsp: {
+      url: 'https://icsp.example.com'
+      user: 'Admin',
+      password: 'secret456',
+      ssl_enabled: true, # Optional. Defaults to true
+      timeout: 20 # Optional. In seconds
+    }
+  }
+  ```
+
+- You can also use the following options in your `knife.rb` file:
   
   ```ruby
   # (knife.rb)
   # (in addition to all the normal stuff like node_name, client_key, validation_client_name, validation_key, chef_server_url, etc.)
-  knife[:oneview_url]        = 'https://my-oneview.my-domain.com'
+  knife[:oneview_url]        = 'https://oneview.example.com'
   knife[:oneview_username]   = 'Administrator'
   knife[:oneview_password]   = 'password123'
-  knife[:oneview_ignore_ssl] = true # For self-signed certs
-  knife[:oneview_timeout]    = 10 # Optional. 10 (seconds) is the default
+  knife[:oneview_token]      = 'token123' # Use EITHER this or the username & password
+  knife[:oneview_ignore_ssl] = true # For self-signed certs (discouraged)
+  knife[:oneview_timeout]    = 10 # Optional. In seconds
   
-  knife[:icsp_url]           = 'https://my-icsp.my-domain.com'
+  knife[:icsp_url]           = 'https://icsp.example.com'
   knife[:icsp_username]      = 'Administrator'
   knife[:icsp_password]      = 'password123'
-  knife[:icsp_ignore_ssl]    = true # For self-signed certs
+  knife[:icsp_ignore_ssl]    = true # For self-signed certs (discouraged)
+  knife[:icsp_timeout]       = 20 # Optional. In seconds
   
   knife[:node_root_password] = 'password123'
   
@@ -50,69 +75,84 @@ Currently supports:
   ssl_verify_mode              :verify_none
   ```
 
+- Finally, there are a few environment variables that you can set:
+  
+  ```bash
+  export ONEVIEWSDK_USER='Administrator'
+  export ONEVIEWSDK_PASSWORD='secret123'
+  export ONEVIEWSDK_TOKEN='token123'
+  ```
+
+Since there are a few diferent ways of providing the same config values, here's the order of evaluation:
+  - **OneView URL:** canonical_url (ie `oneview:https://oneview.example.com`), driver_options[:oneview][:url], knife[:oneview_url], ENV['ONEVIEWSDK_URL']
+  - **OneView user, password, & token:** driver_options, knife, environment variable
+  - **ICSP url, user, & password:** driver_options, knife
+
+Note: ICSP is not required, so if you don't want to use it, you can leave out those config options and it will be ignored.
+
+### Additional Setup
+
 - Your OneView, Insight Controll Server Provisioning(ICSP), and Chef server must be trusted by your certificate stores. See [examples/ssl_issues.md](examples/ssl_issues.md) for more info on how to do this.
+  - You can also use the OneView SDK cli tool to import your OneView cert. See [this](https://github.com/HewlettPackard/oneview-sdk-ruby#cli).
 - Your OneView and ICSP servers must be set up beforehand. Unfortunately, this driver doesn't do that for you too.
 
-Note: ICSP is no longer required, so if you don't want to use it, you can leave those config options from your knife.rb.
-
 # Usage
 
 Example recipe:
 ```ruby
 require 'chef/provisioning'
 
-with_driver 'oneview'
-
-with_chef_server "https://my-chef.my-domain.com/organizations/my-org",
-  :client_name => Chef::Config[:node_name],          # NOTE: This must have node & client creation privileges (ie admin group)
-  :signing_key_filename => Chef::Config[:client_key] # NOTE: This must have node & client creation privileges (ie admin group)
+with_driver 'oneview:https://oneview.example.com', {
+  oneview: { user: 'Administrator', password: 'secret123' },
+  icsp: { url: 'https://icsp.example.com' user: 'Admin', password: 'secret456' }
+}
 
 machine 'web01' do
   recipe 'my_server_cookbook::default'
 
-  machine_options :driver_options => {
-      :server_template => 'Web Server Template', # Name of Template OR Server Profile
-      :os_build => 'CHEF-RHEL-6.5-x64', # Name of OS Build Plan on ICSP. Supports array of strings also.
-      :server_location => 'Encl1, bay 16', # Optional. Use to provision a specific server
+  machine_options driver_options: {
+      server_template: 'Web Server Template', # Name of Template OR Server Profile
+      os_build: 'CHEF-RHEL-6.5-x64', # Name of OS Build Plan on ICSP. Supports array of strings also.
+      server_location: 'Encl1, bay 16', # Optional. Use to provision a specific server
       
-      :host_name => 'chef-web01',
-      :ip_address => 'xx.xx.xx.xx', # For bootstrapping. Deprecated in favor of { bootstrap: true } in connection; see below
-      :domainType => 'workgroup',
-      :domainName => 'sub.domain.com',
-      :mask => '255.255.255.0', # Can set here or in individual connections below
-      :dhcp => false, # Can set here or in individual connections below
-      :gateway =>  'xx.xx.xx.1', # Can set here or in individual connections below
-      :dns => 'xx.xx.xx.xx,xx.xx.xx.xx,xx.xx.xx.xx', # Can set here or in individual connections below
-      :connections => {
+      host_name: 'chef-web01',
+      ip_address: 'xx.xx.xx.xx', # For bootstrapping. Deprecated in favor of { bootstrap: true } in connection; see below
+      domainType: 'workgroup',
+      domainName: 'sub.domain.com',
+      mask: '255.255.255.0', # Can set here or in individual connections below
+      dhcp: false, # Can set here or in individual connections below
+      gateway:  'xx.xx.xx.1', # Can set here or in individual connections below
+      dns: 'xx.xx.xx.xx,xx.xx.xx.xx,xx.xx.xx.xx', # Can set here or in individual connections below
+      connections: {
         #1 => { ... } (Reserved for PXE on our setup)
         2 => {
-          :ip4Address => 'xx.xx.xx.xx',
-          :mask => '255.255.254.0', # Optional. Overrides mask property above
-          :dhcp => false            # Optional. Overrides dhcp property above
-          :gateway => 'xx.xx.xx.1'  # Optional. Overrides gateway property above
-          :dns => 'xx.xx.xx.xx'     # Optional. Overrides dns property above
-          :bootstrap => true        # Set this on 1 connection only. Tells Chef which connection to use to bootstrap.
+          ip4Address: 'xx.xx.xx.xx',
+          mask: '255.255.254.0', # Optional. Overrides mask property above
+          dhcp: false            # Optional. Overrides dhcp property above
+          gateway: 'xx.xx.xx.1'  # Optional. Overrides gateway property above
+          dns: 'xx.xx.xx.xx'     # Optional. Overrides dns property above
+          bootstrap: true        # Set this on 1 connection only. Tells Chef which connection to use to bootstrap.
         },
         3 => {
-          :dhcp => true             # Optional. Overrides dhcp property above
-          :gateway => :none         # Optional. Overrides gateway property above
-          :dns => :none             # Optional. Overrides dns property above
+          dhcp: true             # Optional. Overrides dhcp property above
+          gateway: :none         # Optional. Overrides gateway property above
+          dns: :none             # Optional. Overrides dns property above
         }
       },
-      :skip_network_configuration => false, # Default. Set to true for EXSi hosts, etc.
-      :custom_attributes => {
-        :chefCert => 'ssh-rsa AA...' # Optional
+      skip_network_configuration: false, # Default. Set to true for EXSi hosts, etc.
+      custom_attributes: {
+        chefCert: 'ssh-rsa AA...' # Optional
       }
     },
-    :transport_options => {
-      :user => 'root', # Optional. Defaults to 'root'
-      :ssh_options => {
-        :password => Chef::Config.knife[:node_root_password]
+    transport_options: {
+      user: 'root', # Optional. Defaults to 'root'
+      ssh_options: {
+        password: Chef::Config.knife[:node_root_password]
       }
     },
-    :convergence_options => {
-      :ssl_verify_mode => :verify_none, # Optional. For Chef servers with self-signed certs
-      :bootstrap_proxy => 'http://proxy.domain.com:8080' # Optional
+    convergence_options: {
+      ssl_verify_mode: :verify_none, # Optional. For Chef servers with self-signed certs
+      bootstrap_proxy: 'http://proxy.example.com:8080' # Optional
     }
 
   chef_environment '_default'
@@ -125,11 +165,12 @@ See https://github.com/chef/chef-provisioning-ssh for more transport_options.
 NOTE: Some basic connection settings such as :ip4Address and :dhcp are shown in the example recipe, but you can pass in any interface/nic options that exist in the ICsp api for POST requests to /rest/os-deployment-jobs
 
 ### Custom Attributes
+
 Insided the custom attributes hash, you can specify any data that you would like to pass into your ICsp build plan scripts or configuration files. For example, to specify a list of trusted public keys to be placed into the node's .ssh/authorized_keys file, add a custom attribute to the machine resource definition:
 
 ```ruby
-:custom_attributes => {
-  :chefCert => 'ssh-rsa AA...'
+custom_attributes: {
+  chefCert: 'ssh-rsa AA...'
 }
 ```
 
@@ -144,13 +185,14 @@ fi
 ```
 
 ### SSH Keys
+
 To use SSH keys insead of passwords to connect to nodes, you'll need to modify your transport_options to look something like:
 
 ```ruby
-:transport_options => {
-  :ssh_options => {
-    :auth_methods => ['publickey'],
-    :keys => ['~/.ssh/id_rsa']
+transport_options: {
+  ssh_options: {
+    auth_methods: ['publickey'],
+    keys: ['~/.ssh/id_rsa']
   }
 }
 ```
@@ -158,42 +200,54 @@ To use SSH keys insead of passwords to connect to nodes, you'll need to modify y
 You'll also need to put the corresponding public key(s) into the node's authorized_keys file during the OS setup. See the Custom Attributes section above for one way to do this.
 
 ### Behind a proxy
-Add `:bootstrap_proxy => 'http://proxy.domain.com:8080'` to your convergence_options hash.
+
+Add `bootstrap_proxy: 'http://proxy.example.com:8080'` to your convergence_options hash.
 Also, make sure your OS build plans set up the proxy configuration in a post OS install script.
 
 ### SAN Storage
+
 In order to attach a SAN volume as a bootable volume, the volume name must start with 'boot'; it will be appended with the the profile name on creation.
 
 ### Switching to a different network after provisioning
-Add `1 => {:net => "Deadnetwork", :deployNet => "PXE Network", :dhcp => true}` to your connections hash. 
+
+Add `1 => {net: "Deadnetwork", deployNet: "PXE Network", dhcp: true}` to your connections hash. 
 This will flip the first connection of the newly provisioned machine off of your pxe network to your Deadnetwork right after provisioning. This is helpful for taking the newly provisioned machine off the PXE network as soon as possible. 
 
 ### Adding Nic Teams
-Add `:team => 'TeamName'` into a connection in your connections hash. Make sure that you have 2 connections in a team and the name does not include hyphens. This information will be passed to ISCP as the 'teams' custom attribute in the format: `"TeamName1-mac1,mac2|TeamName2-mac6,mac7,mac8"` to be consumed in a custom build plan script.
+
+Add `team: 'TeamName'` into a connection in your connections hash. Make sure that you have 2 connections in a team and the name does not include hyphens. This information will be passed to ISCP as the 'teams' custom attribute in the format: `"TeamName1-mac1,mac2|TeamName2-mac6,mac7,mac8"` to be consumed in a custom build plan script.
 
 # Doing a test run
+
 This repo contains everything you need to get started, including example recipes and knife configuration files. See the README in the [examples](examples/) directory for how to begin provisioning.
 
 
 # Troubleshooting
+
 See the [Trouleshooting wiki page](https://github.com/HewlettPackard/chef-provisioning-oneview/wiki/Troubleshooting)
 
 
 # Contributing
+
 You know the drill. Fork it, branch it, change it, commit it, pull-request it. We're passionate about improving this driver, and glad to accept help to make it better.
 
 ### Building the Gem
+
 To build this gem, run `$ rake build` or `gem build chef-provisioning-oneview.gemspec`.
 
 Then once it's built you can install it by running `$ rake install` or `$ gem install ./chef-provisioning-oneview-<VERSION>.gem`.
 
+Note: You may need to first install the `ruby-devel` or `ruby-dev` package for your system.
+
 ### Testing
+
 - RuboCop: `$ rake rubocop` or `$ rubocop .`
 - Rspec: `$ rake spec` or `$ rspec`
 - Both: Run `$ rake test` to run both RuboCop and Rspec tests.
 
 # Authors
+
  - Jared Smartt - [@jsmartt](https://github.com/jsmartt)
- - Gunjan Kamle - [@kgunjan](https://github.com/kgunjan)
  - Matthew Frahry - [@mbfrahry](https://github.com/mbfrahry)
  - Andy Claiborne - [@veloandy](https://github.com/veloandy)
+ - Gunjan Kamle - [@kgunjan](https://github.com/kgunjan)

data/chef-provisioning-oneview.gemspec

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/lib')
+require 'chef/provisioning/version'
+
+Gem::Specification.new do |s|
+  s.name = 'chef-provisioning-oneview'
+  s.version = Chef::Provisioning::ONEVIEW_DRIVER_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
+  s.summary = 'Chef Provisioning driver for OneView'
+  s.description = 'Chef Provisioning driver for creating and managing OneView infrastructure.'
+  s.author = 'Hewlett Packard Enterprise'
+  s.email = ['jared.smartt@hpe.com', 'gunjan.kamle@hpe.com']
+  s.homepage = 'https://github.com/HewlettPackard/chef-provisioning-oneview'
+  s.license = 'Apache-2.0'
+
+  case RUBY_VERSION
+  when /^2\.0/
+    s.add_dependency 'chef', '~> 12.0', '< 12.9'
+  when /^2\.(1|2\.[01])/
+    s.add_dependency 'chef', '~> 12.0', '< 12.14'
+  else
+    s.add_dependency 'chef', '~> 12.0'
+  end
+  s.add_dependency 'oneview-sdk', '~> 2.1'
+  s.add_dependency 'chef-provisioning', '~> 1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'sinatra'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rubocop', '= 0.40.0'
+  s.add_development_dependency 'pry'
+
+  s.require_path = 'lib'
+
+  all_files = `git ls-files -z`.split("\x0")
+  s.files = Dir['LICENSE', 'README.md', '*.gemspec', 'lib/**/*'].reject { |f| !all_files.include?(f) }
+end

data/lib/chef/provisioning/create_machine.rb

@@ -1,51 +1,48 @@
-module CreateMachine
-  private
-
-  # Chef oneview provisioning
-  def create_machine(action_handler, machine_spec, machine_options)
-    host_name = machine_options[:driver_options][:host_name]
-
-    # Check if profile exists first
-    matching_profiles = rest_api(:oneview, :get, "/rest/server-profiles?filter=name matches '#{host_name}'&sort=name:asc")
-    if matching_profiles['count'] > 0
-      profile = matching_profiles['members'].first
-      return profile
-    end
-
-    # Search for OneView Template by name
-    template = get_oneview_template(machine_options[:driver_options][:server_template])
-
-    # Get first availabe (and compatible) HP OV server blade
-    # If a server_location has been specified, uses that
-    chosen_blade = available_hardware_for_template(template, machine_options[:driver_options][:server_location])
-
-    power_off(action_handler, machine_spec, chosen_blade['uri'])
-
-    # Create new profile instance from template
-    action_handler.perform_action "Initialize creation of server profile for #{machine_spec.name}" do
-      action_handler.report_progress "INFO: Initializing creation of server profile for #{machine_spec.name}"
-
-      # Add name & hardware uri to template
-      template['name'] = host_name
-      template['serverHardwareUri'] = chosen_blade['uri']
-
-      update_san_info(machine_spec, template)
+module OneviewChefProvisioningDriver
+  # Handles allocation of OneView ServerProfile
+  module CreateMachine
+    # Allocate OneView server profile
+    def create_machine(action_handler, machine_name, machine_options)
+      host_name = machine_options[:driver_options][:host_name] || machine_name
+      profile_name = machine_options[:driver_options][:profile_name] || host_name
+
+      # Check if profile exists first
+      matching_profile = OneviewSDK::ServerProfile.find_by(@ov, name: host_name).first
+      return matching_profile if matching_profile
+
+      # Search for OneView Template or Profile by name
+      template_name = machine_options[:driver_options][:server_template]
+      profile = profile_from_template(template_name, profile_name)
+
+      # Get first availabe (and compatible) OneView server blade.
+      # If a server_location has been specified, uses that
+      hw = available_hardware_for_profile(profile, machine_options[:driver_options][:server_location])
+
+      action_handler.perform_action "Power off server #{hw['name']} for machine '#{machine_name}'" do
+        action_handler.report_progress "INFO: Powering off server #{hw['name']} for machine '#{machine_name}'"
+        hw.power_off
+      end
 
-      # Post back to /rest/server-profiles
-      options = { 'body' => template }
-      options['X-API-Version'] = 200 if @current_oneview_api_version >= 200 && template['type'] == 'ServerProfileV5'
-      task = rest_api(:oneview, :post, '/rest/server-profiles', options)
-      task_uri = task['uri']
-      raise "Failed to create OneView server profile #{host_name}. Details: " unless task_uri
-      # Wait for profile to appear
-      60.times do # Wait for up to 5 min
-        matching_profiles = rest_api(:oneview, :get, "/rest/server-profiles?filter=name matches '#{host_name}'&sort=name:asc")
-        return matching_profiles['members'].first if matching_profiles['members'].first
-        print '.'
-        sleep 5
+      # Create new ServerProfile from the template
+      action_handler.perform_action "Create server profile for #{machine_name}" do
+        action_handler.report_progress "INFO: Creating server profile for #{machine_name}"
+        profile.set_server_hardware(hw)
+        update_san_info(machine_name, profile)
+        response = @ov.rest_post(profile.class::BASE_URI, { 'body' => profile.data }, profile.api_version)
+        unless response.code.to_i == 202
+          task = JSON.parse(response.body)
+          raise "Server profile couldn't be created! #{task['taskStatus']}. #{task['taskErrors'].first['message'] rescue nil}"
+        end
+        60.times do # Wait for up to 5 min for profile to appear in OneView
+          return profile if profile.retrieve!
+          task = @ov.response_handler(@ov.rest_get(response.header['location'] || JSON.parse(response.body)['uri']))
+          break if task['taskState'] == 'Error'
+          print '.'
+          sleep 5
+        end
+        raise "Server profile couldn't be created! #{task['taskStatus']}. #{task['taskErrors'].first['message'] rescue nil}"
       end
-      task = rest_api(:oneview, :get, task_uri)
-      raise "Server profile couldn't be created! #{task['taskStatus']}. #{task['taskErrors'].first['message']}"
+      profile
     end
   end
 end