incubator/jaeger

Chart version: 0.17.4
Api version: v1
App version: 1.15.1
A Jaeger Helm chart for Kubernetes
application
Chart Type
DEPRECATED
Status
Unknown
License
11693
Downloads
https://charts.helm.sh/incubator
Set me up:
helm repo add center https://repo.chartcenter.io
Install Chart:
helm install jaeger center/incubator/jaeger
Versions (0)

DEPRECATED Jaeger

This chart has been deprecated and moved to its new home:

To add the repo:

$ helm repo add jaegertracing https://jaegertracing.github.io/helm-charts

Jaeger is a distributed tracing system.

Introduction

This chart adds all components required to run Jaeger as described in the jaeger-kubernetes GitHub page for a production-like deployment. The chart default will deploy a new Cassandra cluster (using the cassandra chart), but also supports using an existing Cassandra cluster, deploying a new ElasticSearch cluster (using the elasticsearch chart), or connecting to an existing ElasticSearch cluster. Once the back storage available, the chart will deploy jaeger-agent as a DaemonSet and deploy the jaeger-collector and jaeger-query components as standard individual deployments.

Prerequisites

  • Has been tested on Kubernetes 1.7+

  • The Cassandra chart calls out the following requirements (default) for a test environment (please see the important note in the installation section):

    resources:
    requests:
    memory: 4Gi
    cpu: 2
    limits:
    memory: 4Gi
    cpu: 2
    
  • The Cassandra chart calls out the following requirements for a production environment:

    resources:
    requests:
    memory: 8Gi
    cpu: 2
    limits:
    memory: 8Gi
    cpu: 2
    
  • The ElasticSearch chart calls out the following requirements for a production environment:

    client:
    ...
    resources:
    limits:
      cpu: "1"
      # memory: "1024Mi"
    requests:
      cpu: "25m"
      memory: "512Mi"
    master:
    ...
    resources:
    limits:
      cpu: "1"
      # memory: "1024Mi"
    requests:
      cpu: "25m"
      memory: "512Mi"
    data:
    ...
    resources:
    limits:
      cpu: "1"
      # memory: "2048Mi"
    requests:
      cpu: "25m"
      memory: "1536Mi"
    

Installing the Chart

To install the chart with the release name myrel, run the following command:

$ helm install incubator/jaeger --name myrel

After a few minutes, you should see a 3 node Cassandra instance, a Jaeger DaemonSet, a Jaeger Collector, and a Jaeger Query (UI) pod deployed into your Kubernetes cluster.

IMPORTANT NOTE: For testing purposes, the footprint for Cassandra can be reduced significantly in the event resources become constrained (such as running on your local laptop or in a Vagrant environment). You can override the resources required run running this command:

helm install incubator/jaeger --name myrel --set cassandra.config.max_heap_size=1024M --set cassandra.config.heap_new_size=256M --set cassandra.resources.requests.memory=2048Mi --set cassandra.resources.requests.cpu=0.4 --set cassandra.resources.limits.memory=2048Mi --set cassandra.resources.limits.cpu=0.4

Tip: List all releases using helm list

Installing the Chart using an Existing Cassandra Cluster

If you already have an existing running Cassandra cluster, you can configure the chart as follows to use it as your backing store (make sure you replace <HOST>, <PORT>, etc with your values):

helm install incubator/jaeger --name myrel --set provisionDataStore.cassandra=false --set storage.cassandra.host=<HOST> --set storage.cassandra.port=<PORT> --set storage.cassandra.user=<USER> --set storage.cassandra.password=<PASSWORD>

Tip: It is highly encouraged to run the Cassandra cluster with storage persistence.

Installing the Chart using an Existing Cassandra Cluster with TLS

If you already have an existing running Cassandra cluster with TLS, you can configure the chart as follows to use it as your backing store:

Content of the values.yaml file:

storage:
  type: cassandra
  cassandra:
    host: <HOST>
    port: <PORT>
    user: <USER>
    password: <PASSWORD>
    tls:
      enabled: true
      secretName: cassandra-tls-secret

