Install

Learn how to install and configure StormForge Optimize Live

Prerequisites

Installing the StormForge Optimize Live Controller

The StormForge Optimize Live Controller runs inside your Kubernetes cluster. It can be configured to talk to an API for automatic tuning of your application parameters.

Login

You will need to authenticate using the StormForge CLI prior to installing the StormForge Optimize Live controller. This is done in order to authenticate and grab the credentials required for the StormForge Optimize Live install via the Helm chart. You can download and install using:

$ curl -L https://app.stormforge.io/downloads/stormforge-linux-amd64.tar.gz | tar -xz && \
  sudo mv stormforge /usr/local/bin/
$ curl -L https://app.stormforge.io/downloads/stormforge-darwin-amd64.tar.gz | tar -xz && \
  sudo mv stormforge /usr/local/bin/
$ curl -L https://app.stormforge.io/downloads/stormforge-darwin-arm64.tar.gz | tar -xz && \
  sudo mv stormforge /usr/local/bin/
$ brew install thestormforge/tap/stormforge

Make sure that your version is v2.0.8+ by running stormforge version. Then login using a web-based form:

$ stormforge login

Helm Installation

Prometheus Metrics

helm install optimize-live optimize-live \
  --repo https://registry.stormforge.io/chartrepo/library/ \
  --wait \
  --namespace stormforge-system \
  --create-namespace \
  --set metricsURL=http://prometheus-k8s-kube-promet-prometheus.monitoring.svc:9090 \
  -f <(stormforge generate secret -o helm --name optimize-live)

This installs the Optimize Live Controller in the stormforge-system namespace. You can configure your metrics store endpoint using the --set metricsURL= option.

DataDog Metrics

To use DataDog as a metrics provider for Optimize Live we need to configure these variables:

  • DD_API_KEY
  • DD_APP_KEY
  • DD_CLUSTER_NAME
  • DD_RATE_LIMIT_THRESHOLD ( optional )

The DD_API_KEY and DD_APP_KEY values can be generated through the DataDog platform under Organization Settings -> Access. DD_CLUSTER_NAME is provided during the DataDog agent installation. It can be viewed by inspecting the environment variables for the agent daemonset.

These variables should be set in the stormforge config:

stormforge config set controller.default.env.DD_APP_KEY <DD_APP_KEY>
stormforge config set controller.default.env.DD_API_KEY <DD_API_KEY>
stormforge config set controller.default.env.DD_CLUSTER_NAME <DD_CLUSTER_NAME>

After these variables have been set, helm will be used to deploy Optimize Live:

helm install optimize-live optimize-live \
  --repo https://registry.stormforge.io/chartrepo/library/ \
  --wait \
  --namespace stormforge-system \
  --create-namespace \
  -f <(stormforge generate secret -o helm --name optimize-live)

This installs the Optimize Live Controller in the stormforge-system namespace.

Manual Installation

In cases where you would need to generate and manually apply the manifests, you can generate them and output them to a file by running the below command:

helm template optimize-live optimize-live \
  --repo https://registry.stormforge.io/chartrepo/library/ \
  -f <(stormforge generate secret -o helm --name optimize-live)

You are now ready to optimize your first application by following our configuration page.

Last modified June 29, 2022