From 70c28be5fa5b494bff60ef2e239729376e57dbb2 Mon Sep 17 00:00:00 2001 From: nold Date: Tue, 16 Nov 2021 10:07:12 +0100 Subject: [PATCH] Update docs --- README.md | 9 ++++++--- docs/Filestructure.md | 2 ++ docs/config/application.md | 1 + 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 65ed17a..6e58af8 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,17 @@ *Heqet (Egyptian ḥqt, also ḥqtyt "Heqtit") is an Egyptian goddess of fertility.* -Heqet is my attempt to make Kubernetes GitOps Deployments as easy as possible. It reduces the need of configuration by generating the required Kubernetes resource definitions for you. Heqet heavily relies on a Helm-Chart which will generate all ArgoCD-Applications, -Projects, Namespaces & more using Argo-CDs [App-of-Apps-Pattern](https://argoproj.github.io/argo-cd/operator-manual/cluster-bootstrapping/). +Heqet is my attempt to make Kubernetes GitOps Deployments as easy as possible. It reduces the need of redundant configuration by generating the required Kubernetes resource definitions for you. Heqet heavily relies on a Helm-Chart which will generate all ArgoCD-Applications, -Projects, Namespaces & more using Argo-CDs [App-of-Apps-Pattern](https://argoproj.github.io/argo-cd/operator-manual/cluster-bootstrapping/). ## Keyfeatures * Easy Setup [Just requires a sane Kubernetes cluster + ArgoCD + PVC-StorageClass] * Easy / DRY application definition & configuration * Follows the GitOps principles * Deploy a whole application environment or cluster from a singe git-repo - * Addons like generation of `VaultSecret` and `NetworkPolicy` resources + * Addons for simple generation of `VaultSecret` and `NetworkPolicy` resources + * Include reuseable resources like value snippets & NetworkPolicies into your app -**This project is still in a very early stage of development, but feel free to try it out, give feedback, create an issue and contribute!** +**This project is still under active development. Feel free to try it out, give feedback, create an issue and contribute!** ## Overview @@ -30,8 +31,10 @@ The configuration is seperated in different files & directories: * `project.yaml` - The most important config, containing all our applications of this project * `values/` - Every app in our project can have it's own `values.yaml` here, named: `name-of-app.yaml` * `name-of-app.yaml` - Values file for the application "name-of-app" + * `manifests/` - Static yaml manifests for your app * `resources/` - This directory contains all global config, like NetworkPolcies, Repos * `manifests/` - Can be used for static YAML-Manifests + * `sippets/` - Value snippets for your apps ## Installation diff --git a/docs/Filestructure.md b/docs/Filestructure.md index 486c895..33f6721 100644 --- a/docs/Filestructure.md +++ b/docs/Filestructure.md @@ -5,8 +5,10 @@ * `project.yaml` - The most important config, containing all our applications of this project * `values/` - Every app in our project can have it's own `values.yaml` here, named: `name-of-app.yaml` * `name-of-app.yaml` - Values file for the application "name-of-app" + * `manifests/` - Static YAML-files for the project * `resources/` - This directory contains all global config, like NetworkPolcies, Repos * `manifests/` - Can be used for static YAML-Manifests + * `snippets/` - Value snippets that can be included using `include`-Array in apps ## Overview diff --git a/docs/config/application.md b/docs/config/application.md index b40ed3d..a7ec905 100644 --- a/docs/config/application.md +++ b/docs/config/application.md @@ -23,6 +23,7 @@ | automated.selfHeal | bool | `false` | `true` | ArgoCD automatic self-heal app | | ignoreDiff | array | | See ArgoCD docs | ArgoCD [ignoreDifferences](https://argoproj.github.io/argo-cd/user-guide/diffing/) | parameters | array | |- name: ingress.host
value: awesome.url | Parameters override values of app | +| include | array | | - value-snippet | Include a values snippet from `resources/snippets` | ## Full Example Check out the `hive`-Branch of this repo for my current homelab setup.