Skip to content
Merged
Changes from 1 commit
Commits
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
22 changes: 12 additions & 10 deletions modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +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`.
You can set up a mode for Redpanda to use on start.

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
The mode uses well-known configuration properties for development and test
environments:

Bundled flags:
Expand All @@ -35,7 +35,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, you can modify the cluster properties by running:

[,bash]
----
Expand Down Expand Up @@ -78,7 +78,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 +98,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 +133,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 +146,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