Merge pull request #35 from project-codeflare/features-md

Adding mcad features documentation

Author: Mohammed Abdi

FEATURES.md

@@ -0,0 +1,135 @@
+# MCAD DASHBOARD
+
+## Features
+
+### Dashboard Tab
+- [1: Cluster Avaiable Resources](#cluster-avaiable-resources)
+- [2: Status Summary](#status-summary)
+- [3: Appwrapper Summary](#appwrapper-summary)
+
+### Metrics Tab
+- [4: Cluster Status Summary Metrics](#cluster-status-summary-metrics)
+- [5: Appwrapper Quota Summary](#appwrapper-quota-summary-metrics)
+- [6: CPU Usage by Appwrapper](#cpu-usage-by-appwrapper)
+- [7: Memory Usage by Appwrapper](#memory-usage-by-appwrapper)
+- [8: CPU Request by Namespace](#cpu-request-by-namespace)
+- [9: Memory Request by Namespace](#memory-request-by-namespace)
+- [10: Refresh Rate](#refresh-rate)
+- [11: Time Range](#time-range)
+
+
+#### 1. Cluster Avaiable Resources
+
+This section on the dashboard shows cluster avaiable resources such as:
+
+- Avaiable CPU %
+- Utilized CPU %
+- Avaiable Memory %
+- Utilized Memory %
+- Avaiable CPU (Cores)
+- Avaiable Memory (Mebibytes)
+
+![Cluster Avaiable Resources](docs/rsrc/MCAD-dashboard/cluster_avaiable_resources.png)
+
+#### 2. Status Summary
+
+The appwrapper status summary section that shows overall/ total appwrapper states including:
+
+- Dispatched
+- Queued
+- Re-enqueued
+- Other
+
+![Status Summary](docs/rsrc/MCAD-dashboard/status_summary.png)
+
+#### 3. Appwrapper Summary
+
+Appwrapper summary table that shows appwrapper metadata including:
+
+- Name of Appwrapper
+- Namespace
+- Date Created On
+- Age of Appwrapper since creation
+- Priority of Appwrapper
+- Current State of Appwrapper 
+- Number of Times Appwrapper was Re-enqueued
+- Latest Message - which gives more details on current state of appwrapper
+
+![Appwrapper Summary](docs/rsrc/MCAD-dashboard/appwrapper_summary.png)
+
+#### Appwrapper Summary Full Table
+![Appwrapper Summary Full](docs/rsrc/MCAD-dashboard/appwrapper_summary_full.png)
+
+#### Appwrapper Summary Search
+
+There is a search feature within the appwrapper summary table, the table is searchable by :
+
+- Name of Appwrapper 
+- Namespace
+- Date Created On
+
+![Appwrapper Summary Search](docs/rsrc/MCAD-dashboard/appwrapper_summary_search.png)
+
+#### 4. Cluster Status Summary Metrics
+
+This feature is under the metrucs tab, which shows the cluster resources summary such as:
+
+- CPU Utilization %
+- Memory Utilization %
+- CPU Requests Commitment 
+- Memory Requests Commitment
+- CPU Limits Commitment 
+- Memory Limits Commitment
+
+![Cluster Status Summary Metrics](docs/rsrc/MCAD-dashboard/metrics_cluster_status_summary.png)
+
+#### 5. Appwrapper Quota Summary Metrics
+
+This section displays a table of appwrapper quota sumary by namespace, it shows namespace specific information such as:
+
+- Name of Namespace
+- Number of Appwrappers in Namespace
+- CPU Usage
+- Memory Usage 
+- CPU Requests
+- Memory Requests
+- CPU Limits
+- Memory Limits 
+
+![Appwrapper Quota Summary Metrics](docs/rsrc/MCAD-dashboard/metrics_appwrapper_quota-summary.png)
+
+#### 6. CPU Usage by Appwrapper
+
+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. 
+
+![CPU Usage (by Appwrapper) Metrics](docs/rsrc/MCAD-dashboard/metrics_cpu_usage_by_appwrapper.png)
+
+#### 7. Memory Usage by Appwrapper
+
+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. 
+
+![Memory Usage (by Appwrapper) Metrics](docs/rsrc/MCAD-dashboard/metrics_memory_usage_by_appwrapper.png)
+
+#### 8. CPU Request by Namespace
+
+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. 
+
+![CPU Request (by Namespace) Metrics](docs/rsrc/MCAD-dashboard/metrics_cpu_request_by_namespace.png)
+
+#### 9. Memory Request by Namespace
+
+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. 
+
+![Memory Request (by Namespace) Metrics](docs/rsrc/MCAD-dashboard/metrics_memory_request_by_namespace.png)
+
+#### 10. Refresh Rate
+
+The refresh rate to retrive data from server can be changed using the dropdown on top of the dashboard
+
+![Refresh Rate](docs/rsrc/MCAD-dashboard/refresh_rate.png)
+
+#### 11. Time Range
+
+The time range can be changed by using the Time Range drop down on top of the dashboard. 
+
+![Time Range](docs/rsrc/MCAD-dashboard/time_range.png)

README.md

@@ -2,6 +2,14 @@
 
 A dashboard for Multi-Cluster App Dispatcher and Open Data Hub components.
 
+![Status Summary](docs/rsrc/MCAD-dashboard/status_summary.png)
+
+For more detailed current features of the MCAD dashboard:
+ 
+- [MCAD Dashboard Features](/FEATURES.md)
+
+
+ODH Dashboard Installation and Components:
 - Shows what's installed
 - Show's what's available for installation
 - Links to component UIs