Streaming

rpk k8s multicluster bundle

Collect environment data from each Kubernetes cluster in a Stretch Cluster deployment and package it into a ZIP file for support. This is the operator-side counterpart to rpk debug bundle, which collects data from the Redpanda brokers themselves.

By default, only one Kubernetes context is required. The bundle command discovers peer clusters from labelled cache Secrets stored by the operator’s raft-bootstrap flow on the starting cluster, so the tool stays useful when one of the peer clusters is down. Pass multiple --context flags to bypass discovery and diagnose exactly that set.

Usage

rpk k8s multicluster bundle [flags]

Examples

This section provides examples of how to use rpk k8s multicluster bundle.

Use a single context and discover peers from the starting cluster:

rpk k8s multicluster bundle --kubeconfig /path/to/kubeconfig

Start from a specific cluster in the default kubeconfig:

rpk k8s multicluster bundle --context cluster-a

Bypass discovery and bundle the listed clusters directly:

rpk k8s multicluster bundle --context cluster-a --context cluster-b --context cluster-c

Write the bundle to a specific path:

rpk k8s multicluster bundle --context cluster-a -o /tmp/operator-bundle.zip

Flags

Value Type Description

--context

strings

Kubernetes contexts. Repeatable. If omitted with --kubeconfig, all contexts in the file are used.

--include-private-keys

bool

Include TLS private keys and cached peer kubeconfigs in serialised Secrets. Off by default.

--kubeconfig

string

Path to a kubeconfig file (all contexts in the file are used unless --context is also specified).

--logs-size-limit

string

Per-container log byte cap (human-readable, for example, "5M", "10MiB", "1G"; "0" disables the cap) (default "5M").

--logs-tail-lines

int

Per-container log tail-line cap (0 disables the cap) (default 5000).

--metrics-interval

duration

Interval between successive /metrics samples (for example, 10s, 1m). Must be > 0. (default 10s).

--metrics-samples

int

Number of /metrics samples taken per cluster (>= 2). Lets investigators compute counter rates post-hoc. (default 2).

--name-override

stringArray

Override the TLS secret prefix for a context, in context=prefix format. Defaults to the context name. Repeatable.

--namespace

string

Namespace for operator resources (default redpanda).

-o, --output

string

Output mode. Empty (the default) applies resources to clusters. yaml emits manifests for GitOps and makes no cluster calls.

--service-name

string

Operator deployment label selector value (app.kubernetes.io/name) (default operator).

--skip-logs

bool

Skip operator pod log collection.

--skip-metrics

bool

Skip operator /metrics scrape.

-v, --verbose

bool

Print per-step progress to stderr (use to diagnose slow runs / hangs).

Global flags

Value Type Description

--config

string

Redpanda or rpk config file; default search paths are ~/Library/Application Support/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

-X, --config-opt

stringArray

Override rpk configuration settings; -X help for detail or -X list for terser detail.

--ignore-profile

bool

Ignore rpk.yaml and redpanda.yaml; use default settings.

--profile

string

rpk profile to use.

-v, --verbose

bool

Enable verbose logging.