foreman_google 0.0.1 → 1.0.0

data/app/models/foreman_google/google_compute.rb

@@ -1,25 +1,19 @@
+require 'google/apis/compute_v1'
+
 module ForemanGoogle
   class GoogleCompute
-    attr_reader :identity, :name, :hostname, :machine_type, :network_interfaces,
-      :associate_external_ip, :image_id, :disks, :metadata
+    attr_reader :identity, :name, :hostname, :creation_timestamp, :machine_type, :network_interfaces, :volumes,
+      :associate_external_ip, :network, :zone, :zone_name, :image_id, :disks, :metadata
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    def initialize(client:, zone:, identity: nil, args: {})
+    def initialize(client:, zone:, identity: nil, instance: nil, args: {})
       @client = client
       @zone = zone
       @identity = identity
+      @instance = instance
 
-      @name = parameterize_name(args[:name])
-      @hostname = @name
-      @machine_type = args[:machine_type]
-      @network_interfaces = construct_network(args[:network] || 'default', args[:associate_external_ip] || '0', args[:network_interfaces] || [])
-      @image_id = args[:image_id]
-      @disks = load_disks(args[:image_id], args[:volumes])
-      @metadata = construct_metadata(args[:user_data])
-
-      identity && load
+      load if identity && instance.nil?
+      load_attributes(args)
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def persisted?
       !!identity
@@ -38,8 +32,9 @@ module ForemanGoogle
     # @returns [String] one of PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED
     # if nil, instance is not persisted as VM on GCE
     def status
-      persisted? && instance.status
+      persisted? && @instance.status
     end
+    alias_method :state, :status
 
     def start
       raise Foreman::Exception('unable to start machine that is not persisted') unless persisted?
@@ -52,76 +47,91 @@ module ForemanGoogle
     end
 
     def to_s
+      @name
     end
 
     def interfaces
       @network_interfaces
     end
 
-    def interfaces_attributes=(attrs)
+    def create_volumes
+      @volumes.each do |vol|
+        @client.insert_disk(@zone, vol.insert_attrs)
+        wait_for { @client.disk(@zone, vol.device_name).status == 'READY' }
+      end
     end
 
-    def volumes
-      @disks
+    def destroy_volumes
+      @volumes.each do |volume|
+        @client.delete_disk(@zone, volume.device_name)
+      end
     end
 
-    private
+    def create_instance
+      args = GoogleCloudCompute::ComputeAttributes.new(@client).for_create(self)
+      @client.insert_instance(@zone, args)
+    end
 
-    def instance
-      return unless identity
-      @instance || load
+    def set_disk_auto_delete
+      @client.set_disk_auto_delete(@zone, @name)
     end
 
-    def load
-      @instance = @client.instance(@zone.split('/').last, identity)
+    def pretty_machine_type
+      return @machine_type unless @instance
+      @instance.machine_type.split('/').last
     end
 
-    def parameterize_name(name)
-      name&.parameterize || "foreman_#{Time.now.to_i}"
+    def vm_description
+      pretty_machine_type
     end
 
-    def construct_network(network_name, associate_external_ip, network_interfaces)
-      # handle network_interface for external ip
-      # assign  ephemeral external IP address using associate_external_ip
-      if ActiveModel::Type::Boolean.new.cast(associate_external_ip)
-        network_interfaces = [{ network: 'global/networks/default' }] if network_interfaces.empty?
-        access_config = { name: 'External NAT', type: 'ONE_TO_ONE_NAT' }
+    def vm_ip_address
+      return if @instance.network_interfaces.empty?
 
-        # Note - no support for external_ip from foreman
-        # access_config[:nat_ip] = external_ip if external_ip
-        network_interfaces[0][:access_configs] = [access_config]
-        return network_interfaces
-      end
+      @instance.network_interfaces.first.access_configs.first&.nat_i_p
+    end
+    alias_method :public_ip_address, :vm_ip_address
+
+    def private_ip_address
+      return unless @instance.network_interfaces.any?
 
-      network = "https://compute.googleapis.com/compute/v1/projects/#{@client.project_id}/global/networks/#{network_name}"
-      [{ network: network }]
+      @instance.network_interfaces.first.network_i_p
     end
 
-    def load_image(image_id)
-      return unless image_id
+    def pretty_image_name
+      return unless @instance.disks.any?
+
+      disk_name = @instance.disks.first.source.split('/').last
+      image_name = @client.disk(@zone_name, disk_name).source_image
 
-      image = @client.images.find { |img| img.id == image_id.to_i }
-      raise ::Foreman::Exception, N_('selected image does not exist') if image.nil?
-      image
+      image_name.split('/').last
     end
 
