Skip to content

Conversation

@amotl
Copy link
Member

@amotl amotl commented Oct 30, 2025

About

@matriv discovered that when using Docker on Windows/PowerShell, users must quote -C parameters.

The workaround for Docker is to include each setting in single
quotes, like '-Cdiscovery.type=single-node'.

docker run --rm --publish=4200:4200 --publish=5432:5432 docker.io/crate '-Cdiscovery.type=single-node'

References

/cc @karynzv, @surister, @seut, @michaelkremmel, @grbade

@amotl amotl added the maintenance C'est la vie. label Oct 30, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 30, 2025

Walkthrough

Documentation files across multiple guides now consistently quote the -Cdiscovery.type=single-node argument in Docker commands. The change ensures consistent shell argument parsing by wrapping the option in single quotes across ten documentation files.

Changes

Cohort / File(s) Summary
Admin documentation
docs/admin/clustering/logical-replication-setup.md, docs/admin/troubleshooting/jcmd/docker.md
Wrapped -Cdiscovery.type=single-node argument in single quotes in Docker run commands and jcmd invocation output.
Feature documentation
docs/feature/search/fts/analyzer.md
Wrapped -Cdiscovery.type=single-node argument in single quotes in Docker run command.
Integration guides
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
Wrapped -Cdiscovery.type=single-node argument in single quotes in Docker run commands across all integration documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

This is a highly homogeneous, repetitive formatting change applied consistently across documentation files with no logic or control-flow modifications. All edits follow the identical pattern of shell quoting.

Possibly related PRs

Suggested reviewers

  • matriv
  • seut

Poem

🐰 Shell quoting hops with care,
Each argument stands proud and fair,
Quotes wrap the flags so fine,
Single-node discovery divine,
Ten docs now unified with flair!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title "Sweep: Fix Docker invocation on Windows/PowerShell" accurately reflects the main objective of the changeset. The word "Sweep" indicates a bulk update across multiple files, which aligns with the systematic quoting of -Cdiscovery.type=single-node arguments across 10 documentation files. The title clearly identifies the primary change: fixing Docker invocation issues on Windows/PowerShell by properly quoting the discovery type parameter, which directly matches the raw_summary showing quoting changes in all modified files.
Description Check ✅ Passed The pull request description clearly relates to the changeset. The author explains that the PR addresses a Windows/PowerShell issue where -C parameters must be quoted, provides a concrete example of the fix ('-Cdiscovery.type=single-node'), and includes relevant references. The raw summary confirms that all changed files involve wrapping the -Cdiscovery.type=single-node argument in single quotes across multiple documentation files, which directly aligns with the described solution. The description is neither vague nor off-topic, and it conveys meaningful information about the intent behind the changes.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch shell-fix-discoery-type

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

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

> The workaround for Docker is to include each setting in single
> quotes, like `'-Cdiscovery.type=single-node'`.

Otherwise, users will receive an error like this:

  NullPointerException: Cannot invoke "String.isEmpty()"
@amotl amotl force-pushed the shell-fix-discoery-type branch from 1e1967e to 85620a3 Compare October 30, 2025 04:36
@amotl amotl changed the title CrateDB OCI: Use '-Cdiscovery.type=single-node' to fix start on Windows Sweep: Fix Docker invocation on Windows/PowerShell Oct 30, 2025
@amotl amotl requested review from hammerhead and matriv October 30, 2025 04:40
@amotl amotl added the sanding-1200 Fine sanding. label Oct 30, 2025
Copy link
Contributor

@matriv matriv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx!

@amotl amotl merged commit f6a6b51 into main Oct 30, 2025
2 of 3 checks passed
@amotl amotl deleted the shell-fix-discoery-type branch October 30, 2025 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance C'est la vie. sanding-1200 Fine sanding.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Windows: CrateDB fails to start on Docker for Windows with -Cdiscovery.type=single-node

3 participants