top-level README

This commit is contained in:
Ludovico Magnocavallo 2022-08-06 11:07:22 +02:00
parent 3745b2885e
commit 34d5156eeb
1 changed files with 5 additions and 5 deletions

View File

@ -1,10 +1,10 @@
# GKE Multitenant stage
TODO: one paragraph description
This directory contains a stage that can be used to centralize management of GKE multinenant clusters.
This directory contains
The Terraform code follows the same general approach used for the [project factory](../03-project-factory/) and [data platform](../03-data-platform/) stages, where a "fat module" contains the stage code and is used by thin code wrappers that localize it for each environment or specialized configuration:
- a reference [`dev` environment](./dev/) that can be used as-is, and cloned with few changes to implement further environments
- the [GKE stage "module"](./_module) that implements the underlying stage and is then wrapped for specific environments or configurations like `dev` above
- the [`dev` folder](./dev/) contains an example setup for a generic development environment, and can be used as-is or cloned to implement other environments, or more specialized setups
- the [`_module` folder](./_module) implements the actual stage code
Refer to the example [`dev/README.md`](./dev/README.md) for configuration details.
Refer to [the `dev` documentation](./dev/README.md) configuration details, and to [the `_module` documentation](./_module/README.md) for the architectural design and decisions taken.