From ea2253ce3798a676a33e37cc335074025dd4dc25 Mon Sep 17 00:00:00 2001 From: adityadshmkh Date: Thu, 10 Mar 2022 07:34:49 +0530 Subject: [PATCH 1/2] Added minikube config to pre-req minikube config command is added to make a seamless contributing experience --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b629efc5..9024362d 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,24 @@ Info: Access autotune tunables using: kubectl -n monitoring get autotuneconfig - **What does it not do ?** It does not kick off any experiments with the tunables (as yet). Stay tuned !! - **pre-req** - It expects minikube to be installed with atleast 8 CPUs and 16384MB Memory. + It expects minikube to be installed with atleast 8 CPUs and 16384MB Memory. The default memory limit is 2GB and CPU limit is 2. You can see the current config with the following command: + Altogether: + ``` + $ minikube config view vm-driver + - cpus: 2 + - memory: 2048 + ``` + Each One: + ``` + $ minikube config get memory + 2048 + $ minikube config get cpus + 2 + ``` + Also, you can set default CPU and memory while starting the minikube: + ``` + minikube start --cpus=8 --memory=16384 + ``` - ##### WARNING: The script deletes any existing minikube cluster. ## What is an Objective Function ? From 3dac0f9f85a5f54ebcaff22af447c91f5fc3c90d Mon Sep 17 00:00:00 2001 From: Aditya Deshmukh <95485007+adityadshmkh@users.noreply.github.com> Date: Mon, 28 Mar 2022 21:23:44 +0530 Subject: [PATCH 2/2] corrected a typo in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9024362d..e3ce021e 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Autotune can take an arbitrarily large set of tunables and run experiments to co - **Goal** The user has an application that is deployed to minikube and is looking to improve some aspect of performance of the application. The user specifies an "objective function" in an "Autotune object" that defines the performance aspect of the application that needs to be optimized. Autotune then analyzes the user application, breaks it down into its component layers and provides tunables associated with each layer that can help optimize the user provided objective function. - **Steps** - This demo installs Autotune along with Prometheus and Grafana to minikube. It also deploys two example REST CRUD applications, quakus galaxies and springboot petclinic, to the minikube cluster. It then deploys the "Autotune Objects" that define the objective function of the performance tuning that needs to be done for each application. + This demo installs Autotune along with Prometheus and Grafana to minikube. It also deploys two example REST CRUD applications, quarkus galaxies and springboot petclinic, to the minikube cluster. It then deploys the "Autotune Objects" that define the objective function of the performance tuning that needs to be done for each application. - **What does it do ?** It provides a list of URLs that defines the tunables for a user provided slo. See the docs for the definition of the [REST API](https://github.com/kruize/autotune/blob/master/design/API.md) associated with these URLs.