redpanda-data / redpanda-data/redpanda

Update `NEEDS-RESTART` value when `redpanda.yaml` updates are detected

Open
#14,477 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/enhance
Dominant language
C++
Stars
12.6k
Forks
792
PR merge metrics
No merged PRs in 30d

Description

Who is this for and what problem do they have today?

Users deploying with the helm chart are frequently surprised at the value of external advertised listeners and want to change this value. Today there is no way to do this without uninstalling and redeploying.

But this would require NEEDS-RESTART to take into account appropriate changes to redpanda.yaml (mainly redpanda.advertised_kafka_api).

What are the success criteria?

NEEDS-RESTART would get updated to true when a change to redpanda.advertised_kafka_api in redpanda.yaml is detected.

Why is solving this problem impactful?

The helm chart needs a way to determine if brokers need a restart, and one of the best ways to do this is by reading the value of NEEDS-RESTART in the output of rpk cluster config status.

Additional notes

Related helm issue: https://github.com/redpanda-data/helm-charts/issues/595

JIRA Link: CORE-1535

Contributor guide

Open the contributing guide

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 tracing the redpanda.yaml configuration handling and the output of rpk cluster config status, focusing on changes to redpanda.advertised_kafka_api. Review the related Helm issue for deployment context. Done means NEEDS-RESTART becomes true when that configuration changes and the behavior is covered by the relevant existing tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, helm, kubernetes
Domain
backend, devops
Issue type
Feature
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.