vagrant-zones 0.0.1

data/lib/vagrant-zones/errors.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'vagrant'
+
+module VagrantPlugins
+  module ProviderZone
+    module Errors
+      class VagrantZonesError < Vagrant::Errors::VagrantError
+        error_namespace('vagrant_zones.errors')
+      end
+
+      class SystemVersionIsTooLow < VagrantZonesError
+        error_key(:system_version_too_low)
+      end
+
+      class MissingCompatCheckTool < VagrantZonesError
+        error_key(:missing_compatability_check_tool)
+      end
+
+      class MissingBhyve < VagrantZonesError
+        error_key(:missing_bhyve)
+      end
+
+      class HasNoRootPrivilege < VagrantZonesError
+        error_key(:has_no_root_privilege)
+      end
+
+      class ExecuteError < VagrantZonesError
+        error_key(:execute_error)
+      end
+
+      class TimeoutError < VagrantZonesError
+        error_key(:timeout_error)
+      end
+
+      class VirtualBoxRunningConflictDetected < VagrantZonesError
+        error_key(:virtual_box_running_conflict_detected)
+      end
+
+      class NotYetImplemented < VagrantZonesError
+        error_key(:not_yet_implemented)
+      end
+
+      class TimeoutHalt < VagrantZonesError
+        error_key(:halt_timeout)
+      end
+
+      class InvalidbhyveBrand < VagrantZonesError
+        error_key(:invalidbhyve_brand)
+      end
+
+      class InvalidLXBrand < VagrantZonesError
+        error_key(:invalidLX_brand)
+      end
+
+      class ConsoleFailed < VagrantZonesError
+        error_key(:console_failed_exit)
+      end
+    end
+  end
+end

data/lib/vagrant-zones/executor.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'vagrant/util/busy'
+require 'vagrant/util/subprocess'
+
+module VagrantPlugins
+  module ProviderZone
+    module Executor
+      # This class is used to execute commands as subprocess.
+      class Exec
+        # When we need the command's exit code we should set parameter
+        # exit_code to true, otherwise this method will return executed
+        # command's stdout
+        def execute(exit_code, *cmd, **_opts, &block)
+          # Append in the options for subprocess
+          cmd << { notify: %i[stdout stderr] }
+
+          cmd.unshift('sh', '-c')
+          interrupted = false
+          # Lambda to change interrupted to true
+          int_callback = -> { interrupted = true }
+          result = ::Vagrant::Util::Busy.busy(int_callback) do
+            ::Vagrant::Util::Subprocess.execute(*cmd, &block)
+          end
+          return result.exit_code if exit_code
+
+          result.stderr.gsub!("\r\n", "\n")
+          result.stdout.gsub!("\r\n", "\n")
+          puts "Command Failed: #{cmd}" if result.exit_code != 0 || interrupted
+          puts "Exit Results: #{result.stderr}" if result.exit_code != 0 || interrupted
+          raise Errors::ExecuteError if result.exit_code != 0 || interrupted
+
+          result.stdout[0..-2]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-zones/plugin.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The Vagrant Zones plugin must be run within Vagrant.'
+end
+
+module VagrantPlugins
+  module ProviderZone
+    # This is a the plugin droping for the Vagrant-zones vagrant plugin
+    class Plugin < Vagrant.plugin('2')
+      name 'zone'
+      description <<-DESC
+        This plugin allows vagrant to manage bhyve, lx-branded zones or native zones on
+        OmniOSce or any other illumos based distribution
+      DESC
+
+      config(:zone, :provider) do
+        require_relative 'config'
+        Config
+      end
+      ## Experimental Parallel Execucution
+      ## provider(:zone, parallel: true) do
+      provider(:zone) do
+        require_relative 'provider'
+        Provider
+      end
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path('locales/en.yml', ProviderZone.source_root)
+        I18n.reload!
+      end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require 'log4r'
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV['VAGRANT_LOG'].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil unless level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+
+        return unless level
+
+        logger = Log4r::Logger.new('vagrant_zones')
+        logger.outputters = Log4r::Outputter.stderr
+        logger.level = level
+        logger
+      end
+
+      # Setup logging and i18n before any autoloading loads other classes
+      # with logging configured as this prevents inheritance of the log level
+      # from the parent logger.
+      setup_logging
+      setup_i18n
+
+      ## This setups the zone commands master
+      command('zone') do
+        require_relative 'command/zone'
+        Command::Zone
+      end
+    end
+  end
+end

