Bitnami package for Jaeger

Jaeger is a distributed tracing system. It is used for monitoring and troubleshooting microservices-based distributed systems.

Overview of Jaeger

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.

TL;DR

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/jaeger

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository.

Introduction

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.

Prerequisites

• Kubernetes 1.23+
• Helm 3.8.0+
• PV provisioner support in the underlying infrastructure
• ReadWriteMany volumes for deployment scaling

Installing the Chart

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 and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_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

Uninstalling the Chart

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.

Configuration and installation details

Resource requests and limits

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 resourcePreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.

Rolling VS Immutable tags

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.

External database support

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

Additional environment variables

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, agent, query.

collector:
  extraEnvVars:
    - name: ENV_VAR_NAME
      value: ENV_VAR_VALUE

agent:
  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.

Sidecars

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, agent, 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. The sidecars 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.

Pod affinity

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.

Persistence

The Bitnami jaeger image stores the trace onto an external database. Persistent Volume Claims are used to keep the data across deployments.

Parameters

Global parameters

Name	Description	Value
global.imageRegistry	Global Docker image registry	""
global.imagePullSecrets	Global Docker registry secret names as an array	[]
global.storageClass	Global StorageClass for Persistent Volume(s)	""
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

Common parameters

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"]

Jaeger parameters

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

Query deployment parameters

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	16687
query.service.type	Jaeger service type	ClusterIP
query.service.ports.api	Port for API	16686
query.service.ports.admin	Port for admin	16687
query.service.nodePorts.api	Node port for API	""
query.service.nodePorts.admin	Node port for admin	""
query.service.extraPorts	Extra ports to expose in the service (normally used with the sidecar value)	[]
query.service.loadBalancerIP	LoadBalancerIP if service type is LoadBalancer	""
query.service.loadBalancerSourceRanges	Service Load Balancer sources	[]
query.service.clusterIP	Service Cluster IP	""
query.service.externalTrafficPolicy	Service external traffic policy	Cluster
query.service.annotations	Provide any additional annotations which may be required.	{}
query.service.sessionAffinity	Session Affinity for Kubernetes service, can be “None” or “ClientIP”	None
query.service.sessionAffinityConfig	Additional settings for the sessionAffinity	{}
query.service.metrics.annotations	Annotations for Prometheus metrics	{}
query.networkPolicy.enabled	Specifies whether a NetworkPolicy should be created	true
query.networkPolicy.allowExternal	Don’t require server label for connections	true
query.networkPolicy.allowExternalEgress	Allow the pod to access any range of port and all destinations.	true
query.networkPolicy.extraIngress	Add extra ingress rules to the NetworkPolicy	[]
query.networkPolicy.extraEgress	Add extra ingress rules to the NetworkPolicy	[]
query.networkPolicy.ingressNSMatchLabels	Labels to match to allow traffic from other namespaces	{}
query.networkPolicy.ingressNSPodMatchLabels	Pod labels to match to allow traffic from other namespaces	{}
query.serviceAccount.create	Enables ServiceAccount	true
query.serviceAccount.name	ServiceAccount name	""
query.serviceAccount.annotations	Annotations to add to all deployed objects	{}
query.serviceAccount.automountServiceAccountToken	Automount API credentials for a service account.	false
query.podSecurityContext.enabled	Enabled Jaeger pods’ Security Context	true
query.podSecurityContext.fsGroupChangePolicy	Set filesystem group change policy	Always
query.podSecurityContext.sysctls	Set kernel settings using the sysctl interface	[]
query.podSecurityContext.supplementalGroups	Set filesystem extra groups	[]
query.podSecurityContext.fsGroup	Set Jaeger pod’s Security Context fsGroup	1001
query.containerSecurityContext.enabled	Enabled containers’ Security Context	true
query.containerSecurityContext.seLinuxOptions	Set SELinux options in container	{}
query.containerSecurityContext.runAsUser	Set containers’ Security Context runAsUser	1001
query.containerSecurityContext.runAsGroup	Set containers’ Security Context runAsGroup	1001
query.containerSecurityContext.runAsNonRoot	Set container’s Security Context runAsNonRoot	true
query.containerSecurityContext.privileged	Set container’s Security Context privileged	false
query.containerSecurityContext.readOnlyRootFilesystem	Set container’s Security Context readOnlyRootFilesystem	true
query.containerSecurityContext.allowPrivilegeEscalation	Set container’s Security Context allowPrivilegeEscalation	false
query.containerSecurityContext.capabilities.drop	List of capabilities to be dropped	["ALL"]
query.containerSecurityContext.seccompProfile.type	Set container’s Security Context seccomp profile	RuntimeDefault
query.podAnnotations	Additional pod annotations	{}
query.podLabels	Additional pod labels	{}
query.podAffinityPreset	Pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard	""
query.podAntiAffinityPreset	Pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard	soft
query.nodeAffinityPreset.type	Node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard	""
query.nodeAffinityPreset.key	Node label key to match. Ignored if affinity is set	""
query.nodeAffinityPreset.values	Node label values to match. Ignored if affinity is set	[]
query.priorityClassName	Server priorityClassName	""
query.affinity	Affinity for pod assignment	{}
query.nodeSelector	Node labels for pod assignment	{}
query.tolerations	Tolerations for pod assignment	[]
query.topologySpreadConstraints	Topology Spread Constraints for pod assignment	[]
query.schedulerName	Alternative scheduler	""
query.updateStrategy.type	Jaeger query deployment strategy type	RollingUpdate
query.updateStrategy.rollingUpdate	Jaeger query deployment rolling update configuration parameters	{}
query.extraVolumes	Optionally specify extra list of additional volumes for jaeger container	[]
query.initContainers	Add additional init containers to the jaeger pods	[]
query.pdb.create	Enable/disable a Pod Disruption Budget creation	true
query.pdb.minAvailable	Minimum number/percentage of pods that should remain scheduled	""
query.pdb.maxUnavailable	Maximum number/percentage of pods that may be made unavailable. Defaults to 1 if both query.pdb.minAvailable and query.pdb.maxUnavailable are empty.	""
query.sidecars	Add additional sidecar containers to the jaeger pods	[]

