Docs » Integrations Guide » Use the Smart Agent » Install and configure the Smart Agent » Install Using Helm

Install Using Helm ๐Ÿ”—

Use the Helm package manager to install the Smart Agent to Kubernetes environments.

If you donโ€™t have Helm installed already, use kubectl to install the Smart Agent. To learn more, see Install the Smart Agent using kubectl.

Prerequisites ๐Ÿ”—

  • Linux kernel version 2.6.32 or higher
  • Terminal or a similar command-line interface application
  • Helm:
    • The installation chart for the Smart Agent is compatible with Helm version 2 or Helm version 3.
    • To learn more, see the Helm site.
  • Tiller installed on all of your Kubernetes hosts. Because of the way that the installation chart works, you need Tiller even if youโ€™re using Helm version 3.
  • SignalFx realm for your organization. See Realms.
  • A SignalFx access token. See Smart Agent Access Token.

Configure Helm for the Smart Agent ๐Ÿ”—

The SignalFx Smart Agent chart for Helm comes with a values.yaml configuration file that contains useful default values. If you want to modify these values, override them by creating your own values file. Follow these steps:

  1. Download the default values.yaml file.
  2. Rename the file. For example, rename it to myValues.yaml.
  3. Edit the file to update the values with your own choices, then save the file.

When you install the Smart Agent using Helm, add the -f <values_yaml_file> parameter to the install command. For example, add the -f myValues.yaml parameter.

Install with Helm ๐Ÿ”—

Preliminary tasks ๐Ÿ”—

  1. Remove collector services such as collectd.

  2. Add the SignalFx Helm chart repository to Helm by entering the following command:

    helm repo add signalfx https://dl.signalfx.com/helm-repo
    
  3. Check that the repository is up-to-date by entering the following command:

    helm repo update
    

Get required values ๐Ÿ”—

Get the following required values:

Name Example Meaning
<access_token> 'abcd1234zzz' Required. Access token. See Prerequisites.
<cluster_name> 'myCluster' Required.Name of the cluster to monitor
<realm> 'us0' Required. Your realm. See Prerequisites.

Get optional values ๐Ÿ”—

Determine if you want to use the following optional values:

Name Example Meaning
<values_yaml_file> myValues.yaml Optional. Custom configuration file. If you don't specify this file, Helm installs the defaults. If you don't use this parameter, don't use -f.
<version> 5.1.6 Optional. Smart Agent version. See Smart Agent releases for a a list of versions. If you don't use this, Helm installs the latest release. If you don't use this, don't use --set agentVersion=.

Configure optional OpenShift support ๐Ÿ”—

Determine if you want OpenShift support:

  • If you want OpenShift support, substitute the values from the previous steps and run this command:

    helm install -f <values_yaml_file> --set signalFxAccessToken=<access_token> --set clusterName=<cluster_name> --set agentVersion=<version> --set signalFxRealm=<realm> signalfx/signalfx-agent --set kubernetesDistro=openshift
    
  • If you donโ€™t want OpenShift support, substitute the values from the previous steps and run this command:

    helm install -f <values_yaml_file> --set signalFxAccessToken=<access_token> --set clusterName=<cluster_name> --set agentVersion=<version> --set signalFxRealm=<realm> signalfx/signalfx-agent
    

Verify the SignalFx Smart Agent ๐Ÿ”—

The SignalFx Smart Agent runs as soon as you install it using Helm.

To verify that your installation and config is working:

  • For infrastructure monitoring:

    1. In SignalFx UI, open the Infrastructure built-in dashboard.
    2. In the override bar, select Choose a host. Select one of your nodes from the dropdown.

    The charts display metrics from the infrastructure for that node.

    To learn more, see Built-In Dashboards and Charts.

  • For Kubernetes monitoring:

    1. In SignalFx UI, from the main menu select Infrastructure > Kubernetes Navigator > Cluster map.
    2. In the cluster display, find the cluster <cluster_name> you chose in the previous steps.
    3. Click the magnification icon to view the nodes in the cluster.

    The detail pane on the right hand side of the page displays details of your cluster and nodes.

    To learn more, see Getting Around the Kubernetes Navigator.

  • For APM monitoring, learn how to install, configure, and verify the Smart Agent for Microservices APM (ยตAPM). See Get started with SignalFx ยตAPM.