How do I create a new instance?

Who can do this

Platform Admin or Infra Ops

An instance is a deployed Exto stack that hosts tenants. Creating one in the Console registers it — the actual stack is stood up out-of-band, and the credentials returned here are what the instance uses to call back to the Console.

Steps

1. Open Instances in the Admin Console sidebar.
2. Click New Instance.
3. Fill in:
   • Name — e.g. us-east-1a.
   • API base URL — the URL the Console will use to reach this instance's API.
   • MongoDB URI — the connection string for the instance's database.
   • Max tenants — soft cap used by tenant placement.
4. Click Create Instance.

Result

A credentials modal appears with four values:

• CONSOLE_INSTANCE_TOKEN
• CONSOLE_INSTANCE_ID
• CONSOLE_BASE_URL
• MONGODB_URI (echoed for convenience)

Copy the token now

The token is shown only once. Save it to your secrets manager or paste it into the instance's env config before closing the modal. If you lose it, decommission the instance and create a new one.

The instance appears in the table with status Active once it makes its first heartbeat.

Related

• How do I create a new tenant?
• How do I update environment variables on an instance?
• How do I decommission an instance?