Manage your Nobl9 Agent with Helm Charts
Nobl9 provides a collection of Helm charts you can use to manage Nobl9 Agents to retrieve SLI metrics from configured data sources and send the data back to Nobl9. The Helm charts are available on GitHub.
What is Helm?
Helm is the package manager for Kubernetes. With Helm, you can manage even the most complex Kubernetes application. You can find more detailed information in the Helm Documentation.
Helm Chart Configuration
To set up the chart, follow these steps:
Install Helm by following the steps described in the Helm Documentation and set up a connection to the desired Kubernetes cluster.
Add the Nobl9 repository by entering the following command:
helm repo add nobl9 https://nobl9.github.io/helm-charts
After entering the above-mentioned command, you can discover the available charts, for example:
helm search repo Nobl9
NAME CHART VERSION APP VERSION DESCRIPTION
nobl9/nobl9-agent 1.0.0 0.48.0 Agent to retrieve SLI metrics from configured d...
Get the Agent variables from the Nobl9 Agent configuration page in the Nobl9 UI.tip
You can find the Agent variables in the Nobl9 App by navigating to the Integrations > Sources and choosing the data source created using the Agent connection method. The variables are presented in the Agent Configuration tab.note
If there are no available data sources created using the Agent connection method in the Sources tab, you can create one by following the steps described in the Agent Documentation. For more Integration-specific details, refer to the Agent Configuration in the UI section in each Integration’s subpage.
Prepare the chart values.
Review the default configuration and the default values in the
values.yamlfile described in the nobl9-agent | Nobl9 Helm Charts Documentation.
You can extend this file with custom variables as needed. For example, if you want to add OpenTSDB as a data source, create new
values.ymlfile and add the following values:
- name: N9_METRICS_PORT
clientSecretvalues correspond to the
N9_CLIENT_SECRETvariables from the Agent Configuration.
Note that the OpenTSDB data source requires an additional
N9_AUTH_SERVERvariables can be omitted because these values are equal to the defaults described in the values.yaml | Nobl9 Helm Charts Documentation.
Deploy the chart by entering the following command:
helm install --values values.yml --generate-name nobl9/nobl9-agent
The expected output looks like this:
LAST DEPLOYED: Wed Sep 14 10:13:20 2022
TEST SUITE: None
Helm Chart Use Cases
Here are some ways you can customize your Helm chart with:
Use Existing Kubernetes Secrets
If you have an existing Kubernetes secret, for example, one synced with AWS Secrets Manager, you can adjust the chart instead of creating a new one.
As such, instead of providing secrets inline:
extraEnvs variable, for example:
- name: N9_CLIENT_ID
- name: N9_CLIENT_SECRET
Override the Namespace or Secret Name
Charts are installed in the default namespace. The secret name corresponds to the chart name. You can change that behavior using overrides, for example:
Add Extra Data to a Secret
Some data sources, Splunk, for example, require additional variables such as tokens or passwords. To securely store them, you should use Kubernetes secrets. In the Helm chart, you can define the variables you want to be included in the secret, for example:
- name: splunk_app_token
name: <secret name (defaults to chart name)>
Add Extra Labels and Annotations
You can set custom annotations and labels:
The specified variables will be appended to the existing labels, annotations, and selectors lists, for example:
You can find more combinations in the values.yaml | Nobl9 Helm Charts Documentation.