Deploy Telemetry Service

Learn how to deploy Telemetry Service.

Related documentation:

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

RSS:

• For private edition

Important

Make sure to review Before you begin for the full list of prerequisites required to deploy Telemetry Service.

Deploy the service

To install the Telemetry Service, run the following command:

helm install -f values-tlm.yaml telemetry-service telemetry-service/

Validate the deployment

To validate the installed release, run the following command:

helm list –n tlm

Verify that details of the Telemetry Service deployment information is displayed.

To check the status of installed Helm release, execute the following command:

helm status telemetry-service -n tlm

Verify that the deployment status mentions 'STATUS: deployed'.

To verify if the objects are created and available in the Telemetry namespace

kubectl get all -n tlm

Verify that all pods, services, and config maps are displayed.

Expose ports for access

To make the Telemetry service accessible from outside the cluster, you have to create ingress files for external and internal access points and apply them to the containers.

Configuring ports for external access

• Create an ingress file named tlm-ingress-cert.yaml and modify it to reflect your domain configurations:

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: tlm-ingress
  namespace: tlm
  annotations:
    cert-manager.io/cluster-issuer: <ca-cluster-issuer>
    kubernetes.io/ingress.class: <nginx>
    nginx.ingress.kubernetes.io/ssl-redirect: 'false'
    nginx.ingress.kubernetes.io/use-regex: 'true'
spec:
  tls:
    - hosts:
        - tlm.<$domain>
      secretName: tlm-secret-ext
  rules:
    - host: tlm.<$domain>
      http:
        paths:
          - path: /.*
            pathType: ImplementationSpecific
            backend:
              service:
                name: telemetry-service
                port:
                  number: 8107

• Apply the access rules:

kubectl apply -f tlm-ingress-cert.yaml -n tlm

Configuring ports for internal access

• Create an ingress file named tlm-ingress-int-cert.yaml and modify it to reflect your domain configurations:

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: tlm-ingress-int
  namespace: tlm
  annotations:
    cert-manager.io/cluster-issuer: ca-cluster-issuer
    kubernetes.io/ingress.class: nginx
    nginx.ingress.kubernetes.io/ssl-redirect: 'false'
    nginx.ingress.kubernetes.io/use-regex: 'true'
spec:
  tls:
    - hosts:
        - tlm.<$domain>
      secretName: tlm-secret-int
  rules:
    - host: tlm.<$domain>
      http:
        paths:
          - path: /metrics
            pathType: ImplementationSpecific
            backend:
              service:
                name: telemetry-service
                port:
                  number: 9107

• Apply the access rules:

kubectl apply -f tlm-ingress-int-cert.yaml -n tlm

Verify if the routes are created correctly:

kubectl get ingress -n tlm