k3s

Welcome to k3s module. This module installs the Rancher's lightweight Kubernetes, k3s (see more on https://k3s.io/).

Table of Contents

1. Description
2. Setup - The basics of getting started with k3s
   • Beginning with k3s
3. Usage - Configuration options and additional functionality
4. Development - Guide for contributing to the module

Description

This module installs the open source Rancher's lightweight Kubernetes, k3s.

Using this module, you can easily automate k3s installation in many machines, like in a School Lab or in a Raspberry Pi cluster.

Setup

Beginning with k3s

Install this module using Puppet: puppet module install igorolivei/k3s

Or via Puppetfile: mod 'igorolivei-k3s', '1.0.0'

Usage

• Quick run: puppet apply -e "include k3s"

• Installing using the script installation mode:

class { 'k3s':
  installation_mode => 'script',
}

• Installing using the binary installation mode:

class { 'k3s':
  installation_mode => 'binary',
}

• Ensuring that it is uninstalled:

class { 'k3s':
  ensure            => 'absent',
  installation_mode => 'binary',
}

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: Igor Oliveira (igor.bezerra96@gmail.com)

Reference

Public classes

k3s

Interface class to manage installation or uninstall.

Parameters

ensure

Whether the k3s must be installed or not. Valid options: 'present' or 'absent'.

Default: 'present'.

installation_mode

The k3s installation method. Valid options: 'script' or 'binary'.

The binary method only installs k3s.

Default: 'script'.

binary_path

Parameter responsible to define the installation path of the binary. Valid options: 'string'.

Default: '/usr/bin/k3s'.

binary_version

Binary version to be installed. Valid options: 'string' in the format 'v0.0.0'.

Default: 'v1.18.8'.

Private classes

k3s::install

Class responsible to install k3s.

k3s::uninstall

Class responsible to uninstall k3s.

Changelog

All notable changes to this project will be documented in this file.

Release 1.0.0

Features

Install K3s using the official script or downloading the official binary.

Release 1.0.1

Features

Fix error on metadata requirements.