vagrant-rke2 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44cbff5c2550189bfb8d345b2c511d4ee2e15541db773ba88433c36f883d5f85
-  data.tar.gz: 8204fe3eb22eedebd4edc1b719db57220fb183eaae5c4eae6891df5cb099b4f2
+  metadata.gz: 78c886a21fe07d3859076242fcb5a32e15c9c36ab63ea49fa253d9edabe7d33f
+  data.tar.gz: ea435d06bc44c4f1417abce3fa741ed271ee8d808ae1e7e80e477615fb215abe
 SHA512:
-  metadata.gz: b8a7d3db19e1ab2effc97216b9469251232f3bbd1b66bc19955e72c17939a3d9974e93cc8f916e9695f835d33231c09671802664b8bd517f18b1c97dc89ee704
-  data.tar.gz: cf0da81adf5067d9b7358531fee5208c2d62834c014223f3c1efc7760025038bd629cf720c7c3343a9457768abc49a7c4f443735c29790a5766b86b0a5972dbb
+  metadata.gz: 48ffee57addebb1a35058aa067b90536713bbf78ecdaefe0c2a025902af7a0c104525d71e626c4e9fc00d1e13f837b255ff8d1d19b9cbb4da69e34925c32b22f
+  data.tar.gz: 2cb388f448d50b54551cd09f00a2ab93690bd75170fbf8f8aeb62315372f524275ae6787e06c23eaa34551a992619eb5b5efe23182ab9bbfdb7982487f24b2ef

data/.gitignore