provisionDataStore:
  cassandra: false

Content of the jaeger-tls-cassandra-secret.yaml file:

apiVersion: v1
kind: Secret
metadata:
  name: cassandra-tls-secret
data:
  commonName: <SERVER NAME>
  ca-cert.pem: |
    -----BEGIN CERTIFICATE-----
    <CERT>
    -----END CERTIFICATE-----
  client-cert.pem: |
    -----BEGIN CERTIFICATE-----
    <CERT>
    -----END CERTIFICATE-----
  client-key.pem: |
    -----BEGIN RSA PRIVATE KEY-----
    -----END RSA PRIVATE KEY-----
  cqlshrc: |
    [ssl]
    certfile = ~/.cassandra/ca-cert.pem
    userkey = ~/.cassandra/client-key.pem
    usercert = ~/.cassandra/client-cert.pem

kubectl apply -f jaeger-tls-cassandra-secret.yaml
helm install incubator/jaeger --name myrel --values values.yaml

Installing the Chart using a New ElasticSearch Cluster

To install the chart with the release name myrel using a new ElasticSearch cluster instead of Cassandra (default), run the following command:

$ helm install incubator/jaeger --name myrel --set provisionDataStore.cassandra=false  --set provisionDataStore.elasticsearch=true --set storage.type=elasticsearch

After a few minutes, you should see 2 ElasticSearch client nodes, 2 ElasticSearch data nodes, 3 ElasticSearch master nodes, a Jaeger DaemonSet, a Jaeger Collector, and a Jaeger Query (UI) pod deployed into your Kubernetes cluster.

Tip: If the ElasticSearch client nodes do not enter the running state, try –set elasticsearch.rbac.create=true

Installing the Chart using an Existing ElasticSearch Cluster

If you already have an existing running ElasticSearch cluster, you can configure the chart as follows to use it as your backing store:

helm install incubator/jaeger --name myrel --set provisionDataStore.cassandra=false --set provisionDataStore.elasticsearch=false --set storage.type=elasticsearch --set storage.elasticsearch.host=<HOST> --set storage.elasticsearch.port=<PORT> --set storage.elasticsearch.user=<USER> --set storage.elasticsearch.password=<password>

Tip: It is highly encouraged to run the ElasticSearch cluster with storage persistence.

Installing the Chart using an Existing ElasticSearch Cluster with TLS

If you already have an existing running ElasticSearch cluster with TLS, you can configure the chart as follows to use it as your backing store:

Content of the jaeger-values.yaml file:

storage:
  type: elasticsearch
  elasticsearch:
    host: <HOST>
    port: <PORT>
    scheme: https
    user: <USER>
    password: <PASSWORD>
provisionDataStore:
  cassandra: false
  elasticsearch: false
query:
  cmdlineParams:
    es.tls.ca: "/tls/es.pem"
  extraConfigmapMounts:
    - name: jaeger-tls
      mountPath: /tls
      subPath: ""
      configMap: jaeger-tls
      readOnly: true
collector:
  cmdlineParams:
    es.tls.ca: "/tls/es.pem"
  extraConfigmapMounts:
    - name: jaeger-tls
      mountPath: /tls
      subPath: ""
      configMap: jaeger-tls
      readOnly: true

Content of the jaeger-tls-cfgmap.yaml file:

apiVersion: v1
kind: ConfigMap
metadata:
  name: jaeger-tls
data:
  es.pem: |
    -----BEGIN CERTIFICATE-----
    <CERT>
    -----END CERTIFICATE-----
kubectl apply -f jaeger-tls-cfgmap.yaml
helm install incubator/jaeger --name myrel --values jaeger-values.yaml

Uninstalling the Chart

To uninstall/delete the myrel deployment:

$ helm delete myrel

The command removes all the Kubernetes components associated with the chart and deletes the release.

Tip: To completely remove the release, run helm delete --purge myrel

Configuration

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

