vagrant-lxd 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37988b3901f0e99417203fbab0b8c532e631f0c4
-  data.tar.gz: c39bdfa2e6e7912cd5dc3cad36600bc6d98ff51d
+  metadata.gz: fef7b1d0ba6f86c3f621e843abe99b6bfcda266f
+  data.tar.gz: 2de77f085615f775deff08f65a10bdd584182647
 SHA512:
-  metadata.gz: 1c14feb0f9522935357fe750329e288697bb8dc226218aeeebec74baa8e78afc36689a3972db637db9fa0e507e594dcfc9ae8df0c68a25550ee6359e536f6d35
-  data.tar.gz: 68cb1f0440026627051a5754e64857b25a78dc5d7a0d155c798304af8676efff555a5e226e01be3daa6d4d258e0d64856fa6195070c8a8366004df987bade911
+  metadata.gz: cc3718c25b56973c47858ad5bc7711a23d0ba1a9ae43b9ab55f42dbf10cd2e67d4730948e92dbcb1e0eddbff595eabc815e4dfd952235766a1d8bb5e69c3dca7
+  data.tar.gz: c87aa4c96a58bf9162124a6fa910cabeb9ab29c17726ef4403a88a11ec74ff9f11124f49e39ebe13bdcaae38da71427cfcaa31267c3717dc882f5385edc8a9d0

data/Gemfile.lock

@@ -27,13 +27,13 @@ GIT
 PATH
   remote: .
   specs:
-    vagrant-lxd (0.4.0)
+    vagrant-lxd (0.4.1)
       hyperkit (~> 1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)

data/README.md

@@ -191,7 +191,7 @@ In order to run Linux containers on an LXD-backed machine, it must be
 created with the `nesting` and `privileged` properties set to `true`.
 These correspond to the `security.nesting` and `security.privileged`
 configuration items for LXD, respectively. Refer to LXD's [container
-configuration documentation][docs] for details.
+configuration documentation][containers] for details.
 
     config.vm.provider 'lxd' do |lxd|
       lxd.nesting = true
@@ -202,7 +202,38 @@ Note that enabling these options will invalidate any user and group ID
 mappings you may have configured for synced folders, since privileged
 containers use the same UID and GID space as the host machine.
 
