Helm
  • 26 Dec 2022
  • 1 Minute to read

Helm


Complete the following steps to install all the Traceable components using a helm chart. Traceable currently only supports Helm 3.

Label Namespace

Make sure that you have gone through prerequisites and other information available in the Kubernetes topic. Export token and Environment. You can obtain token by completing the following steps:

  1. Log in to your Traceable account.
  2. Navigate to Administration (image-1638268402925) > Account > Agent Tokens.
  3. Click on Generate Token.

Make sure to copy and save the generated token, as you cannot access it again. You can only edit the name of the token or delete it. This token is used in steps detailed below. If this token is deleted from Traceable Platform (UI), the communication between Traceable Platform agent and Traceable Platform (UI) will break. In such a case, generate a new token and update the same in Platform agent.traceable_generate_authentication_tokenExport Token and Environment:

export TOKEN = <token>
export ENV = <dev,test,stage,prod>

Install Traceable services

Enter the following command to install Traceable services into your Kubernetes cluster.

Note:

Traceable supports only Helm 3.

  1. Add Traceable repo. Enter the following command:
    ActionScript
    helm repo add traceableai https://helm.traceable.ai
  2. Update the repo. Enter the following command:
    ActionScript
    helm repo update
  3. Install Traceable agent. Enter the following command:
    ActionScript
    helm install --namespace traceableai traceable-agent traceableai/traceable-agent --create-namespace --set token=$TOKEN --set environment=$ENV

Load balance Platform agent

In a deployment where you have deployed more than one Traceable Platform agent, and you expect high span load, you load balance the spans among the Platform agents. Load balancing is available in Platform agent 1.26.0 and later and only applies to the Go agent. In Helm chart, add the following value: 

serviceType:Headless

Configurable registry suffix

You can configure registry suffix if you are using Helm chart to deploy Platform agent and use custom image registry. Use the registrySuffix field for configurable registry paths.

imageCredentials:
  registry: docker.io
  registrySuffix: traceableai

Using registrySuffix you can use a custom path, for example, my-internal-docker.io/my-images/security-team/traceable-images/traceable-agent. This option to have a custom path is available in Platform agent 1.27.2 and later.

Verify

Enter the following command to verify a successful installation of Traceable agent:

kubectl get pod -n traceableai

The output should show 1/1 READY, similar to the following:

NAME                                     READY   STATUS    RESTARTS   AGE
traceable-agent-d8ff7cd79-qn2wb          1/1     Running   0          34m

Was this article helpful?

What's Next