Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating ReadMe For Local Monitoring #97

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updating ReadMe For Local Monitoring #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
419669f
updating readme for benchmarks and min resources
shekhar316 Oct 18, 2024
503f856
adding space
shekhar316 Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions monitoring/local_monitoring/ReadMe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

With Kruize's local monitoring mode, let's explore a demonstration of local monitoring, highlighting how it provides customized recommendations for various load scenarios in Openshift.

## Requirements
- Demo requires a kubernetes cluster. Currently, it supports `Kind`, `Minikube` and `Openshift`
- To run this demo locally, demo expects minikube or kind cluster to be installed with atleast 8 CPUs and 16384 MB (16 GB) Memory.

## Getting Started with the Demo

To begin exploring local monitoring capabilities, follow these steps:
Expand Down Expand Up @@ -46,16 +50,22 @@ m = manifests of the benchmark

This demo focuses on using the TFB (TechEmpower Framework Benchmarks) benchmark to simulate different load conditions and observe how Kruize-Autotune reacts with its recommendations. Here’s a breakdown of what happens during the demo:

- TFB deployment in default Namespace
- Benchmarks Installation
- For *conatiner* and *namespace* experiment type TFB deployment is created in default Namespace
- The TFB benchmark is initially deployed in the default namespace, comprising two key deployments
- tfb-qrh: Serving as the application server.
- tfb-database: Database to the server.
- Load is applied to the server for 20 mins within this namespace to simulate real-world usage scenarios
- For *gpu* experiment type Human-Eval job is created in default Namespace
- The Human-Eval benchmark is deployed as a Job in the default namespace.
- Install Kruize
- Installs kruize under openshift-tuning name.
- Metadata Collection and Experiment Creation
- Kruize gathers data sources and metadata from the cluster.
- Experiments `monitor_tfb_benchmark` and `monitor_tfb-db_benchmark` are created for the server and database deployments respectively in the `default` namespace.
- Following experiments are created based on experiment type -
- For *container* experiment type `monitor_tfb_benchmark` and `monitor_tfb-db_benchmark` experiments are created for the server and database deployments respectively in the `default` namespace.
- For *namespace* experiment type `monitor_app_namespace` experiment is created in the `default` namespace.
- For *gpu* experiment type `monitor_human_eval_benchmark` experiment is created for `human-eval-deployment-job` job in the `default` namespace.
- Generate Recommendations
- Generates Recommendations for all the experiments created.

Expand Down