Collector deployment parameters

Name	Description	Value
collector.command	Command for running the container (set to default if not set). Use array form	[]
collector.args	Args for running the container (set to default if not set). Use array form	[]
collector.automountServiceAccountToken	Mount Service Account token in pod	false
collector.hostAliases	Set pod host aliases	[]
collector.lifecycleHooks	Override default etcd container hooks	{}
collector.extraEnvVars	Extra environment variables to be set on jaeger container	[]
collector.extraEnvVarsCM	Name of existing ConfigMap containing extra env vars	""
collector.extraEnvVarsSecret	Name of existing Secret containing extra env vars	""
collector.replicaCount	Number of Jaeger replicas	1
collector.livenessProbe.enabled	Enable livenessProbe on collector nodes	true
collector.livenessProbe.initialDelaySeconds	Initial delay seconds for livenessProbe	10
collector.livenessProbe.periodSeconds	Period seconds for livenessProbe	10
collector.livenessProbe.timeoutSeconds	Timeout seconds for livenessProbe	1
collector.livenessProbe.failureThreshold	Failure threshold for livenessProbe	3
collector.livenessProbe.successThreshold	Success threshold for livenessProbe	1
collector.startupProbe.enabled	Enable startupProbe on collector containers	false
collector.startupProbe.initialDelaySeconds	Initial delay seconds for startupProbe	10
collector.startupProbe.periodSeconds	Period seconds for startupProbe	10
collector.startupProbe.timeoutSeconds	Timeout seconds for startupProbe	1
collector.startupProbe.failureThreshold	Failure threshold for startupProbe	15
collector.startupProbe.successThreshold	Success threshold for startupProbe	1
collector.readinessProbe.enabled	Enable readinessProbe	true
collector.readinessProbe.initialDelaySeconds	Initial delay seconds for readinessProbe	10
collector.readinessProbe.periodSeconds	Period seconds for readinessProbe	10
collector.readinessProbe.timeoutSeconds	Timeout seconds for readinessProbe	1
collector.readinessProbe.failureThreshold	Failure threshold for readinessProbe	15
collector.readinessProbe.successThreshold	Success threshold for readinessProbe	1
collector.customLivenessProbe	Custom livenessProbe that overrides the default one	{}
collector.customStartupProbe	Override default startup probe	{}
collector.customReadinessProbe	Override default readiness probe	{}
collector.resourcesPreset	Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if collector.resources is set (collector.resources is recommended for production).	small
collector.resources	Set container requests and limits for different resources like CPU or memory (essential for production workloads)	{}
collector.extraVolumeMounts	Optionally specify extra list of additional volumeMounts for jaeger container	[]
collector.containerPorts.zipkin	can accept Zipkin spans in Thrift, JSON and Proto (disabled by default)	9411
collector.containerPorts.grpc	used by jaeger-agent to send spans in model.proto format	14250
collector.containerPorts.binary	can accept spans directly from clients in jaeger.thrift format over binary thrift protocol	14268
collector.containerPorts.admin	Admin port: health check at / and metrics at /metrics	14269
collector.containerPorts.otlp.grpc	Accepts traces in OpenTelemetry OTLP format over gRPC	4317
collector.containerPorts.otlp.http	Accepts traces in OpenTelemetry OTLP format over HTTP	4318
collector.service.type	Jaeger service type	ClusterIP
collector.service.ports.zipkin	can accept Zipkin spans in Thrift, JSON and Proto (disabled by default)	9411
collector.service.ports.grpc	used by jaeger-agent to send spans in model.proto format	14250
collector.service.ports.binary	can accept spans directly from clients in jaeger.thrift format over binary thrift protocol	14268
collector.service.ports.admin	Admin port: health check at / and metrics at /metrics	14269
collector.service.ports.otlp.grpc	Accepts traces in OpenTelemetry OTLP format over gRPC	4317
collector.service.ports.otlp.http	Accepts traces in OpenTelemetry OTLP format over HTTP	4318
collector.service.nodePorts.zipkin	can accept Zipkin spans in Thrift, JSON and Proto (disabled by default)	""
collector.service.nodePorts.grpc	used by jaeger-agent to send spans in model.proto format	""
collector.service.nodePorts.binary	can accept spans directly from clients in jaeger.thrift format over binary thrift protocol	""
collector.service.nodePorts.admin	Admin port: health check at / and metrics at /metrics	""
collector.service.nodePorts.otlp.grpc	Accepts traces in OpenTelemetry OTLP format over gRPC	""
collector.service.nodePorts.otlp.http	Accepts traces in OpenTelemetry OTLP format over HTTP	""
collector.service.extraPorts	Extra ports to expose in the service (normally used with the sidecar value)	[]
collector.service.loadBalancerIP	LoadBalancerIP if service type is LoadBalancer	""
collector.service.loadBalancerSourceRanges	Service Load Balancer sources	[]
collector.service.clusterIP	Service Cluster IP	""
collector.service.externalTrafficPolicy	Service external traffic policy	Cluster
collector.service.annotations	Provide any additional annotations which may be required.	{}
collector.service.sessionAffinity	Session Affinity for Kubernetes service, can be “None” or “ClientIP”	None
collector.service.sessionAffinityConfig	Additional settings for the sessionAffinity	{}
collector.service.metrics.annotations	Annotations for Prometheus metrics	{}
collector.networkPolicy.enabled	Specifies whether a NetworkPolicy should be created	true
collector.networkPolicy.allowExternal	Don’t require server label for connections	true
collector.networkPolicy.allowExternalEgress	Allow the pod to access any range of port and all destinations.	true
collector.networkPolicy.extraIngress	Add extra ingress rules to the NetworkPolicy	[]
collector.networkPolicy.extraEgress	Add extra ingress rules to the NetworkPolicy	[]
collector.networkPolicy.ingressNSMatchLabels	Labels to match to allow traffic from other namespaces	{}
collector.networkPolicy.ingressNSPodMatchLabels	Pod labels to match to allow traffic from other namespaces	{}
collector.serviceAccount.create	Enables ServiceAccount	true
collector.serviceAccount.name	ServiceAccount name	""
collector.serviceAccount.annotations	Annotations to add to all deployed objects	{}
collector.serviceAccount.automountServiceAccountToken	Automount API credentials for a service account.	false
collector.podSecurityContext.enabled	Enabled Jaeger pods’ Security Context	true
collector.podSecurityContext.fsGroupChangePolicy	Set filesystem group change policy	Always
collector.podSecurityContext.sysctls	Set kernel settings using the sysctl interface	[]
collector.podSecurityContext.supplementalGroups	Set filesystem extra groups	[]
collector.podSecurityContext.fsGroup	Set Jaeger pod’s Security Context fsGroup	1001
collector.containerSecurityContext.enabled	Enabled containers’ Security Context	true
collector.containerSecurityContext.seLinuxOptions	Set SELinux options in container	{}
collector.containerSecurityContext.runAsUser	Set containers’ Security Context runAsUser	1001
collector.containerSecurityContext.runAsGroup	Set containers’ Security Context runAsGroup	1001
collector.containerSecurityContext.runAsNonRoot	Set container’s Security Context runAsNonRoot	true
collector.containerSecurityContext.privileged	Set container’s Security Context privileged	false
collector.containerSecurityContext.readOnlyRootFilesystem	Set container’s Security Context readOnlyRootFilesystem	true
collector.containerSecurityContext.allowPrivilegeEscalation	Set container’s Security Context allowPrivilegeEscalation	false
collector.containerSecurityContext.capabilities.drop	List of capabilities to be dropped	["ALL"]
collector.containerSecurityContext.seccompProfile.type	Set container’s Security Context seccomp profile	RuntimeDefault
collector.podAnnotations	Additional pod annotations	{}
collector.podLabels	Additional pod labels	{}
collector.podAffinityPreset	Pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard	""
collector.podAntiAffinityPreset	Pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard	soft
collector.nodeAffinityPreset.type	Node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard	""
collector.nodeAffinityPreset.key	Node label key to match. Ignored if affinity is set	""
collector.nodeAffinityPreset.values	Node label values to match. Ignored if affinity is set	[]
collector.priorityClassName	Server priorityClassName	""
collector.affinity	Affinity for pod assignment	{}
collector.nodeSelector	Node labels for pod assignment	{}
collector.tolerations	Tolerations for pod assignment	[]
collector.topologySpreadConstraints	Topology Spread Constraints for pod assignment	[]
collector.schedulerName	Alternative scheduler	""
collector.updateStrategy.type	Jaeger collector deployment strategy type	RollingUpdate
collector.updateStrategy.rollingUpdate	Jaeger collector deployment rolling update configuration parameters	{}
collector.extraVolumes	Optionally specify extra list of additional volumes for jaeger container	[]
collector.initContainers	Add additional init containers to the jaeger pods	[]
collector.pdb.create	Enable/disable a Pod Disruption Budget creation	true
collector.pdb.minAvailable	Minimum number/percentage of pods that should remain scheduled	""
collector.pdb.maxUnavailable	Maximum number/percentage of pods that may be made unavailable. Defaults to 1 if both collector.pdb.minAvailable and collector.pdb.maxUnavailable are empty.	""
collector.sidecars	Add additional sidecar containers to the jaeger pods	[]

