Skip to content

Commit 3bf2fa3

Browse files
mfernestclaudeFeediver1
authored
fix(DOC-1675): document --overprovisioned flag and improve rpk redpanda start prose (#1618)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com> Co-authored-by: Joyce Fee <joyce@redpanda.com>
1 parent ba1c02f commit 3bf2fa3

1 file changed

Lines changed: 6 additions & 7 deletions

File tree

modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,22 @@ include::reference:partial$unsupported-os-rpk.adoc[]
55

66
Start Redpanda.
77

8-
== Setting up a mode
8+
== Set up a mode
99

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

12-
To set up the mode `dev-container` run:
12+
Run the following command to start Redpanda in `dev-container` mode:
1313

1414
[,bash]
1515
----
1616
rpk redpanda start --mode dev-container
1717
----
1818

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

2221
Bundled flags:
2322

24-
* `--overprovisioned`
23+
* xref:reference:rpk/rpk-redpanda/rpk-redpanda-mode.adoc#development-mode[`--overprovisioned`] (disables thread affinity and other production guards; see xref:reference:rpk/rpk-redpanda/rpk-redpanda-mode.adoc#development-mode[`rpk redpanda mode`] for details)
2524
* `--reserve-memory 0M`
2625
* `--check=false`
2726
* `--unsafe-bypass-fsync`
@@ -35,7 +34,7 @@ Bundled cluster properties:
3534
* `topic_partitions_per_shard: 1000`
3635
* `fetch_reads_debounce_timeout: 10`
3736

38-
After redpanda starts you can modify the cluster properties using:
37+
After Redpanda starts, you can modify cluster properties by running:
3938

4039
[,bash]
4140
----

0 commit comments

Comments
 (0)