Truefoundry Onboarding

Getting Started Steps on Truefoundry

This guide will walk you through the steps of setting up and getting onboarded to TrueFoundry.
For that you will have to do the following:

  1. Register for a TrueFoundry account and log in
  2. Connect a Kubernetes cluster to TrueFoundry
  3. Set up integrations

If you encounter any difficulties, please contact us for assistance here: Slack Invite

Step 1: Register and Login

To register for a TrueFoundry account, visit the TrueFoundry Registration Page. During registration, you will be asked to provide your company name; please remember this as it will be useful later.

Once you have registered, you will receive an email containing a confirmation link. Click on the link to activate your account.

After your account is activated, you can access the login portal at https\://<companyname>.truefoundry.cloud.

Once logged in, follow the steps outlined below to set up your account and connect your Kubernetes cluster.

Step 2: Connect a Kubernetes Cluster to TrueFoundry

To use TrueFoundry, you'll need to connect a Kubernetes cluster to the platform. You have two options:

  1. TrueFoundry Managed Cluster:
    If you prefer a hassle-free experience, select the TrueFoundry Managed Cluster. This option allows you to explore the platform without connecting your own cluster for the first few weeks.

  2. Bring Your Own Cluster:
    Alternatively, you can choose to connect your own Kubernetes cluster using the Bring Your Own Cluster option.

2.1 Connect to a TrueFoundry Managed Cluster

2.2 Bring your own Cluster

You should have an active Kubernetes cluster. TrueFoundry offers support for the three major cloud providers: AWS EKS, GCP GKE, and Azure AKS, as well as local clusters using kind and minikube.

For the complete range of platform features, it is recommended to use one of the three major cloud providers. Please note that kind and minikube may not support all the platform features, such as service exposure, autoscaling, GPUs, and more.

If you don't already have a Kubernetes cluster, you can quickly create one based on the cloud you are using:

  1. Creating an AWS EKS cluster
  2. Creating an Azure AKS cluster
  3. Creating a GCP GKE cluster
  4. Creating a kind cluster on local machine (Partial feature set available)
  5. Creating a minikube cluster on local machine (Partialfeature set available)

If you already have a running cluster, you can swiftly proceed using the steps given in the Platform

Step 3: Add Integrations

Integrations allow TrueFoundry to interact with other services that you are using, such as your Docker registry, Blob storage, Git repository, and Secret store. This makes it easier to deploy and manage your applications on TrueFoundry.

Once you have connected a Kubernetes cluster to TrueFoundry, you will need to set up integrations with the following services:

IntegrationPurpose
Docker RegistrySave images built for the deployment of code or repository.
Deploy images from the repository to one of your connected workspaces.
GitDeploy source code from private git repositories to TrueFoundry.
Blob StorageStore artifacts, logs, and metrics generated by TrueFoundry.
Secret StoreStore secrets securely

To configure various integrations, navigate to the Integrations tab on the platform:

3.1 Docker Registry

TrueFoundry needs to access your Docker registry to save images built for deploying code or repositories and to deploy images from the registry to one of your connected workspaces. For more details, refer to Docker Registry Integration Documentation.

3.2 Git (Optional)

TrueFoundry needs to be able to access your Git repository in order to Deploy source code from private git repositories to TrueFoundry. refer to Git Integration Documentation.

3.3 Blob Storage (Optional)

TrueFoundry needs to be able to access your blob storage in order to Store artifacts, logs, and metrics generated by TrueFoundry. For more details, refer to Blob Storage Integration Documentation.

3.4 Secret Store (Optional)

TrueFoundry needs to be able to access your secret store in order to Store secrets securely. For more details, refer to Secret Store Integration Documentation.