vagrant-lxd 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32163f21b3b3f37aee19bb36b0fbb6ada2d822eb
-  data.tar.gz: 2b17ef463e4c1a22c9741637aa33f42fefd07e50
+  metadata.gz: 2ae29284d2a4a870ad54f62da227bfa06e1a879d
+  data.tar.gz: 1a7977adf19891632b59233f7de7bad527ed93b4
 SHA512:
-  metadata.gz: 2bf717caad37765335e0493ba27038b4437c6cfbcf738ae3eca0b69a795088fd91451c2293847f595bc7159ea1cb6463efc59a6e67495392ce657bd647085963
-  data.tar.gz: 5e27b6a883443794e47a9cfa7b4627dd88a26c0895e8629e5c1c621472da50c236065c73268ded9349aa961797ac3973facbbc9b7031bb96e0c036f27a655ab4
+  metadata.gz: 94b0882c41cd75aa6caf9f672b7f7353cfb56b9e60762f785f6b9fc23774ee8b2bb4443da86b35f957a52588cffb564a9e4130798498e3f1ab07fe037287fc0b
+  data.tar.gz: 9b1344147ebd312227be8186571ed421bfdc1dc4421a45c09f17bb0008759b2682b23b78c19228ed2901aa58f63f3782edaf78cb364564bf9e7982df6c9b12c1

data/Gemfile.lock

@@ -23,7 +23,7 @@ GIT
 PATH
   remote: .
   specs:
-    vagrant-lxd (0.1.0)
+    vagrant-lxd (0.1.1)
       hyperkit (~> 1.1.0)
 
 GEM

data/README.md

@@ -25,7 +25,16 @@ The plugin requires LXD 2.0 and Vagrant 1.8.7 or newer.
 
 ## Installation
 
-Installing the plugin from this repository is a three-step process.
+### From Rubygems
+
+You can install the latest version of the plugin directly from
+rubygems.org with the `vagrant plugin` command:
+
+    $ vagrant plugin install vagrant-lxd
+
+### From Git
+
+Installing from this repository is a three-step process.
 
  1. Use Bundler to install development dependencies:
     
@@ -43,12 +52,17 @@ Installing the plugin from this repository is a three-step process.
 
 ### Quick Start
 
-This plugin reuses the `lxc` box format, so VM images from [Vagrant
-Cloud][cloud] should work without modification:
+First, make sure that you've [configured LXD correctly][setting-up-lxd]
+for use with Vagrant.
+
+Once LXD is set up, you can use `vagrant up --provider lxd` to create
+container-backed machines. This plugin reuses the `lxc` box format, so
+VM images from [Vagrant Cloud][cloud] should work without modification:
 
     $ vagrant init --minimal debian/stretch64
     $ vagrant up --provider lxd
 
+[setting-up-lxd]: doc/setting-up-lxd.md
 [cloud]: https://app.vagrantup.com/boxes/search?provider=lxc
 
 #### Configuration

data/doc/setting-up-lxd.md

@@ -0,0 +1,57 @@
+# Setting up LXD
+
+LXD needs to be configured a particular way before Vagrant can use it.
+
+Specifically, the following settings need to be applied:
+
+ 1. LXD must allow HTTPS API access from your machine.
+ 2. LXD must have a working network bridge.
+ 3. Your user must be in the "lxd" group.
+ 4. Your user must have a client certificate registered with LXD.
+
+## Xenial
+
+To install LXD and configure it as described above on Ubuntu 16.04, you
+can use the following commands:
+
+```sh
+# install lxd
+sudo apt install -y lxd
+
+# enable https api access
+sudo lxd init --auto --network-address=127.0.0.1 --network-port=8443
+
+# set up a network bridge (press enter to accept the default values)
+sudo dpkg-reconfigure -p medium lxd
+
+# add your user to the lxd group
+sudo usermod -a lxd -G $(whoami)
+```
+
+Once LXD is configured, you should register a client certificate for
+Vagrant to use when authenticating to the API (this command will
+automatically generate the certificate for you):
+
+```sh
+# apply new group membership
+newgrp lxd
+
+# create and add a client certificate
+lxc config trust add /home/ubuntu/.config/lxc/client.crt
+```
+
+At this point everything should be set up for the plugin to work
+correctly.
+
+## Other Platforms
+
+The Linux Containers website has a [detailed guide][getting-started-cli]
+to installing LXD on other platforms. The steps to configure LXD for
+Vagrant will be similar to those above, but some commands will differ.
+
+If you're using the plugin on another platform, please feel free to
+propose an addition to this document or add instructions to the
+project's [wiki][] for others to follow.
+
+[getting-started-cli]: https://linuxcontainers.org/lxd/getting-started-cli/
+[wiki]: https://gitlab.com/catalyst-it/vagrant-lxd/wikis

