This repository contains Helm charts for deploying CockroachDB, the open-source, cloud-native distributed SQL database.
You can install CockroachDB using two approaches, depending on your requirements:
The traditional chart that deploys CockroachDB in StatefulSet mode.
This is a direct installation method for running CockroachDB clusters.
➡️ See the cockroachdb-legacy/README.md for detailed installation instructions.
The new recommended way of installing CockroachDB using the CockroachDB Operator.
Install the Operator and CockroachDB charts as two separate Helm releases, in that order.
Direct installation of the umbrella chart is unsupported, including for local testing.
➡️ See the cockroachdb-operator/charts/operator/README.md for details on installing the Operator. ➡️ See the cockroachdb-operator/charts/cockroachdb/README.md for details on installing cockroachdb. ➡️ See VERSIONING.md for operator-managed chart versions, upgrade order, and published chart locations.
-
Self-Signer
- Information about certificate management with self-signer can be found here.
-
Cert-manager
- Information about certificate management with cert-manager can be found here.
There are two common migration paths:
-
From the public operator → CockroachDB Operator
- Automatic (recommended): docs/migration/operator/controller_migration.md
- Manual: docs/migration/operator/manual_migration.md
-
From a StatefulSet deployment → CockroachDB Operator
- Automatic (recommended): docs/migration/helm/controller_migration.md
- Manual: docs/migration/helm/manual_migration.md