The purpose of this guide is to get you started with StormForge Optimize Pro. In this example, you will use StormForge Optimize Pro to tune the memory and cpu requirements for Postgres. We will cover:
- Initializing StormForge Optimize Pro Controller in your cluster
- Deploying the Postgres experiment to your cluster
- Running trials using machine learning (ML) to determine the best configuration
- Comparing StormForge Optimize Pro results to a baseline configuration
- Kubernetes cluster
- A typical minikube cluster will be sufficient. The experiment may consume up to 4vcpu and 4GB memory
- kubectl properly configured for your cluster
- kustomize v3.1.0+
- StormForge Optimize Pro Account
Initialize the StormForge Optimize Pro Controller
$ stormforge login
When you initialize StormForge Optimize in your cluster, the following resources will be created:
trialcustom resource definitions
ClusterRoleBindingfor the controller service account
- an authorization secret for the controller
Initialize your cluster with the following command:
$ stormforge init
Verify controller is running:
$ stormforge check controller
Create the Experiment
We’re going to use the Postgres example.
This example will deploy the Postgres application and configure an experiment to tune the memory and CPU limits for Postgres.
The controller will schedule trials (Kubernetes jobs) using
pgbench to generate load against our Postgres instance.
Each trial will test a different set of parameters provided by the API.
The effectiveness of each trial is gauged by the metrics, in this case we contrast cost versus duration.
Deploy the Postgres application and experiment using the following:
$ kustomize build github.com/thestormforge/examples/postgres | \ kubectl apply -f -
You can monitor the progress using
$ kubectl get trials -o wide -w
You should see output similar to this:
NAME STATUS ASSIGNMENTS VALUES postgres-example-000 Completed cpu=1319, memory=1457 duration=7, cost=33 postgres-example-001 Completed cpu=963, memory=2647 duration=5, cost=29 postgres-example-002 Completed cpu=2394, memory=1934 duration=5, cost=58 postgres-example-003 Completed cpu=3508, memory=2654 duration=6, cost=85 postgres-example-004 Completed cpu=3410, memory=1019 duration=5, cost=78 postgres-example-005 Completed cpu=2757, memory=2538 duration=4, cost=68 postgres-example-006 Completed cpu=983, memory=3057 duration=6, cost=30 postgres-example-007 Completed cpu=373, memory=3065 duration=15, cost=17 postgres-example-008 Waiting cpu=1198, memory=2701
The trials will run until the
experimentBudget is satisfied. In this example, there will be 40 trials that run.
While the trial is running, there may be assignment combinations that are unstable and result in a failure.
After the trial is complete, you will be able to view the parameters and the metrics generated from the trial.
View the Results
The results can be reviewed as a visualization in the StormForge app.
You can review the trials that have taken place and decide which parameter makes the most appropriate trade-off or use our recommended configuration.
The baseline trial (which is typically used to compare your current configuration to the optimized configurations) will be displayed as a triangle on the results page along with your experiment results, this was set using the
baseline field for each parameter in our experiment.
There is a filter on the upper right hand side where you can narrow your results to show only the
These are the trials with the best possible combination of cost and duration, meaning if you hold cost fixed at a given value, we have found the best possible duration.
You can choose any
best configuration that works for your cost and duration preferences.
Often you find that since the metrics are not linearly related, there are some points that give a bigger boost in duration at a similar cost, so it is useful to explore all of the options to find the best one for you.
Once you have chosen an optimized configuration, click on the point to display the parameters to use in the application manifests.
Remove the Experiment
To clean up the data from your experiment, simply delete the experiment. The delete will cascade to the associated trials and other Kubernetes objects:
$ kustomize build github.com/thestormforge/examples/postgres | \ kubectl delete -f -