Install StormForge as an EKS add-on

If you’re running an Amazon EKS cluster, you can install StormForge as an EKS add-on in one of two ways:

• Using the EKS UI and StormForge UI
• Using the EKS CLI and StormForge UI

Prerequisites

• An Amazon EKS cluster
• A StormForge account — sign up for a free trial

Install using the EKS UI and StormForge UI

Install the add-on

1. Open two browser windows side by side.

2. In one window, navigate to and log in to your Amazon EKS cluster.

3. On the cluster page, add the Add-ons tab, and then click Get more add-ons.

4. On the Select add-ons page, scroll to the AWS Marketplace add-ons section.

5. From the Any category menu, select cost-management.

6. On the StormForge add-on card, select the check box in the upper right (see below); then, click Next.

   

7. On the Configure selected add-ons settings page, expand the Optional configuration settings section.

8. In the Add-on configuration schema section, you can customize your installation the same way you can customize a Helm install.

9. Copy the following placeholder text into the Configuration values text area. In a later step, you’ll replace this text with the values generated on the StormForge Access Credentials page.

   authorization:
     issuer:
     clientID:
     clientSecret:
   standbyMode: false
   

Get the cluster credentials and copy them to EKS configuration values

1. In the second browser window, go to app.stormforge.io.

2. In the left navigation, click Settings > Access Credentials, and press Add Credential.

3. In the Create Credential window, provide an identifier for the credential and click Create.

4. Copy the issuer, clientID, and clientSecret from the new credential.

   

5. In your EKS browser window, copy the new credential into the Configuration values text area, replacing the empty placeholder. The Advanced configuration panel will look like this:

   

6. In the Conflict resolution method, select Override.

7. Click Next, and then click Next again.

Validate the installation

In the StormForge left navigation, click Settings > Cluster Management and confirm the new cluster was added.

Install using the EKS CLI and StormForge UI

This method installs StormForge in standby mode.

Install the add-on

Run the following command, replacing CLUSTER_NAME with the name of your cluster and REGION with your region.

eksctl create addon --cluster CLUSTER_NAME --name stormforge_optimize-live --version "v2.8.0-eksbuild.1" --region REGION --force

This installs the add-on with the default values provided by StormForge. The Agent pod is in standby mode, and the Prometheus agent is not started yet.

Validate the installation

To validate the installation, run:

aws eks describe-addon --cluster-name CLUSTER_NAME --region REGION --addon-name stormforge_optimize-live

The output resembles the following:

In the output, look for "status": "ACTIVE" and confirm that there are no issues in the "health" section:

Manage your StormForge subscription

In Amazon EKS, go to the Add-ons page. To get the stormforge_optimize-live add-on, click the Manage subscription link.

Create a config.yaml file

This config.yaml file updates an existing cluster with the EKS add-ons. Update the placeholder values and apply:

apiVersion: eksctl.io/v1alpha5
kind: ClusterConfig
metadata:
  name: "NAME"
  region: "REGION"
addons:
- name: stormforge_optimize-live
  version: v2.8.0-eksbuild.1
  configurationValues: |-
    authorization:
      issuer: https://api.stormforge.io/
      clientID: "CLIENT_ID"
      clientSecret: "CLIENT_SECRET"
    standbyMode: false
  resolveConflicts: overwrite

Get the cluster credentials

1. In a browser window, go to app.stormforge.io.

2. In the left navigation, click Settings > Access Credentials, and press Add Credential.

3. In the Create Credential window, provide an identifier for the credential and click Create.

4. Copy the issuer, clientID, and clientSecret lines from the new credential.

   

5. Replace the issuer, clientID, and clientSecret in the EKS config.yaml file with the new credential information you just copied. Be sure to copy it to the addons.configurationValues.authorization section.

Apply the YAML config and activate the add-on

Run the following command to apply the config file and remove it from standby mode:

eksctl update addon --config-file config.yaml --force

After a minute or two, you should see output similar to the following:

Subscribe

You must subscribe to use this add-on.

1. Sign in to aws.amazon.com, and in the AWS Marketplace Buyer website, search for StormForge.
2. On the StormForge product page, click Continue to Subscribe in the upper right.
3. Review the agreement and then click Create Contract.