Configure Telemetry Service

Learn how to configure Telemetry Service.

Related documentation:

• Suite-level guide
• All services
• Telemetry Service Release Notes

RSS:

• For private edition

Override Helm chart values

Parameter	Description	Default	Valid values
tlm.replicaCount	Number of replicas	2
tlm.image.registry	docker registry	pureengage-docker-staging.jfrog.io
tlm.image.repository	docker repository	telemetry
tlm.image.tag	WWE image version	``
tlm.image.pullPolicy	Image pull policy	IfNotPresent
tlm.image.imagePullSecrets	Image pull secrets	[]
tlm.service.type	k8s service type	ClusterIP
tlm.service.port_external	k8s service port external (for customer facing)	8107
tlm.service.port_internal	k8s service port internal (for metric scrapping endpoint)	9107
tlm.ingress	Ingress configuration block. See #Ingress	{enabled:false}
tlm.resources.limits.cpu	Maximum amount of CPU K8s allocates for container	750m
tlm.resources.limits.memory	Maximum amount of Memory K8s allocates for container	1400Mi
tlm.resources.requests.cpu	Guaranteed CPU allocation for container	750m
tlm.resources.requests.memory	Guaranteed Memory allocation for container	1400Mi
tlm.deployment.strategy	k8s deployment strategy	{}
tlm.priorityClassName	k8s priority classname	genesysengage-high-priority
tlm.affinity	pod affinity	{}
tlm.nodeselector	k8s nodeselector map	{ genesysengage.com/nodepool: general }
tlm.tolerations	pod toleration	[]
tlm.annotations	pod annotations	[]
tlm.autoscaling.enabled	activate auto scaling	true
tlm.autoscaling.targetCPUPercent	CPU percentage autoscaling trigger	40
tlm.autoscaling.minReplicas	Minimum number of replicas	2
tlm.autoscaling.maxReplicas	Maximum number of replicas	10
tlm.secrets.name_override	Name override of the secret to target	``
tlm.secrets.TELEMETRY_AUTH_CLIENT_SECRET	GAuth client Secret value	``
tlm.context.envs.*	Environment variables for Telemetry Service. Please refer to TLM service documentation	``
tlm.context.envs.TELEMETRY_AUTH_CLIENT_ID	GAuth client ID value	telemetry_client
tlm.context.envs.TELEMETRY_CLOUD_PROVIDER	Specify the mode how telemetry service should be executed: Possible values aws / azure / openshift	``
serviceMonitor.enabled	Activation of service monitor	true
podDisruptionBudget.enabled	Activation of pod disruption	true

You can modify the configuration to suit your environment by two methods:

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

  helm install telemetry-service.tgz --set tlm.replicaCount 4

• Specify the parameters to be modified in a values.yaml file.

  helm install --name tlm -f values.yaml telemetry-service.tgz

Configure Kubernetes

Document the layouts for the following so customers can create them if their Helm chart doesn't include a way to do this:

• ConfigMaps
• Secrets

NA

Configure security

List security-related settings, such as how to set up credentials and certificates for third-party services.

NA

}}