agent deployment parameters

Name	Description	Value
agent.command	Command for running the container (set to default if not set). Use array form	[]
agent.args	Args for running the container (set to default if not set). Use array form	[]
agent.automountServiceAccountToken	Mount Service Account token in pod	false
agent.hostAliases	Set pod host aliases	[]
agent.lifecycleHooks	Override default etcd container hooks	{}
agent.extraEnvVars	Extra environment variables to be set on jaeger container	[]
agent.extraEnvVarsCM	Name of existing ConfigMap containing extra env vars	""
agent.extraEnvVarsSecret	Name of existing Secret containing extra env vars	""
agent.replicaCount	Number of Jaeger replicas	1
agent.livenessProbe.enabled	Enable livenessProbe on agent nodes	true
agent.livenessProbe.initialDelaySeconds	Initial delay seconds for livenessProbe	10
agent.livenessProbe.periodSeconds	Period seconds for livenessProbe	10
agent.livenessProbe.timeoutSeconds	Timeout seconds for livenessProbe	1
agent.livenessProbe.failureThreshold	Failure threshold for livenessProbe	3
agent.livenessProbe.successThreshold	Success threshold for livenessProbe	1
agent.startupProbe.enabled	Enable startupProbe on agent containers	false
agent.startupProbe.initialDelaySeconds	Initial delay seconds for startupProbe	10
agent.startupProbe.periodSeconds	Period seconds for startupProbe	10
agent.startupProbe.timeoutSeconds	Timeout seconds for startupProbe	1
agent.startupProbe.failureThreshold	Failure threshold for startupProbe	15
agent.startupProbe.successThreshold	Success threshold for startupProbe	1
agent.readinessProbe.enabled	Enable readinessProbe	true
agent.readinessProbe.initialDelaySeconds	Initial delay seconds for readinessProbe	10
agent.readinessProbe.periodSeconds	Period seconds for readinessProbe	10
agent.readinessProbe.timeoutSeconds	Timeout seconds for readinessProbe	1
agent.readinessProbe.failureThreshold	Failure threshold for readinessProbe	15
agent.readinessProbe.successThreshold	Success threshold for readinessProbe	1
agent.customLivenessProbe	Custom livenessProbe that overrides the default one	{}
agent.customStartupProbe	Override default startup probe	{}
agent.customReadinessProbe	Override default readiness probe	{}
agent.resourcesPreset	Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if agent.resources is set (agent.resources is recommended for production).	small
agent.resources	Set container requests and limits for different resources like CPU or memory (essential for production workloads)	{}
agent.extraVolumeMounts	Optionally specify extra list of additional volumeMounts for jaeger container	[]
agent.containerPorts.compact	accept jaeger.thrift in compact Thrift protocol used by most current Jaeger clients	6831
agent.containerPorts.binary	accept jaeger.thrift in binary Thrift protocol used by Node.js Jaeger client	6832
agent.containerPorts.config	Serve configs, sampling strategies	5778
agent.containerPorts.zipkin	Accept zipkin.thrift in compact Thrift protocol (deprecated; only used by very old Jaeger clients, circa 2016)	5775
agent.containerPorts.admin	Admin port: health check at / and metrics at /metrics	14271
agent.service.type	Jaeger service type	ClusterIP
agent.service.ports.compact	accept jaeger.thrift in compact Thrift protocol used by most current Jaeger clients	6831
agent.service.ports.binary	accept jaeger.thrift in binary Thrift protocol used by Node.js Jaeger client	6832
agent.service.ports.config	Serve configs, sampling strategies	5778
agent.service.ports.zipkin	Accept zipkin.thrift in compact Thrift protocol (deprecated; only used by very old Jaeger clients, circa 2016)	5775
agent.service.ports.admin	Admin port: health check at / and metrics at /metrics	14271
agent.service.nodePorts.compact	accept jaeger.thrift in compact Thrift protocol used by most current Jaeger clients	""
agent.service.nodePorts.binary	accept jaeger.thrift in binary Thrift protocol used by Node.js Jaeger client	""
agent.service.nodePorts.config	Serve configs, sampling strategies	""
agent.service.nodePorts.zipkin	Accept zipkin.thrift in compact Thrift protocol (deprecated; only used by very old Jaeger clients, circa 2016)	""
agent.service.nodePorts.admin	Admin port: health check at / and metrics at /metrics	""
agent.service.extraPorts	Extra ports to expose in the service (normally used with the sidecar value)	[]
agent.service.loadBalancerIP	LoadBalancerIP if service type is LoadBalancer	""
agent.service.loadBalancerSourceRanges	Service Load Balancer sources	[]
agent.service.clusterIP	Service Cluster IP	""
agent.service.externalTrafficPolicy	Service external traffic policy	Cluster
agent.service.annotations	Provide any additional annotations which may be required.	{}
agent.service.sessionAffinity	Session Affinity for Kubernetes service, can be “None” or “ClientIP”	None
agent.service.sessionAffinityConfig	Additional settings for the sessionAffinity	{}
agent.service.metrics.annotations	Annotations for Prometheus metrics	{}
agent.networkPolicy.enabled	Specifies whether a NetworkPolicy should be created	true
agent.networkPolicy.allowExternal	Don’t require server label for connections	true
agent.networkPolicy.allowExternalEgress	Allow the pod to access any range of port and all destinations.	true
agent.networkPolicy.extraIngress	Add extra ingress rules to the NetworkPolicy	[]
agent.networkPolicy.extraEgress	Add extra ingress rules to the NetworkPolicy	[]
agent.networkPolicy.ingressNSMatchLabels	Labels to match to allow traffic from other namespaces	{}
agent.networkPolicy.ingressNSPodMatchLabels	Pod labels to match to allow traffic from other namespaces	{}
agent.serviceAccount.create	Enables ServiceAccount	true
agent.serviceAccount.name	ServiceAccount name	""
agent.serviceAccount.annotations	Annotations to add to all deployed objects	{}
agent.serviceAccount.automountServiceAccountToken	Automount API credentials for a service account.	false
agent.podSecurityContext.enabled	Enabled Jaeger pods’ Security Context	true
agent.podSecurityContext.fsGroupChangePolicy	Set filesystem group change policy	Always
agent.podSecurityContext.sysctls	Set kernel settings using the sysctl interface	[]
agent.podSecurityContext.supplementalGroups	Set filesystem extra groups	[]
agent.podSecurityContext.fsGroup	Set Jaeger pod’s Security Context fsGroup	1001
agent.containerSecurityContext.enabled	Enabled containers’ Security Context	true
agent.containerSecurityContext.seLinuxOptions	Set SELinux options in container	nil
agent.containerSecurityContext.runAsUser	Set containers’ Security Context runAsUser	1001
agent.containerSecurityContext.runAsGroup	Set containers’ Security Context runAsGroup	1001
agent.containerSecurityContext.runAsNonRoot	Set container’s Security Context runAsNonRoot	true
agent.containerSecurityContext.privileged	Set container’s Security Context privileged	false
agent.containerSecurityContext.readOnlyRootFilesystem	Set container’s Security Context readOnlyRootFilesystem	true
agent.containerSecurityContext.allowPrivilegeEscalation	Set container’s Security Context allowPrivilegeEscalation	false
agent.containerSecurityContext.capabilities.drop	List of capabilities to be dropped	["ALL"]
agent.containerSecurityContext.seccompProfile.type	Set container’s Security Context seccomp profile	RuntimeDefault
agent.podAnnotations	Additional pod annotations	{}
agent.podLabels	Additional pod labels	{}
agent.podAffinityPreset	Pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard	""
agent.podAntiAffinityPreset	Pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard	soft
agent.nodeAffinityPreset.type	Node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard	""
agent.nodeAffinityPreset.key	Node label key to match. Ignored if affinity is set	""
agent.nodeAffinityPreset.values	Node label values to match. Ignored if affinity is set	[]
agent.priorityClassName	Server priorityClassName	""
agent.affinity	Affinity for pod assignment	{}
agent.nodeSelector	Node labels for pod assignment	{}
agent.tolerations	Tolerations for pod assignment	[]
agent.topologySpreadConstraints	Topology Spread Constraints for pod assignment	[]
agent.schedulerName	Alternative scheduler	""
agent.updateStrategy.type	Jaeger agent deployment strategy type	RollingUpdate
agent.updateStrategy.rollingUpdate	Jaeger agent deployment rolling update configuration parameters	{}
agent.extraVolumes	Optionally specify extra list of additional volumes for jaeger container	[]
agent.initContainers	Add additional init containers to the jaeger pods	[]
agent.pdb.create	Enable/disable a Pod Disruption Budget creation	true
agent.pdb.minAvailable	Minimum number/percentage of pods that should remain scheduled	""
agent.pdb.maxUnavailable	Maximum number/percentage of pods that may be made unavailable. Defaults to 1 if both agent.pdb.minAvailable and agent.pdb.maxUnavailable are empty.	""
agent.sidecars	Add additional sidecar containers to the jaeger pods	[]
migration.podLabels	Additional pod labels	{}
migration.podAnnotations	Additional pod annotations	{}
migration.annotations	Provide any additional annotations which may be required.	{}
migration.podSecurityContext.enabled	Enabled Jaeger pods’ Security Context	true
migration.podSecurityContext.fsGroupChangePolicy	Set filesystem group change policy	Always
migration.podSecurityContext.sysctls	Set kernel settings using the sysctl interface	[]
migration.podSecurityContext.supplementalGroups	Set filesystem extra groups	[]
migration.podSecurityContext.fsGroup	Set Jaeger pod’s Security Context fsGroup	1001
migration.containerSecurityContext.enabled	Enabled containers’ Security Context	true
migration.containerSecurityContext.seLinuxOptions	Set SELinux options in container	{}
migration.containerSecurityContext.runAsUser	Set containers’ Security Context runAsUser	1001
migration.containerSecurityContext.runAsGroup	Set containers’ Security Context runAsGroup	1001
migration.containerSecurityContext.runAsNonRoot	Set container’s Security Context runAsNonRoot	true
migration.containerSecurityContext.privileged	Set container’s Security Context privileged	false
migration.containerSecurityContext.readOnlyRootFilesystem	Set container’s Security Context readOnlyRootFilesystem	true
migration.containerSecurityContext.allowPrivilegeEscalation	Set container’s Security Context allowPrivilegeEscalation	false
migration.containerSecurityContext.capabilities.drop	List of capabilities to be dropped	["ALL"]
migration.containerSecurityContext.seccompProfile.type	Set container’s Security Context seccomp profile	RuntimeDefault
migration.extraEnvVars	Extra environment variables to be set on jaeger migration container	[]
migration.extraEnvVarsCM	Name of existing ConfigMap containing extra env vars	""
migration.extraEnvVarsSecret	Name of existing Secret containing extra env vars	""
migration.extraVolumeMounts	Optionally specify extra list of additional volumeMounts for jaeger container	[]
migration.resourcesPreset	Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if migration.resources is set (migration.resources is recommended for production).	small
migration.resources	Set container requests and limits for different resources like CPU or memory (essential for production workloads)	{}
migration.initContainer.resourcesPreset	Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if migration.resources is set (migration.resources is recommended for production).	nano
migration.initContainer.resources	Set container requests and limits for different resources like CPU or memory (essential for production workloads)	{}
migration.networkPolicy.enabled	Specifies whether a NetworkPolicy should be created	true
migration.networkPolicy.allowExternal	Don’t require server label for connections	true
migration.networkPolicy.allowExternalEgress	Allow the pod to access any range of port and all destinations.	true
migration.networkPolicy.extraIngress	Add extra ingress rules to the NetworkPolicy	[]
migration.networkPolicy.extraEgress	Add extra ingress rules to the NetworkPolicy	[]
migration.networkPolicy.ingressNSMatchLabels	Labels to match to allow traffic from other namespaces	{}
migration.networkPolicy.ingressNSPodMatchLabels	Pod labels to match to allow traffic from other namespaces	{}
migration.extraVolumes	Optionally specify extra list of additional volumes for jaeger container	[]