-[docs]: https://lxd.readthedocs.io/en/latest/containers/
+[containers]: https://lxd.readthedocs.io/en/latest/containers/
+
+### Adding Devices
+
+You can attach arbitrary devices to the container with the `devices`
+setting. This should be a map of device names to configuration hashes,
+where the hash keys and values are valid [device configuration
+settings][device-config].
+
+For example, the following configuration uses a `proxy` device to
+forward local X11 traffic from the container to the host, allowing you
+to run graphical applications transparently from within the guest:
+
+    # e.g. vagrant ssh -c 'DISPLAY=:0 firefox'
+    config.vm.provider 'lxd' do |lxd|
+      lxd.devices = {
+        x11: {
+          type: 'proxy',
+          mode: '0777',
+          bind: 'container',
+          listen: 'unix:/tmp/.X11-unix/X0',
+          connect: 'unix:/tmp/.X11-unix/X0',
+          'security.uid': Process.uid.to_s,
+          'security.gid': Process.gid.to_s,
+        }
+      }
+    end
+
+Note that disk devices should be configured as [synced
+folders](#synced-folders) rather than ad-hoc devices.
+
+[device-config]: https://lxd.readthedocs.io/en/latest/containers/#device-configuration
 
 ## Hacking
 

data/lib/vagrant-lxd/action.rb

@@ -227,6 +227,7 @@ module VagrantLXD
               c.use SetHostname
               c.use SyncedFolders
               c.use LXD.action(:resume)
+              c.use LXD.action(:reconnect)
               c.use WaitForCommunicator
             else
               c.use Message, :error, "Machine cannot be resumed while #{env[:machine_state]}."

data/lib/vagrant-lxd/config.rb

@@ -26,6 +26,7 @@ module VagrantLXD
     attr_accessor :name
     attr_accessor :timeout
     attr_accessor :config
+    attr_accessor :devices
     attr_accessor :environment
     attr_accessor :ephemeral
     attr_accessor :nesting
@@ -40,6 +41,7 @@ module VagrantLXD
       @name = UNSET_VALUE
       @timeout = UNSET_VALUE
       @config = UNSET_VALUE
+      @devices = UNSET_VALUE
       @environment = UNSET_VALUE
       @nesting = UNSET_VALUE
       @privileged = UNSET_VALUE
@@ -74,15 +76,27 @@ module VagrantLXD
       if not config.is_a? Hash
         errors << "Invalid `config' (value must be a hash): #{config.inspect}"
       elsif not config.keys.all? { |x| x.is_a? Symbol }
-        errors << "Invalid `config' (hash keys must be symbols): #{config.inspect}"
+        errors << "Invalid `config' (keys must be symbols): #{config.inspect}"
+      end
+
+      if not devices.is_a? Hash
+        errors << "Invalid `devices' (value must be a hash): #{devices.inspect}"
+      elsif not devices.keys.all? { |x| x.is_a? String or x.is_a? Symbol }
+        errors << "Invalid `devices' (keys must be strings or symbols): #{devices.inspect}"
+      elsif devices.keys.any? { |x| x =~ /^(.*([^a-z0-9.\-_]).*)$/ }
+        errors << "Invalid `devices' (device name `#{$1}' contains invalid character '#{$2}'): #{devices.inspect}"
+      elsif not devices.values.all? { |x| x.is_a? Hash }
+        errors << "Invalid `devices' (values must be hashes): #{devices.inspect}"
+      elsif not devices.values.map(&:values).flatten.all? { |x| x.is_a? String }
+        errors << "Invalid `devices' (device value must be strings): #{devices.inspect}"
       end
 
       if not environment.is_a? Hash
         errors << "Invalid `environment' (value must be a hash): #{environment.inspect}"
       elsif not environment.keys.all? { |x| x.is_a? String or x.is_a? Symbol }
-        errors << "Invalid `environment' (hash keys must be strings or symbols): #{environment.inspect}"
+        errors << "Invalid `environment' (keys must be strings or symbols): #{environment.inspect}"
       elsif not environment.values.all? { |x| x.is_a? String }
-        errors << "Invalid `environment' (hash values must be strings): #{environment.inspect}"
+        errors << "Invalid `environment' (values must be strings): #{environment.inspect}"
       end
 
       begin
@@ -151,6 +165,10 @@ module VagrantLXD
         @config = {}
       end
 
+      if devices == UNSET_VALUE
+        @devices = {}
+      end
+
       if environment == UNSET_VALUE
         @environment = {}
       end

data/lib/vagrant-lxd/driver.rb

@@ -18,6 +18,7 @@
 #
 
 require 'active_support/core_ext/object/deep_dup'
+require 'active_support/core_ext/hash/except'
 require 'hyperkit'
 require 'securerandom'
 require 'tempfile'
@@ -112,11 +113,21 @@ module VagrantLXD
       end
     end
 
+    module Hyperkit::Client::Containers
+      alias extract_container_options_without_devices extract_container_options
+
+      def extract_container_options(name, options)
+        opts = extract_container_options_without_devices(name, options)
+        options.slice(:devices).merge(opts)
+      end
+    end
+
     NOT_CREATED = Vagrant::MachineState::NOT_CREATED_ID
 
     attr_reader :api_endpoint
     attr_reader :name
     attr_reader :timeout
+    attr_reader :devices
     attr_reader :environment
     attr_reader :ephemeral
     attr_reader :nesting
@@ -131,7 +142,8 @@ module VagrantLXD
       @machine = machine
       @timeout = machine.provider_config.timeout
       @api_endpoint = machine.provider_config.api_endpoint
-      @config = @machine.provider_config.config
+      @config = machine.provider_config.config
+      @devices = machine.provider_config.devices
       @environment = machine.provider_config.environment
       @nesting = machine.provider_config.nesting
       @privileged = machine.provider_config.privileged
@@ -187,9 +199,7 @@ module VagrantLXD
 
     def unmount(name, options)
       container = lxd.container(machine_id)
-      devices = container[:devices].to_hash
-      devices.delete(name.to_sym)
-      container[:devices] = devices
+      container[:devices] = container[:devices].to_hash.except(name.to_sym)
       lxd.update_container(machine_id, container)
     rescue Hyperkit::BadRequest => e
       @machine.ui.error 'Failed to unmount synced folder'
@@ -271,7 +281,7 @@ module VagrantLXD
           end
         end
 
-        container = lxd.create_container(machine_id, ephemeral: ephemeral, fingerprint: fingerprint, config: config, profiles: profiles)
+        container = lxd.create_container(machine_id, devices: devices, ephemeral: ephemeral, fingerprint: fingerprint, config: config, profiles: profiles)
         @logger.debug 'Created container: ' << container.inspect
 
         @machine.id = machine_id
@@ -334,12 +344,42 @@ module VagrantLXD
     def configure
       container = lxd.container(machine_id)
       container[:config] = container[:config].to_hash.merge(config)
+      container[:devices] = container[:devices].to_hash.merge(devices)
       lxd.update_container(machine_id, container)
     rescue Hyperkit::Error => e
       @machine.ui.error 'Failed to configure container'
       fail ContainerConfigurationFailure, machine_name: @machine.name, reason: e.reason
     end
 
+    # When a container is restarted, the `forkproxy` processes that manage
+    # its proxy devices will persist but will not reliably recreate
+    # container-side listeners for devices that are configured with
+    # "bind=container". Removing and re-creating the devices forces the
+    # proxy processes to be recreated, ensuring the listeners are as well.
+    def reconnect
+      # select proxy devices
+      container = lxd.container(machine_id)
+      devices = container[:devices].to_hash
+      proxies = devices.select { |_, d| d[:type] == 'proxy' }
+
+      # bail if there's nothing to do
+      return if proxies.empty?
+
+      # TODO move messaging into a dedicated action
+      @machine.ui.info 'Reconnecting proxy devices...'
+
+      # remove proxy devices
+      container[:devices] = devices.except(*proxies.keys)
+      lxd.update_container(machine_id, container)
+
+      # restore all devices (including proxies)
+      container[:devices] = devices.merge(proxies)
+      lxd.update_container(machine_id, container)
+    rescue Hyperkit::Error => e
+      @machine.ui.error 'Failed to connect proxy devices'
+      fail ContainerConfigurationFailure, machine_name: @machine.name, reason: e.reason
+    end
+
     def info
       if in_state? :running, :frozen
         {
@@ -520,6 +560,7 @@ module VagrantLXD
       lxd_rootfs = lxd_dir / 'rootfs.tar.gz'
       lxd_metadata = YAML.load(File.read(lxd_dir / 'metadata.yaml')) rescue nil
 
+      # TODO move messaging into a dedicated action
       if lxd_rootfs.exist? and lxd_metadata.is_a? Hash and lxd_metadata['source_fingerprint'] == lxc_fingerprint
         @machine.ui.info 'Importing LXC image...'
       else

data/lib/vagrant-lxd/version.rb

@@ -20,7 +20,7 @@
 module VagrantLXD
   module Version
     NAME = 'vagrant-lxd'
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'
     DESCRIPTION = 'Vagrant LXD provider'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-lxd
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Evan Hanson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hyperkit
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Vagrant LXD provider