rancher / terraform-null-rke2-install

Terraform module to install RKE2

Terraform RKE2 Install

This module installs RKE2 on any Linux based server.

Requirements

Provider Setup

Only two of the providers require setup:

• AWS Provider : Config Reference
• GitHub Provider : Config Reference

We recommend setting the following environment variables for quick personal use:

GITHUB_TOKEN
AWS_REGION
AWS_SECRET_ACCESS_KEY
AWS_ACCESS_KEY_ID

Curl

You will need Curl available on the server running Terraform.

Local Filesystem Write Access

You will need write access to the filesystem on the server running Terraform. If downloading the files from GitHub (not setting 'skip_download'), then you will need about 2GB storage space available in the 'local_file_path' location (defaults to ./rke2).

Terraform Version

We specify the Terraform version < 1.6 to avoid potential license issues and version > 1.5.0.

RKE2 Config

Where do I put my config files? This module assumes all *.yaml files in the local_file_path are config files which can go in /etc/rancher/rke2/config/yaml.d and be used to configure rke2 see https://docs.rke2.io/install/configuration#multiple-config-files for more information.

If you are using the 'tar' install path you may supply files in that same path to fully control what is installed, you must use the expected names for the files:

generally that is:

• "rke2-images.${local.system}-${local.arch}.tar.gz"
• "rke2.${local.system}-${local.arch}.tar.gz"
• "sha256sum-${local.arch}.txt"

Examples

We have a few example implementations to get you started, these examples are tested in our CI before release. When you use them, update the source and version to use the Terraform registry.

Local State

The specific use case for the example modules is temporary infrastructure for testing purposes. With that in mind, it is not expected that we manage the resources as a team, therefore the state files are all stored locally. If you would like to store the state files remotely, add a terraform backend file (*.name.tfbackend) to your root module. https://www.terraform.io/language/settings/backends/configuration#file

Development and Testing

Paradigms and Expectations

Please make sure to read terraform.md to understand the paradigms and expectations that this module has for development.

Environment

It is important to us that all collaborators have the ability to develop in similar environments, so we use tools which enable this as much as possible. These tools are not necessary, but they can make it much simpler to collaborate.

• I use nix that I have installed using their recommended script
• I use direnv that I have installed using brew.
• I simply use direnv allow to enter the environment
• I navigate to the tests directory and run go test -v -timeout=40m -parallel=10
  • It is important to note that the test files do not stand alone, they expect to run as a package.
  • This means that specifying the file to test (as follows) will fail: go test -v -timeout 40m -parallel 10 basic_test.go
• To run an individual test I navigate to the tests directory and run go test -v -timeout 40m -parallel 10 -run="<test function name>"
  • eg. go test -v -timeout 40m -parallel 10 -run TestBasic
• I store my credentials in a local files and generate a symlink to them
  • eg. ~/.config/github/default/rc
  • this will be automatically sourced when you enter the nix environment (and unloaded when you leave)
  • see the .envrc and .rcs file for the implementation

Automated Tests

Our continuous integration uses Nix to ensure a consistent environment.

Our CI has special integrations with AWS to allow secure authentication, see https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services for more information.