Instances

The Instances page manages the fleet of hosted environments that run tenants. Each instance is typically a Kubernetes cluster or hosted backend.

List page

Toolbar

• Search — matches instance name or any tag key/value.
• Status — All / Active / Provisioning / Inactive / Decommissioned.
• Environment — filter by env tag value.
• Region — filter by region tag value.
• Clear — appears when any filter is active.
• New Instance button (top right).
• Count chip — filtered vs. total.

Columns

Column	Notes
Name	Clickable link to instance detail.
Tags	Key:value chips.
Status	Active (green) / Provisioning (orange) / Inactive (grey) / Decommissioned (red).
Tenants	Capacity utilisation, e.g. "50 / 100".
Last Heartbeat	Relative timestamp from the agent's last check-in.
Actions	Edit / Decommission / Delete.

Creating a new instance

Click New Instance. The modal has these sections:

Basics (required)

• Name — display name.
• API Base URL — the instance's API root, used by the Console.
• MongoDB URI — connection string for the instance's data plane.
• Max Tenants — hard cap on tenant count.
• Health Check URL — optional override; the agent's default is used if blank.

OIDC Redirect URIs

A list of allowed OAuth redirect URIs. Defaults shown can be edited.

Environment & Region

• Environment — DEV / QA / UAT / STAGING / DEMO / PRE_PROD / PROD.
• Region — Azure region.

Pipeline

• Exclude from pipeline toggle. When on, the instance is skipped by automated CI/CD branch deployment and only receives explicit docker-tag deploys.

Tags

Key-value editor for free-form metadata.

Click Create.

Provisioning credentials

Screenshot

Provisioning credentials reveal: the post-create state of the modal showing the four credential values and the "copy these now" warning. High value — this is the one screen operators must not miss.

After creation the modal flips to show the provisioning credentials:

• CONSOLE_INSTANCE_TOKEN
• CONSOLE_INSTANCE_ID
• CONSOLE_CLIENT_ID
• EXTOID_PROJECT_ID

Copy these now. The token will never be shown again. Store them as a Kubernetes secret on the target cluster and deploy the Console agent there. The instance stays in provisioning status until the agent reports in.

Editing an instance

The pencil icon opens an edit modal with a subset of fields: Name, Environment, Exclude from pipeline, Max Tenants, Health Check URL, Tags. API URL and MongoDB URI are not editable here — they are set once at creation.

Decommissioning

The power icon opens a confirmation dialog. Decommissioning cannot be undone. Tenants on the instance must be migrated or deleted first.

Deleting

The trash icon opens a confirmation dialog. Delete is a hard removal and is typically reserved for instances that were never put into service.

Instance detail page

Header

Instance name, environment tag, and action buttons.

Tabs

Overview

• Details card — Name, Environment, API URL, Database URL, Max Tenants, Health Check URL, Exclude from Pipeline. Click Edit for inline editing.
• Services Health widget — rolled-up status, list of running services with status dot, version, replica counts, restart count, and last deployed time. Colour reflects state: green all healthy, red all unavailable, orange mixed, grey no data.

Tenants

The tenants currently provisioned on this instance, with quick navigation to each.

Jobs

Migration jobs that target this instance — clones, deletes, imports, instance replaces. Status, start time, duration.

Insights

Time-series usage for the instance.

• Date range toggle — 7d / 30d / 90d.
• Usage meters — CPU, Memory, Disk.
• Charts for each metric.

SPOCs

Single Points of Contact for this instance — used by the release pipeline's approval flow. Add or remove SPOCs here.

Services

Screenshot

Services tab with drift: the service list with at least one row showing environment drift (expected vs. actual values), and an expanded row revealing per-variable Set/Remove Override controls.

The full service catalogue for the instance, with a managed-vs-all toggle.

• Managed — services declared in the Release Configuration. These are the ones the pipeline operates on.
• All — managed plus any other discovered service pods.

Per-service rows show name, image, version, replicas (ready / desired), status dot, restart count, last deployed.

Environment drift is detected and surfaced: if the agent reports a variable value different from what the Console resolved, the row is highlighted with an "expected vs. actual" view.

Expand a row to see its full environment-variable list. Each variable can be overridden at the instance level:

• Set Override — opens a modal to enter a value or a secret reference (name/key).
• Remove Override — drops back to the global default.

A warning banner appears if a managed service is configured but no pods are reporting.