vagrant-lxd 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daabe10181291cc4bf1459828a65236d208c210970d646f14dcfe9c707d73f06
-  data.tar.gz: 50e5a72cd3e1e9f8e3187e7c6da8ba0c4dc97919ee250ba15bbfbe485e3fa8ba
+  metadata.gz: a5c54e824e6ddcb541c28c0630b0d93bf019b3e4adc3d78c8353b80d677f29b4
+  data.tar.gz: 95548bc78e3df80c016ed817210cc05c12b664a7fbb043a600a1c3a7420e22e1
 SHA512:
-  metadata.gz: 97a2e2e0ebcd5c601cad8825cf2a7cb2411f2641fbcb8c79b79b1d13e001a2993bf5827060ca43473c54073b774a997f76aa394516dad193680e3cdacd9c865a
-  data.tar.gz: 96d298c3e91599753a8f9a628b73c74fbbedd532ec6b9586e3162db73f7ca28c58fc1b3970323aaba65c3b39dc98ba967032e36a444dcee8e0ca9f98fbf26816
+  metadata.gz: 8ff4335dfb7edb5bf3995b9f1c71ade7044a0277b4346978958775c99402ac0b0db74ba8cd586d1464408ae09c544a68b773761b29789dfb084402ac36534c1c
+  data.tar.gz: 7d7ce503fb62c834911d3647b88e1b4c6cb0434532432fb1d1c055aa62ffee4ff493eb0c2561046ac243ac0949cdde57b0cb2b73c9c8bf1f85a887f0ad53808c

data/.gitlab-ci.yml

@@ -1,4 +1,4 @@
-image: ruby:2.5
+image: ruby:3.0
 
 before_script:
   - apt-get -y update

data/Gemfile

@@ -7,7 +7,8 @@ group :development do
   gem 'rspec'
   gem 'rspec-its'
   gem 'rspec-mocks'
-  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git', tag: 'v2.2.15'
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git', tag: 'v2.4.0'
+  gem 'webrick'
 end
 
 group :plugins do

data/Gemfile.lock

@@ -1,33 +1,39 @@
 GIT
   remote: https://github.com/mitchellh/vagrant.git
-  revision: 9247e07fc8ffe2fdb91c6422bbb133a25983fe15
-  tag: v2.2.15
+  revision: 5a2b888c371bd0c8dcae3abe1403e89020c6d6ca
+  tag: v2.4.0
   specs:
-    vagrant (2.2.15)
+    vagrant (2.4.0)
       bcrypt_pbkdf (~> 1.1)
-      childprocess (~> 4.0.0)
-      ed25519 (~> 1.2.4)
+      childprocess (~> 4.1.0)
+      ed25519 (~> 1.3.0)
       erubi
+      googleapis-common-protos-types (~> 1.3)
+      grpc (~> 1.56.0)
       hashicorp-checkpoint (~> 0.1.5)
-      i18n (~> 1.8)
-      listen (~> 3.4)
+      i18n (~> 1.12)
+      ipaddr (>= 1.2.4)
+      listen (~> 3.7)
       log4r (~> 1.1.9, < 1.1.11)
       mime-types (~> 3.3)
-      net-scp (~> 1.2.0)
-      net-sftp (~> 3.0)
-      net-ssh (>= 6.1.0, < 7)
+      net-ftp (~> 0.2)
+      net-scp (~> 4.0)
+      net-sftp (~> 4.0)
+      net-ssh (~> 7.0)
       rb-kqueue (~> 0.2.0)
-      rubyzip (~> 2.0)
-      vagrant_cloud (~> 3.0.4)
-      wdm (~> 0.1.0)
-      winrm (>= 2.3.4, < 3.0)
-      winrm-elevated (>= 1.2.1, < 2.0)
-      winrm-fs (>= 1.3.4, < 2.0)
+      rexml (~> 3.2)
+      rgl (~> 0.5.10)
+      rubyzip (~> 2.3.2)
+      vagrant_cloud (~> 3.1.0)
+      wdm (~> 0.1.1)
+      winrm (>= 2.3.6, < 3.0)
+      winrm-elevated (>= 1.2.3, < 2.0)
+      winrm-fs (>= 1.3.5, < 2.0)
 
 PATH
   remote: .
   specs:
-    vagrant-lxd (0.6.0)
+    vagrant-lxd (0.7.0)
       activesupport (~> 5.2.3)
       faraday (~> 0.17)
       hyperkit (~> 1.3.0)
