Deploy the TrueFoundry control plane and AI Gateway. See the overview for compute requirements and prerequisites.Documentation Index
Fetch the complete documentation index at: https://www.truefoundry.com/llms.txt
Use this file to discover all available pages before exploring further.
Installation Instructions
Create S3 Bucket
Create a S3 Bucket with following config:
- Make sure the bucket has lifecycle configuration to abort multipart upload set for 7 days.
- Make sure CORS is applied on the bucket with the below configuration:
Setup Control Plane Platform IAM Role
Creating AWS IAM Role for Control Plane
Creating AWS IAM Role for Control Plane
Control Plane IAM Role needs to have permission to access the S3 bucket created in the previous step.Create a IAM Policy to allow access to the S3 Bucket with following config:Attach the IAM Policy to the Control Plane Platform IAM Role. You can also attach the IAM policy to access AWS bedrock models from the link here.
- Create a new IAM role for Control Plane with a suitable name like
tfy-control-plane-platform-deps - Add the following trust policy to the Control Plane IAM Role:
In place of
<ACCOUNT_ID>, <AWS_REGION>, and <OIDC_ID> you can also give the values from your EKS cluster.
You can find the OIDC_ID from the EKS cluster. Also, here we are assuming that the service account is truefoundry and the namespace is truefoundry, you can change it as per your needs.If you want to restrict the S3 permissions to a minimal set instead of using
s3:*, see the FAQ.If you are integrating with AWS bedrock models from a different AWS account, see the FAQ.
Create Postgres RDS Database
Create a Postgres RDS instance of size
db.t3.medium with storage size of 30GB.In case you want to setup PostgreSQL on Kubernetes and not use RDS for testing purposes, skip this step and set
devMode to true in the values file belowCreate Kubernetes Secrets
We will create two secrets in this step:
- Store the License Key and DB Credentials
- Store the Image Pull Secret
Create Kubernetes Secret for License Key and DB Credentials
Create Kubernetes Secret for License Key and DB Credentials
We need to create a Kubernetes secret containing the licence key and db credentials.Apply the secret to the Kubernetes cluster (Assuming you are installing the control plane in the
If you are using PostgreSQL on Kubernetes in the dev mode, the values will be as follows:DB_HOST: <HELM_RELEASE_NAME>-postgresql.<NAMESPACE>.svc.cluster.local // eg. truefoundry-postgresql.truefoundry.svc.cluster.localDB_NAME: truefoundryDB_USERNAME: postgres # In order to use custom username, please update the same at
postgresql.auth.usernameDB_PASSWORD: randompassword # You can change this to any value here.truefoundry-creds.yaml
truefoundry namespace)Create Kubernetes Secret for Image Pull Secret
Create Kubernetes Secret for Image Pull Secret
We need to create a Image Pull Secret to enable pulling the truefoundry images from the private registry.Apply the secret to the Kubernetes cluster (Assuming you are installing the control plane in the
truefoundry-image-pull-secret.yaml
truefoundry namespace)Create HelmChart Values file
Create a values file as given below and replace the following values:
- Control Plane URL: URL that you will map to the control plane dashboard (e.g.,
https://truefoundry.example.com) - Tenant Name: Tenant name provided by TrueFoundry team
- AWS S3 Bucket Name: Name of the S3 bucket you created in the previous step (e.g.,
my-truefoundry-bucket) - AWS Region: Region of the S3 bucket you created in the previous step (e.g.,
us-west-2) - Control Plane IAM Role ARN: ARN of the IAM role you created in the previous step (e.g.,
arn:aws:iam::123456789012:role/tfy-control-plane-platform-deps)
truefoundry-values.yaml