-    def load_disks(image_id, volumes = [])
-      return [] if volumes.empty?
-      image = load_image(image_id)
+    def volumes_attributes=(_attrs)
+    end
 
-      volumes.first[:source_image] = image.name if image
-      # TODO: Is OpenStruct enough to replace Fog::Compute::Google::Disk
-      #       or do we need our own class?
-      volumes.map.with_index do |vol_attrs, i|
-        OpenStruct.new(**vol_attrs.merge(name: "#{@name}-disk#{i + 1}"))
-      end
+    def serial_port_output
+      @client.serial_port_output(@zone, @identity)&.contents
+    end
+
+    def ip_addresses
+      [vm_ip_address, private_ip_address]
+    end
+
+    def wait_for(&block)
+      @client.wait_for(&block)
+    end
+
+    private
+
+    def load
+      @instance = @client.instance(@zone.split('/').last, identity)
     end
 
-    # Note - GCE only supports cloud-init for Container Optimized images and
-    # for custom images with cloud-init setup
-    def construct_metadata(user_data)
-      return if user_data.blank?
-      { items: [{ key: 'user-data', value: user_data }] }
+    def load_attributes(args_for_new)
+      klass = GoogleCloudCompute::ComputeAttributes.new(@client)
+      attrs = @instance ? klass.for_instance(@instance) : klass.for_new(args_for_new)
+      attrs.each { |name, value| instance_variable_set("@#{name}", value) }
     end
   end
 end

data/app/views/compute_resources/form/_gce.html.erb

@@ -0,0 +1,10 @@
+<%= http_proxy_field f %>
+
+<%= textarea_f f, :password, :label => _("JSON key"),
+              :help_inline => file_field(:password, :json, accept: "application/JSON", onchange: 'tfm.gce.jsonLoader(this)'),
+              :id => 'gce_json', :class => 'col-md-8' %>
+
+<% zones = f.object.zones rescue [] %>
+
+<%= selectable_f(f, :zone, zones, {}, {:label => _('Zone'), :disabled => zones.empty?,
+                 :help_inline_permanent => load_button_f(f, zones.any?, _("Load Zones")) }) %>

data/app/views/compute_resources_vms/form/gce/_base.html.erb

@@ -0,0 +1,18 @@
+<%= select_f f, :machine_type, compute_resource.machine_types, :name, :name,
+			{ :selected => f.object.pretty_machine_type },
+			{ :label => _('Machine type'), :label_size => "col-md-2" } %>
+
+<% if controller_name != "compute_attributes" %>
+	<%
+	  arch ||= nil ; os ||= nil
+	  images = possible_images(compute_resource, arch, os)
+	%>
+	<div id='image_selection'>
+	  <%= select_f f, :image_id, images, :uuid, :name,
+	               { :include_blank => (images.empty? || images.size == 1) ? false : _('Please select an image') },
+	               { :disabled => images.empty?, :label => _('Image'), :label_size => "col-md-2" } %>
+	</div>
+<% end %>
+
+<%= selectable_f f, :network, compute_resource.networks, {}, :label => _('Network'), :label_size => "col-md-2" %>
+<%= checkbox_f f, :associate_external_ip, :label => _('Associate Ephemeral External IP'), :label_size => "col-md-2" %>

data/app/views/compute_resources_vms/form/gce/_volume.html.erb

@@ -0,0 +1,5 @@
+<%
+  # For backwards compatibility, Fog has :size_gb, Google has :disk_size_gb
+  field_name = f.object.class == Google::Cloud::Compute::V1::AttachedDisk ? :disk_size_gb : :size_gb
+%>
+<%= text_f f, field_name, class: "col-md-2", label: _("Size (GB)"), label_size: "col-md-2", onchange: 'tfm.computeResource.capacityEdit(this)' %>

data/app/views/compute_resources_vms/index/_gce.html.erb

@@ -0,0 +1,26 @@
+<thead>
+  <tr>
+    <th><%= _('Name') %></th>
+    <th><%= _('Type') %></th>
+    <th><%= _('State') %></th>
+    <th><%= _('Actions') %></th>
+  </tr>
+</thead>
+<tbody>
+  <% @vms.each do |vm| %>
+    <%
+      view_path = hash_for_compute_resource_vm_path(compute_resource_id: @compute_resource, id: vm.identity).merge(auth_object: @compute_resource.id, auth_action: 'view', authorizer: authorizer)
+      delete_link = display_delete_if_authorized(hash_for_compute_resource_vm_path(compute_resource_id: @compute_resource, id: vm.identity).merge(auth_object: @compute_resource, authorizer: authorizer))
+    %>
+    <tr>
+      <td><%= link_to_if_authorized vm.name, view_path %></td>
+      <td><%= vm.pretty_machine_type %></td>
+      <td><%= vm.status.downcase %></td>
+      <td>
+        <%= action_buttons(vm_power_action(vm, authorizer),
+                           vm_import_action(vm),vm_associate_link(vm),
+                           delete_link) %>
+      </td>
+    </tr>
+  <% end %>
+</tbody>

