Skip to content

Commit ddf56a3

Browse files
Mohammed AbdiMohammed Abdi
Mohammed Abdi
authored and
Mohammed Abdi
committed
update features doc and readme
Signed-off-by: Mohammed Abdi <[email protected]>
1 parent 2337285 commit ddf56a3

9 files changed

+39
-20
lines changed

FEATURES.md

+38-19
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,22 @@
66
- [1: Cluster Avaiable Resources](#cluster-avaiable-resources)
77
- [2: Status Summary](#status-summary)
88
- [3: Appwrapper Summary](#appwrapper-summary)
9+
- [4: Appwrapper Progress Tracker](#appwrapper-progress-tracker)
910

10-
### Metrics Tab
11-
- [4: Cluster Status Summary Metrics](#cluster-status-summary-metrics)
12-
- [5: Appwrapper Quota Summary](#appwrapper-quota-summary-metrics)
13-
- [6: CPU Usage by Appwrapper](#cpu-usage-by-appwrapper)
14-
- [7: Memory Usage by Appwrapper](#memory-usage-by-appwrapper)
15-
- [8: CPU Request by Namespace](#cpu-request-by-namespace)
16-
- [9: Memory Request by Namespace](#memory-request-by-namespace)
17-
- [10: Refresh Rate](#refresh-rate)
18-
- [11: Time Range](#time-range)
11+
### Appwrapper Metrics Tab
12+
- [5: Total Appwrapper Count by Status](#total-appwrapper-count-by-status)
13+
- [6: Appwrapper Status](#appwrapper-status)
14+
15+
### Cluster Resources Tab
16+
- [7: Cluster Status Summary Metrics](#cluster-status-summary-metrics)
17+
- [8: Appwrapper Quota Summary](#appwrapper-quota-summary-metrics)
18+
- [9: CPU Usage by Appwrapper](#cpu-usage-by-appwrapper)
19+
- [10: Memory Usage by Appwrapper](#memory-usage-by-appwrapper)
20+
- [11: CPU Request by Namespace](#cpu-request-by-namespace)
21+
- [12: Memory Request by Namespace](#memory-request-by-namespace)
22+
- [13: Refresh Rate](#refresh-rate)
23+
- [14: Time Range](#time-range)
24+
- [15: Custom Time Range](#custom-time-range)
1925

2026

2127
#### 1. Cluster Avaiable Resources
@@ -29,7 +35,7 @@ This section on the dashboard shows cluster avaiable resources such as:
2935
- Avaiable CPU (Cores)
3036
- Avaiable Memory (Mebibytes)
3137

32-
![Cluster Avaiable Resources](docs/rsrc/MCAD-dashboard/cluster_avaiable_resources.png)
38+
![Cluster Avaiable Resources](docs/rsrc/MCAD-dashboard/cluster_avaiable_resources_full.png)
3339

3440
#### 2. Status Summary
3541

@@ -68,9 +74,22 @@ There is a search feature within the appwrapper summary table, the table is sear
6874
- Namespace
6975
- Date Created On
7076

71-
![Appwrapper Summary Search](docs/rsrc/MCAD-dashboard/appwrapper_summary_search.png)
77+
#### Appwrapper Progress Tracker
78+
![Appwrapper Progress Tracker](docs/rsrc/MCAD-dashboard/appwrapper-progress-tracker.png)
79+
80+
#### 4. Appwrapper Metrics
81+
82+
This feature is under the appwrapper metrics tab, which shows the appwrapper mcad specific metrics from promethues:
83+
84+
- Total Appwrapper Count by Status
85+
86+
![Total Appwrapper Count by Status](docs/rsrc/MCAD-dashboard/total-appwrapper-count-by-status.png)
87+
88+
- Appwrapper Status
89+
90+
![Appwrapper Status](docs/rsrc/MCAD-dashboard/appwrapper-status.png)
7291

73-
#### 4. Cluster Status Summary Metrics
92+
#### 5. Cluster Status Summary Metrics
7493

7594
This feature is under the metrucs tab, which shows the cluster resources summary such as:
7695

@@ -83,7 +102,7 @@ This feature is under the metrucs tab, which shows the cluster resources summary
83102

84103
![Cluster Status Summary Metrics](docs/rsrc/MCAD-dashboard/metrics_cluster_status_summary.png)
85104

86-
#### 5. Appwrapper Quota Summary Metrics
105+
#### 6. Appwrapper Quota Summary Metrics
87106

88107
This section displays a table of appwrapper quota sumary by namespace, it shows namespace specific information such as:
89108

@@ -98,37 +117,37 @@ This section displays a table of appwrapper quota sumary by namespace, it shows
98117

99118
![Appwrapper Quota Summary Metrics](docs/rsrc/MCAD-dashboard/metrics_appwrapper_quota-summary.png)
100119

101-
#### 6. CPU Usage by Appwrapper
120+
#### 7. CPU Usage by Appwrapper
102121

103122
The following graph shows CPU usage per appwrapper through a given time, the time range can be changed by using the Time Range drop down on top of the dashboard.
104123

105124
![CPU Usage (by Appwrapper) Metrics](docs/rsrc/MCAD-dashboard/metrics_cpu_usage_by_appwrapper.png)
106125

107-
#### 7. Memory Usage by Appwrapper
126+
#### 8. Memory Usage by Appwrapper
108127

109128
The following graph shows Memory usage per appwrapper through a given time, the time range can be changed by using the Time Range drop down on top of the dashboard.
110129

111130
![Memory Usage (by Appwrapper) Metrics](docs/rsrc/MCAD-dashboard/metrics_memory_usage_by_appwrapper.png)
112131

113-
#### 8. CPU Request by Namespace
132+
#### 9. CPU Request by Namespace
114133

115134
The following graph shows CPU Request per namespace through a given time, the time range can be changed by using the Time Range drop down on top of the dashboard.
116135

117136
![CPU Request (by Namespace) Metrics](docs/rsrc/MCAD-dashboard/metrics_cpu_request_by_namespace.png)
118137

119-
#### 9. Memory Request by Namespace
138+
#### 10. Memory Request by Namespace
120139

121140
The following graph shows Memory request per namespace through a given time, the time range can be changed by using the Time Range drop down on top of the dashboard.
122141

123142
![Memory Request (by Namespace) Metrics](docs/rsrc/MCAD-dashboard/metrics_memory_request_by_namespace.png)
124143

125-
#### 10. Refresh Rate
144+
#### 11. Refresh Rate
126145

127146
The refresh rate to retrive data from server can be changed using the dropdown on top of the dashboard
128147

129148
![Refresh Rate](docs/rsrc/MCAD-dashboard/refresh_rate.png)
130149

131-
#### 11. Time Range
150+
#### 12. Time Range
132151

133152
The time range can be changed by using the Time Range drop down on top of the dashboard.
134153

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A dashboard for Multi-Cluster App Dispatcher and Open Data Hub components.
44

5-
![Status Summary](docs/rsrc/MCAD-dashboard/status_summary.png)
5+
![Status Summary](docs/rsrc/MCAD-dashboard/cluster_avaiable_resources.png)
66

77
MCAD/ ODH Dashboard Installation and Components:
88
- Shows what's installed
Loading
395 KB
Loading
Loading
Loading
128 KB
Loading
267 KB
Loading
Loading

0 commit comments

Comments
 (0)