bitnamicharts/jaeger
Bitnami Helm chart for Jaeger
100K+
Jaeger is a distributed tracing system. It is used for monitoring and troubleshooting microservices-based distributed systems.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/jaeger
Looking to use Jaeger in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
This chart bootstraps a jaeger deployment on a Kubernetes cluster using the Helm package manager.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.
To install the chart with the release name my-release
:
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/jaeger
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
These commands deploy jaeger on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
To uninstall/delete the my-release
statefulset:
helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release. Use the option --purge
to delete all history too.
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
You may want to have Jaeger connect to an external database rather than installing one inside your cluster. Typical reasons for this are to use a managed database service, or to share a common database server for all your applications. To achieve this, the chart allows you to specify credentials for an external database with the externalDatabase
parameter. You should also disable the Cassandra installation with the cassandra.enabled
option. Here is an example:
cassandra.enabled=false
externalDatabase.host=myexternalhost
externalDatabase.port=9042
In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars
property inside each of the subsections: collector
, query
.
collector:
extraEnvVars:
- name: ENV_VAR_NAME
value: ENV_VAR_VALUE
query:
extraEnvVars:
- name: ENV_VAR_NAME
value: ENV_VAR_VALUE
Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM
or the extraEnvVarsSecret
values.
If additional containers are needed in the same pod as jaeger (such as additional metrics or logging exporters), they can be defined using the sidecars
parameter inside each of the subsections: collector
, query
.
sidecars:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts
parameter (where available), as shown in the example below:
service:
extraPorts:
- name: extraPort
port: 11311
targetPort: 11311
NOTE: This Helm chart already includes sidecar containers for the Prometheus exporters (where applicable). These can be activated by adding the
--enable-metrics=true
parameter at deployment time. Thesidecars
parameter should therefore only be used for any extra sidecar containers.
If additional init containers are needed in the same pod, they can be defined using the initContainers
parameter. Here is an example:
initContainers:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
Learn more about sidecar containers and init containers.
This chart allows you to set your custom affinity using the affinity
parameter. Find more information about Pod affinity in the kubernetes documentation.
As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset
, podAntiAffinityPreset
, or nodeAffinityPreset
parameters inside each of the subsections: distributor
, compactor
, ingester
, querier
, queryFrontend
and vulture
.
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
The Bitnami jaeger image stores the trace onto an external database. Persistent Volume Claims are used to keep the data across deployments.
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | auto |
Name | Description | Value |
---|---|---|
nameOverride | String to partially override common.names.fullname | "" |
fullnameOverride | String to fully override common.names.fullname | "" |
kubeVersion | Force target Kubernetes version (using Helm capabilities if not set) | "" |
commonLabels | Labels to add to all deployed objects (sub-charts are not considered) | {} |
commonAnnotations | Annotations to add to all deployed objects | {} |
diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | false |
diagnosticMode.command | Command to override all containers in the deployment | ["sleep"] |
diagnosticMode.args | Args to override all containers in the deployment | ["infinity"] |
Name | Description | Value |
---|---|---|
image.registry | Jaeger image registry | REGISTRY_NAME |
image.repository | Jaeger image repository | REPOSITORY_NAME/jaeger |
image.digest | Jaeger image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
image.pullPolicy | image pull policy | IfNotPresent |
image.pullSecrets | Jaeger image pull secrets | [] |
image.debug | Enable image debug mode | false |
Name | Description | Value |
---|---|---|
query.command | Command for running the container (set to default if not set). Use array form | [] |
query.args | Args for running the container (set to default if not set). Use array form | [] |
query.automountServiceAccountToken | Mount Service Account token in pod | false |
query.hostAliases | Set pod host aliases | [] |
query.lifecycleHooks | Override default etcd container hooks | {} |
query.extraEnvVars | Extra environment variables to be set on jaeger container | [] |
query.extraEnvVarsCM | Name of existing ConfigMap containing extra env vars | "" |
query.extraEnvVarsSecret | Name of existing Secret containing extra env vars | "" |
query.replicaCount | Number of Jaeger replicas | 1 |
query.livenessProbe.enabled | Enable livenessProbe on Query nodes | true |
query.livenessProbe.initialDelaySeconds | Initial delay seconds for livenessProbe | 10 |
query.livenessProbe.periodSeconds | Period seconds for livenessProbe | 10 |
query.livenessProbe.timeoutSeconds | Timeout seconds for livenessProbe | 1 |
query.livenessProbe.failureThreshold | Failure threshold for livenessProbe | 3 |
query.livenessProbe.successThreshold | Success threshold for livenessProbe | 1 |
query.startupProbe.enabled | Enable startupProbe on Query containers | false |
query.startupProbe.initialDelaySeconds | Initial delay seconds for startupProbe | 10 |
query.startupProbe.periodSeconds | Period seconds for startupProbe | 10 |
query.startupProbe.timeoutSeconds | Timeout seconds for startupProbe | 1 |
query.startupProbe.failureThreshold | Failure threshold for startupProbe | 15 |
query.startupProbe.successThreshold | Success threshold for startupProbe | 1 |
query.readinessProbe.enabled | Enable readinessProbe | true |
query.readinessProbe.initialDelaySeconds | Initial delay seconds for readinessProbe | 10 |
query.readinessProbe.periodSeconds | Period seconds for readinessProbe | 10 |
query.readinessProbe.timeoutSeconds | Timeout seconds for readinessProbe | 1 |
query.readinessProbe.failureThreshold | Failure threshold for readinessProbe | 15 |
query.readinessProbe.successThreshold | Success threshold for readinessProbe | 1 |
query.customLivenessProbe | Custom livenessProbe that overrides the default one | {} |
query.customStartupProbe | Override default startup probe | {} |
query.customReadinessProbe | Override default readiness probe | {} |
query.resourcesPreset | Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if query.resources is set (query.resources is recommended for production). | small |
query.resources | Set container requests and limits for different resources like CPU or memory (essential for production workloads) | {} |
query.extraVolumeMounts | Optionally specify extra list of additional volumeMounts for jaeger container | [] |
query.containerPorts.grpc | Port for GRPC | 16685 |
query.containerPorts.api | Port for API | 16686 |
query.containerPorts.admin | Port for admin |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/jaeger/README.md