Docs » Integrations Guide » Monitor Kubernetes » Kubernetes Quick Installation

Kubernetes Quick Installation 🔗

We recommend that you use Helm to install and configure the SignalFx Smart Agent in your Kubernetes environment. Helm allows multiple resources (that is, DaemonSet, configmap, clusterrole, and clusterrole binding) to be configured by a single script action.

If you want to install the SignalFx Smart Agent on your Kubernetes cluster using kubectl, see the Kubernetes Advanced Installation.

Smart Agent Quick Install for Kubernetes using Helm 🔗

Prerequisites

  • You have installed and configured the Helm client; for more information, see Installing Helm.
  • Tiller is running on your Kubernetes cluster.

Step 1. Add the SignalFx Helm chart repository to Helm.

$ helm repo add signalfx https://dl.signalfx.com/helm-repo

Step 2. Ensure the latest state of the repository.

$ helm repo update

Step 3. Install the Smart Agent chart with the necessary configuration values for the chart.

$ helm install --set signalFxAccessToken=<YOUR_ACCESS_TOKEN> --set clusterName=<YOUR_CLUSTER_NAME> --set agentVersion=<VERSION_NUMBER> --set signalFxRealm=<YOUR_SIGNALFX_REALM> <SIGNALFX_AGENT_APPNAME> signalfx/signalfx-agent


Config Options Required or Optional Description
YOUR_ACCESS_TOKEN Required The token used to authenticate your connection to SignalFx.
YOUR_CLUSTER_NAME Required (if not overriding the Smart Agent config template and providing your own cluster name) A name that will be applied as the kubernetes-cluster dimension to any metric originating in this cluster.
VERSION_NUMBER Optional Specify the version to install. By default, the latest released version will be installed.
YOUR_SIGNALFX_REALM Required Specify the name of the realm in which your organization is hosted. The realm name is shown on your profile page in the SignalFx web application.
SIGNALFX_AGENT_APPNAME Required

Provide a name or specify --generate-name. For example, if you choose signalfx-agent for the application name, once the Helm install is successful, you will see the following output:

NAME: signalfx-agent
LAST DEPLOYED: Fri May  8 11:35:26 2020
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
The SignalFx agent is being deployed in your Kubernetes cluster.  You should
see metrics flowing once the agent image is downloaded and started (this may
take a few minutes since it has to download the agent container image).
Assuming you are logged into SignalFx in your browser, visit
https://app.us0.signalfx.com/#/navigator/kubernetes%20pods/kubernetes%20pods
to see all of the pods in your cluster.

Optionally, specify agentConfig if you want to provide your own agent configuration.

If you are using OpenShift, set kubernetesDistro to openshift to get OpenShift-specific functionality.

$ helm install --set signalFxAccessToken=<YOUR_ACCESS_TOKEN> --set clusterName=<YOUR_CLUSTER_NAME> --set agentVersion=<VERSION_NUMBER> --set signalFxRealm=<YOUR_SIGNALFX_REALM> <SIGNALFX_AGENT_APPNAME> signalfx/signalfx-agent --set kubernetesDistro=openshift

Your installation is complete.