redpanda-data / redpanda-data/redpanda-operator

rpk: provide alternative to ClusterRoleBinding for `rpk debug bundle` in k8s environments

Open
#714 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
84
Forks
32
Avg merge
1d 19h
Merged PRs (30d)
104

Description

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

Currently, rpk relies on having a ClusterRole to collect the information needed for the debug bundle, see:

https://docs.redpanda.com/current/manage/kubernetes/troubleshooting/k-diagnostics-bundle/#generate-a-diagnostics-bundle

This is done to:

  1. Discover the admin API addresses of the cluster, currently, there is no way to do that. (See https://github.com/redpanda-data/redpanda/issues/8975).
  2. Collect the Logs of every pod in the cluster, this saves time in large clusters since the user only has to create one bundle instead of n-bundles.
  3. Collect k8s resources in the Redpanda namespace, for debugging.
Alternatives discussed:

This issue is to track the discussion, but the alternatives discussed are:

  • Use kubeconfig to authenticate, the bundle would have to be fired off from the debugger's machine, read the kubeconfig, and authenticate. This will allow collection of the Logs and Resources, but it has its limitations regarding the Admin API calls.
  • Use RoleBinding, so it stays in the namespace.

JIRA Link: CORE-2649

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 with the rpk debug bundle entry point and the linked Kubernetes diagnostics-bundle documentation to understand the current ClusterRole requirements. Compare the kubeconfig and namespace-scoped RoleBinding alternatives, including their stated limitations, and clarify which approach should preserve the required log, resource, and Admin API collection before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, kubernetes
Domain
cli, infrastructure
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.