README
¶
CockroachDB Helm Charts
This repository contains Helm charts for deploying CockroachDB, the open-source, cloud-native distributed SQL database.
Installation Options
You can install CockroachDB using two approaches, depending on your requirements:
1. cockroachdb-legacy
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.
2. cockroachdb-operator
The new recommended way of installing CockroachDB using the CockroachDB Operator.
This umbrella chart manages both the Operator and the CockroachDB cluster it provisions.
➡️ 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.
Certificates and Security
-
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.
Migration
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
Directories
¶
| Path | Synopsis |
|---|---|
|
migrate
command
|
|
|
cockroachdb-operator
|
|
|
pkg
|
|
|
tests
|
|
|
e2e/operator/infra
Package infra provides AWS infrastructure provisioning and management for e2e operator tests.
|
Package infra provides AWS infrastructure provisioning and management for e2e operator tests. |