data/lib/vagrant-lxd/command.rb

@@ -61,8 +61,10 @@ module VagrantLXD
     end
 
     def attach(args)
+      options = Hash[force: false]
+
       opts = OptionParser.new do |o|
-        o.banner = 'Usage: vagrant lxd attach [machine ...] <container>'
+        o.banner = 'Usage: vagrant lxd attach [-f] [machine ... container]'
         o.separator ''
         o.separator 'Associates a VM with a preexisting LXD container.'
         o.separator ''
@@ -70,6 +72,8 @@ module VagrantLXD
         o.separator 'preexisting LXD container. Once it has been associated with a container,'
         o.separator 'the machine can be used just like it had been created with `vagrant up`'
         o.separator 'or detached from the container again with `vagrant lxd detach`.'
+        o.separator ''
+        o.on('-f', '--force', 'Force attachment and ignore missing containers')
       end
 
       if args.include?('-h') or args.include?('--help')
@@ -77,16 +81,25 @@ module VagrantLXD
         exit 0
       end
 
-      unless container = args.pop
-        fail Vagrant::Errors::CLIInvalidUsage, help: opts.help
-      end
+      options[:force] ||= args.delete('-f')
+      options[:force] ||= args.delete('--force')
+      options[:container_name] = args.pop
 
       with_target_machines(args) do |machine|
-        if machine.id == container
+        if not container = options[:container_name] || machine.provider_config.name
+          machine.ui.warn 'No container name specified, skipping...'
+        elsif machine.id == container
           machine.ui.warn "Machine is already attached to container '#{container}', skipping..."
         elsif machine.state.id == Vagrant::MachineState::NOT_CREATED_ID
           machine.ui.info "Attaching to container '#{container}'..."
-          Driver.new(machine).attach(container)
+          begin
+            Driver.new(machine).attach(container)
+          rescue Driver::ContainerNotFound
+            raise unless options[:force]
+          end
+        elsif options[:force]
+          detach([machine.name])
+          redo
         else
           machine.ui.error "Machine is already attached to container '#{machine.id}'"
           fail Driver::DuplicateAttachmentFailure, machine_name: machine.name, container: container
@@ -115,9 +128,8 @@ module VagrantLXD
         if machine.id.nil? or machine.state.id == Vagrant::MachineState::NOT_CREATED_ID
           machine.ui.warn "Machine is not attached to a container, skipping..."
         else
-          driver = Driver.new(machine)
-          machine.ui.info "Detaching from container '#{driver.machine_id}'..."
-          driver.detach
+          machine.ui.info "Detaching from container '#{machine.id}'..."
+          Driver.new(machine).detach
         end
       end
     end

data/lib/vagrant-lxd/driver.rb

@@ -65,6 +65,10 @@ module VagrantLXD
       error_key 'lxd_duplicate_attachment_failure'
     end
 
+    class SnapshotNotFound < Vagrant::Errors::VagrantError
+      error_key 'snapshot_not_found'
+    end
+
     class Hyperkit::BadRequest
       def reason
         return unless data.is_a? Hash