data/lib/vagrant-zones/provider.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'vagrant'
+require 'log4r'
+
+module VagrantPlugins
+  # This is a module to assist in managing, creating bhyve, kvm, and lx zones
+  module ProviderZone
+    autoload :Driver, 'vagrant-zones/driver'
+    # This is a module to assist in managing, creating bhyve, kvm, and lx zones
+    class Provider < Vagrant.plugin('2', :provider)
+      def initialize(machine)
+        @logger = Log4r::Logger.new('vagrant::provider::zone')
+        @machine = machine
+        super(machine)
+      end
+
+      def driver
+        return @driver if @driver
+
+        @driver = Driver.new(@machine)
+      end
+
+      def ssh_info
+        # We just return nil if were not able to identify the VM's IP and
+        # let Vagrant core deal with it like docker provider does
+        return nil if state.id != :running
+        return nil unless driver.get_ip_address('ssh_info')
+
+        passwordauth = 'passwordauth'
+        ssh_info = {
+          host: driver.get_ip_address('ssh_info'),
+          port: driver.sshport(@machine).to_s,
+          password: driver.vagrantuserpass(@machine).to_s,
+          username: driver.user(@machine),
+          private_key_path: driver.userprivatekeypath(@machine).to_s,
+          PasswordAuthentication: passwordauth
+        }
+        return ssh_info unless ssh_info.nil?
+      end
+
+      # This should return an action callable for the given name.
+      # @param [Symbol] name Name of the action.
+      # @return [Object] A callable action sequence object, whether it
+      #        is a proc, object, etc.
+      def action(name)
+        # Attempt to get the action method from the Action class if it
+        # exists, otherwise return nil to show that we don't support the
+        # given action
+        action_method = "action_#{name}"
+        return Action.send(action_method) if Action.respond_to?(action_method)
+
+        nil
+      end
+
+      # This method is called if the underying machine ID changes. Providers
+      # can use this method to load in new data for the actual backing
+      # machine or to realize that the machine is now gone (the ID can
+      # become `nil`). No parameters are given, since the underlying machine
+      # is simply the machine instance given to this object. And no
+      # return value is necessary.
+      def machine_id_changed
+        nil
+      end
+
+      def state
+        state_id = nil
+        state_id = :not_created unless @machine.id
+        state_id = driver.state(@machine) if @machine.id && !state_id
+        # This is a special pseudo-state so that we don't set the
+        # NOT_CREATED_ID while we're setting up the machine. This avoids
+        # clearing the data dir.
+        state_id = :preparing if @machine.id == 'preparing'
+        # Get the short and long description
+        short = state_id.to_s.tr('_', ' ')
+        # If we're not created, then specify the special ID flag
+        state_id = Vagrant::MachineState::NOT_CREATED_ID if state_id == :not_created
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, short)
+      end
+    end
+  end
+end

data/lib/vagrant-zones/util/subprocess.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'log4r'
+module VagrantPlugins
+  module ProviderZone
+    module Util
+      # This shiny device polishes bared foos
+      class Subprocess
+        def initialize(cmd, &_block)
+          Open3.popen3(cmd) do |_stdin, stdout, stderr, thread|
+            # read each stream from a new thread
+            { :out => stdout, :err => stderr }.each do |key, stream|
+              Thread.new do
+                until (line = stream.gets).nil?
+                  # yield the block depending on the stream
+                  if key == :out
+                    yield line, nil, thread if block_given?
+                  elsif block_given?
+                    yield nil, line, thread
+                  end
+                end
+              end
+            end
+            thread.join # don't exit until the external process is done
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-zones/util/timer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module ProviderZone
+    module Util
+      # This is a utlity to time commands and scripts
+      class Timer
+        # A basic utility method that times the execution of the given
+        # block and returns it.
+        def self.time
+          start_time = Time.now.to_f
+          yield
+          end_time = Time.now.to_f
+          end_time - start_time
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-zones/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module VagrantPlugins
+  module ProviderZone
+    VERSION = '0.0.1'
+  end
+end