Set the image to use for the migration job

Name	Description	Value
cqlshImage.registry	Cassandra image registry	REGISTRY_NAME
cqlshImage.repository	Cassandra image repository	REPOSITORY_NAME/cassandra
cqlshImage.digest	Cassandra image digest in the way sha256:aa…. Please note this parameter, if set, will override the tag	""
cqlshImage.pullPolicy	image pull policy	IfNotPresent
cqlshImage.pullSecrets	Cassandra image pull secrets	[]
cqlshImage.debug	Enable image debug mode	false
cqlshImage.resourcesPreset	Set container resources according to one common preset (allowed values: none, nano, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production).	nano
cqlshImage.resources	Set container requests and limits for different resources like CPU or memory (essential for production workloads)	{}
externalDatabase.host	External database host	""
externalDatabase.port	External database port	9042
externalDatabase.dbUser.user	Cassandra admin user	bn_jaeger
externalDatabase.dbUser.password	Password for dbUser.user. Randomly generated if empty	""
externalDatabase.existingSecret	Name of existing secret containing the database secret	""
externalDatabase.existingSecretPasswordKey	Name of existing secret key containing the database password secret key	""
externalDatabase.cluster.datacenter	Name for cassandra’s jaeger datacenter	dc1
externalDatabase.keyspace	Name for cassandra’s jaeger keyspace	bitnami_jaeger