data/app/views/compute_resources_vms/show/_gce.html.erb

@@ -0,0 +1,21 @@
+<% title @vm.name %>
+
+<div class='col-md-12'>
+  <table class="<%= table_css_classes %>">
+    <thead>
+      <tr><th colspan="2"><%=_("Properties") %></th></tr>
+    </thead>
+    <tbody>
+      <%= prop :state %>
+      <%= prop :pretty_machine_type, _("Machine Type") %>
+      <%= prop :zone_name, _("Zone") %>
+      <tr>
+        <td>Created</td>
+        <td><%= date_time_relative(@vm.creation_timestamp) %></td>
+      </tr>
+      <%= prop :private_ip_address %>
+      <%= prop :public_ip_address %>
+      <%= prop :pretty_image_name, _("Image") %>
+    </tbody>
+  </table>
+</div>

data/app/views/images/form/_gce.html.erb

@@ -0,0 +1,3 @@
+<%= text_f f, :username, :value => @image.username || "user", :help_inline => _("The user that is used to ssh into the instance, normally cloud-user, ec2-user, ubuntu, etc. Note: Google engine doesn't support SSH for the root user.") %>
+<%= image_field(f) %>
+<%= checkbox_f f, :user_data, :help_inline => _("Does this image support user data input (e.g. via cloud-init)?") %>

data/db/migrate/20220331113745_foreman_gce_to_foreman_google_gce.rb

@@ -0,0 +1,24 @@
+# rubocop:disable Metrics/MethodLength
+class ForemanGceToForemanGoogleGce < ActiveRecord::Migration[6.0]
+  def up
+    User.without_auditing do
+      original_type = 'Foreman::Model::GCE'
+      new_type = 'ForemanGoogle::GCE'
+
+      # First update the type to avoid error:
+      # ActiveRecord::SubclassNotFound: The single-table inheritance
+      # mechanism failed to locate the subclass: 'Foreman::Model::GCE'
+      ComputeResource.unscoped.where(type: original_type).update_all(type: new_type)
+
+      ComputeResource.unscoped.where(type: new_type).each do |cr|
+        unless cr.attrs[:key_path]
+          say("Compute resource [#{cr.name}] is missing path to JSON key file, can't load the data. Please update the resource manually.")
+          next
+        end
+        json_data = File.read(cr.attrs[:key_path])
+        cr.update(password: json_data)
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/MethodLength

data/lib/foreman_google/engine.rb

@@ -12,7 +12,8 @@ module ForemanGoogle
 
     initializer 'foreman_google.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_google do
-        requires_foreman '>= 2.4.0'
+        requires_foreman '>= 3.5.0'
+        register_global_js_file 'global'
 
         in_to_prepare do
           compute_resource(ForemanGoogle::GCE)
@@ -22,7 +23,14 @@ module ForemanGoogle
 
     # Include concerns in this config.to_prepare block
     config.to_prepare do
-      ::ComputeResourcesController.include ForemanGoogle::TemporaryPrependPath
+      require 'google/cloud/compute/v1'
+
+      ::Host::Managed.include ForemanGoogle::HostManagedExtensions
+      ::Api::V2::ComputeResourcesController.include ForemanGoogle::Api::V2::ComputeResourcesExtensions
+      ::Api::V2::ComputeResourcesController.include ForemanGoogle::Api::V2::ApipieExtensions
+      ::Api::V2::ComputeResourcesController.include Foreman::Controller::Parameters::ComputeResourceExtension
+      ::ComputeResourcesController.include Foreman::Controller::Parameters::ComputeResourceExtension
+      Google::Cloud::Compute::V1::AttachedDisk.include GoogleExtensions::AttachedDisk
     rescue StandardError => e
       Rails.logger.warn "ForemanGoogle: skipping engine hook (#{e})"
     end

data/lib/foreman_google/version.rb

@@ -1,3 +1,3 @@
 module ForemanGoogle
-  VERSION = '0.0.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/locale/action_names.rb

@@ -0,0 +1,6 @@
+# Autogenerated!
+_('Preupgrade job')
+_('Action with sub plans')
+_('Import facts')
+_('Import Puppet classes')
+_('Remote action:')

data/locale/en/foreman_google.edit.po

