TLM/Current/TLMPEGuide/Configure - Revision history

WikiSysop at 08:32, February 28, 2023

2023-02-28T08:32:04Z

WikiSysop at 07:46, July 27, 2022

2022-07-27T07:46:00Z

WikiSysop at 06:45, June 3, 2022

2022-06-03T06:45:38Z

WikiSysop at 06:30, June 3, 2022

2022-06-03T06:30:41Z

Xavier: Published

2022-05-30T15:23:36Z

Published

Show changes

WikiSysop at 14:45, May 20, 2022

2022-05-20T14:45:46Z

Show changes

Xavier: Published

2021-12-22T17:20:28Z

Published

Show changes

Xavier.roy@genesys.com: Published

2021-06-30T11:25:17Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Configure Telemetry Service
|Context=Learn how to configure Telemetry Service.
|ComingSoon=No
|Section={{Section
|sectionHeading=Override Helm chart values
|alignment=Vertical
|structuredtext={{{!}} class="wikitable"
{{!}}+
!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,
*:<pre>helm install telemetry-service.tgz --set tlm.replicaCount 4</pre>

*Specify the parameters to be modified in a '''values.yaml''' file.
*:<pre>helm install --name tlm -f values.yaml telemetry-service.tgz</pre>
|Status=No
}}{{Section
|sectionHeading=Configure Kubernetes
|alignment=Vertical
|structuredtext=<div style="background-color: aliceblue; font-style: italic;">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
</div>NA
|Status=Yes
}}{{Section
|sectionHeading=Configure security
|alignment=Vertical
|structuredtext=<div style="background-color: aliceblue; font-style: italic;">List security-related settings, such as how to set up credentials and certificates for third-party services.</div>NA
<br />
|Status=Yes
}}
|PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
}}
}}

@@ Line 196: / Line 196: @@
      runAsNonRoot: true
 </syntaxhighlight>
 ===Arbitrary UIDs in OpenShift===
 If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the '''values.yaml''' file, so that you do not define any specific IDs.<syntaxhighlight>
