The CockroachDB Helm chart provides an easy way to deploy CockroachDB, a distributed SQL database built on a transactional and strongly-consistent key-value store. This chart allows you to manage CockroachDB instances on Kubernetes with customizable resource allocation, persistence, and scaling options.

Add Helm Repository

To install the CockroachDB Helm chart, use the following command:

helm install [RELEASE_NAME]

Replace [RELEASE_NAME] with your desired release name. For example:

To customize configurations, provide a values.yaml file or override values via the command line.

See Helm Install Documentation for more information.


Uninstall Helm Chart

To remove the CockroachDB deployment and all associated Kubernetes resources, use the following command:

helm uninstall [RELEASE_NAME]

For example:

See Helm Uninstall Documentation for additional details.


Configuration

The CockroachDB Helm chart includes several configuration options to tailor the deployment to your needs. Below is a summary of the key configurations:

Input

Type

Description

Default

image

string

Docker image and tag for the Cassandra container.

cockroachdb/cockroach:v25.1.2

resources.requests.memory

string

Minimum memory resources required by the CockroachDB container.

"512Mi"

resources.requests.cpu

string

Minimum CPU resources required by the CockroachDB container.

"100m"

resources.limits.memory

string

Maximum memory resources the CockroachDB container can use.

"512Mi"

resources.limits.cpu

string

Maximum CPU resources the CockroachDB container can use.

"100m"

diskSize

string

Size of the persistent volume for storing CockroachDB data.

"10Gi"

You can override these values in a values.yaml file or via the command line during installation.


Example values.yaml File


To use this configuration, save it to a values.yaml file and apply it during installation:

helm install my-cockroachdb zopdev/cockroachdb -f values.yaml


Features

  • Distributed SQL Database: Deploy a scalable, distributed SQL database with strong consistency guarantees.

  • Persistent Storage: Keep CockroachDB data intact across pod restarts with configurable persistent volumes.

  • Customizable Resource Allocation: Tailor CPU and memory resources to match workload requirements.

  • Version Control: Specify the CockroachDB version to deploy.

  • Multi-Database Support: Configure multiple database services through the services configuration.

  • Easy Deployment: Simplified Helm chart for rapid deployment of CockroachDB in Kubernetes environments.


Contributing

We welcome contributions to improve this Helm chart. Please refer to the CONTRIBUTING.md file for contribution guidelines.


Code of Conduct

To maintain a healthy and collaborative community, please adhere to our Code of Conduct.


License

This project is licensed under the LICENSE. Please review it for terms of use.

Prerequisites

Kubernetes 1.19+

Helm 3+

Build By

Zop.dev

Category

See Helm Install Documentation for more information.

Need Help with This Integration?

We’re here to make setup smooth. Let us know what’s confusing—or which tools you'd like to see integrated next.

Need technical support or have product questions?

Tell us how we can help