vagrant-google 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ed6ee3d8610c741c80fb0a023922309c396ba06f
-  data.tar.gz: e5110f3de87fad8d872150e38e371f560e65993c
+SHA256:
+  metadata.gz: 22135d118cd7749f09bab503e584dce947d56ce3dbe1fe7d43624be1d8edd9bf
+  data.tar.gz: 4d4e3e45565c5a3ce26494ba5942000d404791a46045a990b866ebd401cb4d1a
 SHA512:
-  metadata.gz: caa68543e38fa5432182179df747283e5182fd303edca1dae9f1c3581805182c4d46711d438a13c2d68e090774b10eae95e544ad181e9d29e793d448dcb8e17d
-  data.tar.gz: 4c8e2dac09fa2c02ee3dba1f9cc9e74ca4c89488d85221e6d682ebb5044711f303c5031eff61c2e74506c2316d7bbfbbfebbe797758a78ba75ea9e6a3f36b94f
+  metadata.gz: ed1cb603bd11da1e6d402490e3a92cc683e2c1060a7982c2809b39fa86200ec62a5921791df6c954e45482918b84531d4df8437c3da368b99df717ac2dfac03f
+  data.tar.gz: fbe0d8f7cb29a6d386cb7d501c3057acf426f390c93146c6acfe23274cc83a422c44a09bf1119c8295f0b92547e79d2e9477cca3e0a9aab1ba3543aa093bbb15

data/.rubocop.yml

@@ -1,5 +1,4 @@
-# Importing TODO list to sanely lint new submissions.
-inherit_from: .rubocop_todo.yml
+require: rubocop-performance
 
 # Custom project config
 AllCops:
@@ -7,11 +6,20 @@ AllCops:
   - './Vagrantfile'
   - './vagrant-google.gemspec'
 
-Style/EmptyLinesAroundBlockBody:
+Layout/EmptyLinesAroundBlockBody:
   Enabled: false
 
 Style/StringLiterals:
   Enabled: false
 
 Style/IfUnlessModifier:
-  Enabled: false
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+
+Style/HashSyntax:
+  EnforcedStyle: no_mixed_keys

data/.ruby-version

@@ -1,2 +1,2 @@
-2.4.3
-# Tracking Vagrant 2.0.3
+2.6.6
+# Tracking Vagrant 2.2.9

data/CHANGELOG.md

@@ -2,6 +2,34 @@
 All notable changes to this project will be documented in this file.
 The format is loosely based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## Next
+
+
+### User-facing
+
+#### Added
+
+- \#248 Add support for modifying the configuration of Shielded VM [lcy0321]
+- \#244 Add accelerator (GPU) configuration [johanvdhaegen]
+- \#216 Add support for Windows hosts through WinRM [dvanbrug]
+
+#### Fixed
+
+- \#246 Fix config override during metadata merge [mavin]
+- \#249 Fix shielded API failures on non-shielded VM's [temikus]
+- \#227 Fix additional disks being auto-deleted unless a disk type is specified [chrisgavin]
+
+### Development
+
+#### Fixed
+
+- \#247 chore: Update Gemfile with new `vagrant-spec` branch name [mavin]
+- \#241 Fix unfortunate CI `on:` trigger typo [temikus]
+- \#240 Update development environment, add CI functionality [Temikus]
+- \#239 Remove old fixup in Gemfile [Temikus]
+- \#237 Bump image size for test skeleton [Temikus]
+
+
 ## 2.5.0 (September 2019)
 
 ### User-facing

data/Gemfile

@@ -24,8 +24,6 @@ group :development do
   # gem dependency because we expect to be installed within the
   # Vagrant environment itself using `vagrant plugin`.
 
-  # TODO(temikus): remove to 2.2.4 tag lock when
-  # https://github.com/hashicorp/vagrant/pull/10945 is resolved
-  gem 'vagrant', git: "https://github.com/hashicorp/vagrant.git", :tag => 'v2.2.4'
-  gem 'vagrant-spec', git: "https://github.com/hashicorp/vagrant-spec.git"
+  gem 'vagrant', git: "https://github.com/hashicorp/vagrant.git"
+  gem 'vagrant-spec', git: "https://github.com/hashicorp/vagrant-spec.git", branch: "main"
 end

