Installation Instructions
1
Get S3 compatible storage
You can use Minio or any other S3 compatible storage.
Using Minio (Self-Hosted S3-Compatible Storage)
Using Minio (Self-Hosted S3-Compatible Storage)
If you’re using Minio or another S3-compatible storage solution, you’ll need to provide the following configuration:
- Bucket Name: Name of the S3-compatible bucket
- Region: Region identifier (can be any string for Minio)
- Access Key ID: Access key for authentication
- Secret Access Key: Secret key for authentication
- Endpoint URL: Full URL to your S3-compatible storage endpoint
2
Create Postgres database
If you have a managed postgres database, we highly recommend you to use it. If you don’t have one, you can create a PostgreSQL database of size equivalent to
db.t3.medium with storage size of 30GB.Using Managed PostgreSQL
Using Managed PostgreSQL
For production environments, we strongly recommend using a managed PostgreSQL service:
- Create a PostgreSQL instance with the specifications from the Compute Requirements section
- Create a database named
truefoundry(or your preferred name) - Create a user with full permissions on this database
- Note down the following details:
- DB_HOST: Database hostname or IP address
- DB_PORT: Database port (usually 5432)
- DB_NAME: Database name
- DB_USERNAME: Database username
- DB_PASSWORD: Database password
Using PostgreSQL on Kubernetes (Dev/Testing Only)
Using PostgreSQL on Kubernetes (Dev/Testing Only)
For development or testing purposes only, you can deploy PostgreSQL on Kubernetes:
- Set
devMode.enabled: truein the values file (shown in a later step) - The PostgreSQL will be automatically deployed with the control plane
3
Create 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 Apply the secret to the Kubernetes cluster (Assuming you are installing the control plane in the
LICENSE_JWT, TFY_API_KEY, and the database credentials from the installation packet.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)4
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.Tenant Name: Tenant name provided by TrueFoundry team.AWS S3 Bucket Name: AWS S3 Bucket NameAWS Region: AWS RegionAWS Access Key ID: AWS Access Key IDAWS Secret Access Key: AWS Secret Access KeyAWS Endpoint URL: URL for your S3 compatible Blob storage
truefoundry-values.yaml
5
Install Helm chart