Install Helm Chart

Guide to install and customize the control-plane helm chart

The control-plane helm chart is available in this Github repository: truefoundry. This guide will walk you through the steps to install the helm chart and then customize it as per your needs.

This guide assumes you already have a Kubernetes cluster and have access to it. If you don’t have a Kubernetes cluster, you can follow the AWS Control Plane, GCP Control Plane or Azure Control Plane to create the cluster first.

1. Create truefoundry namespace

   Create truefoundry namespace

   kubectl create ns truefoundry
   
2. Install ArgoCD if not already installed (Optional)

   While you can install the helm chart without ArgoCD, we do recommend to install it via ArgoCD to make it easier to manage in the future.

     helm repo add argocd https://argoproj.github.io/argo-helm
     helm repo update argocd
   

   helm install argocd argo/argo-cd \
   --namespace argocd \
   --create-namespace \
   --version 9.4.14 \
   --set server.extraArgs[0]="--insecure" \
   --set server.extraArgs[1]="--application-namespaces=*" \
   --set controller.extraArgs[0]="--application-namespaces=*" \
   --set applicationSet.enabled=false \
   --set notifications.enabled=false \
   --set dex.enabled=false
   

   If you don’t want to install ArgoCD, you can skip this step and proceed to the next step.

3. Install truefoundry chart

   With ArgoCD

   Coming soon

   Without ArgoCD

   Add truefoundry helm repo

   helm repo add truefoundry https://truefoundry.github.io/infra-charts/
   helm repo update truefoundry
   

   Create a file called values.yaml and fill in the content below:

   truefoundry:
      enabled: true
      devMode:
        enabled: false # Set to true if you want to test the control plane in dev mode
      # Virtual service to create
      virtualservice:
        enabled: false
        hosts: ["domain"]
        gateways: ["istio-system/tfy-wildcard"]
      database:
        host: ""
        name: ""
        username: ""
        password: ""
      tfyApiKey: "" # Given by TrueFoundry team
      truefoundryImagePullConfigJSON: "" # Given by truefoundry team
   

   Install control-plane helm chart

   helm install truefoundry truefoundry/truefoundry -n truefoundry -f values.yaml 
   
4. Point the domain to the Load balancer IP of the control plane

   kubectl get svc -n istio-system
   

   Point the domain to the Load balancer IP of the control plane. Check here on how to add a certificate for TLS.

5. Test the installation

   kubectl get pods -n truefoundry
   
6. Access the control plane dashboard

   Access the control plane dashboard via https://domain or if via port-forward if dev mode is enabled

   kubectl port-forward svc/truefoundry-truefoundry-frontend-app -n truefoundry 5000:5000