Usage guides: Restore -Cdiscovery.type=single-node

[amotl]

About

It was a bad idea to remove -Cdiscovery.type=single-node because CrateDB will easily hit system limits on Docker/Linux systems, like:

max virtual memory areas vm.max_map_count [65530] is too low,
increase to at least [262144]

Evaluation

This reverts commit cba2c1e. Only if this doesn't work on Windows, it is the better option to keep it.

Backlog

Please have a look to satisfy Windows users. They are still the major share of seat users by far, and most of them are naturally using Docker Desktop for Windows all day.

• CrateDB fails to start on Windows with -Cdiscovery.type=single-node crate#18378

[coderabbitai]

Walkthrough

Updated documentation and Docker Compose examples to start CrateDB with the command-line flag -Cdiscovery.type=single-node. Changes are limited to startup commands in multiple Markdown guides and compose files; no other behavior or APIs were altered.

Changes

Cohort / File(s)	Summary of Changes
Docs: docker run snippets docs/feature/search/fts/analyzer.md, docs/integrate/airflow/import-stock-market-data.md, docs/integrate/debezium/tutorial.md, docs/integrate/marquez/usage.md, docs/integrate/risingwave/apache-iceberg.md, docs/integrate/rsyslog/usage.md, docs/integrate/superset/sandbox.md, docs/integrate/superset/usage.md	Updated docker run examples to append -Cdiscovery.type=single-node to the CrateDB startup command.
Docker Compose: cratedb service command docs/integrate/amqp/compose.yaml, docs/integrate/collectd/compose.yaml, docs/integrate/influxdb/compose.yaml, docs/integrate/mongodb/compose.yaml, docs/integrate/mqtt/compose.yaml, docs/integrate/mysql/compose.yaml, docs/integrate/opentelemetry/collector/compose.yaml, docs/integrate/opentelemetry/telegraf/compose.yaml, docs/integrate/oracle/compose.yaml, docs/integrate/postgresql/compose.yaml, docs/integrate/statsd/compose.yaml, docs/integrate/telegraf/compose.yaml	Added or set command for the cratedb service to crate -Cdiscovery.type=single-node (multiline YAML where applicable); no other services or settings changed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Superset: Usage guides #282 — Edits to Superset integration docs that also modify CrateDB startup commands.
• Usage guides: Use {Docker,Podman} Compose where applicable #367 — Similar updates changing CrateDB container startup flags in docs/compose files.

Suggested labels

maintenance, guidance

Poem

I nibble docs and tweak a flag,
One node now, no cluster lag.
Docker wakes, the crate boots fine,
YAML carrots line the line.
A happy hop — single-node time! 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly reflects the PR’s primary change of restoring the -Cdiscovery.type=single-node flag in usage guides. It clearly indicates the context and the specific action without unnecessary detail. A teammate scanning history can easily understand what was changed. This alignment with the changeset indicates the title is appropriate.
Description Check	✅ Passed	The description explains why the flag was restored, references the original commit being reverted, and outlines Windows compatibility considerations. It directly addresses the rationale behind the documentation changes and relates to the modifications across multiple files. The level of detail is adequate for understanding the PR’s intent. Therefore, the description is sufficiently on-topic and informative.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch restore-single-node

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 083c01f and dc352de.

📒 Files selected for processing (21)

• docs/feature/search/fts/analyzer.md (1 hunks)
• docs/integrate/airflow/import-stock-market-data.md (1 hunks)
• docs/integrate/amqp/compose.yaml (1 hunks)
• docs/integrate/collectd/compose.yaml (1 hunks)
• docs/integrate/debezium/tutorial.md (1 hunks)
• docs/integrate/influxdb/compose.yaml (1 hunks)
• docs/integrate/marquez/usage.md (1 hunks)
• docs/integrate/mongodb/compose.yaml (1 hunks)
• docs/integrate/mqtt/compose.yaml (1 hunks)
• docs/integrate/mysql/compose.yaml (1 hunks)
• docs/integrate/opentelemetry/collector/compose.yaml (1 hunks)
• docs/integrate/opentelemetry/telegraf/compose.yaml (1 hunks)
• docs/integrate/oracle/compose.yaml (1 hunks)
• docs/integrate/postgresql/compose.yaml (1 hunks)
• docs/integrate/prometheus/usage.md (1 hunks)
• docs/integrate/risingwave/apache-iceberg.md (1 hunks)
• docs/integrate/rsyslog/usage.md (1 hunks)
• docs/integrate/statsd/compose.yaml (1 hunks)
• docs/integrate/superset/sandbox.md (1 hunks)
• docs/integrate/superset/usage.md (1 hunks)
• docs/integrate/telegraf/compose.yaml (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (12)

• docs/integrate/marquez/usage.md
• docs/integrate/oracle/compose.yaml
• docs/integrate/superset/usage.md
• docs/integrate/influxdb/compose.yaml
• docs/integrate/collectd/compose.yaml
• docs/integrate/postgresql/compose.yaml
• docs/integrate/debezium/tutorial.md
• docs/integrate/airflow/import-stock-market-data.md
• docs/integrate/mysql/compose.yaml
• docs/integrate/amqp/compose.yaml
• docs/integrate/opentelemetry/telegraf/compose.yaml
• docs/integrate/superset/sandbox.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[matriv]

Thx, do we explain somewhere that this is needed only for developement/testing and it shouldn't be added in prod deployments?

[amotl]

Thanks. I've diverted your suggestion to GH-390.