From 34d5156eeb3555190fd152930cfe7dbb23722adf Mon Sep 17 00:00:00 2001 From: Ludovico Magnocavallo Date: Sat, 6 Aug 2022 11:07:22 +0200 Subject: [PATCH] top-level README --- fast/stages/03-gke-multitenant/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/fast/stages/03-gke-multitenant/README.md b/fast/stages/03-gke-multitenant/README.md index 93473f7d..1974f9a7 100644 --- a/fast/stages/03-gke-multitenant/README.md +++ b/fast/stages/03-gke-multitenant/README.md @@ -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.