Helm and terraform values
  • 24 Mar 2023
  • 2 Minutes to read
  • PDF

Helm and terraform values

  • PDF

Article Summary

The following tables summarize the different Helm and Terraform values and their description.

Administration

Helm ValueTerraform VariableDefault ValueDescription
tokentoken-

API token that is used to communicate with Traceable's SaaS platform.

environmentenvironment-The environment in which the platform agent is being installed. For example, production, development, QA.
logLevellogLevelINFODefines the log level. Set it to DEBUG to enable debug logging.

Resources

Helm ValueTerraform VariableDefault ValueDescription
resources.limits.cpuresources.limits.cpu1Platform agent max CPU
resources.limits.memoryresources.limits.memory2GiPlatform agent max memory
resources.requests.cpuresources.requests.cpu200mPlatform agent requested CPU
resources.requests.memoryresources.requests.memory400MiPlatform agent requested memory
multipartMaxFileSizemultipart_max_file_size2048Limits the number of a file's first bytes that are captured for multipart/form-data content type

Autoscaling

Helm ValueTerraform VariableDefault ValueDescription
autoscaling.minReplicasautoscaling.min_replicas1Defines the minimum number of traceable-agent replicas.
autoscaling.maxReplicasautoscaling.max_replicas1Defines the maximum number of traceable-agent replicas.
autoscaling.targetMemoryUtilizationautoscaling.target_memory_utilization80Target memory utilization.
autoscaling.targetCpuUtilizationautoscaling.target_cpu_utilization80Target CPU utilization.

Labels, security policy, and token

Helm ValueTerraform VariableDefault ValueDescription
labelslabels-List of labels to add to the deployment.
podSecurityPoliciesEnabledpod_security_policies_enabledfalseSet it to true to enable the use of pod security policies.
externalTokenSecret.nameexternal_token_secret.name-

Configuring this field allows you to provide the secret before installation instead of specifying the token as a value. 

The name is the secret name.

tlsEnabledtls_enabledfalseSet to true when end-to-end TLS is required for all ports. All traffic must be directed to tlsServerPort. No other agent ports will be exposed by the agent service.
additionalCertAltNames-
Additional certificate alternative names to be added to the auto-generated certificate.
externalTokenSecret.keyexternal_token_secret.key-key is the key name that contains the token value.
remoteCaBundleremote_ca_bundle
Platform CA bundle, which is base64 encoded.
remoteCaCertSecret.secretNameremote_ca_cert_secret.secret_name
Platform CA as a secret in the same namespace, Traceable Platform agent deployment.
remoteCaCertSecret.caCertFileNameremote_ca_cert_secret.ca_cert_file_name
Platform CA key name within the secret.
remoteCaCertFileremote_ca_cert_file
Platform CA as a file injected into the Traceable Platform agent container. Make sure that this is the absolute path to the file.
serviceTypeservice_typeClusterIP

Defines the service type of the Platform agent. Supported values are:

  • ClusterIP
  • NodePort
  • LoadBalancer

Ingress

Helm ValuesTerraform VariableDefault ValueDescription
ingress.enabledingress.enabledfalseEnables an ingress controller for the platform agent when true
ingress.domainingress.domain-The domain name of the Ingress controller
ingress.http.annotationsingress.http.annotations-Ingress controller annotations for the HTTP services
ingress.grpc.annotationsingress.grpc.annotations-Ingress controller annotations for the GRPC services

Collector

Helm ValueTerraform VariableDefault ValueDescription
collector.batch.timeoutcollector.batch.timeout200msThe time duration after which a batch is sent to the Traceable platform regardless of size.
collector.batch.sendBatchSizecollector.batch.send_batch_size8192The number of spans after which a batch is sent to the Traceable platform, regardless of the timeout.
collector.batch.sendBatchMaxSizecollector.batch.send_batch_max_size10000Defines the upper limit of the batch size. 0 means no upper limit of the batch size. This property ensures that larger batches are split into smaller units. It must be greater or equal to send_batch_size
collector.receivers.opencensus.enabledcollector.receivers.opencensus.enabledtrueSet to true to enable OpenCensus receiver.
collector.receivers.zipkin.enabledcollector.receivers.zipkin.enabledtrueSet to true to enable Zipkin receiver.
collector.receivers.jaeger.enabledcollector.receivers.jaeger.enabledtrueSet to true to enable Jaeger receiver.
collector.receivers.otlp.enabledcollector.receivers.otlp.enabledtrueSet to true to enable OTLP receiver.
collector.exporters.otlp.compressioncollector.exporters.otlp.compressiongzipCompression format used to send data to the Traceable platform. An empty value denotes no compression.
collector.ports.opentelemetry
collector.ports.opentelemetry
4317
Configure the OTLP gRPC receiver port.
collector.ports.opentelemetryHttp
collector.ports.opentelemetry_http
4318
Configure the OTLP HTTP receiver port

Injector

Helm ValueTerraform VariableDefault ValueDescription
injector.propagationFormatsinjector.propagation_formats[“TRACECONTEXT”]

List of propagation formats used by the injected sidecar proxy and Java agent. The supported values are TRACECONEXT and B3.

injector.captureContentTypeinjector.capture_content_Type

[“json“,

“grpc“,

“x-www-form-urlencoded”]

List of content types that the injected proxy captures. This is a substring match.
injector.proxy.inboundInterceptionModeinjector.proxy.inbound_interception_modeREDIRECTDefines the iptables interception mode. The supported values are REDIRECT and TPROXY.
injector.traceReporterTypeinjector.trace_reporter_typeOTLPUse this to configure the trace reporting format from OTLP or ZIPKIN.
injectorEnabledinjector_enabledtrueEnables the mutatingwebhook injector service.

eBPF

Helm valueTerraform valueDefault valueDescription
ebpfCaptureEnabledebpf_capture_enabledfalseEnables the data capture mode using eBPF.
ebpfTraceReporterType
ebpf_trace_reporter_type
OTLP
Configure the trace reporter. Possible values are OTLP or ZIPKIN.

Miscellaneous

Helm value
Terraform value
Default value
Description
allowedContentTypes
allowed_content_types
["json", "x-www-form-urlencoded"]
List of content types that are captured for Traceable Module Extension (TME) based agents.
tolerations
tolerations
-
Tolerations are configured on a pod to allow it to be scheduled on nodes with the corresponding taints. For more information on Tolerations and taints, see Taints and Tolerations.

Was this article helpful?