vmpooler-provider-gce 0.1.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1f22f8c5aea6e2a9f2a6cb2d635c3433ccb90c983919d3a33b30a41cb1ab80a
-  data.tar.gz: 84310c0950ebf6ba4fd87457e8750aaf689a64eb6b79f4c1490878294e27785a
+  metadata.gz: d84f2dc8dd84470083c1f6d7b87b8c4d213d9d1ed1dca1558fbdf02ef8553bf8
+  data.tar.gz: dac3ab9c8105b1dda22c61f787d5a2e0f7bf1cdee25998a130c1e286dfdca19c
 SHA512:
-  metadata.gz: 24d390125d902e57a1ef0b48e53b207b386e97cb0439f8a411cf0a9eb64b754ce31842c96fa66a51601590e47e4548613844dac3d8515e22068713c10795c128
-  data.tar.gz: 8f9166867e5258c310c8b1f2ab0e2d51bb32d2d93dff85b4b96e5a69dc9d8ae8adc07c769ad1e3987019b03a94552e3709cdfc3952596b01a6344436a460fad9
+  metadata.gz: 857d5925f6a618b75f90fde55265366804455cbc126bf6395e2d0d5f7e17a10c40f1901ddb3e900ba93024b684b185e34ded7d13cb11b46b3e81ada5657be244
+  data.tar.gz: 6c8681ed0c3b8cf9df4b5726fee60756cba2d0c9919421f0fc2eaf898f4e45fb8ecab23d5bfcd82b69e455bfaf7e3a3a8cb3fbab3e6bb1eb31e5826d0ad9e7db

data/lib/vmpooler/cloud_dns.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'googleauth'
+require 'google/cloud/dns'
+
+module Vmpooler
+  class PoolManager
+    # This class interacts with GCP Cloud DNS to create or delete records.
+    class CloudDns
+      def initialize(project, dns_zone_resource_name)
+        @dns = Google::Cloud::Dns.new(project_id: project)
+        @dns_zone_resource_name = dns_zone_resource_name
+      end
+
+      def dns_create_or_replace(created_instance)
+        dns_zone = @dns.zone(@dns_zone_resource_name) if @dns_zone_resource_name
+        return unless dns_zone && created_instance && created_instance['name'] && created_instance['ip']
+
+        retries = 0
+        name = created_instance['name']
+        begin
+          change = dns_zone.add(name, 'A', 60, [created_instance['ip']])
+          debug_logger("#{change.id} - #{change.started_at} - #{change.status} DNS address added") if change
+        rescue Google::Cloud::AlreadyExistsError => _e
+          # DNS setup is done only for new instances, so in the rare case where a DNS record already exists (it is stale) and we replace it.
+          # the error is Google::Cloud::AlreadyExistsError: alreadyExists: The resource 'entity.change.additions[0]' named 'instance-8.test.vmpooler.net. (A)' already exists
+          change = dns_zone.replace(name, 'A', 60, [created_instance['ip']])
+          debug_logger("#{change.id} - #{change.started_at} - #{change.status} DNS address previously existed and was replaced") if change
+        rescue Google::Cloud::FailedPreconditionError => e
+          # this error was experienced intermittently, will retry to see if it can complete successfully
+          # the error is Google::Cloud::FailedPreconditionError: conditionNotMet: Precondition not met for 'entity.change.deletions[0]'
+          debug_logger("DNS create failed, retrying error: #{e}")
+          sleep 5
+          retry if (retries += 1) < 30
+        end
+      end
+
+      def dns_teardown(created_instance)
+        dns_zone = @dns.zone(@dns_zone_resource_name) if @dns_zone_resource_name
+        return unless dns_zone && created_instance
+
+        retries = 0
+        name = created_instance['name']
+        change = dns_zone.remove(name, 'A')
+        debug_logger("#{change.id} - #{change.started_at} - #{change.status} DNS address removed") if change
+      rescue Google::Cloud::FailedPreconditionError => e
+        # this error was experienced intermittently, will retry to see if it can complete successfully
+        # the error is Google::Cloud::FailedPreconditionError: conditionNotMet: Precondition not met for 'entity.change.deletions[1]'
+        debug_logger("DNS teardown failed, retrying error: #{e}")
+        sleep 5
+        retry if (retries += 1) < 30
+      end
+
+      # used in local dev environment, set DEBUG_FLAG=true
+      # this way the upstream vmpooler manager does not get polluted with logs
+      def debug_logger(message, send_to_upstream: false)
+        # the default logger is simple and does not enforce debug levels (the first argument)
+        puts message if ENV['DEBUG_FLAG']
+        logger.log('[g]', message) if send_to_upstream
+      end
+    end
+  end
+end

data/lib/vmpooler/providers/gce.rb

@@ -2,7 +2,7 @@
 
 require 'googleauth'
 require 'google/apis/compute_v1'
-require 'google/cloud/dns'
+require 'vmpooler/cloud_dns'
 require 'bigdecimal'
 require 'bigdecimal/util'
 require 'vmpooler/providers/base'
@@ -58,11 +58,6 @@ module Vmpooler
           end
         end
 
