OT-CONTAINER-KIT/redis-operator

Add Documentation Regarding Legacy PVC Naming

Open

#1,365 opened on May 21, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (377 forks)auto 404
documentationhelp wanted

Repository metrics

Stars
 (1,416 stars)
PR merge metrics
 (PR metrics pending)

Description

Which document needs to be updated? The Upgrading docs and/or the example values.yaml file for the Redis Operator

Expected changes Add documentation regarding the OPERATOR_STS_PVC_TEMPLATE_NAME environment variable

What version of redis-operator are you using? redis-operator version: v0.19.1

Additional context We upgraded from a very old version of the redis operator (0.14.0) to v0.19.1. It caused us some production issues when pods were deleted due to the change in the VolumeClaimTemplate naming. We had to go over the code to find the OPERATOR_STS_PVC_TEMPLATE_NAME variable in order to not delete our PVCs while upgrading.

It would help to make this variable "Official" in the docs, or add some other way to configure the name.

Thank you in advance 😃

Contributor guide

Research direction
Identify the documentation files that mention PVC naming and add a section about the OPERATOR STS PVC TEMPLATE NAME environment variable. Also update the example values.yaml if necessary.
Tech stack
go
Domain
backenddevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90