stackabletech / stackabletech/hive-operator

CRD update process for new version of the Operators

Open
#273 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/documentation customer-request
Dominant language
Rust
Stars
29
Forks
2
Avg merge
1d 19h
Merged PRs (30d)
12

Description

Hey Stackable team

I have encountered the issue which seems to a common one regarding CRDs and how to handle the versioning/updates of them.

As helm seems to taken a defensive stance on the matter, I think it would be good to have sections dedicated to logging changes and instruction on, how to update already existing CRDs in your cluster.

The purpose of these docs would be to reduce the risk of a customer not being aware of the procedure there is around CRD and potentially safeguard them against force updating the CRD. Updating the CRDs without the proper procedure could result in objects being wiped as a side effect.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing documentation for CRDs, Helm deployments, and operator version upgrades; the issue does not name specific files or tests. Document how CRD changes should be logged and how existing CRDs should be updated safely without force-updating them. Done means customers can find a clear, version-aware procedure and understand the risk of data loss.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
devops, documentation, infrastructure
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.