search string side menu

BRIX On-Premises > BRIX On-Premises Enterprise > Install add-on components for BRIX / Install Jaeger

Install Jaeger

Jaeger is software that is used to trace and troubleshoot issues in interconnected software components, known as microservices. Multiple microservices interact with each other to perform a single software function.

Developers use Jaeger to visualize the chain of events when microservices interact to isolate a problem when something goes wrong. This is also referred to as Jaeger tracing because it tracks or traces the path of a request through a series of interactions between microservices.

Installation consists of three steps:

  1. Download the Helm chart and configuration file.
  2. Fill out the configuration file.
  3. Install the Jaeger chart using helm in the Kubernetes cluster.

Step 1: Download the Helm chart and configuration file

For installation via the internet, obtain the configuration file values-jaeger.yaml by executing the command:

helm repo add elma365 https://charts.elma365.tech
helm repo update
helm show values elma365/jaeger > values-jaeger.yaml

Getting the configuration file for installation in a closed-loop environment without internet access

  1. On a computer with internet access, download the archive of the latest version of the Jaeger chart from the BRIX repository by executing the following command:

helm repo add elma365 https://charts.elma365.tech
helm repo update
helm pull elma365/jaeger

  1. Copy the obtained chart archive jaeger-X.Y.Z.tgz to the server where the installation will be performed.
  1. Unpack this chart and copy the default configuration file values.yaml to values-jaeger.yaml:

tar -xf jaeger-X.Y.Z.tgz
cp jaeger/values.yaml values-jaeger.yaml

Step 2: Fill out the configuration file

Fill out the configuration file values-jaeger.yaml for Jaeger installation.

## Jaeger settings
jaeger:
  resources:
    requests:
      cpu: 100m
      memory: 256Mi
    limits:
      cpu: 500m
      memory: 8Gi
  tolerations:
    - effect: NoSchedule
      key: dedicated
      operator: Equal
      value: monitoring
  service:
    name: jaeger-nodeport
    ## Port for accessing Jaeger when ingress is disabled
    nodePort: 32121
  ingress:
    ## enable host in ingress
    enabled: false
    className: ""
    annotations:
      kubernetes.io/ingress.class: nginx
    ## annotations for cert-manager operation
    # certmanager.io/cluster-issuer: letsencrypt
    hosts:
      ## domain (FQDN) through which the system will be accessible
      - host: example.ru
        paths:
          - path: /
            pathType: ImplementationSpecific
     ## enable encryption, when using cert-manager, specify the used secretName letsencrypt
#    tls:
#      - secretName: example-ru-cert
#        hosts:
#          - example.ru
  ## enable creation of a secret with custom certificates
  ##  indicate the path to the certificate in the lines key: and cert:
  secret:
    enabled: false
    key: "files/my_cert.key"
    cert: "files/my_cert.crt"
  ## To prevent the problem of insufficient memory, specify an integer value for tracing
  memory_max_traces: 50000
  ## number of replicas for high availability
  replicaCount: 1
...

Filling out the parameters for connection to a private registry for installation in a closed loop without internet access

To connect to a private registry, you need to:

  1. Download the BRIX images and upload them to the local image registry. For more details, see Download BRIX images.
  1. Set the address and path for the parameter jaeger.image.repository.
  1. Indicate the name of the secret with access rights to the private registry in the parameter jaeger.image.pullSecrets. The secret must be created manually and encrypted in Base64.

## Jaeger settings
jaeger:
...
  ### connection parameters to a private registry
  image:
    ## address and path for the private registry
    repository: registry.example.com/jaeger
    tag: "1.47"
  ## the secret with access rights to the private registry must be created manually, encrypted in Base64
  pullSecrets:
    - myRegistryKeySecretName

Where the repository format is:

  • Addres is registry.example.com.
  • Path is /jaeger.

Step 3: Install the Jaeger chart using helm in the Kubernetes cluster

Install the Jaeger chart in namespace monitoring.

For installation via the internet, execute the command:

helm upgrade --install jaeger elma365/jaeger -f values-jaeger.yaml -n monitoring

For offline installation without internet access, navigate to the directory with the downloaded chart and execute the command:

helm upgrade --install jaeger ./jaeger -f values-jaeger.yaml -n monitoring

Delete the Jaeger chart using helm in the Kubernetes cluster

To delete the jaeger chart in namespace monitoring, execute the command:

helm uninstall jaeger -n monitoring

event-monitoring.html install-cert-manager.html