@@ -0,0 +1,116 @@
+# foreman_google
+#
+# This file is distributed under the same license as foreman_google.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: 2014-08-20 08:54+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: ../app/models/foreman_google/gce.rb:126
+msgid "console is not available at this time because the instance is powered off"
+msgstr ""
+
+#: ../app/models/foreman_google/gce.rb:170
+msgid "Missing an image for operating system!"
+msgstr ""
+
+#: ../app/views/compute_resources/form/_gce.html.erb:3
+msgid "JSON key"
+msgstr ""
+
+#: ../app/views/compute_resources/form/_gce.html.erb:9 ../app/views/compute_resources_vms/show/_gce.html.erb:11
+msgid "Zone"
+msgstr ""
+
+#: ../app/views/compute_resources/form/_gce.html.erb:10
+msgid "Load Zones"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/form/gce/_base.html.erb:3
+msgid "Machine type"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/form/gce/_base.html.erb:12
+msgid "Please select an image"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/form/gce/_base.html.erb:13 ../app/views/compute_resources_vms/show/_gce.html.erb:18
+msgid "Image"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/form/gce/_base.html.erb:17
+msgid "Network"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/form/gce/_base.html.erb:18
+msgid "Associate Ephemeral External IP"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/form/gce/_volume.html.erb:5
+msgid "Size (GB)"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/index/_gce.html.erb:3
+msgid "Name"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/index/_gce.html.erb:4
+msgid "Type"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/index/_gce.html.erb:5
+msgid "State"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/index/_gce.html.erb:6
+msgid "Actions"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/show/_gce.html.erb:6
+msgid "Properties"
+msgstr ""
+
+#: ../app/views/compute_resources_vms/show/_gce.html.erb:10
+msgid "Machine Type"
+msgstr ""
+
+#: ../app/views/images/form/_gce.html.erb:1
+msgid "The user that is used to ssh into the instance, normally cloud-user, ec2-user, ubuntu, etc. Note: Google engine doesn't support SSH for the root user."
+msgstr ""
+
+#: ../app/views/images/form/_gce.html.erb:3
+msgid "Does this image support user data input (e.g. via cloud-init)?"
+msgstr ""
+
+#: action_names.rb:2
+msgid "Preupgrade job"
+msgstr ""
+
+#: action_names.rb:3
+msgid "Action with sub plans"
+msgstr ""
+
+#: action_names.rb:4
+msgid "Import facts"
+msgstr ""
+
+#: action_names.rb:5
+msgid "Import Puppet classes"
+msgstr ""
+
+#: action_names.rb:6
+msgid "Remote action:"
+msgstr ""
+
+#: gemspec.rb:2
+msgid "Google Compute Engine plugin for the Foreman."
+msgstr ""

data/locale/en/foreman_google.po

@@ -2,12 +2,10 @@
 #
 # This file is distributed under the same license as foreman_google.
 #
-#, fuzzy
 msgid ""
 msgstr ""
 "Project-Id-Version: version 0.0.1\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2014-08-20 08:46+0100\n"
 "PO-Revision-Date: 2014-08-20 08:54+0100\n"
 "Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
 "Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
@@ -17,3 +15,77 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
+msgid "Action with sub plans"
+msgstr ""
+
+msgid "Actions"
+msgstr ""
+
+msgid "Associate Ephemeral External IP"
+msgstr ""
+
+msgid "Does this image support user data input (e.g. via cloud-init)?"
+msgstr ""
+
+msgid "Google Compute Engine plugin for the Foreman."
+msgstr ""
+
+msgid "Image"
+msgstr ""
+
+msgid "Import Puppet classes"
+msgstr ""
+
+msgid "Import facts"
+msgstr ""
+
+msgid "JSON key"
+msgstr ""
+
+msgid "Load Zones"
+msgstr ""
+
+msgid "Machine Type"
+msgstr ""
+
+msgid "Machine type"
+msgstr ""
+
+msgid "Missing an image for operating system!"
+msgstr ""
+
+msgid "Name"
+msgstr ""
+
+msgid "Network"
+msgstr ""
+
+msgid "Please select an image"
+msgstr ""
+
+msgid "Preupgrade job"
+msgstr ""
+
+msgid "Properties"
+msgstr ""
+
+msgid "Remote action:"
+msgstr ""
+
+msgid "Size (GB)"
+msgstr ""
+
+msgid "State"
+msgstr ""
+
+msgid "The user that is used to ssh into the instance, normally cloud-user, ec2-user, ubuntu, etc. Note: Google engine doesn't support SSH for the root user."
+msgstr ""
+
+msgid "Type"
+msgstr ""
+
+msgid "Zone"
+msgstr ""
+
+msgid "console is not available at this time because the instance is powered off"
+msgstr ""