Skip to content

Commit

Permalink
docs: add product workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
ffforest authored and 镜烛 committed Oct 23, 2023
1 parent 46b4f7f commit 75e0e6b
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions docs/core-workflow.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 75e0e6b

Please sign in to comment.