Parameter Description Default
agent.annotations Annotations for Agent nil
agent.cmdlineParams Additional command line parameters nil
agent.dnsPolicy Configure DNS policy for agents ClusterFirst
agent.service.annotations Annotations for Agent SVC nil
agent.service.binaryPort jaeger.thrift over binary thrift 6832
agent.service.compactPort jaeger.thrift over compact thrift 6831
agent.image Image for Jaeger Agent jaegertracing/jaeger-agent
agent.podAnnotations Annotations for Agent pod nil
agent.pullPolicy Agent image pullPolicy IfNotPresent
agent.service.loadBalancerSourceRanges list of IP CIDRs allowed access to load balancer (if supported) []
agent.service.annotations Annotations for Agent SVC nil
agent.service.binaryPort jaeger.thrift over binary thrift 6832
agent.service.compactPort jaeger.thrift over compact thrift 6831
agent.service.zipkinThriftPort zipkin.thrift over compact thrift 5775
agent.useHostNetwork Enable hostNetwork for agents false
agent.tolerations Node Tolerations []
collector.autoscaling.enabled Enable horizontal pod autoscaling false
collector.autoscaling.minReplicas Minimum replicas 2
collector.autoscaling.maxReplicas Maximum replicas 10
collector.autoscaling.targetCPUUtilizationPercentage Target CPU utilization 80
collector.autoscaling.targetMemoryUtilizationPercentage Target memory utilization nil
collector.cmdlineParams Additional command line parameters nil
collector.podAnnotations Annotations for Collector pod nil
collector.service.httpPort Client port for HTTP thrift 14268
collector.service.annotations Annotations for Collector SVC nil
collector.image Image for jaeger collector jaegertracing/jaeger-collector
collector.pullPolicy Collector image pullPolicy IfNotPresent
collector.tolerations Node Tolerations []
collector.service.annotations Annotations for Collector SVC nil
collector.service.httpPort Client port for HTTP thrift 14268
collector.service.loadBalancerSourceRanges list of IP CIDRs allowed access to load balancer (if supported) []
collector.service.tchannelPort Jaeger Agent port for thrift 14267
collector.service.type Service type ClusterIP
collector.service.zipkinPort Zipkin port for JSON/thrift HTTP 9411
collector.extraConfigmapMounts Additional collector configMap mounts []
collector.samplingConfig Sampling strategies json file nil
elasticsearch.rbac.create To enable RBAC false
fullnameOverride Override full name nil
hotrod.enabled Enables the Hotrod demo app false
hotrod.service.loadBalancerSourceRanges list of IP CIDRs allowed access to load balancer (if supported) []
nameOverride Override name nil
provisionDataStore.cassandra Provision Cassandra Data Store true
provisionDataStore.elasticsearch Provision Elasticsearch Data Store false
query.agentSidecar.enabled Enable agent sidecare for query deployment true
query.service.annotations Annotations for Query SVC nil
query.cmdlineParams Additional command line parameters nil
query.image Image for Jaeger Query UI jaegertracing/jaeger-query
query.ingress.enabled Allow external traffic access false
query.ingress.annotations Configure annotations for Ingress {}
query.ingress.hosts Configure host for Ingress nil
query.ingress.tls Configure tls for Ingress nil
query.podAnnotations Annotations for Query pod nil
query.pullPolicy Query UI image pullPolicy IfNotPresent
query.tolerations Node Tolerations []
query.service.loadBalancerSourceRanges list of IP CIDRs allowed access to load balancer (if supported) []
query.service.port External accessible port 80
query.service.type Service type ClusterIP
query.basePath Base path of Query UI, used for ingress as well (if it is enabled) /
query.extraConfigmapMounts Additional query configMap mounts []
schema.annotations Annotations for the schema job nil
schema.extraConfigmapMounts Additional cassandra schema job configMap mounts []
schema.image Image to setup cassandra schema jaegertracing/jaeger-cassandra-schema
schema.mode Schema mode (prod or test) prod
schema.pullPolicy Schema image pullPolicy IfNotPresent
schema.activeDeadlineSeconds Deadline in seconds for cassandra schema creation job to complete 120
schema.traceTtl Time to live for trace data in seconds nil
schema.keyspace Set explicit keyspace name nil
schema.dependenciesTtl Time to live for dependencies data in seconds nil
serviceAccounts.agent.create Create service account true
serviceAccounts.agent.name The name of the ServiceAccount to use. If not set and create is true, a name is generated using the fullname template
serviceAccounts.cassandraSchema.create Create service account true
serviceAccounts.cassandraSchema.name The name of the ServiceAccount to use. If not set and create is true, a name is generated using the fullname template
serviceAccounts.collector.create Create service account true
serviceAccounts.collector.name The name of the ServiceAccount to use. If not set and create is true, a name is generated using the fullname template
serviceAccounts.hotrod.create Create service account true
serviceAccounts.hotrod.name The name of the ServiceAccount to use. If not set and create is true, a name is generated using the fullname template
serviceAccounts.query.create Create service account true
serviceAccounts.query.name The name of the ServiceAccount to use. If not set and create is true, a name is generated using the fullname template
serviceAccounts.spark.create Create service account true
serviceAccounts.spark.name The name of the ServiceAccount to use. If not set and create is true, a name is generated using the fullname template
spark.enabled Enables the dependencies job false
spark.image Image for the dependencies job jaegertracing/spark-dependencies
spark.pullPolicy Image pull policy of the deps image Always
spark.schedule Schedule of the cron job "49 23 * * *"
spark.successfulJobsHistoryLimit Cron job successfulJobsHistoryLimit 5
spark.failedJobsHistoryLimit Cron job failedJobsHistoryLimit 5
spark.tag Tag of the dependencies job image latest
spark.tolerations Node Tolerations []
storage.cassandra.existingSecret Name of existing password secret object (for password authentication) nil
storage.cassandra.host Provisioned cassandra host cassandra
storage.cassandra.password Provisioned cassandra password (ignored if storage.cassandra.existingSecret set) password
storage.cassandra.port Provisioned cassandra port 9042
storage.cassandra.tls.enabled Provisioned cassandra TLS connection enabled false
storage.cassandra.tls.secretName Provisioned cassandra TLS connection existing secret name (possible keys in secret: ca-cert.pem, client-key.pem, client-cert.pem, cqlshrc, commonName)
storage.cassandra.usePassword Use password true
storage.cassandra.user Provisioned cassandra username user
storage.elasticsearch.existingSecret Name of existing password secret object (for password authentication) nil
storage.elasticsearch.host Provisioned elasticsearch host elasticsearch
storage.elasticsearch.password Provisioned elasticsearch password (ignored if storage.elasticsearch.existingSecret set) changeme
storage.elasticsearch.port Provisioned elasticsearch port 9200
storage.elasticsearch.scheme Provisioned elasticsearch scheme http
storage.elasticsearch.usePassword Use password true
storage.elasticsearch.user Provisioned elasticsearch user elastic
storage.elasticsearch.nodesWanOnly Only access specified es host false
storage.type Storage type (ES or Cassandra) cassandra
tag Image tag/version 1.15.1

For more information about some of the tunable parameters that Cassandra provides, please visit the helm chart for cassandra and the official website at apache.org.

For more information about some of the tunable parameters that Jaeger provides, please visit the official Jaeger repo at GitHub.com.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name myrel \
    --set cassandra.config.rack_name=rack2 \
    incubator/jaeger

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart.

Storage persistence

Jaeger itself is a stateful application that by default uses Cassandra to store all related data. That means this helm chart has a dependency on the Cassandra helm chart for its data persistence. To deploy Jaeger with storage persistence, please take a look at the README.md for configuration details.

Override any required configuration options in the Cassandra chart that is required and then enable persistence by setting the following option: --set cassandra.persistence.enabled=true

Pending enhancements

  • [ ] Sidecar deployment support