Agent configuration
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
- Installing on Red Hat OpenShift
- Feature gates
- Namespace allowList and denyList
Third-party secret management
Indicates whether the StormForge Agent creates and manages its authorization secret.
Helm parameter | Default value |
---|---|
manageAuthSecret |
true |
Description
Set to false
to manage the Agent authorization secret with a third-party credential manager. For details and the Agent secret format, see this guide.
Valid values
true
(default)false
Installing on Red Hat OpenShift
Required only when installing the Agent on Red Hat OpenShift.
Helm parameter | Default value |
---|---|
openshift |
false |
Description
Set to true
when installing the StormForge Agent on Red Hat OpenShift Container Platform version 4.x and later. For detailed steps, see this guide.
Valid values
true
false
Feature gates
Used for enabling or disabling features that are:
- In a preview stage (not production-ready but available for testing).
- Apply only to specific environments.
You can turn these features on or off by:
- Using the
--set featureGates.FEATURE=VALUE
command line flag in a Helm command. - Including the parameter in a
values.yaml
file.
Feature | Default value | Comment | Stage |
---|---|---|---|
optimizeCronJobs |
false | Optimize CronJob workload types. |
Preview |
optimizeSparkOperator |
false | Optimize ScheduledSparkApplication workload types. |
Preview |
optimizeGithubARC |
false | Optimize AutoscalingRunnerSet workload types. |
Preview |
Note about CronJobs
A CronJob (or any short-duration job) must typically run for at least 10 continuous minutes in order for Optimize Live to generate a recommendation. In some scenarios, less than 10 minutes is sufficient, depending on the frequency of the job. If a job doesn’t run long enough to provide enough metrics, Optimize Live labels the workload as Unsupported ().Valid values
false
true
Example:
featureGates:
optimizeCronJobs: true
optimizeSparkOperator: true
Namespace allowList and denyList
Comma-separated list of namespaces that constrains metrics collection to workloads in specific namespaces.
Helm parameter | Default value |
---|---|
workload.allowNamespaces |
None |
workload.denyNamespaces |
["kube-system","openshift.*"] |
Description
Set only one of these values, not both. If both lists are provided, workload.denyNamespaces
is ignored.
- To allow metrics collection on specific workloads, use
workload.allowNamespaces
. - To deny metrics collection on specific workloads, use
workload.denyNamespaces
.
The default value for the workload.denyNamespaces
Helm parameter lists common system namespaces that the Agent does not monitor.
Valid values
An array containing any string or regex expressions ([]*regexp.Regexp
) to match against namespace names.
Examples:
workload:
denyNamespaces:
- ".*-system"
or
workload:
denyNamespaces: null
allowNamespaces:
- "monitoring"
- "frontend"
- ".ecommerce-*"
To explicitly unset either of these values, use null
.
workload:
denyNamespaces: null