Installation on StormForge Documentation

Basic installation

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

A Kubernetes cluster (from any Kubernetes distribution, such as EKS, AKS, minikube, or kind)
A StormForge account: Sign up for free at app.stormforge.io/signup.
In an enterprise environment, make sure a system administrator has addressed additional prerequisites (such as firewall rules and proxies)

Install the StormForge Agent

Advanced installation

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

You’ll need:

A StormForge Account
Kubernetes version 1.24 or later
Helm version 3.14.0 or later
kubectl properly configured for your cluster
Cluster-Admin access (for installation only)
A Kubernetes cluster and the cluster name to install the Agent into.
The cluster name cannot exceed 63 characters, cannot start or end with a dash (-), and must follow the RFC 1123 DNS label standard.

Be sure to:

Configure a proxy, if needed
If you use a private container registry, import the required containers
Configure firewall rules, including granting Kubernetes clusters access to these StormForge services endpoints on port 443:
- api.stormforge.io
- in.stormforge.io
- registry.stormforge.io*
  (*If you configure the Agent to use an internal registry, you don’t need to grant cluster access to this endpoint).

Prepare to install

Install the StormForge CLI tool

The StormForge CLI is used to authenticate, retrieve credentials, and register the StormForge Agent on your Kubernetes cluster.

Agent configuration

Mon, 01 Jan 0001 00:00:00 +0000

The purpose of this topic is to list and describe the additional parameters available for configuring the StormForge Agent. For parameters that apply to the StormForge Applier, see the Applier configuration topic.

Agent parameters:

Third-party secret management

Indicates whether the StormForge Agent creates and manages its authorization secret.

Applier configuration

Mon, 01 Jan 0001 00:00:00 +0000

The purpose of this topic is to list and describe the additional parameters available for configuring the StormForge Applier. For parameters that apply to the StormForge Agent, see the Agent configuration topic.

Applier settings:

Continuous reconciliation

Controls resource patching behavior based on CI/CD and cluster activity. Auto-deploy must be enabled.

Parameter	Default value
`reconciliation.mode`	`EventBased`
`reconciliation.conflictingManagers`	None

Description

The StormForge Applier can be configured to continuously reconcile drift, ensuring that the latest recommended settings are always maintained on a workload.

Install Optimize Live as an EKS add-on

Mon, 01 Jan 0001 00:00:00 +0000

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

Install using the EKS UI and StormForge UI

Get the add-on

Open two browser windows side by side.
In one window, navigate to and log in to your Amazon EKS cluster.

Install on Red Hat OpenShift Container Platform

Mon, 01 Jan 0001 00:00:00 +0000

Red Hat OpenShift Container Platform is a Kubernetes solution for both cloud and on-premises with providers such as AWS, Google and Microsoft Azure. Optimize Live is compatible with OpenShift Container Platform versions 4.x and later.

Installation

To install the StormForge Agent on OpenShift, do one of the following:

In the StormForge Agent values.yaml file, set openshift: true as a non-nested key-value pair, and then apply the file:
```
kubectl apply -f values.yaml
```
Include the --set openshift=true argument when you run helm install, as in this example:

Upgrade

Mon, 01 Jan 0001 00:00:00 +0000

Upgrade both the Agent and the Applier at the same time to ensure compatibility between them.

(Optional) Review the current Helm values:
```
helm get values stormforge-agent -n stormforge-system 
```
Note: To change (add, remove, or edit) the existing Helm values, save this output to a .yaml file and modify it as needed. When you upgrade, pass the adjusted values file to Helm using the -f flag.
To upgrade the Agent and reuse all the current Helm values, run:

Uninstall

Mon, 01 Jan 0001 00:00:00 +0000

Uninstall both the Agent and Applier when you want to stop optimizing workloads on a cluster or before you delete a cluster from Optimize Live.

Uninstall the Applier:

helm uninstall stormforge-applier -n stormforge-system

Uninstall the Agent:

helm uninstall stormforge-agent -n stormforge-system