foreman_nutanix 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72f1e26e3c671aaf28a8bac7d0cf5096d806b68f6eb5f0cc0a804f00fc093615
+  data.tar.gz: b7208fcee1fbc1862cb51660450768dcded3667515d26497e82feb277f645c3f
+SHA512:
+  metadata.gz: 7821fc531b943cf9fd9313275250de30f98147e9e7d3b677d5cd1d1162d309c21a0f8f659e32a642c3f03121d0db3ad82745e31c222487634f401611c8a2e966
+  data.tar.gz: 05f0992cc5f62bf0981bfa5b3525f41b880bd8a0553ae14c72e3778769660a926e19b8b15a6920aadd24404a29979364b435d1dc18aada78a8e116603acc41ce

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 NORCE Research
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,32 @@
+# Foreman Nutanix Plugin
+
+Nutanix compute resource plugin for [Foreman](https://theforeman.org/).
+
+## Installation
+
+Add to your Foreman's bundler.d:
+
+```ruby
+# bundler.d/foreman_nutanix.rb
+gem 'foreman_nutanix'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+This plugin requires the [nutanix-shim-server](https://pypi.org/project/nutanix-shim-server/) to be running and accessible.
+
+Set the shim server address:
+
+```bash
+export NUTANIX_SHIM_SERVER_ADDR=http://localhost:8000
+```
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,49 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanNutanix'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue StandardError => _e
+  puts 'Rubocop not loaded.'
+rescue LoadError
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

data/app/assets/javascripts/foreman_nutanix/locale/en/foreman_nutanix.js

@@ -0,0 +1,55 @@
+locales["foreman_nutanix"] = locales["foreman_nutanix"] || {};
+locales["foreman_nutanix"]["en"] = {
+  domain: "foreman_nutanix",
+  locale_data: {
+    foreman_nutanix: {
+      "": {
+        "Project-Id-Version": "foreman_nutanix 1.0.0",
+        "Report-Msgid-Bugs-To": "",
+        "PO-Revision-Date": "2025-02-20 10:11+0100",
+        "Last-Translator": "FULL NAME <EMAIL@ADDRESS>",
+        "Language-Team": "LANGUAGE <LL@li.org>",
+        Language: "",
+        "MIME-Version": "1.0",
+        "Content-Type": "text/plain; charset=UTF-8",
+        "Content-Transfer-Encoding": "8bit",
+        "Plural-Forms": "nplurals=INTEGER; plural=EXPRESSION;",
+        lang: "en",
+        domain: "foreman_nutanix",
+        plural_forms: "nplurals=INTEGER; plural=EXPRESSION;",
+      },
+      Actions: [""],
+      "Associate Ephemeral External IP": [""],
+      "Certificate path, for Nutanix only": [""],
+      "Deprecated, email is automatically loaded from the JSON file. For Nutanix only":
+        [""],
+      "Deprecated, project is automatically loaded from the JSON file. For Nutanix only":
+        [""],
+      "Does this image support user data input (e.g. via cloud-init)?": [""],
+      "nutanix Compute Engine plugin for the Foreman.": [""],
+      Image: [""],
+      "JSON key": [""],
+      "Load Zones": [""],
+      "Machine Type": [""],
+      "Machine type": [""],
+      "Missing an image for operating system!": [""],
+      Name: [""],
+      Network: [""],
+      "Please select an image": [""],
+      Properties: [""],
+      "Size (GB)": [""],
+      State: [""],
+      "The email parameter is deprecated, value is automatically loaded from the JSON file":
+        [""],
+      "The project parameter is deprecated, value is automatically loaded from the JSON file":
+        [""],
+      "The user that is used to ssh into the instance, normally cloud-user, ec2-user, ubuntu, etc. Note: nutanix engine doesn't support SSH for the root user.":
+        [""],
+      Type: [""],
+      Zone: [""],
+      "Zone, for Nutanix only": [""],
+      "console is not available at this time because the instance is powered off":
+        [""],
+    },
+  },
+};

data/app/controllers/concerns/foreman/controller/parameters/compute_resource_extension.rb

@@ -0,0 +1,17 @@
+module Foreman
+  module Controller
+    module Parameters
+      module ComputeResourceExtension
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def compute_resource_params_filter
+            super.tap do |filter|
+              filter.permit :key_path, :zone, :cluster, :host_id
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_nutanix/api/v2/apipie_extensions.rb

@@ -0,0 +1,16 @@
+module ForemanNutanix
+  module Api
+    module V2
+      module ApipieExtensions
+        extend Apipie::DSL::Concern
+
+        update_api(:create, :update) do
+          param :compute_resource, Hash do
+            param :cluster, String, desc: N_('Nutanix cluster UUID')
+            param :zone, String, desc: N_('Zone/availability zone')
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_nutanix/api/v2/compute_resources_extensions.rb

@@ -0,0 +1,29 @@
+module ForemanNutanix
+  module Api
+    module V2
+      module ComputeResourcesExtensions
+        extend ActiveSupport::Concern
+
+        included do
+          before_action :read_key, only: [:create]
+          before_action :deprecated_params, only: [:create]
+        end
+
+        private
+
+        def read_key
+          return unless compute_resource_params['provider'] == 'Nutanix'
+          # Handle key file reading if needed
+          Rails.logger.info "ForemanNutanix: Reading key for Nutanix provider"
+        end
+
+        def deprecated_params
+          return unless compute_resource_params['provider'] == 'Nutanix'
+
+          # Handle deprecated parameters
+          Rails.logger.info "ForemanNutanix: Checking deprecated params for Nutanix provider"
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_nutanix/api/v2/hosts_controller_extensions.rb

@@ -0,0 +1,50 @@
+module ForemanNutanix
+  module Api
+    module V2
+      module HostsControllerExtensions
+        extend ActiveSupport::Concern
+
+        included do
+          # Prepend to override the power_status method
+          prepend PowerStatusOverride
+        end
+
+        module PowerStatusOverride
+          def power_status
+            Rails.logger.info '=== NUTANIX: HostsControllerExtensions::power_status called ==='
+
+            # Check if this host uses a Nutanix compute resource
+            if @host&.compute_resource.is_a?(ForemanNutanix::Nutanix)
+              Rails.logger.info "=== NUTANIX: Host #{@host.name} uses Nutanix compute resource ==="
+
+              # Get the VM and its actual power state
+              vm = @host.compute_resource.find_vm_by_uuid(@host.uuid)
+              if vm
+                state = vm.state
+                Rails.logger.info "=== NUTANIX: VM state is '#{state}' ==="
+
+                # Map to Foreman's expected format
+                case state
+                when 'running'
+                  render json: { id: @host.id, state: 'on', title: 'On', statusText: 'Powered On' }
+                when 'stopped'
+                  render json: { id: @host.id, state: 'off', title: 'Off', statusText: 'Powered Off' }
+                when 'paused'
+                  render json: { id: @host.id, state: 'paused', title: 'Paused', statusText: 'Paused' }
+                else
+                  render json: { id: @host.id, state: 'na', title: 'N/A', statusText: 'Unknown' }
+                end
+              else
+                Rails.logger.warn "=== NUTANIX: VM not found for host #{@host.name} ==="
+                render json: { id: @host.id, state: 'na', title: 'N/A', statusText: 'VM Not Found' }
+              end
+            else
+              # Fall back to default behavior for non-Nutanix hosts
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/lib/foreman_nutanix/nutanix_adapter.rb

@@ -0,0 +1,105 @@
+module ForemanNutanix
+  class NutanixAdapter
+    def initialize(cluster)
+      Rails.logger.info "=== NUTANIX: NutanixAdapter::initialize cluster=#{cluster} ==="
+      @cluster = cluster
+    end
+
+    # Required by Foreman - returns a collection of servers
+    def servers(attrs = {})
+      Rails.logger.info "=== NUTANIX: NutanixAdapter::servers called with attrs: #{attrs} ==="
+      ServersCollection.new(@cluster)
+    end
+
+    # Mock servers collection for Foreman
+    class ServersCollection
+      def initialize(cluster)
+        @cluster = cluster
+      end
+
+      def new(attrs = {})
+        Rails.logger.info "=== NUTANIX: ServersCollection::new called with attrs: #{attrs} ==="
+        # Return the NutanixCompute model that Foreman expects
+        NutanixCompute.new(@cluster, attrs)
+      end
+
+      def get(uuid)
+        Rails.logger.info "=== NUTANIX: ServersCollection::get called with uuid: #{uuid} ==="
+
+        # Extract the actual UUID if it has a prefix
+        actual_uuid = uuid.to_s.include?(':') ? uuid.to_s.split(':').last : uuid.to_s
+
+        # Fetch full VM details from shim server
+        base = ENV['NUTANIX_SHIM_SERVER_ADDR'] || 'http://localhost:8000'
+        uri = URI("#{base.chomp('/')}/api/v1/vmm/vms/#{actual_uuid}")
+        response = Net::HTTP.get_response(uri)
+
+        if response.is_a?(Net::HTTPSuccess)
+          data = JSON.parse(response.body)
+
+          total_cpus = (data['num_sockets'] || 1) * (data['num_cores_per_socket'] || 1)
+          memory_gb = data['memory_size_bytes'] ? (data['memory_size_bytes'].to_f / 1024**3).round : 4
+
+          vm = NutanixCompute.new(@cluster, {
+            identity: data['ext_id'],
+            name: data['name'],
+            cpus: total_cpus,
+            memory: memory_gb,
+            power_state: data['power_state'],
+            mac_address: data['mac_address'],
+            ip_addresses: data['ip_addresses'] || [],
+            create_time: data['create_time'],
+          })
+          vm.instance_variable_set(:@persisted, true)
+          vm
+        elsif response.code == '404'
+          Rails.logger.warn "=== NUTANIX: VM not found (deleted from Nutanix?): #{uuid} ==="
+          # Return nil so Foreman knows the VM doesn't exist
+          nil
+        else
+          Rails.logger.error "=== NUTANIX: ServersCollection::get failed: #{response.code} - #{response.body} ==="
+          nil
+        end
+      rescue StandardError => e
+        Rails.logger.error "=== NUTANIX: ServersCollection::get error: #{e.message} ==="
+        nil
+      end
+
+      def all(opts = {})
+        Rails.logger.info "=== NUTANIX: ServersCollection::all called with opts: #{opts} ==="
+
+        # Fetch VMs from shim server (now includes MAC and IP)
+        base = ENV['NUTANIX_SHIM_SERVER_ADDR'] || 'http://localhost:8000'
+        uri = URI("#{base.chomp('/')}/api/v1/vmm/list-vms")
+        response = Net::HTTP.get_response(uri)
+        data = JSON.parse(response.body)
+
+        # Filter VMs by cluster
+        filtered_data = data.select { |vm| vm['cluster_ext_id'] == @cluster }
+
+        # Convert to NutanixCompute instances
+        filtered_data.map do |vm_data|
+          total_cpus = (vm_data['num_sockets'] || 1) * (vm_data['num_cores_per_socket'] || 1)
+          memory_gb = vm_data['memory_size_bytes'] ? (vm_data['memory_size_bytes'].to_f / 1024**3).round : 4
+
+          vm = NutanixCompute.new(@cluster, {
+            identity: vm_data['ext_id'],
+            name: vm_data['name'],
+            cpus: total_cpus,
+            memory: memory_gb,
+            power_state: vm_data['power_state'],
+            mac_address: vm_data['mac_address'],
+            ip_addresses: vm_data['ip_addresses'] || [],
+            create_time: vm_data['create_time'],
+          })
+          vm.instance_variable_set(:@persisted, true)
+          vm
+        end
+      rescue StandardError => e
+        Rails.logger.error "=== NUTANIX: Error fetching VMs: #{e.message} ==="
+        []
+      end
+    end
+  end
+end
+

data/app/lib/nutanix_compute/compute_collection.rb

@@ -0,0 +1,23 @@
+module NutanixCompute
+  class ComputeCollection
+    include Enumerable
+
+    def initialize(client, zone, attrs = {})
+      instances = client.instances(zone, **attrs)
+      @virtual_machines = instances.map do |vm|
+        ForemanNutanix::NutanixCompute.new client: client,
+          zone: zone,
+          identity: vm.id,
+          instance: vm
+      end
+    end
+
+    def each(&block)
+      @virtual_machines.each(&block)
+    end
+
+    def all(_opts = {})
+      @virtual_machines
+    end
+  end
+end

data/app/lib/nutanix_extensions/attached_disk.rb

@@ -0,0 +1,22 @@
+module NutanixExtensions
+  module AttachedDisk
+    def persisted?
+    end
+
+    def id
+    end
+
+    def _delete
+    end
+
+    def insert_attrs
+      attrs = { name: device_name, size_gb: disk_size_gb }
+      attrs[:source_image] = source if source.present?
+      attrs
+    end
+
+    def size_gb
+      disk_size_gb
+    end
+  end
+end

data/app/models/concerns/foreman_nutanix/host_managed_extensions.rb

@@ -0,0 +1,38 @@
+module ForemanNutanix
+  module HostManagedExtensions
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    def ip_addresses
+      Rails.logger.info "=== NUTANIX: HOST::ip_addresses called, vm: #{vm.inspect} ==="
+      vm&.ip_addresses || ['192.168.1.100', '10.0.0.100']
+    end
+
+    # TODO: Hard-coded should probably be removed
+    def vm_ip_address
+      Rails.logger.info "=== NUTANIX: HOST::vm_ip_address called, vm: #{vm.inspect} ==="
+      vm&.vm_ip_address || '192.168.1.100'
+    end
+
+    # Override provisioning methods to add debugging
+    def provision_method
+      Rails.logger.info '=== NUTANIX: HOST::provision_method called ==='
+      super
+    end
+
+    def build?
+      Rails.logger.info "=== NUTANIX: HOST::build? called, build: #{super} ==="
+      super
+    end
+
+    # Override vm method to add debugging
+    def vm
+      Rails.logger.info "=== NUTANIX: HOST::vm called, compute_resource: #{compute_resource.inspect} ==="
+      Rails.logger.info "=== NUTANIX: HOST::vm uuid: #{uuid} ==="
+      super
+    end
+  end
+end
+