data/README.md

@@ -16,7 +16,7 @@ The maintainers for this plugin are @temikus(primary), @erjohnso(backup).
 * Boot Google Compute Engine instances.
 * SSH into the instances.
 * Provision the instances with any built-in Vagrant provisioner.
-* Synced folder support via Vagrant's 
+* Synced folder support via Vagrant's
 [rsync action](https://www.vagrantup.com/docs/synced-folders/rsync.html).
 * Define zone-specific configurations so Vagrant can manage machines in
   multiple zones.
@@ -73,8 +73,8 @@ Service Account for API Access.
 ## Quick Start
 
 After installing the plugin (instructions above), the quickest way to get
-started is to actually use a dummy Google box from Atlas and specify all the 
-details manually within a `config.vm.provider` block. 
+started is to actually use a dummy Google box from Atlas and specify all the
+details manually within a `config.vm.provider` block.
 
 So first, make a Vagrantfile that looks like the following, filling in
 your information where necessary:
@@ -86,9 +86,9 @@ Vagrant.configure("2") do |config|
   config.vm.provider :google do |google, override|
     google.google_project_id = "YOUR_GOOGLE_CLOUD_PROJECT_ID"
     google.google_json_key_location = "/path/to/your/private-key.json"
-    
+
     google.image_family = 'ubuntu-1604-lts'
-    
+
     override.ssh.username = "USERNAME"
     override.ssh.private_key_path = "~/.ssh/id_rsa"
     #override.ssh.private_key_path = "~/.ssh/google_compute_engine"
@@ -99,10 +99,10 @@ end
 
 And then run `vagrant up --provider=google`.
 
-This will start a latest version of Ubuntu 16.04 LTS instance in the 
-`us-central1-f` zone, with an `n1-standard-1` machine, and the `"default"` 
-network within your project. And assuming your SSH information (see below) was 
-filled in properly within your Vagrantfile, SSH and provisioning will work as 
+This will start a latest version of Ubuntu 16.04 LTS instance in the
+`us-central1-f` zone, with an `n1-standard-1` machine, and the `"default"`
+network within your project. And assuming your SSH information (see below) was
+filled in properly within your Vagrantfile, SSH and provisioning will work as
 well.
 
 Note that normally a lot of this boilerplate is encoded within the box file,
@@ -165,13 +165,13 @@ configuration for this provider.
 This provider exposes quite a few provider-specific configuration options:
 
 * `google_json_key_location` - The location of the JSON private key file matching your
-  Service Account.  
+  Service Account.
   (Can also be configured with `GOOGLE_JSON_KEY_LOCATION` environment variable.)
-* `google_project_id` - The Project ID for your Google Cloud Platform account.  
+* `google_project_id` - The Project ID for your Google Cloud Platform account.
   (Can also be configured with `GOOGLE_PROJECT_ID` environment variable.)
 * `image` - The image name to use when booting your instance.
-* `image_family` - Specify an "image family" to pull the latest image from. For example: `centos-7` 
-will pull the most recent CentOS 7 image. For more info, refer to 
+* `image_family` - Specify an "image family" to pull the latest image from. For example: `centos-7`
+will pull the most recent CentOS 7 image. For more info, refer to
 [Google Image documentation](https://cloud.google.com/compute/docs/images#image_families).
 * `image_project_id` - The ID of the GCP project to search for the `image` or `image_family`.
 * `instance_group` - Unmanaged instance group to add the machine to. If one
@@ -206,20 +206,36 @@ will pull the most recent CentOS 7 image. For more info, refer to
   utility aliases, for example:
   `['storage-full', 'bigquery', 'https://www.googleapis.com/auth/compute']`.
 * `service_account` - The IAM service account email to use for the instance.
-* `additional_disks` - An array of additional disk configurations. `disk_size` is default to `10`GB; 
-  `disk_name` is default to `name` + "-additional-disk-#{index}"; `disk_type` is default to `pd-standard`; 
+* `additional_disks` - An array of additional disk configurations. `disk_size` is default to `10`GB;
+  `disk_name` is default to `name` + "-additional-disk-#{index}"; `disk_type` is default to `pd-standard`;
   `autodelete_disk` is default to `true`. Here is an example of configuration.
-```ruby
-  [{
-   :image_family => "google-image-family",
-   :image => nil,
-   :image_project_id => "google-project-id",
-   :disk_size => 20,
-   :disk_name => "google-additional-disk-0",
-   :disk_type => "pd-standard",
-   :autodelete_disk => true
+  ```ruby
+    [{
+     :image_family => "google-image-family",
+     :image => nil,
+     :image_project_id => "google-project-id",
+     :disk_size => 20,
+     :disk_name => "google-additional-disk-0",
+     :disk_type => "pd-standard",
+     :autodelete_disk => true
+    }]
+  ```
+* `accelerators` - An array of accelerator configurations. `type` is the
+  accelerator type (e.g. `nvidia-tesla-k80`); `count` is the number of
+  accelerators and defaults to 1. Note that only `TERMINATE` is supported for
+  `on_host_maintenance`; this should be set explicitly, since the default is
+  `MIGRATE`.
+  ```ruby
+  google.accelerators = [{
+    :type => "nvidia-tesla-k80",
+    :count => 2
   }]
-```
+
+  google.on_host_maintenance = "TERMINATE"
+  ```
+* `enable_secure_boot` - For [Shielded VM](https://cloud.google.com/security/shielded-cloud/shielded-vm), whether to enable Secure Boot.
+* `enable_vtpm` - For [Shielded VM](https://cloud.google.com/security/shielded-cloud/shielded-vm), whether to enable vTPM.
+* `enable_integrity_monitoring` - For [Shielded VM](https://cloud.google.com/security/shielded-cloud/shielded-vm), whether to enable Integrity monitoring.
 
 These can be set like typical provider-specific configuration:
 
@@ -280,7 +296,7 @@ emit a warning, but will otherwise boot the GCE machine.
 ## Synced Folders
 
 Since plugin version 2.0, this is implemented via built-in `SyncedFolders` action.
-See Vagrant's [rsync action](https://www.vagrantup.com/docs/synced-folders/rsync.html) 
+See Vagrant's [rsync action](https://www.vagrantup.com/docs/synced-folders/rsync.html)
 documentation for more info.
 
 ## Development

data/lib/vagrant-google/action.rb

@@ -82,6 +82,15 @@ module VagrantPlugins
         end
       end
 
+      # This action is called to setup the Windows user/password on the machine.
+      def self.action_setup_winrm_password
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectGoogle
+          b.use SetupWinrmPassword
+        end
+      end
+
       # This action is called to read the state of the machine. The
       # resulting state is expected to be put into the `:machine_state_id`
       # key.
@@ -182,6 +191,7 @@ module VagrantPlugins
       autoload :MessageNotCreated, action_root.join("message_not_created")
       autoload :MessageWillNotDestroy, action_root.join("message_will_not_destroy")
       autoload :ReadSSHInfo, action_root.join("read_ssh_info")
+      autoload :SetupWinrmPassword, action_root.join('setup_winrm_password')
       autoload :ReadState, action_root.join("read_state")
       autoload :RunInstance, action_root.join("run_instance")
       autoload :StartInstance, action_root.join("start_instance")

data/lib/vagrant-google/action/run_instance.rb

@@ -14,6 +14,7 @@
 require "log4r"
 require 'vagrant/util/retryable'
 require 'vagrant-google/util/timer'
+require 'vagrant-google/action/setup_winrm_password'
 
 module VagrantPlugins
   module Google
@@ -41,65 +42,73 @@ module VagrantPlugins
           zone = env[:machine].provider_config.zone
 
           # Get the configs
-          zone_config            = env[:machine].provider_config.get_zone_config(zone)
-          image                  = zone_config.image
-          image_family           = zone_config.image_family
-          image_project_id       = zone_config.image_project_id
-          instance_group         = zone_config.instance_group
-          name                   = zone_config.name
-          machine_type           = zone_config.machine_type
-          disk_size              = zone_config.disk_size
-          disk_name              = zone_config.disk_name
-          disk_type              = zone_config.disk_type
-          network                = zone_config.network
-          network_project_id     = zone_config.network_project_id
-          subnetwork             = zone_config.subnetwork
-          metadata               = zone_config.metadata
-          labels                 = zone_config.labels
-          tags                   = zone_config.tags
-          can_ip_forward         = zone_config.can_ip_forward
-          use_private_ip         = zone_config.use_private_ip
-          external_ip            = zone_config.external_ip
-          network_ip             = zone_config.network_ip
-          preemptible            = zone_config.preemptible
-          auto_restart           = zone_config.auto_restart
-          on_host_maintenance    = zone_config.on_host_maintenance
-          autodelete_disk        = zone_config.autodelete_disk
-          service_account_scopes = zone_config.scopes
-          service_account        = zone_config.service_account
-          project_id             = zone_config.google_project_id
-          additional_disks       = zone_config.additional_disks
+          zone_config                 = env[:machine].provider_config.get_zone_config(zone)
+          image                       = zone_config.image
+          image_family                = zone_config.image_family
+          image_project_id            = zone_config.image_project_id
+          instance_group              = zone_config.instance_group
+          name                        = zone_config.name
+          machine_type                = zone_config.machine_type
+          disk_size                   = zone_config.disk_size
+          disk_name                   = zone_config.disk_name
+          disk_type                   = zone_config.disk_type
+          network                     = zone_config.network
+          network_project_id          = zone_config.network_project_id
+          subnetwork                  = zone_config.subnetwork
+          metadata                    = zone_config.metadata
+          labels                      = zone_config.labels
+          tags                        = zone_config.tags
+          can_ip_forward              = zone_config.can_ip_forward
+          use_private_ip              = zone_config.use_private_ip
+          external_ip                 = zone_config.external_ip
+          network_ip                  = zone_config.network_ip
+          preemptible                 = zone_config.preemptible
+          auto_restart                = zone_config.auto_restart
+          on_host_maintenance         = zone_config.on_host_maintenance
+          autodelete_disk             = zone_config.autodelete_disk
+          service_account_scopes      = zone_config.scopes
+          service_account             = zone_config.service_account
+          project_id                  = zone_config.google_project_id
+          additional_disks            = zone_config.additional_disks
+          accelerators                = zone_config.accelerators
+          enable_secure_boot          = zone_config.enable_secure_boot
+          enable_vtpm                 = zone_config.enable_vtpm
+          enable_integrity_monitoring = zone_config.enable_integrity_monitoring
 
           # Launch!
           env[:ui].info(I18n.t("vagrant_google.launching_instance"))
-          env[:ui].info(" -- Name:            #{name}")
-          env[:ui].info(" -- Project:         #{project_id}")
-          env[:ui].info(" -- Type:            #{machine_type}")
-          env[:ui].info(" -- Disk type:       #{disk_type}")
-          env[:ui].info(" -- Disk size:       #{disk_size} GB")
-          env[:ui].info(" -- Disk name:       #{disk_name}")
-          env[:ui].info(" -- Image:           #{image}")
-          env[:ui].info(" -- Image family:    #{image_family}")
-          env[:ui].info(" -- Image Project:   #{image_project_id}") if image_project_id
-          env[:ui].info(" -- Instance Group:  #{instance_group}")
-          env[:ui].info(" -- Zone:            #{zone}") if zone
-          env[:ui].info(" -- Network:         #{network}") if network
-          env[:ui].info(" -- Network Project: #{network_project_id}") if network_project_id
-          env[:ui].info(" -- Subnetwork:      #{subnetwork}") if subnetwork
-          env[:ui].info(" -- Metadata:        '#{metadata}'")
-          env[:ui].info(" -- Labels:          '#{labels}'")
-          env[:ui].info(" -- Network tags:    '#{tags}'")
-          env[:ui].info(" -- IP Forward:      #{can_ip_forward}")
-          env[:ui].info(" -- Use private IP:  #{use_private_ip}")
-          env[:ui].info(" -- External IP:     #{external_ip}")
-          env[:ui].info(" -- Network IP:      #{network_ip}")
-          env[:ui].info(" -- Preemptible:     #{preemptible}")
-          env[:ui].info(" -- Auto Restart:    #{auto_restart}")
-          env[:ui].info(" -- On Maintenance:  #{on_host_maintenance}")
-          env[:ui].info(" -- Autodelete Disk: #{autodelete_disk}")
-          env[:ui].info(" -- Scopes:          #{service_account_scopes}") if service_account_scopes
-          env[:ui].info(" -- Service Account: #{service_account}") if service_account
-          env[:ui].info(" -- Additional Disks:#{additional_disks}")
+          env[:ui].info(" -- Name:                 #{name}")
+          env[:ui].info(" -- Project:              #{project_id}")
+          env[:ui].info(" -- Type:                 #{machine_type}")
+          env[:ui].info(" -- Disk type:            #{disk_type}")
+          env[:ui].info(" -- Disk size:            #{disk_size} GB")
+          env[:ui].info(" -- Disk name:            #{disk_name}")
+          env[:ui].info(" -- Image:                #{image}")
+          env[:ui].info(" -- Image family:         #{image_family}")
+          env[:ui].info(" -- Image Project:        #{image_project_id}") if image_project_id
+          env[:ui].info(" -- Instance Group:       #{instance_group}")
+          env[:ui].info(" -- Zone:                 #{zone}") if zone
+          env[:ui].info(" -- Network:              #{network}") if network
+          env[:ui].info(" -- Network Project:      #{network_project_id}") if network_project_id
+          env[:ui].info(" -- Subnetwork:           #{subnetwork}") if subnetwork
+          env[:ui].info(" -- Metadata:             '#{metadata}'")
+          env[:ui].info(" -- Labels:               '#{labels}'")
+          env[:ui].info(" -- Network tags:         '#{tags}'")
+          env[:ui].info(" -- IP Forward:           #{can_ip_forward}")
+          env[:ui].info(" -- Use private IP:       #{use_private_ip}")
+          env[:ui].info(" -- External IP:          #{external_ip}")
+          env[:ui].info(" -- Network IP:           #{network_ip}")
+          env[:ui].info(" -- Preemptible:          #{preemptible}")
+          env[:ui].info(" -- Auto Restart:         #{auto_restart}")
+          env[:ui].info(" -- On Maintenance:       #{on_host_maintenance}")
+          env[:ui].info(" -- Autodelete Disk:      #{autodelete_disk}")
+          env[:ui].info(" -- Scopes:               #{service_account_scopes}") if service_account_scopes
+          env[:ui].info(" -- Service Account:      #{service_account}") if service_account
+          env[:ui].info(" -- Additional Disks:     #{additional_disks}")
+          env[:ui].info(" -- Accelerators:         #{accelerators}")
+          env[:ui].info(" -- Secure Boot:          #{enable_secure_boot}") if enable_secure_boot
+          env[:ui].info(" -- vTPM:                 #{enable_vtpm}") if enable_vtpm
+          env[:ui].info(" -- Integrity Monitoring: #{enable_integrity_monitoring}") if enable_integrity_monitoring
 
           # Munge image config
           if image_family
@@ -129,6 +138,21 @@ module VagrantPlugins
           # Munge service_accounts / scopes config
           service_accounts = [ { :email => service_account, :scopes => service_account_scopes } ]
 
+          # Construct accelerator URLs
+          accelerators_url = []
+          accelerators.each do |accelerator|
+            unless accelerator.key?(:type)
+              next
+            end
+            accelerator_type = "https://compute.googleapis.com/compute/v1/projects/#{project_id}/zones/#{zone}/acceleratorTypes/#{accelerator[:type]}"
+            accelerator_count = accelerator.fetch(:count, 1)
+            accelerators_url.push({ :accelerator_type => accelerator_type,
+                                    :accelerator_count => accelerator_count })
+          end
+
+          # Munge shieldedInstance config
+          shielded_instance_config = { :enable_secure_boot => enable_secure_boot, :enable_vtpm => enable_vtpm, :enable_integrity_monitoring => enable_integrity_monitoring }
+
           begin
             request_start_time = Time.now.to_i
             disk = nil
@@ -201,7 +225,7 @@ module VagrantPlugins
 
               # Get additional disk auto delete
               additional_disk_auto_delete = nil
-              if disk_config[:disk_type].nil?
+              if disk_config[:autodelete_disk].nil?
                 # Default auto delete to true
                 additional_disk_auto_delete = true
               else
@@ -243,24 +267,33 @@ module VagrantPlugins
             end
 
             defaults = {
-              :name                => name,
-              :zone                => zone,
-              :machine_type        => machine_type,
-              :disk_size           => disk_size,
-              :disk_type           => disk_type,
-              :image               => image,
-              :network_interfaces  => network_interfaces,
-              :metadata            => { :items => metadata.each.map { |k, v| {:key => k.to_s, :value => v.to_s} } },
-              :labels              => labels,
-              :tags                => { :items => tags },
-              :can_ip_forward      => can_ip_forward,
-              :use_private_ip      => use_private_ip,
-              :external_ip         => external_ip,
-              :network_ip          => network_ip,
-              :disks               => disks,
-              :scheduling          => scheduling,
-              :service_accounts    => service_accounts
+              :name               => name,
+              :zone               => zone,
+              :machine_type       => machine_type,
+              :disk_size          => disk_size,
+              :disk_type          => disk_type,
+              :image              => image,
+              :network_interfaces => network_interfaces,
+              :metadata           => { :items => metadata.each.map { |k, v| { :key => k.to_s, :value => v.to_s } } },
+              :labels             => labels,
+              :tags               => { :items => tags },
+              :can_ip_forward     => can_ip_forward,
+              :use_private_ip     => use_private_ip,
+              :external_ip        => external_ip,
+              :network_ip         => network_ip,
+              :disks              => disks,
+              :scheduling         => scheduling,
+              :service_accounts   => service_accounts,
+              :guest_accelerators => accelerators_url
             }
+
+            # XXX HACK - only add  of the parameters are set in :shielded_instance_config we need to drop the field from
+            # the API call otherwise we'll error out with Google::Apis::ClientError
+            # TODO(temikus): Remove if the API changes, see internal GOOG ref: b/175063371
+            if shielded_instance_config.has_value?(true)
+              defaults[:shielded_instance_config] = shielded_instance_config
+            end
+
             server = env[:google_compute].servers.create(defaults)
             @logger.info("Machine '#{zone}:#{name}' created.")
           rescue *FOG_ERRORS => e
@@ -287,10 +320,26 @@ module VagrantPlugins
             env[:interrupted] = true
           end
 
+          # Parse out the image project in case it was not set
+          # and check if it is part of a public windows project
+          img_project = image.split("/")[6]
+          is_windows_image = img_project.eql?("windows-cloud") || img_project.eql?("windows-sql-cloud")
+
+          # Reset the password if a windows image unless flag overrides
+          setup_winrm_password = zone_config.setup_winrm_password
+          if setup_winrm_password.nil? && is_windows_image
+            setup_winrm_password = true
+          end
+
+          if setup_winrm_password
+            env[:ui].info("Setting up WinRM Password")
+            env[:action_runner].run(Action.action_setup_winrm_password, env)
+          end
+
           unless env[:terminated]
-            env[:metrics]["instance_ssh_time"] = Util::Timer.time do
-              # Wait for SSH to be ready.
-              env[:ui].info(I18n.t("vagrant_google.waiting_for_ssh"))
+            env[:metrics]["instance_comm_time"] = Util::Timer.time do
+              # Wait for Comms to be ready.
+              env[:ui].info(I18n.t("vagrant_google.waiting_for_comm"))
               while true
                 # If we're interrupted just back out
                 break if env[:interrupted]
@@ -298,8 +347,8 @@ module VagrantPlugins
                 sleep 2
               end
             end
-            @logger.info("Time for SSH ready: #{env[:metrics]["instance_ssh_time"]}")
-            env[:ui].info(I18n.t("vagrant_google.ready_ssh")) unless env[:interrupted]
+            @logger.info("Time for Comms ready: #{env[:metrics]["instance_comm_time"]}")
+            env[:ui].info(I18n.t("vagrant_google.ready_comm")) unless env[:interrupted]
           end
 
           # Terminate the instance if we were interrupted