# Service planes

The InstantML API binary runs in one of three service-plane roles, and the
hosted deployment splits control-plane and data-plane responsibilities behind
one public API URL.

## Service roles

| Role | Routes | Typical use |
| --- | --- | --- |
| `combined` | All control and data routes in one process. | Local development and single-binary self-hosting (the Docker Compose default). |
| `control` | Auth, sessions, workspaces, seats, invitations, billing, API-key admin, dashboard preferences, and saved workspace views. | Hosted account service. |
| `data` | Projects, runs, metrics, console logs, attributes, rich objects, artifacts, reports, imports, export, and usage. | Hosted tenant product service. |

Platform routes exist on every service regardless of role:

- `GET /health`
- `GET /healthz`
- `GET /readyz`
- `GET /metrics`
- `GET /openapi.json`
- `GET /api/auth/config`

`/openapi.json` and `/api/auth/config` report the active service plane, so you
can verify which role served a request.

## Hosted split topology

| Source | Route | Backing data |
| --- | --- | --- |
| Browser / dashboard | Public HTTPS API URL | Control service for auth, billing, seats, API keys, preferences, and workspace views; data service for product reads. |
| Python SDK / uploader | Public HTTPS API URL | Data service for projects, runs, metrics, logs, artifacts, objects, reports, imports, export, and usage. |
| Control service | Control-plane Postgres | Account, session, billing, API-key, and tenant-route records. |
| Data service | Routed tenant ClickHouse databases | Tenant product records and metric tables. |

Requests are routed by path for a single data cell. A plain load balancer
cannot inspect the workspace hidden inside a bearer token before
authentication, so scaling to many cells adds a discovery step at the
application layer rather than a central hot-path proxy.

The default hosted data store is InstantML-owned ClickHouse on Google Cloud.
Premium workspaces can instead route their tenant data to
[customer-owned ClickHouse](/docs/guides/customer-owned-clickhouse.md).

## Readiness

`/readyz` fails until ClickHouse is reachable and the process-local control
projection (tenant routes, memberships, API keys) has loaded. After that, a
data-plane auth miss forces one control-record refresh and retry, so a freshly
created API key or browser session becomes usable without waiting for the next
background refresh.

## Scaling posture

Control and data services scale conservatively to preserve tenant isolation,
predictable routing, and consistent control-record replay. Teams that need
stronger isolation, noisy-neighbor protection, or custom retention can run on
a dedicated data cell or bring their own ClickHouse deployment.

## Next steps

- [System overview](/docs/architecture/system-overview.md)
- [Storage model](/docs/architecture/storage-model.md)
- [Google Cloud ClickHouse](/docs/architecture/google-clickhouse.md)
- [Health and observability API](/docs/api/health-observability.md)
- [API authentication](/docs/api/authentication.md)

## Agent navigation

- [Docs index](/llms.txt)
- [Full docs bundle](/llms-full.txt)

### Get Started

- [Overview](/docs/index.md)
- [Quickstart](/docs/quickstart.md)
- [Core Concepts](/docs/concepts/core-concepts.md)
- [Pricing](/docs/pricing.md)
- [Benchmarks](/docs/benchmarks.md)
- [Examples](/docs/guides/examples.md)
- [Troubleshooting](/docs/troubleshooting.md)

### SDK

- [Installation Auth](/docs/sdk/installation-auth.md)
- [Logging](/docs/sdk/logging.md)
- [Tracing](/docs/sdk/tracing.md)
- [Metrics Steps](/docs/sdk/metrics-steps.md)
- [Config Tags Notes](/docs/sdk/config-tags-notes.md)
- [Artifacts Checkpoints](/docs/sdk/artifacts-checkpoints.md)
- [Rich Objects](/docs/sdk/rich-objects.md)
- [Distributed Training](/docs/sdk/distributed-training.md)
- [Console System Integrations](/docs/sdk/console-system-integrations.md)
- [Reliability](/docs/sdk/reliability.md)
- [Cli Login](/docs/sdk/cli-login.md)
- [Querying Data](/docs/sdk/querying-data.md)
- [Agent Mcp](/docs/sdk/agent-mcp.md)
- [Examples Patterns](/docs/sdk/examples-patterns.md)

### Integrations

- [Overview](/docs/integrations/overview.md)
- [Pytorch Lightning](/docs/integrations/pytorch-lightning.md)
- [Huggingface Transformers](/docs/integrations/huggingface-transformers.md)
- [Keras](/docs/integrations/keras.md)
- [Wandb](/docs/integrations/wandb.md)

### Dashboard

- [Tour](/docs/dashboard/tour.md)
- [Organizations Workspaces](/docs/dashboard/organizations-workspaces.md)
- [Runs Workspace](/docs/dashboard/runs-workspace.md)
- [Metrics Charts](/docs/dashboard/metrics-charts.md)
- [Run Detail](/docs/dashboard/run-detail.md)
- [Traces](/docs/dashboard/traces.md)
- [Compare Runs](/docs/dashboard/compare-runs.md)
- [Research Dashboards](/docs/dashboard/research-dashboards.md)
- [Artifacts Files](/docs/dashboard/artifacts-files.md)
- [Run Health](/docs/dashboard/alerts.md)
- [Datasets](/docs/dashboard/datasets.md)
- [Checkpoints](/docs/dashboard/checkpoints.md)
- [Reports](/docs/dashboard/reports.md)
- [Settings Api Keys](/docs/dashboard/settings-api-keys.md)
- [Api Tab](/docs/dashboard/api-tab.md)
- [Onboarding Team Billing](/docs/dashboard/onboarding-team-billing.md)

### Data

- [Imports](/docs/guides/imports.md)
- [W&B alternative](/docs/guides/wandb-alternative.md)
- [InstantML vs MLflow](/docs/guides/instantml-vs-mlflow.md)
- [W&B import guide](/docs/guides/wandb-import-guide.md)
- [W&B and Neptune imports](/docs/guides/wandb-neptune-imports.md)
- [Export Usage Limits](/docs/guides/export-usage-limits.md)
- [Pricing Limits Billing](/docs/guides/pricing-limits-billing.md)
- [Auth Billing Storage](/docs/guides/auth-billing-storage.md)
- [Customer Owned Clickhouse](/docs/guides/customer-owned-clickhouse.md)
- [Observability](/docs/guides/observability.md)

### API

**Practical API guides**

- [Authentication](/docs/api/authentication.md)
- [Errors And Limits](/docs/api/errors-and-limits.md)
- [Health Observability](/docs/api/health-observability.md)
- [Projects Runs](/docs/api/projects-runs.md)
- [Metrics Series](/docs/api/metrics-series.md)
- [Attributes Objects](/docs/api/attributes-objects.md)
- [Artifacts](/docs/api/artifacts.md)
- [Reports](/docs/api/reports.md)
- [Iframe Embeds](/docs/api/iframe-embeds.md)
- [Import Export Usage](/docs/api/import-export-usage.md)
- [Dashboard Control State](/docs/api/dashboard-control-state.md)
**Architecture**

- [System Overview](/docs/architecture/system-overview.md)
- [Service Planes](/docs/architecture/service-planes.md) (current page)
- [Storage Model](/docs/architecture/storage-model.md)
- [Google Clickhouse](/docs/architecture/google-clickhouse.md)
- [Auth Tenancy](/docs/architecture/auth-tenancy.md)
- [Schema Reference](/docs/architecture/schema-reference.md)

### API Reference

- [API Reference](/docs/api-reference.md)