Cassandra storage sub-chart

Name	Description	Value
cassandra.enabled	Enables cassandra storage pod	true
cassandra.cluster.datacenter	Name for cassandra’s jaeger datacenter	dc1
cassandra.keyspace	Name for cassandra’s jaeger keyspace	bitnami_jaeger
cassandra.dbUser.user	Cassandra admin user	bn_jaeger
cassandra.dbUser.password	Password for dbUser.user. Randomly generated if empty	""
cassandra.dbUser.existingSecret	Name of an existing secret containing the user password.	""
cassandra.service.ports.cql	Cassandra cql port	9042
cassandra.resourcesPreset	Set container resources according to one common preset (allowed values: none, nano, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production).	large
cassandra.resources	Set container requests and limits for different resources like CPU or memory (essential for production workloads)	{}

Tip: You can use the default values.yaml

Troubleshooting

Find more information about how to deal with common errors related to Bitnami’s Helm charts in this troubleshooting guide.

Upgrading

To 2.0.0

This major bump changes the following security defaults:

• runAsGroup is changed from 0 to 1001
• readOnlyRootFilesystem is set to true
• resourcesPreset is changed from none to the minimum size working in our test suites (NOTE: resourcesPreset is not meant for production usage, but resources adapted to your use case).
• global.compatibility.openshift.adaptSecurityContext is changed from disabled to auto.

This could potentially break any customization or init scripts used in your deployment. If this is the case, change the default values to the previous ones.

To 1.0.0

This major updates the Cassandra subchart to its newest major, 10.0.0. Here you can find more information about the changes introduced in that version.

License

Copyright © 2024 Broadcom. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.