rke2
Version information
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
- Puppet >= 4.10.0 < 7.0.0
- , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'etma-rke2', '1.1.31'
Learn more about managing modules with a PuppetfileDocumentation
rke2
Welcome to rke2 module. This module installs the Rancher's lightweight Kubernetes, rke2 (see more on https://rke2.io/).
Table of Contents
- Description
- Setup - The basics of getting started with rke2
- Usage - Configuration options and additional functionality
- Development - Guide for contributing to the module
Description
This module installs the open source Rancher's next-generation Kubernetes, rke2.
Using this module, you can easily automate rke2 installation in many machines, like in a School Lab.
Setup
Beginning with rke2
Install this module using Puppet: puppet module install etma/rke2
Or via Puppetfile: mod 'etma-rke2', '1.0.0'
Usage
-
Quick run:
puppet apply -e "include rke2"
-
Installing using the script installation mode:
class { 'rke2':
installation_mode => 'script',
}
- Installing using the binary installation mode:
class { 'rke2':
installation_mode => 'binary',
}
- Ensuring that it is uninstalled:
class { 'rke2':
ensure => 'absent',
installation_mode => 'script',
}
Development
Contributing
- Create a topic branch from where you want to base your work. This is usually the master branch.
- Push your changes to a topic branch in your fork of the repository.
- Add yourself as a contributor in the Contributors sections of this file.
- Make sure your commits messages are describing what has changed.
- Make sure you have tested your changes and nothing breaks.
- Validate your module using
pdk validate
. - Submit a pull request to this repository.
Release Notes/Contributors/Etc.
- Author: Erik Andersen (etma@vertisky.com)
- Based on the k3s script from Igor Oliveira (igor.bezerra96@gmail.com) (igorolivei/puppet-k3s)
Reference
Public classes
rke2
Interface class to manage installation or uninstall.
Parameters
ensure
Whether the rke2 must be installed or not. Valid options: 'present' or 'absent'.
Default: 'present'.
installation_mode
The rke2 installation method. Valid options: 'script' or 'binary'.
The binary method only installs rke2.
Default: 'script'.
binary_path
Parameter responsible to define the installation path of the binary. Valid options: 'string'.
Default: '/usr/bin/rke2'.
binary_version
Binary version to be installed. Valid options: 'string' in the format 'v0.0.0'.
Default: 'v1.18.8'.
Private classes
rke2::install
Class responsible to install rke2.
rke2::uninstall
Class responsible to uninstall rke2.
Dependencies
- puppet/archive (>= 4.6.0)