@@ -6,4 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-.vagrant/
+.vagrant/
+/*.gem

data/Gemfile

@@ -7,4 +7,5 @@ end
 # Specify your gem's dependencies in vagrant-rke2.gemspec
 group :plugins do
   gem "vagrant-rke2", path: "."
+  # gem "vagrant-reload", path "."
 end

data/Gemfile.lock

@@ -28,7 +28,7 @@ GIT
 PATH
   remote: .
   specs:
-    vagrant-rke2 (0.1.0)
+    vagrant-rke2 (0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -39,8 +39,8 @@ GEM
     concurrent-ruby (1.1.9)
     ed25519 (1.2.4)
     erubi (1.10.0)
-    excon (0.89.0)
-    ffi (1.15.4)
+    excon (0.90.0)
+    ffi (1.15.5)
     gssapi (1.3.1)
       ffi (>= 1.0.1)
     gyoku (1.3.1)
@@ -49,7 +49,7 @@ GEM
     httpclient (2.8.3)
     i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    listen (3.7.0)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     little-plugger (1.1.4)

data/README.md

@@ -1,8 +1,10 @@
 # Vagrant::RKE2
-This plugin was heavily inspired by the [vagrant-k3s](https://github.com/dweomer/vagrant-k3s) plugin. Check that out and give dweomer some stars.
+This plugin is the companion to the [vagrant-k3s](https://github.com/k3s-io/vagrant-k3s) plugin. It makes deploying RKE2 on vagrant boxes much easier.
 
 ## Installation
 
+Vagrant must be >= v2.2.17 
+
 ```shell
 vagrant plugin install vagrant-rke2
 vagrant up --provider=<your favorite provider>
@@ -10,19 +12,93 @@ vagrant up --provider=<your favorite provider>
 
 ## Usage
 
+See the [Vagrantfile](./test/Vagrantfile) for a working example.
+
+### Linux VMs
 ```ruby
+Vagrant.require_version ">= 2.2.17"
 Vagrant.configure("2") do |config|
-  config.vm.box = ""
+  config.vm.box = 'generic/ubuntu2004'
+
   config.vm.provision :rke2, run: "once" do |rke2|
-   
+    # installer_url: can be anything that curl can access from the guest
+    # default =>`https://get.rke2.io`
+    # type => String
+    rke2.installer_url = 'https://get.rke2.io'
+
+    # env: environment variables to be set before invoking the installer script
+    # type => Array<String> || String
+    rke2.env = %w[INSTALL_RKE2_CHANNEL=latest INSTALL_RKE2_TYPE=server]
+    # or
+    rke2.env = <<~ENV
+    INSTALL_RKE2_CHANNEL=latest
+    INSTALL_RKE2_TYPE=server
+    ENV
+
+    # env_path: where to write the envvars to be sourced prior to invoking the installer script
+    # default => `/etc/rancher/rke2/install.env`
+    rke2.env_path = '/etc/rancher/rke2/install.env'
+    rke2.env_mode = '0600' # default
+    rke2.env_owner = 'root:root' #default
+
+    # config: config file content in yaml
+    # type => String
+    rke2.config = <<~YAML
+      disable:
+      - local-storage
+      - servicelb
+    YAML
+    # config_mode: config file permissions
+    # type => String
+    # default => `0600`
+    rke2.config_mode = '0644' # side-step https://github.com/k3s-io/k3s/issues/4321
+    rke2.config_owner = 'root:root' #default
+
+    # install_path: QOL feature, add RKE2 to the PATH and points the KUBECONFIG to rke2.yaml
+    # type => Boolean
+    # default => true
+    rke2.install_path = false
   end
 end
+```
+
+### Windows VMs
+Windows setup is much more restricted. See https://docs.rke2.io/install/install_options/windows_agent_config/ for more info
+```ruby
+Vagrant.require_version ">= 2.2.17"
+Vagrant.configure("2") do |config|
+  config.vm.box          = "StefanScherer/windows_2019"
+  config.vm.communicator = "winrm"
+
+  config.vm.provision :rke2, run: "once" do |rke2|
+    # installer_url: can be anything that Invoke-WebRequest can access from the guest
+    # default =>`https://raw.githubusercontent.com/rancher/rke2/master/install.ps1`
+    # type => String
+    rke2.installer_url = 'https://raw.githubusercontent.com/rancher/rke2/master/install.ps1'
+
+    # env: environment variables passed to the install.ps1 script
+    # type => Array<String> || String
+    rke2.env = %w[Channel=latest Method=Tar]
+    # or
+    rke2.env = "-Channel latest -Method Tar"
 
+    # config: config file content in yaml
+    # type => String
+    # NOTE: kube-proxy-arg: "feature-gates=IPv6DualStack=false" is currently a required config for windows
+    rke2.config = <<~YAML
+      kube-proxy-arg: "feature-gates=IPv6DualStack=false"
+      server: https://172.168.1.200:9345
+      token: vagrant-rke2
+    YAML
+  end
+end
 ```
+
 ## Development
 
 See https://www.vagrantup.com/docs/plugins/development-basics
-
+- `gem build`
+- `VAGRANT_CWD=./test bundle exec vagrant up`
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/dereknola/vagrant-rke2. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).

data/lib/vagrant-rke2/cap/windows/scripts/install-containers-feature.ps1

@@ -0,0 +1,2 @@
+Write-Host "Install Containers feature"
+Install-WindowsFeature -Name Containers

data/lib/vagrant-rke2/cap/windows/scripts/setup-rke2.ps1

@@ -0,0 +1,22 @@
+# !!ITEMS!! are placeholders for injecting strings via vagrant plugin
+Write-Host "Downloading RKE2 installer for Windows..."
+Invoke-WebRequest -Uri !!INSTALL_URL!! -Outfile install.ps1
+
+Write-Host "Creating RKE2 configuration..."
+New-Item -Type Directory C:/etc/rancher/rke2 -Force
+Set-Content -Path !!CONFIG_PATH!! -Value @"
+!!CONFIG!!
+"@
+
+Write-Host "Installing RKE2 as an agent..."
+./install.ps1 !!ENV!!
+
+Write-Host "Creating RKE2 environment variables..."
+$env:PATH+=";C:\var\lib\rancher\rke2\bin;c:\usr\local\bin"
+[Environment]::SetEnvironmentVariable("Path",
+        [Environment]::GetEnvironmentVariable("Path", [EnvironmentVariableTarget]::Machine) + ";C:\var\lib\rancher\rke2\bin;c:\usr\local\bin",
+        [EnvironmentVariableTarget]::Machine)
+
+Write-Host "Open ports for RKE2 and Calico in firewall..."
+netsh advfirewall firewall add rule name= "RKE2-kubelet" dir=in action=allow protocol=TCP localport=10250
+netsh advfirewall firewall add rule name= "RKE2-agent" dir=in action=allow protocol=TCP localport=4789

data/lib/vagrant-rke2/config.rb

@@ -2,19 +2,23 @@
 
 module VagrantPlugins
     module Rke2
+      DEFAULT_CONFIG_PATH_LINUX = '/etc/rancher/rke2/config.yaml'
+      DEFAULT_CONFIG_PATH_WINDOWS = 'C:/etc/rancher/rke2/config.yaml'
+      DEFAULT_INSTALLER_URL_LINUX = 'https://get.rke2.io'
+      DEFAULT_INSTALLER_URL_WINDOWS = 'https://raw.githubusercontent.com/rancher/rke2/master/install.ps1'
+
       class Config < Vagrant.plugin(2, :config)
         DEFAULT_FILE_MODE = '0600'
         DEFAULT_FILE_OWNER = 'root:root'
         DEFAULT_CONFIG_MODE = DEFAULT_FILE_MODE
         DEFAULT_CONFIG_OWNER = DEFAULT_FILE_OWNER
-        DEFAULT_CONFIG_PATH = '/etc/rancher/rke2/config.yaml'
+        
         DEFAULT_ENV_MODE = DEFAULT_FILE_MODE
         DEFAULT_ENV_OWNER = DEFAULT_FILE_OWNER
         DEFAULT_ENV_PATH = '/etc/rancher/rke2/install.env'
-        DEFAULT_INSTALLER_URL = 'https://get.rke2.io'
   
-        # string (.yaml) or hash
-        # @return [Hash]
+        # string (.yaml)
+        # @return [String]
         attr_accessor :config
   
         # Defaults to `0600`
@@ -49,6 +53,15 @@ module VagrantPlugins
         # @return [String]
         attr_accessor :installer_url
   
+        # Defaults to true
+        # @return [Boolean]
+        attr_accessor :install_path
+
+        # Defaults to false
+        # @return [Boolean]
+        attr_accessor :skip_start
+
+
         def initialize
           @config = UNSET_VALUE
           @config_mode = UNSET_VALUE
@@ -59,30 +72,33 @@ module VagrantPlugins
           @env_owner = UNSET_VALUE
           @env_path = UNSET_VALUE
           @installer_url = UNSET_VALUE
+          @install_path = UNSET_VALUE
+          @skip_start = UNSET_VALUE
         end
   
         def finalize!
           @config = "" if @config == UNSET_VALUE
           @config_mode = @config_mode == UNSET_VALUE ? DEFAULT_CONFIG_MODE : @config_mode.to_s
           @config_owner = @config_owner == UNSET_VALUE ? DEFAULT_CONFIG_OWNER : @config_owner.to_s
-          @config_path = @config_path == UNSET_VALUE ? DEFAULT_CONFIG_PATH : @config_path.to_s
+          @config_path = @config_path == UNSET_VALUE ? DEFAULT_CONFIG_PATH_LINUX : @config_path.to_s
           @env = [] if @env == UNSET_VALUE
           @env_mode = DEFAULT_ENV_MODE if @env_mode == UNSET_VALUE
           @env_owner = DEFAULT_ENV_OWNER if @env_owner == UNSET_VALUE
           @env_path = DEFAULT_ENV_PATH if @env_path == UNSET_VALUE
-          @installer_url = DEFAULT_INSTALLER_URL if @installer_url == UNSET_VALUE
-  
+          @installer_url = DEFAULT_INSTALLER_URL_LINUX if @installer_url == UNSET_VALUE
+          @install_path = true if @install_path == UNSET_VALUE
+          @skip_start = false if @skip_start == UNSET_VALUE
         end
   
         def validate(machine)
           errors = _detected_errors
   
           unless config_valid?
-            errors << "Rke2 provisioner `config` must be a hash or string (yaml)."
+            errors << "Rke2 provisioner `config` must be a string (yaml)."
           end
   
           unless env_valid?
-            errors << "Rke2 provisioner `env` must be an array, hash, or string."
+            errors << "Rke2 provisioner `env` must be an array or string."
           end
   
           { "rke2 provisioner" => errors }
@@ -90,14 +106,12 @@ module VagrantPlugins
   
         def config_valid?
           return true if config.is_a?(String)
-          return true if config.is_a?(Hash)
           false
         end
   
         def env_valid?
           return true unless env
           return true if env.is_a?(String)
-          return true if env.is_a?(Hash)
           if env.is_a?(Array)
             env.each do |a|
               return false unless a.kind_of?(String)

data/lib/vagrant-rke2/plugin.rb

@@ -28,24 +28,29 @@ module VagrantPlugins
       end
 
       guest_capability(:alpine, :curl_install) do
-        require_relative "cap/alpine/curl_install"
+        require_relative "cap/curl_install"
         Cap::Alpine::CurlInstall
       end
 
       guest_capability(:debian, :curl_install) do
-        require_relative "cap/debian/curl_install"
+        require_relative "cap/curl_install"
         Cap::Debian::CurlInstall
       end
 
       guest_capability(:redhat, :curl_install) do
-        require_relative "cap/redhat/curl_install"
+        require_relative "cap/curl_install"
         Cap::Redhat::CurlInstall
       end
 
       guest_capability(:suse, :curl_install) do
-        require_relative "cap/suse/curl_install"
+        require_relative "cap/curl_install"
         Cap::Suse::CurlInstall
       end
+    
+      guest_capability(:windows, :rke2_installed) do
+        require_relative "cap/windows/rke2_installed"
+        Cap::Windows::Rke2Installed
+      end
     end
   end
 end

data/lib/vagrant-rke2/provisioner.rb

@@ -15,6 +15,16 @@ module VagrantPlugins
       end
 
       def provision
+        @machine.ui.info "Guest Identity: %s" % @machine.config.vm.guest
+        case @machine.config.vm.guest
+        when :windows
+          provisionWindows
+        else
+          provisionLinux
+        end
+      end
+      
+      def provisionLinux
         unless @machine.guest.capability(:curl_installed)
           @machine.ui.info 'Installing Curl ...'
           @machine.guest.capability(:curl_install)
@@ -34,6 +44,9 @@ module VagrantPlugins
         end
         file_upload "rke2-install.env", env_file, env_text
 
+        capture = env_text.match(/INSTALL_RKE2_TYPE=([a-z]+)/)
+        service = capture ? capture.captures[0] : ""
+
         prv_file = "/vagrant/rke2-provisioner.sh"
         prv_text = <<~EOF
           #/usr/bin/env bash
@@ -49,12 +62,8 @@ module VagrantPlugins
         EOF
         file_upload("rke2-install.sh", prv_file, prv_text)
         @machine.ui.info "Invoking: #{prv_file}"
-
-        outputs, handler = build_outputs
-        begin
-          @machine.communicate.sudo("chmod +x #{prv_file} && #{prv_file}", error_key: :ssh_bad_exit_status_muted, &handler)
-        ensure
-          outputs.values.map(&:close)
+        @machine.communicate.sudo("chmod +x #{prv_file} && #{prv_file}", :error_key => :ssh_bad_exit_status_muted) do |type, line|
+          @machine.ui.detail line, :color => :yellow
         end
 
         begin
@@ -66,15 +75,93 @@ module VagrantPlugins
         rescue Vagrant::Errors::VagrantError => e
           @machine.ui.detail "#{e.extra_data[:stderr].chomp}", :color => :red
         else
+          @machine.communicate.sudo("#{exe} --version", :error_key => :ssh_bad_exit_status_muted) do |type, line|
+            @machine.ui.detail line, :color => :yellow
+          end
+        end
+
+        @machine.ui.info "Starting RKE2 service..."
+        if !service.empty?
+          @machine.communicate.sudo("systemctl enable rke2-#{service}.service")
+          @machine.communicate.sudo("systemctl start rke2-#{service}.service") do |type, line|
+            @machine.ui.detail line, :color => :yellow
+          end
+        else
+          @machine.communicate.sudo("systemctl enable rke2-server.service")
+          if !config.skip_start 
+            @machine.communicate.sudo("systemctl start rke2-server.service") do |type, line|
+              @machine.ui.detail line, :color => :yellow
+            end
+          end
+         end
+
+        if config.install_path
+          @machine.ui.info "Adding RKE2 to PATH and KUBECONFIG"
           outputs, handler = build_outputs
           begin
-            @machine.communicate.sudo("#{exe} --version", :error_key => :ssh_bad_exit_status_muted, &handler)
+            @machine.communicate.sudo("echo 'export KUBECONFIG=/etc/rancher/rke2/rke2.yaml PATH=$PATH:/var/lib/rancher/rke2/bin' >> /home/vagrant/.bashrc", &handler)
+            @machine.communicate.sudo("echo 'export KUBECONFIG=/etc/rancher/rke2/rke2.yaml PATH=$PATH:/var/lib/rancher/rke2/bin' >> /root/.bashrc", &handler)
           ensure
             outputs.values.map(&:close)
           end
         end
       end
 
+      def provisionWindows 
+
+        if config.config_path == DEFAULT_CONFIG_PATH_LINUX
+          config.config_path = DEFAULT_CONFIG_PATH_WINDOWS
+        end
+        if config.installer_url == DEFAULT_INSTALLER_URL_LINUX
+          config.installer_url = DEFAULT_INSTALLER_URL_WINDOWS     
+        end
+
+        config.installer_url
+
+        scriptDir = File.expand_path('./cap/windows/scripts', File.dirname(__FILE__)) + "/"
+
+        env_text = ""
+        if config.env.is_a?(String)
+          env_text = config.env
+        end
+        if config.env.is_a?(Array)
+          config.env.each {|line| env_text << "-#{line.gsub("=", " ")} "}
+        end
+
+        containerScript = "install-containers-feature.ps1" 
+        @machine.ui.info "Invoking: #{containerScript}"
+  
+        command = File.read(scriptDir + containerScript)
+        @machine.communicate.execute(command, {shell: :powershell, elevated: true})
+        @machine.guest.capability(:reboot)
+        @machine.guest.capability(:wait_for_reboot)
+
+        setupRke2 = "setup-rke2.ps1" 
+        @machine.ui.info "Invoking: #{setupRke2}"
+  
+        command = File.read(scriptDir + setupRke2)
+        command["!!INSTALL_URL!!"] = config.installer_url
+        command["!!CONFIG_PATH!!"] = config.config_path
+        command["!!CONFIG!!"] = config.config
+        command["!!ENV!!"] = env_text
+        @machine.communicate.execute(command, {shell: :powershell, elevated: true}) do |type, line|
+          @machine.ui.detail line.chomp, :color => :yellow
+        end
+
+        @machine.ui.info "Checking RKE2 version:"
+        @machine.communicate.test("Get-Command rke2", {shell: :powershell})
+        @machine.communicate.execute("rke2 --version", {shell: :powershell})  do |type, line|
+          @machine.ui.detail line, :color => :yellow
+        end
+
+        @machine.ui.info "Starting RKE2 agent:"
+        @machine.communicate.execute("rke2.exe agent service --add", {shell: :powershell, elevated: true} )
+        if !config.skip_start 
+          @machine.communicate.execute("Start-Service -Name 'rke2'", {shell: :powershell, elevated: true} )
+        end
+        
+      end
+
       def build_outputs
         outputs = {
           stdout: Vagrant::Util::LineBuffer.new { |line| handle_comm(:stdout, line) },
@@ -116,9 +203,12 @@ module VagrantPlugins
           remote_tmp_dir = @machine.guest.capability :create_tmp_path, {:type => :directory}
           remote_tmp_path = [remote_tmp_dir, File.basename(remote_path)].join('/')
           @machine.communicate.upload(local_path, remote_tmp_path)
-          @machine.communicate.sudo("install -v -DTZ #{remote_tmp_path} #{remote_path}") do |type, line|
-            @machine.ui.info line.chomp, :color => {:stderr => :red, :stdout => :default}[type]
+          if @machine.config.vm.guest != "windows"
+            @machine.communicate.sudo("install -v -DTZ #{remote_tmp_path} #{remote_path}") do |type, line|
+              @machine.ui.info line.chomp, :color => {:stderr => :red, :stdout => :default}[type]
+            end
           end
+
         end
         @machine.ui.detail content.chomp, :color => :yellow
         remote_path

data/lib/vagrant-rke2/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Rke2
-    VERSION = "0.1.0"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-rke2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Derek Nola
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies: []
 description: Manage RKE2 installations on Vagrant guests
 email:
@@ -30,6 +30,8 @@ files:
 - lib/vagrant-rke2/cap/curl_install.rb
 - lib/vagrant-rke2/cap/linux/curl_installed.rb
 - lib/vagrant-rke2/cap/linux/rke2_installed.rb
+- lib/vagrant-rke2/cap/windows/scripts/install-containers-feature.ps1
+- lib/vagrant-rke2/cap/windows/scripts/setup-rke2.ps1
 - lib/vagrant-rke2/config.rb
 - lib/vagrant-rke2/plugin.rb
 - lib/vagrant-rke2/provisioner.rb
@@ -56,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Manage RKE2 installations on Vagrant guests