From 37017d2da9a7d3d2e859bf3057e922cec3483eb8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=95=9C=E7=83=9B?= <chenzai.cz@antgroup.com>
Date: Mon, 23 Oct 2023 21:53:23 +0800
Subject: [PATCH] docs: add product workflow

---
 docs/core-workflow.md | 68 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 docs/core-workflow.md

diff --git a/docs/core-workflow.md b/docs/core-workflow.md
new file mode 100644
index 00000000..76c9c513
--- /dev/null
+++ b/docs/core-workflow.md
@@ -0,0 +1,68 @@
+# Product Workflow
+
+## Core workflow
+Configure (Admin) -> Search (User) -> Insight (User)
+
+## User workflow:
+- Login
+- Configure (Admin)
+    - Cluster Management
+        - Cluster Registration
+            - Cluster Registration (manual)
+                - If Cluster not registered:
+                    - Click "register new cluster"
+                    - Fill in cluster name (in the scope of Karbour)
+                    - Fill in cluster metadata: Description, Tags
+                    - Fill in cluster credential
+                        - Paste the KubeConfig content in the text box
+                        - Or upload the KubeConfig file
+                    - Click "submit"
+                - If Cluster already registered (Optional):
+                    - Update cluster metadata only: Description, Tags
+                    - Rotate certificates
+                        - Paste the new KubeConfig content in the text box
+                        - Or upload the new KubeConfig file
+            - Cluster Registration (automatic using third-party extension)
+        - Check Cluster Status
+            - Click into Cluster Insight (-> Cluster Insight)
+        - Resource Data Customization
+            - Paste data storage customization
+- Search (User)
+    - Resource Search
+        - Choose search syntax: DSL-based, SQL, Natural Language
+        - Fill in search criteria (with tips, prompts and auto-completes)
+        - Click "Search"
+        - Click any search results (-> Resource Insight) or search again
+- Insight (User)
+    - Click into Cluster Insight (-> Cluster Insight)
+    - Cluster Insight
+        - Cluster Info
+            - Hover on certain fields to display more information
+            - Click into Node Details (-> Resource Insight for nodes)
+        - Cluster Overview
+            - Click "view Event"
+            - Click "view Logs" for control plane logs
+        - Cluster Issue
+            - Filter issue by keyword, severity or labels
+            - Sort by columns (By severity by default)
+            - Click into any issue to display more information (-> Issue Details)
+        - Cluster Score
+            - Click to expand into a time-series chart
+    - Resource Insight
+        - Resource Topology
+            - Hover on any resource to display more information
+            - Zoom in or out
+            - Click any resource (-> Resource Insight)
+        - Resource Overview
+            - Click "view YAML"
+            - Click "view Event"
+            - Click "view Logs" for workloads
+        - Resource Issues
+            - Filter issue by keyword, severity or labels
+            - Sort by columns (By severity by default)
+            - Click into any issue to display more information (-> Issue Details)
+        - Resource Score
+            - Click to expand into a time-series chart
+    - Issue Details (User)
+        - Check Issue Details
+        - Click QuickFix if present