-        def dns
-          @dns ||= Google::Cloud::Dns.new(project_id: project)
-          @dns
-        end
-
         # main configuration options
         def project
           provider_config['project']
@@ -181,19 +176,28 @@ module Vmpooler
             network: network_name
           )
           network_interfaces.subnetwork = subnetwork_name(pool_name) if subnetwork_name(pool_name)
-          init_params = {
+          init_params = Google::Apis::ComputeV1::AttachedDiskInitializeParams.new(
             source_image: pool['template'], # The source image to create this disk.
             labels: { 'vm' => new_vmname, 'pool' => pool_name },
             disk_name: "#{new_vmname}-disk0"
-          }
+          )
+          # rubocop:disable Style/IfUnlessModifier
+          if pool['disk_type'] && !pool['disk_type'].empty?
+            init_params.disk_type = "https://www.googleapis.com/compute/v1/projects/#{project}/zones/#{zone(pool_name)}/diskTypes/#{pool['disk_type']}"
+          end
+          # rubocop:enable Style/IfUnlessModifier
           disk = Google::Apis::ComputeV1::AttachedDisk.new(
             auto_delete: true,
             boot: true,
-            initialize_params: Google::Apis::ComputeV1::AttachedDiskInitializeParams.new(init_params)
+            initialize_params: init_params
           )
+          append_domain = domain || global_config[:config]['domain']
+          fqdn = "#{new_vmname}.#{append_domain}" if append_domain
+
           # Assume all pool config is valid i.e. not missing
           client = ::Google::Apis::ComputeV1::Instance.new(
             name: new_vmname,
+            hostname: fqdn,
             machine_type: pool['machine_type'],
             disks: [disk],
             network_interfaces: [network_interfaces],
@@ -557,28 +561,13 @@ module Vmpooler
         # END BASE METHODS
 
         def dns_setup(created_instance)
-          dns_zone = dns.zone(dns_zone_resource_name) if dns_zone_resource_name
-          return unless dns_zone && created_instance && created_instance['name'] && created_instance['ip']
-
-          name = created_instance['name']
-          begin
-            change = dns_zone.add(name, 'A', 60, [created_instance['ip']])
-            debug_logger("#{change.id} - #{change.started_at} - #{change.status} DNS address added") if change
-          rescue Google::Cloud::AlreadyExistsError => _e
-            # DNS setup is done only for new instances, so in the rare case where a DNS record already exists (it is stale) and we replace it.
-            # the error is Google::Cloud::AlreadyExistsError: alreadyExists: The resource 'entity.change.additions[0]' named 'instance-8.test.vmpooler.net. (A)' already exists
-            change = dns_zone.replace(name, 'A', 60, [created_instance['ip']])
-            debug_logger("#{change.id} - #{change.started_at} - #{change.status} DNS address previously existed and was replaced") if change
-          end
+          dns = Vmpooler::PoolManager::CloudDns.new(project, dns_zone_resource_name)
+          dns.dns_create_or_replace(created_instance)
         end
 
         def dns_teardown(created_instance)
-          dns_zone = dns.zone(dns_zone_resource_name) if dns_zone_resource_name
-          return unless dns_zone && created_instance
-
-          name = created_instance['name']
-          change = dns_zone.remove(name, 'A')
-          debug_logger("#{change.id} - #{change.started_at} - #{change.status} DNS address removed") if change
+          dns = Vmpooler::PoolManager::CloudDns.new(project, dns_zone_resource_name)
+          dns.dns_teardown(created_instance)
         end
 
         def should_be_ignored(item, allowlist)

data/lib/vmpooler-provider-gce/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VmpoolerProviderGce
-  VERSION = '0.1.2'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,177 +1,182 @@
 --- !ruby/object:Gem::Specification
 name: vmpooler-provider-gce
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Puppet
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: google-apis-compute_v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
-  type: :runtime
+  name: google-apis-compute_v1
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
 - !ruby/object:Gem::Dependency
-  name: googleauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.16.2
-  type: :runtime
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  name: googleauth
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.16.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: google-cloud-dns
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.35.1
-  type: :runtime
+  name: google-cloud-dns
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.35.1
 - !ruby/object:Gem::Dependency
-  name: vmpooler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
-  type: :development
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  name: vmpooler
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
-  type: :development
+  name: climate_control
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: mock_redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.17.0
-  type: :development
+  name: mock_redis
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.17.0
 - !ruby/object:Gem::Dependency
-  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: pry
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
-  type: :development
+  name: rack-test
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-  type: :development
+  name: rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
-  type: :development
+  name: rubocop
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.2
-  type: :development
+  name: simplecov
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.2
 - !ruby/object:Gem::Dependency
-  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -180,8 +185,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
-  type: :development
+  name: thor
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -191,20 +197,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: yarjuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :development
+  name: yarjuf
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - support@puppet.com
 executables: []
@@ -212,12 +218,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/vmpooler-provider-gce/version.rb
+- lib/vmpooler/cloud_dns.rb
 - lib/vmpooler/providers/gce.rb
 homepage: https://github.com/puppetlabs/vmpooler-provider-gce
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -232,9 +239,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.2.29
+signing_key:
 specification_version: 4
 summary: GCE provider for VMPooler
 test_files: []