@@ -35,93 +41,117 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.8)
+    activesupport (5.2.8.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
     bcrypt_pbkdf (1.1.0)
     builder (3.2.4)
-    childprocess (4.0.0)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
-    ed25519 (1.2.4)
-    erubi (1.10.0)
-    excon (0.87.0)
-    fakefs (1.4.0)
-    faraday (0.17.5)
+    childprocess (4.1.0)
+    concurrent-ruby (1.2.2)
+    date (3.3.3)
+    diff-lcs (1.5.0)
+    ed25519 (1.3.0)
+    erubi (1.12.0)
+    excon (0.104.0)
+    fakefs (2.5.0)
+    faraday (0.17.6)
       multipart-post (>= 1.2, < 3)
-    ffi (1.15.4)
+    ffi (1.16.3)
+    google-protobuf (3.24.4)
+    googleapis-common-protos-types (1.9.0)
+      google-protobuf (~> 3.18)
+    grpc (1.56.2)
+      google-protobuf (~> 3.23)
+      googleapis-common-protos-types (~> 1.0)
     gssapi (1.3.1)
       ffi (>= 1.0.1)
-    gyoku (1.3.1)
+    gyoku (1.4.0)
       builder (>= 2.1.2)
+      rexml (~> 3.0)
     hashicorp-checkpoint (0.1.5)
     httpclient (2.8.3)
     hyperkit (1.3.0)
       activesupport (>= 4.2.6)
       sawyer
-    i18n (1.8.10)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    listen (3.7.0)
+    ipaddr (1.2.5)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     little-plugger (1.1.4)
     log4r (1.1.10)
-    logging (2.3.0)
+    logging (2.3.1)
       little-plugger (~> 1.1)
       multi_json (~> 1.14)
-    mime-types (3.3.1)
+    mime-types (3.5.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0901)
-    minitest (5.16.1)
+    mime-types-data (3.2023.1003)
+    minitest (5.20.0)
     multi_json (1.15.0)
-    multipart-post (2.2.3)
-    net-scp (1.2.1)
-      net-ssh (>= 2.6.5)
-    net-sftp (3.0.0)
-      net-ssh (>= 5.0.0, < 7.0.0)
-    net-ssh (6.1.0)
+    multipart-post (2.3.0)
+    net-ftp (0.2.0)
+      net-protocol
+      time
+    net-protocol (0.2.1)
+      timeout
+    net-scp (4.0.0)
+      net-ssh (>= 2.6.5, < 8.0.0)
+    net-sftp (4.0.0)
+      net-ssh (>= 5.0.0, < 8.0.0)
+    net-ssh (7.2.0)
     nori (2.6.0)
-    public_suffix (4.0.7)
-    rake (13.0.6)
-    rb-fsevent (0.11.0)
+    pairing_heap (3.0.1)
+    public_suffix (5.0.3)
+    rake (13.1.0)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rb-kqueue (0.2.7)
+    rb-kqueue (0.2.8)
       ffi (>= 0.5.0)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rexml (3.2.6)
+    rgl (0.5.10)
+      pairing_heap (>= 0.3.0)
+      rexml (~> 3.2, >= 3.2.4)
+      stream (~> 0.5.3)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
+      rspec-support (~> 3.12.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.10.2)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
     rubyntlm (0.6.3)
     rubyzip (2.3.2)
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
+    stream (0.5.5)
     thread_safe (0.3.6)
-    tzinfo (1.2.9)
+    time (0.2.2)
+      date
+    timeout (0.4.0)
+    tzinfo (1.2.11)
       thread_safe (~> 0.1)
-    vagrant_cloud (3.0.5)
+    vagrant_cloud (3.1.0)
       excon (~> 0.73)
       log4r (~> 1.1.10)
       rexml (~> 3.2.5)
     wdm (0.1.1)
+    webrick (1.8.1)
     winrm (2.3.6)
       builder (>= 2.1.2)
       erubi (~> 1.8)
@@ -152,6 +182,7 @@ DEPENDENCIES
   rspec-mocks
   vagrant!
   vagrant-lxd!
+  webrick
 
 BUNDLED WITH
-   2.1.4
+   2.3.5

data/README.md

@@ -1,10 +1,11 @@
 # vagrant-lxd
 
 This is a [Vagrant][] plugin that adds the ability to manage containers
-with [LXD][].
+with [LXD][] or [Incus][].
 
 [Vagrant]: https://www.vagrantup.com/
-[LXD]: https://linuxcontainers.org/lxd/
+[LXD]: https://documentation.ubuntu.com/lxd/
+[Incus]: https://linuxcontainers.org/incus/
 
 ## Features
 
@@ -22,7 +23,18 @@ The following features are not expected to work yet:
  - Static IP addresses
  - IPv6 networking
 
-The plugin requires LXD 2.0 and Vagrant 1.8.7 or newer.
+## Supported Versions
+
+The plugin requires at least the following software versions:
+
+ - Vagrant 2.2
+ - LXD 3.8
+ - Incus 0.2
+
+Despite its name, this plugin works with Incus as well as LXD. You can
+generally replace "LXD" with "Incus" (and `lxc` with `incus`) when reading
+this documentation and it'll remain correct, although a few important
+differences have been noted.
 
 ## Installation
 
@@ -60,7 +72,7 @@ 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 init --minimal hibox/jammy64
     $ vagrant up --provider lxd
 
 [setting-up-lxd]: doc/setting-up-lxd.md
@@ -69,13 +81,13 @@ VM images from [Vagrant Cloud][cloud] should work without modification:
 #### Configuration
 
 Below is an example Vagrantfile showing most of the provider's
-configurable values, along with their defaults. The `debian/stretch64`
+configurable values, along with their defaults. The `hibox/jammy64`
 box is available on the Vagrant Cloud, so you should be able to copy
 this file and adjust it as you see fit.
 
 ``` ruby
 Vagrant.configure('2') do |config|
-  config.vm.box = 'debian/stretch64'
+  config.vm.box = 'hibox/jammy64'
 
   config.vm.provider 'lxd' do |lxd|
     lxd.api_endpoint = 'https://127.0.0.1:8443'
@@ -100,11 +112,15 @@ By default, the plugin will first try to use files from
 `~/.config/lxc/client.crt` and `client.key`, if they exist. Otherwise,
 it will generate a new 4096-bit RSA certificate (and accompanying
 private key) in Vagrant's data directory. When using the plugin for the
-first time, you will need to add this certificate to LXD's trust store
+first time, you will need to add this certificate to server's trust store
 by running:
 
     $ lxc config trust add ~/.vagrant.d/data/lxd/client.crt
 
+If you're using Incus, the command is slightly different:
+
+    $ incus config trust add-certificate ~/.vagrant.d/data/lxd/client.crt
+
 If you would rather use an existing certificate, you can specify the
 files for the plugin to use with the following settings:
 
@@ -149,7 +165,7 @@ is passed through to LXD. The hash values should all be strings:
       recursive: 'false',
     }
 
-[disk]: https://linuxcontainers.org/lxd/docs/master/instances/#type-disk
+[disk]: https://documentation.ubuntu.com/lxd/en/latest/reference/devices_disk/
 
 ### Shared LXD Containers
 
@@ -192,8 +208,8 @@ about this setting.
 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][containers] for details.
+configuration items for LXD, respectively. Refer to LXD's [instance
+options documentation][instances] for details.
 
     config.vm.provider 'lxd' do |lxd|
       lxd.nesting = true
@@ -204,7 +220,7 @@ 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.
 
-[containers]: https://linuxcontainers.org/lxd/docs/master/instances/
+[instances]: https://documentation.ubuntu.com/lxd/en/latest/reference/instance_options/
 
 ### Adding Devices
 
@@ -235,7 +251,7 @@ to run graphical applications transparently from within the guest:
 Note that disk devices should be configured as [synced
 folders](#synced-folders) rather than ad-hoc devices.
 
-[device-config]: https://linuxcontainers.org/lxd/docs/master/instances/#devices-configuration
+[device-config]: https://documentation.ubuntu.com/lxd/en/latest/reference/devices/
 
 ### Container Configuration
 
@@ -253,11 +269,11 @@ Not all instance settings make sense in the Vagrant context, and some will or
 won't work based on your LXD host's configuration, so making sure the config is
 valid is up to you.
 
-[instance-config]: https://linuxcontainers.org/lxd/docs/master/instances/#key-value-configuration
+[instance-config]: https://documentation.ubuntu.com/lxd/en/latest/reference/instance_options/
 
 ### LXD Projects
 
-Since version 3.8, LXD has supported [projects] as a way to segment an LXD
+Since version 3.8, LXD has supported [projects][] as a way to segment an LXD
 server. Each project has its own set of containers, profiles, images, and so
 on.
 
@@ -286,7 +302,7 @@ correctly. The following commands should get you started with a new project:
     lxc profile device add default eth0 nic name=eth0 parent=lxdbr0 nictype=bridged
     lxc profile device add default root disk path=/ pool=default
 
-[projects]: https://linuxcontainers.org/lxd/docs/master/projects/
+[projects]: https://documentation.ubuntu.com/lxd/en/latest/explanation/projects/
 
 ## Hacking
 

data/doc/setting-up-lxd.md

@@ -1,22 +1,28 @@
 # Setting up LXD
 
-LXD needs to be configured a particular way before Vagrant can use it.
+LXD (or Incus) 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.
+ 1. The server must allow HTTPS API access from your machine.
+ 2. The server must have a working network bridge.
+ 3. Your user must be in the "lxd" (or "incus-admin") group.
+ 4. Your user must have a client certificate registered.
 
-## Ubuntu Focal and Later
+Note the following instructions apply specifically to LXD. When using Incus,
+you'll need to change the commands and group names accordingly.
+
+## Ubuntu
+
+### Focal and Later
 
 On Ubuntu 20.04 and later, LXD is installed as a [Snap][]. To install
 and configure it as described above, you can use the following commands:
 
 ```sh
 # install lxd
-sudo apt install -y lxd
+sudo snap install lxd
 
 # enable https api access
 sudo lxd init --auto --network-address=127.0.0.1 --network-port=8443
@@ -42,13 +48,13 @@ following command:
 
 You can find more information about configuring LXD at:
 
-    https://linuxcontainers.org/lxd/getting-started-cli/#initial-configuration
+    https://documentation.ubuntu.com/lxd/en/latest/howto/initialize/
 ```
 
 Once you run that command as instructed, everything should be set up for
 the plugin to work correctly.
 
-## Ubuntu Xenial
+### Xenial and Earlier
 
 To install LXD and configure it as described above on Ubuntu 16.04, you
 can use the following commands:
@@ -84,7 +90,7 @@ correctly.
 
 ## Other Platforms
 
-The Linux Containers website has a [detailed guide][getting-started-cli]
+The Canonical 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.
 
@@ -93,5 +99,5 @@ propose an addition to this document or add instructions to the
 project's [wiki][] for others to follow.
 
 [Snap]: https://snapcraft.io/
-[getting-started-cli]: https://linuxcontainers.org/lxd/getting-started-cli/
+[getting-started-cli]: https://documentation.ubuntu.com/lxd/en/latest/howto/initialize/
 [wiki]: https://gitlab.com/catalyst-it/vagrant-lxd/wikis

data/lib/vagrant-lxd/driver/certificate.rb

@@ -69,8 +69,8 @@ module VagrantLXD
         cert.sign(pkey, OpenSSL::Digest::SHA256.new)
         @logger.debug "Saving new certificate to disk under #{path}..."
         FileUtils.mkdir_p(path, mode: 0o700)
-        File.write(path / 'client.crt', cert.to_s, 0, perm: 0o600)
-        File.write(path / 'client.key', pkey.to_s, 0, perm: 0o600)
+        File.write(path / 'client.crt', cert.to_s, 0, mode: 'w', perm: 0o600)
+        File.write(path / 'client.key', pkey.to_s, 0, mode: 'w', perm: 0o600)
         Certificate.new(path / 'client.crt', path / 'client.key')
       rescue Exception => e
         @logger.error 'Certificate creation failed: ' << e.message

data/lib/vagrant-lxd/driver.rb

@@ -120,6 +120,15 @@ module VagrantLXD
       end
     end
 
+    # Use the correct endpoint for the containers API: "/containers" is
+    # deprecated, replaced by "/instances". See this link for a history:
+    # https://discuss.linuxcontainers.org/t/incus-0-1-has-been-released/18036
+    module Hyperkit::Client::Containers
+      def containers_path
+        '/1.0/instances'
+      end
+    end
+
     class Hyperkit::BadRequest
       def reason
         return unless data.is_a? Hash

data/lib/vagrant-lxd/version.rb

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

data/templates/locales/en.yml

@@ -48,7 +48,7 @@ en:
         
         You can find more documentation about configuring LXD at:
         
-            https://linuxcontainers.org/lxd/getting-started-cli/#initial-configuration
+            https://documentation.ubuntu.com/lxd/en/latest/howto/initialize/
         
       lxd_authentication_failure: |-
         The LXD provider could not authenticate to the daemon at %{api_endpoint}.
@@ -61,8 +61,8 @@ en:
             $ lxc config trust add %{client_cert}
         
         You can find more information about configuring LXD at:
-
-            https://linuxcontainers.org/lxd/getting-started-cli/#initial-configuration
+        
+            https://documentation.ubuntu.com/lxd/en/latest/howto/initialize/
         
       lxd_operation_timeout: |-
         The container failed to respond within %{time_limit} seconds. Try
@@ -105,7 +105,7 @@ en:
         
       lxd_container_deletion_failure: |-
         The provider was unable to delete the container for the '%{machine_name}' VM.
-
+        
         The underlying error message was: %{reason}
         
         The LXD logs may contain more information about the cause of this failure.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-lxd
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Evan Hanson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-20 00:00:00.000000000 Z
+date: 2023-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Vagrant LXD provider