@@ -150,7 +154,7 @@ module VagrantLXD
       end
     rescue Hyperkit::NotFound
       @machine.ui.error "Container doesn't exist: #{container}"
-      fail ContainerNotFound, container: container
+      fail ContainerNotFound, machine_name: @machine.name, container: container
     end
 
     def detach
@@ -166,15 +170,23 @@ module VagrantLXD
     end
 
     def snapshot_save(name)
-      @lxd.create_snapshot(machine_id, name)
+      snapshot_delete(name) # noops if the snapshot doesn't exist
+      operation = @lxd.create_snapshot(machine_id, name, sync: false)
+      wait_for_operation(operation)
     end
 
     def snapshot_restore(name)
-      @lxd.restore_snapshot(machine_id, name)
+      operation = @lxd.restore_snapshot(machine_id, name, sync: false)
+      wait_for_operation(operation)
+    rescue Hyperkit::BadRequest
+      @logger.warn 'Snapshot restoration failed: ' << name
+      fail SnapshotNotFound, machine: @machine.name, snapshot_name: name
     end
 
     def snapshot_delete(name)
       @lxd.delete_snapshot(machine_id, name)
+    rescue Hyperkit::NotFound
+      @logger.warn 'No such snapshot: ' << name
     end
 
     def state
@@ -267,6 +279,10 @@ module VagrantLXD
 
   private
 
+    def machine_id
+      @machine.id
+    end
+
     def delete_container
       @lxd.delete_container(machine_id)
     rescue Hyperkit::NotFound
@@ -281,6 +297,15 @@ module VagrantLXD
       @logger.error "Unable to delete image for '#{machine_id}'"
     end
 
+    # Hyperkit doesn't handle socket read timeouts even when auto_sync
+    # is enabled or setting sync: true. TODO Upstream a better fix than
+    # this, so that `wait_for_operation` really does.
+    def wait_for_operation(operation)
+      @lxd.wait_for_operation(operation.id)
+    rescue Faraday::TimeoutError
+      retry
+    end
+
     def container
       @lxd.container(machine_id)
     end
@@ -301,10 +326,6 @@ module VagrantLXD
       true
     end
 
-    def machine_id
-      @machine.id
-    end
-
     def generate_machine_id
       @name || begin
         id = "vagrant-#{File.basename(Dir.pwd)}-#{@machine.name}-#{SecureRandom.hex(8)}"

data/lib/vagrant-lxd/version.rb

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

data/templates/locales/en.yml

@@ -12,6 +12,8 @@ en:
     actions:
       vm:
         snapshot:
+          not_found: |-
+            The machine has no snapshot named '%{name}'.
           restored: |-
             The machine has been restored to snapshot '%{name}'!
     errors:
@@ -96,15 +98,24 @@ en:
         A machine can only be associated with one container at a time.
         
         To attach '%{machine_name}' to '%{container}', you must first
-        detach it from its current container using `vagrant lxd detach`.
+        detach it from its current container using `vagrant lxd detach`
+        or pass `--force` to force attachment.
         
       lxd_container_not_found: |-
         The requested container '%{container}' doesn't exist.
         
+        You will need to create this container first, either by using the
+        `lxc launch` command or by setting the VM's `lxd.name` in its LXD
+        provider configuration and running `vagrant up %{machine_name}`.
+        
         You can list available containers with the `lxc list` command.
+        
       lxd_container_already_exists: |-
         A container with the name '%{container}' already exists.
         
         You will either need to delete this container and try again, or attach
         the VM to it with `vagrant lxd attach %{machine_name} %{container}`.
         
+      snapshot_not_found: |-
+        The snapshot name `%{snapshot_name}` was not found for the
+        virtual machine `%{machine}`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-lxd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Evan Hanson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-01 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hyperkit
@@ -37,6 +37,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- doc/setting-up-lxd.md
 - lib/vagrant-lxd.rb
 - lib/vagrant-lxd/action.rb
 - lib/vagrant-lxd/capability.rb