Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
templates
.helmignore
Chart.yaml
OWNERS
README.md
values.yaml

README.md

Instana

Instana is an [APM solution(https://www.instana.com/) built for microservices that enables IT Ops to build applications faster and deliver higher quality services by automating monitoring, tracing and root cause analysis. This solution is optimized for Kubernetes.

Introduction

This chart adds the Instana Agent to all schedulable nodes in your cluster via a DaemonSet.

Prerequisites

Kubernetes 1.9.x - 1.14.x

Working helm and tiller.

Note: Tiller may need a service account and role binding if RBAC is enabled in your cluster.

Installing the Chart

To configure the installation you can either specify the options on the command line using the --set switch, or you can edit values.yaml. Either way you should ensure that you set values for:

  • agent.key
  • zone.name or cluster.name

For most users, setting the zone.name is sufficient. However, if you would like to be able group your hosts based on the availability zone rather than cluster name, then you can specify the cluster name using the cluster.name instead of the zone.name setting. If you omit the zone.name the host zone will be automatically determined by the availability zone information on the host.

If you're in the EU, you'll probably also want to set the regional equivalent values for:

  • agent.endpointHost
  • agent.endpointPort

Note: Check the values for the endpoint entries in the agent backend configuration.

Optionally, if your infrastructure uses a proxy, you should ensure that you set values for:

  • agent.pod.proxyHost
  • agent.pod.proxyPort
  • agent.pod.proxyProtocol
  • agent.pod.proxyUser
  • agent.pod.proxyPassword
  • agent.pod.proxyUseDNS

Optionally, if your infrastructure has multiple networks defined, you might need to allow the agent to listen on all addresses (typically with value set to '*'):

  • agent.listenAddress

If your agent requires download key, you should ensure that you set values for it:

  • agent.downloadKey

Agent can have APM, INFRASTRUCTURE or AWS mode. Default is APM and if you want to override that, ensure you set value:

  • agent.mode

To install the chart with the release name instana-agent and set the values on the command line run:

$ helm install --name instana-agent --namespace instana-agent \
--set agent.key=INSTANA_AGENT_KEY \
--set agent.endpointHost=HOST \
--set zone.name=ZONE_NAME \
stable/instana-agent

To install the chart with the release name instana-agent after editing the values.yaml file, run:

$ helm install --name instana-agent --namespace instana-agent stable/instana-agent

Uninstalling the Chart

To uninstall/delete the instana-agent daemon set:

$ helm del --purge instana-agent

Configuration

Helm Chart

The following table lists the configurable parameters of the Instana chart and their default values.

Parameter Description Default
agent.configuration_yaml Custom content for the agent configuration.yaml file nil See below for more details
agent.downloadKey Your Instana Download key nil Usually not required
agent.endpointHost Instana Agent backend endpoint host saas-us-west-2.instana.io
agent.endpointPort Instana Agent backend endpoint port 443
agent.image.name The image name to pull instana/agent
agent.image.tag The image tag to pull 1.0.29
agent.image.pullPolicy Image pull policy IfNotPresent
agent.key Your Instana Agent key nil You must provide your own key
agent.leaderElectorPort Instana leader elector sidecar port 42655
agent.listenAddress List of addresses to listen on, or "*" for all interfaces nil
agent.mode Agent mode (Supported values are APM, INFRASTRUCTURE, AWS) APM
agent.pod.annotations Additional annotations to apply to the pod {}
agent.pod.limits.cpu Container cpu limits in cpu cores 1.5
agent.pod.limits.memory Container memory limits in MiB 512
agent.pod.proxyHost Hostname/address of a proxy nil
agent.pod.proxyPort Port of a proxy nil
agent.pod.proxyProtocol Proxy protocol (Supported proxy types are "http", "socks4", "socks5") nil
agent.pod.proxyUser Username of the proxy auth nil
agent.pod.proxyPassword Password of the proxy auth nil
agent.pod.proxyUseDNS Boolean if proxy also does DNS nil
agent.pod.requests.memory Container memory requests in MiB 512
agent.pod.requests.cpu Container cpu requests in cpu cores 0.5
agent.pod.tolerations Tolerations for pod assignment []
agent.redactKubernetesSecrets Enable additional secrets redaction for selected Kubernetes resources nil See Kubernetes secrets for more details.
cluster.name Display name of the monitored cluster Value of zone.name
podSecurityPolicy.enable Whether a PodSecurityPolicy should be authorized for the Instana Agent pods. Requires rbac.create to be true as well. false See PodSecurityPolicy for more details.
podSecurityPolicy.name Name of an existing PodSecurityPolicy to authorize for the Instana Agent pods. If not provided and podSecurityPolicy.enable is true, a PodSecurityPolicy will be created for you. nil
rbac.create Whether RBAC resources should be created true
serviceAccount.create Whether a ServiceAccount should be created true
serviceAccount.name Name of the ServiceAccount to use instana-agent
zone.name Zone that detected technologies will be assigned to nil You must provide either zone.name or cluster.name, see above for details

Development and debugging options

These options will be rarely used outside of development or debugging of the agent.

Parameter Description Default
agent.host.repository Host path to mount as the agent maven repository nil

Agent

To configure the agent, you can either:

  • edit the config map, or
  • provide the configuration via the agent.configuration_yaml parameter in values.yaml

This configuration will be used for all Instana Agents on all nodes. Visit the agent configuration documentation for more details on configuration options.

You can’t perform that action at this time.