From 8148a67312475848f30161981d74622e5ff5961e Mon Sep 17 00:00:00 2001 From: Devin Buhl Date: Sun, 18 Apr 2021 07:23:22 -0400 Subject: [PATCH] fix: update readme --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 522f51a1..0f54945e 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ The purpose here is to showcase how you can deploy an entire Kubernetes cluster - [Introduction](https://github.com/k8s-at-home/template-cluster-k3s#wave-introduction) - [Prerequisites](https://github.com/k8s-at-home/template-cluster-k3s#memo-prerequisites) +- [Repository structure](https://github.com/k8s-at-home/template-cluster-k3s#open_file_folder-repository-structure) - [Lets go!](https://github.com/k8s-at-home/template-cluster-k3s#rocket-lets-go) - [Post installation](https://github.com/k8s-at-home/template-cluster-k3s#mega-post-installation) - [Thanks](https://github.com/k8s-at-home/template-cluster-k3s#handshake-thanks) @@ -61,6 +62,32 @@ After pre-commit is installed on your machine run: pre-commit install-hooks ``` +## :open_file_folder:  Repository structure + +The Git repository contains the following directories under `cluster` and are ordered below by how Flux will apply them. + +- **base** directory is the entrypoint to Flux +- **crds** directory contains custom resource definitions (CRDs) that need to exist globally in your cluster before anything else exists +- **core** directory are important infrastructure applications (grouped by namespace) that should never be pruned by Flux +- **apps** directory is where your common applications (grouped by namespace) could be placed, Flux will prune resources here if they are not tracked by Git anymore + +``` +cluster +├── apps +│ ├── default +│ ├── networking +│ └── system-upgrade +├── base +│ └── flux-system +├── core +│ ├── cert-manager +│ ├── metallb-system +│ ├── namespaces +│ └── system-upgrade +└── crds + └── cert-manager +``` + ## :rocket:  Lets go! Very first step will be to create a new repository by clicking the **Use this template** button on this page.