🚧

There are steps in this guide where Truefoundry team will have to be involved. Please reach out to [email protected] to get the credentials

Setting up Truefoundry control plane on a generic cluster involves creating the infrastructure to support the platform and then installing the platform itself.

Generic cluster refers to those cluster which are not managed by any cloud provider.

Setting up Infrastructure

Infrastructure requirements

Installing TrueFoundry

Pre-requisites

1. Installing helm
2. Add the following chart repository
   Shell

   helm repo add argocd https://argoproj.github.io/argo-helm
   helm repo add truefoundry https://truefoundry.github.io/infra-charts/

3. Updating helm repo to download the latest local repository index
   Shell

   helm repo update argocd truefoundry

Installing truefoundry helm chart

1. Installing argocd helm chart

   Shell

   helm upgrade --install argocd argocd/argo-cd -n argocd \
   --create-namespace \
   --version 7.4.4 \
   --set applicationSet.enabled=false \
   --set notifications.enabled=false \
   --set dex.enabled=false

2. Create values.yaml for the truefoundry helm chart.

   YAML

   ## @param tenantName Parameters for tenantName
   ## Tenant Name - This is same as the name of the organization used to sign up 
   ## on Truefoundry
   ##
   tenantName: ""
   
   ## @param controlPlaneURL Parameters for controlPlaneURL
   ## URL of the control plane - This is the URL that can be used by workload to access the truefoundry components
   ##
   controlPlaneURL: ""
   
   ## @param clusterName Name of the cluster
   ## Name of the cluster that you have created on AWS/GCP/Azure
   ##
   clusterName: ""
   
   ## @section notebookController parameters
   ## Notebook Controller is required to power notebooks in Truefoundry
   ##
   notebookController:
     enabled: false
     defaultStorageClass: ""
   
   ## @section tfyAgent parameters
   tfyAgent:
     enabled: false
   
   ## @param truefoundry.enabled Flag to enable TrueFoundry
   ## This installs the Truefoundry control plane helm chart. You can make it true
   ## if you want to install Truefoundry control plane.
   ##
   truefoundry:
     enabled: true
     ## @param truefoundry.devMode.enabled Flag to enable TrueFoundry Dev mode. Postgres will run
     ##
     devMode:
       enabled: true
     truefoundryBootstrap:
       enabled: true
     tfyK8sController:
       enabled: false
     truefoundryFrontendApp:
       replicaCount: 2
       istio:
         virtualservice:
           enabled: true
           gateways: ["istio-system/tfy-wildcard"]
           hosts:
           - ""
     tfyWorkflowAdmin:
       enabled: false
     database:
       host: ""
       name: ""
       username: ""
       password: ""
     ## @param global.tfyApiKey API key for truefoundry
     ##
     tfyApiKey: ""
     ## @param global.truefoundryImagePullConfigJSON JSON config for image pull secret
     ##
     truefoundryImagePullConfigJSON: ""

3. Fill the following values

   1. tenantName - name of the tenant. If you haven't created one. please do it here
   2. controlPlaneURL - URL at which to host the platform (for e.g. https://truefoundry.example.com)
   3. clusterName - name of the cluster

4. For the remaining values

   1. truefoundry.tfyApiKey - api key to given by TrueFoundry team
   2. truefoundry.truefoundryImagePullConfigJSON - Image pull config JSON to be given by TrueFoundry team
   3. truefoundry.truefoundryFrontendApp.istio.hosts[0] - control plane URL without protocol

5. Run the following command to install the chart

   Shell

   helm upgrade --install tfy-k8s-generic-inframold \
   truefoundry/tfy-k8s-generic-inframold \
   -f values.yaml -n argocd

6. Once the helm chart is installed, point the control plane URL to the load balancer's IP address. To get the IP address of the load balancer

kubectl get svc tfy-istio-ingress -n istio-system

7. We will also need the TLS certificates to be passed to the load balancer (in our case istio) to terminate the TLS traffic.
8. Login in the control plane URL with the same credentials used to register the tenant.

Add the compute plane

1. Add the same cluster as the compute-plane from the UI and get the cluster token

2. Add the token in the values.yaml and run the helm install command
   YAML

   ## @section tfyAgent parameters
   tfyAgent:
     enabled: false
     clusterToken: ""

3. The control plane URL should be reachable to from inside of the k8s cluster as the tfy-agent will use the control plane URL to initiate the connection to the control plane.
4. Helm
   Shell

   helm upgrade --install tfy-k8s-generic-inframold \
   truefoundry/tfy-k8s-generic-inframold \
   -f values.yaml -n argocd

Configuring Node Pools for TrueFoundry

To enable node pools in your cluster with TrueFoundry, follow these steps:

Node Pool Label Configuration

Ensure all nodes in your cluster have a node pool label. This label should follow the format <nodepool-label-key>: <nodepool-name>.

Example: If your node pool label key is truefoundry.com/nodepool, each node should have a label like truefoundry.com/nodepool: <nodepool-name>.
You can use any label key already in use.

To configure the label key in TrueFoundry:

1. Click on edit in the Cluster and then toggle on the Advanced Fields section.

2. Under Node Label Keys, fill in the Nodepool Selector Label with your chosen label key.

   

GPU Node Pool Configuration

To deploy workloads on GPU nodes, assign labels to GPU node pools indicating the GPU type.

Label Key: truefoundry.com/gpu_type
Possible Values:

• A10G
• A10_12GB
• A10_24GB
• A10_4GB
• A10_8GB
• A100_40GB
• A100_80GB
• H100_80GB
• H100_94GB
• H200
• L4
• L40S
• P100
• P4
• T4
• V100

Example: If you have a nodepool with A10G (24GB) nodes, label nodes of this nodepool with truefoundry.com/gpu_type: A10_24GB.

This configuration helps TrueFoundry orchestrate deployments on the appropriate nodes.

Adding domain to Load balancer

1. We need to add one more domain to the load balancer so that a separate domain can be used to host the workloads only. This domain can be a wildcard (recommended) as well.
2. To add the domain
   1. Point the domain to the load balancer IP address.
   2. Pass the TLS certificate to istio so that it can terminate the TLS traffic.
   3. Add the domain in the platform.

Adding docker registry

Check the integrations section to know more on this