@@ Line 205: / Line 206: @@
      runAsNonRoot: true
 </syntaxhighlight><br />
 |Status=No
 }}{{Section
@@ Line 224: / Line 226: @@
 {{!}}-
 {{!}}tlm.context.envs.TELEMETRY_CLOUD_PROVIDER
-{{!}}Specify the mode how telemetry service should be executed: Possible values aws / azure / openshift.
+{{!}}Specify the mode how telemetry service should be executed: Possible values aws / azure .
 {{!}}
 {{!}}

@@ Line 159: / Line 159: @@
 {{!}}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.
 {{!}}
 {{!}}
@@ Line 194: / Line 189: @@
 |sectionHeading=Configure security
 |alignment=Vertical
-|structuredtext=NA
+|structuredtext=To learn more about how security is configured for private edition, be sure to read the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=Prerequisites|display text=Permissions}} and {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ConfigSecurity}} topics in the ''Setting up Genesys Multicloud CX Private Edition'' guide.
-<br />
+By default, the user and group IDs are set in the '''values.yaml''' file as <code>500:500:500</code>, meaning the '''genesys''' user.<syntaxhighlight>
-|Status=Yes
+optional:
 }}{{Section
 |sectionHeading=Environment variables
-|anchor=environment variables
+|anchor=en-var
 |alignment=Vertical
 |structuredtext=<br />
@@ Line 217: / Line 230: @@
 {{!}}tlm.context.envs.TELEMETRY_CLOUD_PROVIDER
 {{!}}Specify the mode how telemetry service should be executed: Possible values aws / azure / openshift.
-{{!}}``
+{{!}}
 {{!}}
 {{!}}-
-{{!}}`TELEMETRY_SERVICES_AUTH`
+{{!}}TELEMETRY_SERVICES_AUTH
 {{!}}URL of the GWS Auth public API. This is a mandatory field.
 {{!}}
 {{!}}<nowiki>http://gws-core-auth:8095</nowiki>
 {{!}}-
-{{!}}`TELEMETRY_AUTH_CLIENT_ID`
+{{!}}TELEMETRY_AUTH_CLIENT_ID
 {{!}}The Client ID that is used to authenticate with GWS Auth service.
 {{!}}telemetry_client
 {{!}}
 {{!}}-
-{{!}}`TELEMETRY_CORS_DOMAIN`
+{{!}}TELEMETRY_CORS_DOMAIN
 {{!}}Domains to be supported by CORS. This can a comma separated list.{{NoteFormat|Add a `\` before `.` for regex matching. eg: `\.genesyslab\.com` (another `\` should be added when using quotes).|}}
 {{!}}
 {{!}}
 {{!}}-
-{{!}}`TELEMETRY_TRACES_PROVIDER`
+{{!}}TELEMETRY_TRACES_PROVIDER
 {{!}}The trace provider to use can be `ElasticSearch` or `Console`.
 {{!}}ElasticSearch
 {{!}}
 {{!}}-
-{{!}}`TELEMETRY_TRACES_CONCURRENT`
+{{!}}TELEMETRY_TRACES_CONCURRENT
 {{!}}The maximum of parallel bulk request to Elasticsearch at the same time.
 {{!}}3
 {{!}}
 {{!}}-
-{{!}}`TELEMETRY_TRACES_THRESHOLD`
+{{!}}TELEMETRY_TRACES_THRESHOLD
 {{!}}The maximum buffer entries for Elasticsearch service.
-{{!}}`400000`
+{{!}}400000
 {{!}}
 {{!}}-
-{{!}}`TELEMETRY_CONFIG_SERVICE`
+{{!}}TELEMETRY_CONFIG_SERVICE
 {{!}}The data source to fetch configuration information. Possible values : s3, azure, env, or an empty string.
 {{!}}none
 {{!}}
 {{!}}-
-{{!}}`TELEMETRY_CONFIG_SERVICE_CORS`
+{{!}}TELEMETRY_CONFIG_SERVICE_CORS
 {{!}}This overrides data source to fetch CORS configurations. Possible values : Same value as `TELEMETRY_CONFIG_SERVICE` or `environmentservice` for using the environment-service API (Uses the `TELEMETRY_SERVICES_ENVIRONMENT` variable).
 {{!}}none
 {{!}}
 {{!}}-
-{{!}}`TELEMETRY_CLOUD_PROVIDER`
+{{!}}TELEMETRY_CLOUD_PROVIDER
 {{!}}Cloud provider for the service. Can be `aws`, `azure`, `gcp` or `premise`.
-{{!}}`aws`
+{{!}}aws
 {{!}}
 {{!}}-
-{{!}}`TELEMETRY_CONFIG_CONTRACTS`
+{{!}}TELEMETRY_CONFIG_CONTRACTS
 {{!}}Stringified JSON array to provision contracts through `env` config provider.
-{{!}}`[]`
+{{!}}[]
 {{!}}
 {{!}}-
-{{!}}`TELEMETRY_CONFIG_TENANTS`
+{{!}}TELEMETRY_CONFIG_TENANTS
 {{!}}A Stringified JSON to provision tenants through `env` config provider.
-{{!}}`{}`
+{{!}}{}
 {{!}}
 {{!}}-
-{{!}}`TELEMETRY_SERVICES_ENVIRONMENT`
+{{!}}TELEMETRY_SERVICES_ENVIRONMENT
 {{!}}The URL of the GWS environment service API. Used only if environment service is used for configuration provisioning.
-{{!}}value of `TELEMETRY_SERVICES_AUTH`
+{{!}}value of TELEMETRY_SERVICES_AUTH
 {{!}}http://gauth-environment-active.gauth
 {{!}}}

@@ Line 114: / Line 114: @@
 {{!}}tlm.priorityClassName
 {{!}}k8s priority classname.
-{{!}}genesysengage-high-priority
+{{!}}
 {{!}}
 {{!}}-