cockroachdb / cockroachdb/helm-charts

Include Deprecation Notice

Open
#230 1 comment 8 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
105
Forks
152
Avg merge
4d 23h
Merged PRs (30d)
5

Description

I started using this Helm chart before realizing that it's deprecated according to the [documentation](https://www.cockroachlabs.com/docs/stable/deploy-cockroachdb-with-kubernetes.html?filters=helm#step-2-start-cockroachdb):

> **Warning:**
> The CockroachDB Helm chart is compatible with Kubernetes versions 1.22 and earlier (the latest version as of this writing). However, no new feature development is currently planned. If you are experiencing issues with a Helm deployment on production, contact our [Support team](https://support.cockroachlabs.com/).

There should be a notice on this repository too so that people know to switch to the Operator for any new projects.

Jira issue: HELM-27

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the repository documentation for the Helm chart and compare its guidance with the linked CockroachDB documentation. Add a deprecation notice that directs new projects to the Operator, then verify that the notice is visible to users reviewing this repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.