Skip to content

Latest commit

 

History

History
120 lines (98 loc) · 3.67 KB

README.md

File metadata and controls

120 lines (98 loc) · 3.67 KB
Raw

Vagrant::RKE2

This plugin is the companion to the vagrant-k3s plugin. It makes deploying RKE2 on vagrant boxes much easier.

Installation

Vagrant must be >= v2.2.17

vagrant plugin install vagrant-rke2
vagrant up --provider=<your favorite provider>

Usage

See the Vagrantfile for a working example.

Linux VMs

Vagrant.require_version ">= 2.2.17"
Vagrant.configure("2") do |config|
  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
      write-kubeconfig-mode: '0644'
      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

    # skip_start: install but don't start RKE2
    # type => Boolean
    # default => false
    rke2.skip_start = true
  end
end

Windows VMs

Windows setup is much more restricted. See https://docs.rke2.io/install/install_options/windows_agent_config/ for more info

Vagrant.require_version ">= 2.2.17"
Vagrant.configure("2") do |config|
  config.vm.box          = "jborean93/WindowsServer2022"
  config.vm.communicator = "winssh"
  config.ssh.password = "vagrant"


  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
    rke2.config = <<~YAML
      server: https://172.168.1.200:9345
      token: vagrant-rke2
    YAML

    # install_path: QOL feature, add RKE2 to the PATH
    # type => Boolean
    # default => true
    rke2.install_path = false
    
    # skip_start: install but don't start RKE2
    # type => Boolean
    # default => false
    rke2.skip_start = true
  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.