Streaming

rpk generate

Generate a configuration template for related services.

Usage

rpk generate [template] [flags]

Subcommands

Command Description

rpk generate app

Generate a sample application to connect with Redpanda. This command generates a starter application to produce and consume from the settings defined in the rpk profile.

rpk generate grafana-dashboard

Generate Grafana Dashboards for Redpanda Metrics. Use this command to generate sample Grafana dashboards for Redpanda metrics.

rpk generate license

Generate a trial license. This command generates a license for a 30-day trial of Redpanda Enterprise Edition.

rpk generate prometheus-config

Generate the Prometheus configuration to scrape Redpanda nodes. The output of this command should be included in the scrape_configs array within the YAML configuration file of your Prometheus instance.

rpk generate shell-completion

Shell completion can help autocomplete rpk commands when you press tab. BASH.

Global flags

Value Type Description

--config

string

Redpanda or rpk config file; default search paths are ~/.config/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.