Azure

Setting up Truefoundry control plane on your own cloud involves creating the infrastructure to support the platform and then installing the platform itself.

​

Setting up Infrastructure

​

Requirements

These are the infrastructure components required to set up a production grade Truefoundry control plane.

• Role Based Access Administrator to the above subscription | These are the permissions required by the IAM user in Azure to create the entire control plane components. |

​

Run Infra Provisioning using OCLI

​

Prerequisites

1. Install git if not already present.

2. Setup az CLI

   1. Install azure cli >= 2.50

   2. Log in and set a subscription. Please ensure that the user has Contributor and RBAC admin roles in the Subscription

      # login
      az login
      
      # setting the subscription
      az account set --subscription $SUBSCRIPTION_ID
      

​

Installing OCLI

1. Download the binary using the below command.

   Apple silicon MacOS (arm64))

   Intel MacOS (amd64)

   Linux (arm64)

   Linux (amd64)

   curl -H 'Cache-Control: max-age=0' -s "https://releases.ocli.truefoundry.tech/binaries/ocli_$(curl -H 'Cache-Control: max-age=0' -s https://releases.ocli.truefoundry.tech/stable.txt)_darwin_arm64" -o ocli
   

2. Make the binary executable and move it to $PATH

   Shell

   sudo chmod +x ./ocli
   sudo mv ocli /usr/local/bin
   

3. Confirm by running the command

   Shell

   ocli --version
   

​

Configuring input config file

1. To create a new cluster, you would require your Azure Subscription, Location, Resource Group.

2. Run the following command to fill in the inputs interactively

   Shell

   ocli infra-init
   

3. For networking, there are the following possible configurations:

   1. New resource group & network (Recommended) - This will create a new resource group and a new Virtual network.
   2. Existing resource group with existing network - You can use an existing resource group and an existing Virtual network.
   3. Existing resource group with new network - You can use an existing resource group while creating a new Virtual network

4. Once all the inputs are filled, an input config file with the nametfy-config.yaml would be generated in your current directory

5. Modify the file to enable control plane installation by setting azure.tfy_control_plane.enabled: true. Also modify the azure.tfy_control_plane.subnet_cidr: "" or azure.tfy_control_plane.subnet_id: "" for installing control plane components. Below is the sample for the same:

aws: null
azure:
  cluster:
    name: CLUSTER_NAME
    node_pools:
      cpu_pools:
        - enable_on_demand_pool: true
          enable_spot_pool: true
          instance_type: Standard_D2ds_v5
          max_count: 2
          name: cpu
        - enable_on_demand_pool: true
          enable_spot_pool: true
          instance_type: Standard_D4ds_v5
          max_count: 2
          name: cpu2x
      gpu_pools:
        - enable_on_demand_pool: true
          enable_spot_pool: true
          instance_type: Standard_NV6ads_A10_v5
          max_count: 2
          name: a10
        - enable_on_demand_pool: true
          enable_spot_pool: true
          instance_type: Standard_NC4as_T4_v3
          max_count: 2
          name: t4
        - enable_on_demand_pool: true
          enable_spot_pool: true
          instance_type: Standard_NC24ads_A100_v4
          max_count: 2
          name: a100
      initial:
        instance_type: Standard_D2ds_v5
        name: initial
    version: "1.29"
  location: eastus
  network:
    existing: true
    subnet_cidr: ""
    subnet_id: "/subscriptions/xxxxx-xxxxx-xxxxx-xxxxxxxxx/resourceGroups/RESOURCE_GROUP/providers/Microsoft.Network/virtualNetworks/VNET/subnets/SUBNET"
    vnet_cidr: ""
    vnet_id: "/subscriptions/xxxxx-xxxxx-xxxxx-xxxxxxxxx/resourceGroups/RESOURCE_GROUP/providers/Microsoft.Network/virtualNetworks/VNET"
    vnet_name: ""
  platform_features:
    blob_storage:
      container_enable_override: false
      container_override_name: ""
      enabled: true
      storage_account_enable_override: false
      storage_account_override_name: ""
    cloud_integration:
      azuread_application_enable_override: false
      azuread_application_override_name: ""
      enabled: true
    container_registry:
      container_registry_enable_override: false
      container_registry_override_name: ""
      enabled: true
    enabled: true
  resource_group:
    existing: true
    name: RESOURCE_GROUP
  state:
    container_name: tfy-tfstate-CLUSTER_NAME-cn-1714629250
    resource_group: tfy-tfstate-CLUSTER_NAME-rg-1714629250
    storage_account_name: tfytfstateCLUSTER_NAMEsa
    storage_account_sku: Standard_GRS
  subscription:
    id: SUBSCRIPTION_ID
    name: SUBSCRIPTION_NAME
  tags: {}
  tfy_control_plane:
    database:
      existing_network: true
      instance_class: GP_Standard_D4ds_v5
      subnet_cidr: ""
      subnet_id: "/subscriptions/xxxxx-xxxxx-xxxxx-xxxxxxxxx/resourceGroups/RESOURCE_GROUP/providers/Microsoft.Network/virtualNetworks/VNET/subnets/DB_SUBNET"
    enabled: true
binaries:
  terraform:
    binary_path: null
  terragrunt:
    binary_path: null
gcp: null
provider: azure

​

Create the cluster

Run the following command to create the GKE cluster and IAM roles needed to provide access to various infrastructure components as per the inputs configured above.

ocli infra-create --file tfy-config.yaml

This command may take around 30-45 minutes to complete.

In the last step the database credentials will be printed. Make sure to note them down.

​

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. You can refer to the values for more details

   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: false
     truefoundryBootstrap:
       enabled: true
     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-azure-aks-inframold \
   truefoundry/tfy-k8s-azure-aks-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

   Shell

   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

   YAML

   ## @section tfyAgent parameters
   tfyAgent:
     enabled: true
     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-azure-aks-inframold \
   truefoundry/tfy-k8s-azure-aks-inframold \
   -f values.yaml -n argocd
   

​

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 integrations

• If you have used ocli to bootstrap your infrastructure then it creates the following additional resources alongwith AKS cluster in your selected resource group. Check the below documents to understand how to create the integrations manually, if not done through OCLI and how to add them to the platform.

  • Container registry - How to add container registry to the platform
  • Storage account - how to add storage account to the platform
    • Container
  • Service Principal having read only access to AKS cluster - how to add azure application to TF platform