Skip to content

Commit c304cd6

Browse files
authored
fix: update readme with child module info (rancher#124)
Signed-off-by: matttrach <matt.trachier@suse.com>
1 parent 275dad5 commit c304cd6

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This module deploys infrastructure in AWS, installs rke2, then uses the rancher2 provider to install and configure rancher.
44
This module combines other modules that we provide to give holistic control of the lifecycle of the rancher cluster.
5+
This is a secondary module, it deploys very little on its own, instead, it acts as an adapter/controller talking to other Terraform modules.
6+
In some cases these modules need to exist on their own with heir own state for the infrastructure to scale properly.
7+
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.
8+
These child modules are saved base64 encoded in the root module's state file.
59

610
## Requirements
711

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

8488
#### Automated Tests
8589

86-
Our continuous integration tests using the GitHub [ubuntu-latest runner](https://github.com/actions/runner-images/blob/main/images/linux/Ubuntu2204-Readme.md),
87-
we then rely on Nix to deploy the additional dependencies.
90+
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.
8891

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

0 commit comments

Comments
 (0)