Skip to content

fix: update readme with child module info #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matttrach merged 1 commit into from
Oct 9, 2025
Merged

fix: update readme with child module info #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This module deploys infrastructure in AWS, installs rke2, then uses the rancher2 provider to install and configure rancher.
This module combines other modules that we provide to give holistic control of the lifecycle of the rancher cluster.
This is a secondary module, it deploys very little on its own, instead, it acts as an adapter/controller talking to other Terraform modules.
In some cases these modules need to exist on their own with heir own state for the infrastructure to scale properly.
To accomplish this we save the contents of the state files in our state file as a single resource and regenerate them if necessary on apply.
These child modules are saved base64 encoded in the root module's state file.

## Requirements

Expand Down Expand Up @@ -83,8 +87,7 @@ These tools are not necessary, but they can make it much simpler to collaborate.

#### Automated Tests

Our continuous integration tests using the GitHub [ubuntu-latest runner](https://github.com/actions/runner-images/blob/main/images/linux/Ubuntu2204-Readme.md),
we then rely on Nix to deploy the additional dependencies.
Our continuous integration tests using the GitHub [ubuntu-latest runner](https://github.com/actions/runner-images/blob/main/images/linux/Ubuntu2204-Readme.md), we then rely on Nix to deploy the additional dependencies.

It also 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.
Expand Down