feat(doc): Schema tekton env

batleforc · Aug 19, 2023 · 3c93af4 · 3c93af4
1 parent bae06f6
commit 3c93af4
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 3 deletions.
diff --git a/docs/cicd/Build.md b/docs/cicd/Build.md
diff --git a/docs/cicd/Env.md b/docs/cicd/Env.md
@@ -0,0 +1,57 @@
+# Tekton Env
+
+## WorkFlow
+
+The CI/CD used in this environment is based on Tekton. If you need a deep dive into Tekton, you can read the [official documentation](https://tekton.dev/docs/).
+
+Here i will only explain how i work with Tekton.
+
+```mermaid
+flowchart TB;
+  subgraph RustTemplate;
+    EventListener
+    subgraph Pipeline;
+      FetchSource
+      BuildImage
+      BuildHelm
+      SonarScan
+      HelmUpgrade
+    end
+  end
+  subgraph Github;
+    RepoRustTemplate
+  end
+  subgraph Harbor;
+    NsRustTemplate
+  end
+  subgraph SonarQube;
+    ProjectRustTemplate
+  end
+  subgraph Buildkit;
+    BuildKit1
+  end
+  subgraph Notify;
+    NotifyManager
+    subgraph Mean;
+      Gotify
+      Discord
+    end
+  end
+  NotifyManager -->|Send notification| Gotify
+  NotifyManager -->|Send notification| Discord
+  RepoRustTemplate -->|Receive a push| RepoRustTemplate
+  RepoRustTemplate -->|Call Webhook| EventListener
+  EventListener -->|Trigger| Pipeline
+  EventListener -->|Start Pipeline| FetchSource
+  FetchSource -->|Build image| BuildImage
+  BuildImage -->|Build helm chart| BuildHelm
+  BuildHelm -->|Sonar scan| SonarScan
+  SonarScan -->|Helm upgrade| HelmUpgrade
+  FetchSource ==>|Clone source code| RepoRustTemplate
+  BuildImage -->|Build image| BuildKit1
+  BuildKit1 -->|Push image| NsRustTemplate
+  BuildHelm -->|Push helm chart| NsRustTemplate
+  SonarScan -->|Push sonar scan| ProjectRustTemplate
+  HelmUpgrade -->|Upgrade helm chart| DeployRustTemplate
+  Pipeline -->|Notify of the status| NotifyManager
+```