data/lib/vagrant-zones.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module VagrantPlugins
+  # This is used to configure, manage, create and destroy zones where vagrant by itself cannot
+  module ProviderZone
+    lib_path = Pathname.new(File.expand_path('vagrant-zones', __dir__))
+    autoload :Action, lib_path.join('action')
+    autoload :Executor, lib_path.join('executor')
+    autoload :Driver, lib_path.join('driver')
+    autoload :Errors, lib_path.join('errors')
+    # This function returns the path to the source of this plugin
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('..', __dir__))
+    end
+  end
+end
+
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The Vagrant vagrant-zones plugin must be run within Vagrant.'
+end
+
+raise 'The Vagrant vagrant-zones plugin is only compatible with Vagrant 2+.' if Vagrant::VERSION < '2'
+
+require 'vagrant-zones/plugin'

data/locales/en.yml

@@ -0,0 +1,326 @@
+en:
+  vagrant_zones:
+    states:
+      not_created: |-
+        Your instance of this box haven't been created
+      is_running: |-
+        Your instance has already be booted
+    errors:
+      not_yet_implemented: |-
+        Your configuration is not yet implemented
+      halt_timeout: |-
+        Zone failed to halt in alloted time after waiting for
+      invalidLX_brand: |-
+        Invalid LX brand configuration detected
+      invalidbhyve_brand: |-
+        Invalid bhyve configuration detected
+      console_failed: |-
+        Failed to access console
+      console_failed_exit: |-
+        Exiting
+      execute_error: |-
+        Failed when execute commands
+      timeout_error: |-
+        Timeout exceeded
+      system_version_too_low: |-
+        Please update to OmniOS r38 or higher
+      missing_compatability_check_tool: |-    
+        Please install the Bhyve compatability tool from: https://omnios.org/info/bhyve
+      missing_bhyve: |-    
+        Your system appears to be missing bhyve
+      virtual_box_running_conflict_detected: |-    
+        Virtualbox Box appears to be running virtual machines, to continue, please shut these down!
+    meeting: |-
+      Beggining the zone creation sequence
+    leaving: |-
+      Beggining the zone destruction sequence
+    halting_zone: |-
+      Halting the zone
+    destroy_zone: |-
+      Starting zone destruction
+    graceful_shutdown_failed: |-
+      Zone failed to shutdown in alloted time ==> 
+    graceful_shutdown: |-
+      Asking hypervisor to gracefully stop the zone
+    creating_vnic: |-
+      - Creating VNIC: 
+    configure_interface_using_vnic: |-
+      - Configuring the interface in the zone for VNIC using netplan: 
+    configure_win_interface_using_vnic: |-
+      - Waiting 60 seconds then configuring the Windows network interface in the zone: 
+    configure_interface_using_vnic_dladm: |-
+      - Configuring the interface in the zone for VNIC using dladm: 
+    os_detect: |-
+      - Detecting Operating System to configure networking: 
+    ansible_detect: |-
+      - Detecting if Ansible is installed: 
+    vnic_setup: |-
+      - Setting up VNIC: 
+    networking_int_remove: |-
+      Removing network devices:
+    networking_int_add: |-
+      - Adding network devices:
+    removing_vnic: |-
+      - Deleting zone VNIC: 
+    no_removing_vnic: |-
+      - No zone VNIC to remove
+    removing_host_vnic: |-
+      - Deleting host VNIC: 
+    no_removing_host_vnic: |-
+      - No host VNIC to remove
+    network_setup: |-
+      Preparing zone OS networking interfaces:
+    delete_disks: |-
+      Removing associated disks:
+    zonelogincmd: |-
+      Running command with zLogin
+    user: |-
+      Filtering the user Vagrant will use
+    installing_zone: |-
+      Installing zone as brand: 
+    netplan_remove: |-
+      - Removing stale netplan configurations
+    netplan_set: |-
+      - Generate fresh netplan configurations
+    dladm_applied: |-
+      - dladm and ipadm configurations Applied
+    dladm_route_applied: |-
+      - Route has been applied
+    dladm_dns_applied: |-
+      - DNS has been applied
+    netplan_applied: |-
+      - New Netplan configurations Applied
+    netplan_applied_dhcp: |-
+      - Set DHCP Netplan configurations  
+    stale_netplan_removed: |-
+      - Stale Netplan configurations removed 
+    netplan_applied_static: |-
+      - Set static Netplan configurations:
+        
+    console_failednetplan: |-
+      Netplan configurations failed  
+    lx_zone_dataset: |-
+      - Creating zoned ZFS dataset for LX zone: 
+    bhyve_zone_dataset_root: |-
+      - ZFS root dataset: 
+    begin_create_datasets: |-
+      Creating ZFS datasets and volumes:
+    bhyve_zone_dataset_boot: |-
+      - ZFS boot volume: 
+    setting_cd_rom_configurations: |-
+      - Setting CDROM Configurations: 
+    setting_additional_disks_configurations: |-
+      - Setting additional disk Configurations: 
+    bhyve_zone_dataset_additional_volume: |-
+      - Additional ZFS volume: 
+    bhyve_zone_dataset_additional_volume_destroy: |-
+      - Additional ZFS volume: 
+    addtl_volume_destroy_root: |-
+      - ZFS root dataset for additional ZFS volume: 
+    bhyve_zone_dataset_additional_volume_root: |-
+      - ZFS root dataset for additional ZFS volume: 
+    destroy_root_dataset: |-
+      - ZFS root dataset: 
+    destroy_dataset: |-
+      - ZFS Boot volume dataset: 
+    lx_zone_config_gen: |-
+      Generating configuration for LX zone
+    bhyve_zone_config_gen: |-
+      Generating zone configuration:
+    bhyve_zone_config_remove: |-
+      Removing zonecfg configuration
+    bhyve_zone_config_uninstall: |-
+      Uninstalling the zone
+    preflight_checks: |-
+      Running Preflight checks:
+    vbox_run_check: |-
+      - Checking if VirtualBox is loaded as it may conflict with bhyve
+    lx_check: |-
+      Minimal checks performed for LX Branded zones on the host OS, please use with caution!
+    bhyve_check: |-
+      - Checking OmniOS release against version:
+    bhyve_compat_check: |-
+      - Checking bhyve installation environment
+    wait_for_boot: |-
+      Waiting for the zone to boot
+    sshport: |-
+      Filtering the SSH port that Vagrant will use
+    vagrantuserpass: |-
+      Filtering the Vagrant user Password
+    firmware: |-
+      Filtering the firmware that bhyve will use
+    inserting_ssh_key: |-
+      Inserting SSH key
+    booted_check_terminal_access: |-
+      Zone booted, checking for login access/prompt over Serial: 
+    terminal_access_auto_login: |-
+      Could not login as root, will attempt to auto-login with supplied credentials:
+    detecting_box: |-
+      Detecting image
+    importing_vagrant_key: |-
+      Importing Vagrant key from Cloud:
+    datadir: |-
+      Vagrant datadir: 
+    zfs_snapshot_stream_detected: |-
+      ZFS Snapshot Stream detected ==> 
+    joyent_image_uuid_detected: |-
+      Joyent UUID detected ==> 
+    vagrant_cloud_box_detected: |-
+      - Vagrant Cloud Box detected: 
+    ssh_ready: |-
+      SSH appears to be ready
+    boot_ready: |-
+      The zone has booted
+    dhcp_boot_ready: |-
+      The zone is configured with NAT and booted
+    root_dataset_nil: |-
+      - No root dataset to remove 
+    boot_dataset_nil: |-
+      - No boot volumes to remove 
+    additional_dataset_nil: |-
+      - No additional volumes to remove
+    starting_zone: |-
+      Starting the zone
+    joyent_image_uuid_verified: |-
+      Joyent image UUID has been verified ==> 
+    lx_zone_dataset: |-
+      LX zone dataset ==> 
+    setting_dns_server: |-
+      Setting nameserver ==> 
+    detected_ovf_format: |-
+      Detected OVF
+    importing_box_image: |-
+      - Importing Box image ==> 
+    importing_box_image_to_disk: |-
+      - Importing Box template to disk ==> 
+    template_import_path: |-
+      - Template path:
+    importing_joyent_image: |-
+      - Importing Joyent image ==> 
+    graceful_restart: |-
+      Zone gracefully restarting
+    graceful_shutdown_started: |-
+      Zone gracefully shutting down
+    graceful_shutdown_complete: |-
+      Graceful shutdown complete
+    zone_gracefully_restarted: |-
+      Graceful restart complete
+    zone_gracefully_stopped_waiting_for_boot: |-
+      Zone gracefully shutdown, now waiting for boot
+    console: |-
+      Starting console:
+    setting_console_access: |-
+      - Setting console access port: 
+    zfs_snapshot_cron: |-
+      Listing configured cron jobs
+    zfs_snapshot_create: |-
+      Creating ZFS snapshot(s):
+    setting_cloud_dnsdomain: |-
+      - Setting cloud-init DNS domain: 
+    setting_cloud_password: |-        
+      - Setting cloud-init password: 
+    setting_cloud_resolvers: |-
+      - Setting cloud-init Resolvers: 
+    setting_cloud_ssh_key: |-
+      - Setting cloud-init SSH key: 
+    setting_cloud_init_access: |-
+      - Enabling cloud-init: 
+    control_no_cmd: |-
+      No control command specified
+    ssh_run_command: |-
+      Running Command over SSH: 
+    vtype: |-
+      Filtering zone type
+    nsservers: |-
+      Sanitizing Name Servers: 
+    mac: |-
+      Sanitizing MAC address: 
+    ipaddress: |-
+      Sanitizing IP address: 
+    allowedaddress: |-
+      Sanitizing Allowed IP address: 
+    vnic_name: |-
+      Sanitizing the VNIC name: 
+    get_ip_address: |-
+      Gathering IP address
+    creating_etherstub: |-
+      - Creating etherstub for private network: 
+    creating_etherhostvnic: |-
+      - Creating NAT VNIC for zone over etherstub: 
+    creating_ethervnic: |-
+      - Creating VNIC for host over etherstub: 
+    creating_networking_interfaces: |-
+      Creating networking interfaces for zone: 
+    nat_vnic_setup: |-
+      - Setting up NAT VNIC: 
+    forwarding_nat: |-
+      - Enabling NAT forwarding:
+    configuring_nat: |-
+      - Creating NAT entries: 
+    deconfiguring_nat: |-
+      - Removing NAT configurations: 
+    configuring_dhcp: |-
+      - Configuring DHCP 
+    deconfiguring_dhcp: |-
+      - Removing DHCP configurations: 
+    chk_dhcp_addr: |-
+      - Checking if zone has leased the address: 
+    setting_alt_shared_disk_configurations: |-
+      Setting shared disk configurations
+    zonecfgcpu: |-
+      Setting the CPU for zone
+    pci: |-
+      Setting the PCI devices for zone
+    zfs_snapshot_list: |-
+      ZFS snapshots detected:
+    zfs_snapshot_destroy: |-
+      Destroying ZFS snapshots for zone:
+    cron_entries: |-
+      Listing cron entries for zone
+    cron_set: |-
+      Setting cron entries for zone
+    cron_delete: |-
+      Deleting cron entries for zone
+    control: |-
+      Running control command on zone:
+    delete_ethervnic: |-
+      - Deleting the etherstub: 
+    no_delete_ethervnic: |-
+      - No etherstub to remove
+    automated-zlogin: |-
+      Automatic Login
+    automated-windows-zlogin: |-
+      Windows SAC Autologin
+    automated-zlogin-user: |-
+      - Entering username, Waiting a few seconds
+    automated-zlogin-pass: |-
+      - Entering password, Waiting a few seconds
+    automated-zbootunlock: |-
+      - Unlocking LUKS Keystore for the boot disk
+    automated-zlogin-root: |-
+      - Impersonatig root, Waiting a few seconds
+    windows_skip_first_boot: |-
+      - Skipping First EVENT for CMD due to Sysprep Reboot
+    windows_start_cmd: |-
+      - Starting CMD session
+    windows_access_session: |-
+      - Accessing Command Session
+    windows_access_session_presskey: |-
+      - Pressing Any Key enter Command Session
+    windows_enter_username: |-
+      - Entering Username
+    windows_enter_domain: |-
+      - Entering/Skipping Domain
+    windows_enter_password: |-
+      - Entering password
+    windows_cmd_accessible: |-
+      - CMD Accessible
+    win_applied_rename_adapter: |-
+      - Renamed Default Adapter
+    win_applied_static: |-
+      - Set Static Address
+    win_applied_dns1: |-
+      - Set Primary DNS
+    win_applied_dns2: |-
+      - Set Secondary DNS        
+