Skip to content

fix(DOC-1675): document --overprovisioned flag and improve rpk redpanda start prose #1618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mfernest wants to merge 8 commits into
base: main
Choose a base branch
from
Open

fix(DOC-1675): document --overprovisioned flag and improve rpk redpanda start prose #1618

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7699ad9
fix(DOC-1675): document --overprovisioned flag and improve rpk redpan…
mfernest Mar 18, 2026
641895b
style(DOC-1675): remove \"You can\" and redundant phrasing in dev-con…
mfernest Mar 24, 2026
11abba0
Merge branch 'main' into fix/doc-1675-overprovisioned-flag
mfernest Mar 24, 2026
058eac2
style(DOC-1675): apply Michele style tweaks to rpk-redpanda-start prose
mfernest Mar 24, 2026
9059e63
fix(DOC-1675): remove --overprovisioned from flags table; xref mode page
mfernest Mar 24, 2026
a3fe122
style(DOC-1675): apply style guide fixes to rpk-redpanda-start prose
mfernest Mar 24, 2026
66aab3c
Merge remote-tracking branch 'origin/main' into fix/doc-1675-overprov…
mfernest Mar 26, 2026
5218dd5
fix(DOC-1675): restore auto-gen flags table to main; keep manual zone…
mfernest Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,18 @@ include::reference:partial$unsupported-os-rpk.adoc[]

Start Redpanda.

== Setting up a mode
== Set up a mode

It's possible to setup a mode for redpanda to start. Currently we support the mode `dev-container`.
Redpanda supports a `dev-container` mode with preset configuration for development and test environments.

To set up the mode `dev-container` run:
To set up the `dev-container` mode, run:

[,bash]
----
rpk redpanda start --mode dev-container
----

Mode uses well-known configuration properties for development or tests
environments:
This mode bundles the following flags and cluster properties:

Bundled flags:

Expand All @@ -35,7 +34,7 @@ Bundled cluster properties:
* `topic_partitions_per_shard: 1000`
* `fetch_reads_debounce_timeout: 10`

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

[,bash]
----
Expand Down Expand Up @@ -78,7 +77,7 @@ Pandaproxy addresses to advertise.
<host>:<port>
----

|--check |- |When set to `false`, will disable system checking before
|--check |- |When set to `false`, disables system checking before
starting `redpanda` (default `true`).

|-h, --help |- |Help for start.
Expand All @@ -98,6 +97,8 @@ 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).

|--overprovisioned |- |Disables thread affinity (CPU pinning) to allow fairer CPU distribution among all processes. Do not use in production environments. Set automatically by `--mode dev-container`.

|--pandaproxy-addr |strings |A comma-separated list of Pandaproxy
listener addresses to bind to.

Expand Down Expand Up @@ -131,11 +132,11 @@ to.

|--timeout |duration |The maximum time to wait for the checks and tune
processes to complete. The value passed is a sequence of decimal
numbers, each with optional fraction and a unit suffix, such as
numbers, each with an optional fraction and a unit suffix, such as
`300ms`, `1.5s` or `2h45m`. Valid time units are `ns`, `us`
(or `µs`), `ms`, `s`, `m`, `h` (default 10s).

|--tune |- |When present will enable tuning before starting `redpanda`.
|--tune |- |Enables tuning before starting `redpanda`.

|--well-known-io |string |The cloud vendor and VM type, in the format

Expand All @@ -144,9 +145,9 @@ numbers, each with optional fraction and a unit suffix, such as
<vendor>:<vm-type>:<storage-type>
----

|--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.
|--config |string |Path to the Redpanda or `rpk` configuration file. If not specified, `rpk` searches `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.

|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail.
|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terse detail.

|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.

Expand Down
Loading