Streaming

rpk redpanda start

Start redpanda.

This command is only available on Linux.

Set up a mode

Redpanda supports a dev-container mode with preset configuration for development and test environments.

Run the following command to start Redpanda in dev-container mode:

rpk redpanda start --mode dev-container

This mode bundles the following flags and cluster properties:

Bundled flags:

Bundled cluster properties:

  • write_caching_default: true

  • auto_create_topics_enabled: true

  • group_topic_partitions: 3

  • storage_min_free_bytes: 10485760 (10MiB)

  • topic_partitions_per_shard: 1000

  • fetch_reads_debounce_timeout: 10

After Redpanda starts, you can modify cluster properties by running:

rpk config set <key> <value>

Environment variables

The rpk redpanda start command reads the following environment variables as defaults for broker configuration, which is useful in containerized deployments. Equivalent command-line flags take precedence. Although these variables use the REDPANDA_ prefix, they are read by rpk when it starts the broker, not by the broker process itself.

Variable Description Accepted values

REDPANDA_SEEDS

Seed servers for cluster discovery. Equivalent to the --seeds flag.

Comma-separated list of host:port pairs

REDPANDA_KAFKA_ADDRESS

Kafka API listener address. Equivalent to the --kafka-addr flag.

[name://]host:port

REDPANDA_PANDAPROXY_ADDRESS

HTTP Proxy listener address. Equivalent to the --pandaproxy-addr flag.

[name://]host:port

REDPANDA_SCHEMA_REGISTRY_ADDRESS

Schema Registry listener address. Equivalent to the --schema-registry-addr flag.

[name://]host:port

REDPANDA_RPC_ADDRESS

RPC server listener address. Equivalent to the --rpc-addr flag.

host:port

REDPANDA_ADVERTISE_KAFKA_ADDRESS

Advertised Kafka API address. Equivalent to the --advertise-kafka-addr flag.

[name://]host:port

REDPANDA_ADVERTISE_PANDAPROXY_ADDRESS

Advertised HTTP Proxy address. Equivalent to the --advertise-pandaproxy-addr flag.

[name://]host:port

REDPANDA_ADVERTISE_RPC_ADDRESS

Advertised RPC address. Equivalent to the --advertise-rpc-addr flag.

host:port

For all environment variables that the Redpanda broker and rpk read, see Environment Variables.

Usage

rpk redpanda start [flags]

Flags

Value Type Description

--advertise-kafka-addr

stringSlice

A comma-separated list of Kafka addresses to advertise (scheme://host:port|name).

--advertise-pandaproxy-addr

stringSlice

A comma-separated list of Pandaproxy addresses to advertise (scheme://host:port|name).

--advertise-rpc-addr

string

The advertised RPC address (host:port).

--check

bool

When set to false will disable system checking before starting redpanda.

--install-dir

string

Directory where Redpanda has been installed.

--kafka-addr

stringSlice

A comma-separated list of Kafka listener addresses to bind to (scheme://host:port|name).

--mode

string

Mode sets well-known configuration properties for development or test environments; use --mode help for more info.

--node-tuner-state-path

string

Alternative path to read the node tuner state file from (if exists).

--pandaproxy-addr

stringSlice

A comma-separated list of Pandaproxy listener addresses to bind to (scheme://host:port|name).

--rpc-addr

string

The RPC address to bind to (host:port).

--schema-registry-addr

stringSlice

A comma-separated list of Schema Registry listener addresses to bind to (scheme://host:port|name).

-s, --seeds

stringSlice

A comma-separated list of seed nodes to connect to (scheme://host:port|name).

--timeout

duration

The maximum time to wait for the checks and tune processes to complete (for example, 300ms, 1.5s, 2h45m).

--tune

bool

When present will enable tuning before starting redpanda.

--well-known-io

string

The cloud provider and VM type, in the format <provider>:<vm type>:<storage type>.

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.