Runtime plane — basic setup¶
The shortest path to a working runtime plane: two form pages, two commands, done. This is the right choice for most first-time installs.
Before you start, work through Before you begin on the overview page — a cluster that meets the requirements, kubectl and helm access to it, and the Account Admin role in the portal.
If you need object storage, your own DNS name, a specific secret store, or you are setting up monitoring for custom agents, use Advanced setup instead.
Step 1 — Open the Create Runtime Plane page¶
- Log in to the Trust3 AI portal.
- In the left sidebar, click Settings.
- In the Settings menu, click Runtime.
You are now on Runtime Environments. Any runtime planes you already have are listed here as cards, each showing its name, its type, a status badge such as Running, and when it last reported in. A fresh account normally shows one entry, Trust3 AI Cloud, which is the Trust3-hosted SaaS environment.
- Click + Create New.
Step 2 — Fill in Infrastructure Setup¶
The Create Runtime Plane page opens on step 1 of 2, Infrastructure Setup. Leave Configuration Mode on Basic Config — that is what keeps the wizard to two steps.
Fill in the left-hand column:
| Field | What to enter |
|---|---|
| Deployment Type | Leave Partially Managed ( D2P ). The control plane stays in Trust3 Cloud and only the data plane runs in your environment. (Self-Managed, where you host the database and the control plane yourself, is a different install and is not covered here.) |
| Configuration Mode | Basic Config uses guided defaults. Advanced Config adds the Storage & Connectivity and Cloud Permissions steps. |
| Cloud Provider | Click the tile for the cloud your Kubernetes cluster runs in: AWS, Azure, or GCP. The prerequisites panel on the right changes to match. |
| Region | Pick the region your cluster is deployed in. |
| Runtime Name | Auto-filled as cloud-region-NNN, for example aws-us-east-1-871. Keep it or personalise it. |
About the runtime name¶
This name becomes the Kubernetes namespace, so it has rules:
- 6 to 44 characters
- lowercase letters, numbers, and hyphens only
- must start and end with a letter or number
The ↻ icon next to the field generates a fresh suggestion. If you type a custom region, it must be at least 7 characters and use the same character set, so that the generated name stays a valid namespace.
Pick the name deliberately
The name is used for the namespace and for internal service names, and it becomes part of the hostname of any endpoint the plane exposes. Renaming it later means recreating the runtime plane, so choose something you can live with — a short name that identifies the environment, such as prod-us-east-1 or aws-us-east-1-871.
Confirm the prerequisites¶
On the right-hand side is a checklist for the cloud provider you selected. Work through it and tick each item once it is true of your cluster.
| Item | What it means |
|---|---|
| EKS Cluster Configuration | Kubernetes v1.34+, r5.2xlarge nodes, 1–10 node auto-scaling. |
| Terminal Access to Cluster | You have terminal access to the EKS cluster to run kubectl and helm, with cluster-admin permissions. |
| Required Command-Line Tools | AWS CLI v2.12.0+, kubectl v1.34+, Helm v3.9.0+, and curl/wget are installed. |
| Kubernetes Metrics Server | Metrics Server is installed and running, for monitoring and autoscaling. |
| Item | What it means |
|---|---|
| AKS Cluster Configuration | Kubernetes v1.34+, Standard_E8s_v3 nodes, 1–10 node auto-scaling. |
| Terminal Access to Cluster | You have terminal access to the AKS cluster to run kubectl and helm, with cluster-admin permissions. |
| Required Command-Line Tools | Azure CLI v2.50.0+, kubectl v1.34+, Helm v3.9.0+, and curl/wget are installed. |
| Kubernetes Metrics Server | Metrics Server is installed and running, for monitoring and autoscaling. |
| Item | What it means |
|---|---|
| GKE Cluster Configuration | Kubernetes v1.34+, n2-standard-8 nodes or equivalent, node pool autoscaling 1–10 nodes. |
| Terminal Access to Cluster | Terminal access to run kubectl and Helm with Kubernetes Engine Cluster Admin or equivalent. |
| Required Command-Line Tools | Google Cloud SDK 450.0.0+, kubectl v1.34+, Helm v3.9.0+, and curl or wget. |
| Kubernetes Metrics Server | Metrics Server is installed and running, for monitoring and workload autoscaling. |
Two helpers sit alongside the list:
- Download Script — downloads a script that carries out the preparation steps for you.
- View full details — opens step-by-step manual instructions for that one item.
When every box is ticked, the panel shows All prerequisites confirmed and the button at the bottom of the page becomes available.
Click Generate.
Step 3 — Deploy¶
Copy these now — they are shown only once
The page opens with a Security-Sensitive Configuration warning, and it means it. The installation commands contain your runtime plane's API key. Once you navigate away, the key is not displayed again, and getting a new one invalidates the old one.
Paste both commands somewhere safe before doing anything else — a password manager or your team's secret store, not a chat message.
The Deploy step shows two commands.
The download command. Use the CURL tab, or the WGET tab if you prefer wget. It downloads a values.yaml for your runtime plane:
| Bash | |
|---|---|
The Helm command. It installs the runtime agent into your cluster, creating the namespace:
| Bash | |
|---|---|
Each block has two icons in its top-right corner:
- 📋 copy — copies the command, including the real credential values.
- 👁 eye — reveals the masked values on screen.
There is also a What this command does link next to each, if you want to know exactly what you are about to run.
Save the API key separately if you plan to use custom agents
Click the eye icon on the download command and copy the value of the x-pcloud-key header. That value is your runtime plane's API key — the same string appears as --password in the Helm command.
You need it again when you publish a custom agent inventory with the Trust3 collector SDK — see the custom agents guide linked at the end of this page.
Run the commands on your cluster¶
Open a terminal that is connected to your Kubernetes cluster — the one where kubectl is configured and working — and run the two commands in order, exactly as shown:
- the
curl(orwget) command, which writesvalues.yamlinto your current directory - the
helm upgrade --installcommand, which deploys the runtime agent
Check that kubectl is pointed at the right cluster before you start:
| Bash | |
|---|---|
Wait for the runtime agent to connect¶
Back in the portal, below the commands, you will see Waiting for Runtime Agent to connect…
You do not have to sit on this page. As the message says, you can close the window and finish later; the connection is established automatically once the commands have run.
Once the runtime agent pod is up and has called home, the status changes to connected.
To watch it from your side:
| Bash | |
|---|---|
You are looking for a runtime-agent-… pod in Running state.
Finish¶
- Click Done.
- A dialog appears — Don't lose access to your runtime — reminding you that these commands are how you reach the runtime plane via the instance CLI, and that without them you will have to regenerate access.
- If you have saved the commands, tick I have saved the installation commands securely.
- Click Leave Anyway.
Choose Stay on Page instead if you still need to copy something.
Verify¶
Go back to Settings → Runtime. Your new runtime plane should be listed with a Running status badge and a recent timestamp.
From the cluster side:
| Bash | |
|---|---|
What to do next¶
Open the runtime plane from Settings → Runtime and use its tabs to configure it:
- Collectors — add an AI Assets Collector and point it at your data sources or agents. See Run Collector.
- Configuration — review or change plane-level settings after creation. Anything you skipped by choosing Basic — storage, DNS, ingress — can be added here.
If you are here to govern agents you built yourself, continue with Monitoring custom agents.
Troubleshooting¶
The runtime plane never reaches “connected”
Check the runtime agent pod first:
| Bash | |
|---|---|
ImagePullBackOff usually means the cluster cannot reach the image registry. Pending usually means the node pool has no room — check that autoscaling is enabled and the node type matches the prerequisites.
Pods crash on startup with Init:CrashLoopBackOff
Check the runtime plane name. It doubles as an internal keystore password, and names shorter than six characters are rejected. The form enforces this, but an imported configuration can carry a shorter name.
I lost the installation commands
Open the runtime plane from Settings → Runtime and use Regenerate installation commands.
Regenerating invalidates the old keys immediately
Regenerating creates new API and private keys and invalidates the current ones straight away. Any runtime agent still using the old keys must be redeployed with the new Helm command. Plan a short maintenance window rather than doing it casually — and if you only need the key for the SDK, check your password manager first.
Helm reports an authentication failure
The --username trust3ai and --password <api-key> pair must be sent together with --pass-credentials. Copy the command with the copy icon rather than retyping it.