Skip to main content
Version: main 🚧

Platform External Database

info
This feature is available from the Platform version v4.8.0

What is an external database deployment?​

An external database deployment runs multiple vCluster Platform replicas in a single Kubernetes cluster, all backed by an external database through Kine, which provides an etcd-compatible API backed by relational databases. Leader election ensures that only one replica writes to the database at a time, while the remaining replicas serve read traffic and stand ready to take over if the leader fails. This eliminates the platform as a single point of failure within the region.

Why deploy with an external database?​

The default single-replica platform deployment works for most environments. Consider an external database deployment when you need one or more of the following:

  • Control plane resilience: If the platform pod or its node goes down, another replica takes over leadership automatically. Connected clusters continue operating through the surviving replicas.
  • Strict RBAC environments: Run the platform on a host cluster with limited permissions, similar to Least Privilege Mode for agents. An external database lets the platform replicas use a shared backend without requiring broad cluster-level access.
  • Protection against node failures: Spreading replicas across nodes (using pod anti-affinity or topology spread constraints) ensures that a single node failure does not take down the platform.

How it differs from other deployment modes​

External databaseMulti-region platformRegional Cluster Endpoints
What is replicatedMultiple platform replicas in a single clusterThe platform itself (full replicas in each region)Only the agent endpoints (platform stays in one region)
Shared databaseYes — all replicas share a single Kine-backed databaseYes — all regions share a single Kine-backed databaseNo — single platform database
FailoverAutomatic via leader election within the clusterAutomatic via DNS health checksNo platform failover
Use casePlatform HA within a single regionPlatform HA, low-latency platform API accessLow-latency kubectl access to clusters

Trade-offs​

  • External database operations: An external database deployment requires provisioning and managing a database (RDS or equivalent), adding operational overhead compared to the default embedded PostgreSQL.
  • Cost control unavailable: The cost control feature requires the embedded single-region database and is not compatible with the external Kine backend.
warning

Converting an existing single-replica platform installation to an external database deployment is not supported. An external database deployment must be configured as a fresh installation following the steps below.