From 96b27df11d14f4c679b416f33194e93383a6deaf Mon Sep 17 00:00:00 2001 From: Bill <46893322+Bnjoroge1@users.noreply.github.com> Date: Tue, 30 Jul 2024 19:20:08 -0400 Subject: [PATCH 1/5] Update CONTRIBUTING.md with installation workflow diagram --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39e10306..69b5e3c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -111,6 +111,44 @@ idpbuilder is made of two phases: CLI and Kubernetes controllers. ![idpbuilder.png](docs/images/idpbuilder.png) +##Installation Flow + +```mermaid +flowchart TD + subgraph MainCluster + direction TB + subgraph ArgoCD[ArgoCD Apps] + ArgoCD_App[ArgoCD] + Ingress[Ingress-nginx] + Gitea_App[Gitea] + + end + + subgraph Gitea[Git Repositories] + Gitea_ArgoCD[ArgoCD] + Gitea_Ingress[Ingress-nginx] + Gitea_Gitea[Gitea] + + + end + + ArgoCD -->|GitOps| Gitea + end + + CorePackages[Core Packages: \nArgoCD, \nGitea, \nIngress-nginx] + LocalDir[Local Directory: \n- argocd-app.yaml \n- manifest files] + + subgraph Process + CLI[IDPBUILDER CLI] + CLI -->|1. Create \nKind Cluster| CorePackages + CorePackages -->|2. Install| MainCluster + CorePackages -->|3. Create \nRepositories and hand over \ncontrol to ArgoCD| Gitea + Gitea -->|4. Read| CLI + Gitea -->|5. Sync Custom Packages| LocalDir + end + +``` + ### CLI When the idpbuilder binary is executed, it starts with the CLI phase. From 19b1399fac7f905643cb86dd63671915eed3f612 Mon Sep 17 00:00:00 2001 From: Bill <46893322+Bnjoroge1@users.noreply.github.com> Date: Tue, 30 Jul 2024 19:20:56 -0400 Subject: [PATCH 2/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 69b5e3c4..cce21b39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -111,7 +111,7 @@ idpbuilder is made of two phases: CLI and Kubernetes controllers. ![idpbuilder.png](docs/images/idpbuilder.png) -##Installation Flow +## Installation Flow ```mermaid flowchart TD From f1d3dccf05b9c81b57ad69753124a68968926662 Mon Sep 17 00:00:00 2001 From: Bill <46893322+Bnjoroge1@users.noreply.github.com> Date: Tue, 30 Jul 2024 19:58:55 -0400 Subject: [PATCH 3/5] Update CONTRIBUTING.md to include installation workflow --- CONTRIBUTING.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cce21b39..7b1f4efe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -105,13 +105,8 @@ This script runs helm template to generate most files. See the values file for m ingress-nginx manifests are generated using a bash script available [here](./hack/ingress-nginx/generate-manifests.sh). This script runs kustomize to modify the basic installation manifests provided by ingress-nginx. -## Architecture - -idpbuilder is made of two phases: CLI and Kubernetes controllers. - -![idpbuilder.png](docs/images/idpbuilder.png) - ## Installation Flow +This diagram highlights the installation flow of idpbuilder and the varipus core packages. ```mermaid flowchart TD @@ -148,6 +143,12 @@ flowchart TD end ``` +## Architecture + +idpbuilder is made of two phases: CLI and Kubernetes controllers. + +![idpbuilder.png](docs/images/idpbuilder.png) + ### CLI From 3d50bf8482b0c86655a130924a08555b95bcd5d0 Mon Sep 17 00:00:00 2001 From: Bill <46893322+Bnjoroge1@users.noreply.github.com> Date: Tue, 30 Jul 2024 19:59:27 -0400 Subject: [PATCH 4/5] Update CONTRIBUTING.md to fix typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b1f4efe..5cb09bf8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,7 +106,7 @@ ingress-nginx manifests are generated using a bash script available [here](./hac This script runs kustomize to modify the basic installation manifests provided by ingress-nginx. ## Installation Flow -This diagram highlights the installation flow of idpbuilder and the varipus core packages. +This diagram highlights the installation flow of idpbuilder and the various core packages. ```mermaid flowchart TD From 18c57fe0dafb06cb677ec408cfd5191b715dc3ee Mon Sep 17 00:00:00 2001 From: Bill <46893322+Bnjoroge1@users.noreply.github.com> Date: Tue, 30 Jul 2024 20:05:25 -0400 Subject: [PATCH 5/5] Signed-off-by: Bill Njoroge williamsriunge@gmail.com. Update CONTRIBUTING.md --- CONTRIBUTING.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5cb09bf8..2fcbcb87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -116,15 +116,12 @@ flowchart TD ArgoCD_App[ArgoCD] Ingress[Ingress-nginx] Gitea_App[Gitea] - end subgraph Gitea[Git Repositories] Gitea_ArgoCD[ArgoCD] Gitea_Ingress[Ingress-nginx] Gitea_Gitea[Gitea] - - end ArgoCD -->|GitOps| Gitea