Usage guides: Use {Docker,Podman} Compose where applicable

[amotl]

About

By using {Docker,Podman} Compose, a significant amount of code and configuration noise can be reduced on the prose document, but maintained within a compose.yaml file instead. It aims to improve usability and might also open the door for automated testing within a reasonable range of efforts.

References

• Windows: CrateDB fails to start on Docker for Windows with -Cdiscovery.type=single-node #325
• Windows: Broken line continuation in command-line examples for PowerShell #326
• Mosquitto: Tutorial uses wrong hostname #327
• Mosquitto: Problem running crash #328
• Mosquitto: Improve prerequisites #329
• Windows: Using WSL #331
• Automate the testing of tutorials to ensure cross-platform compatibility crate-docs#8

[coderabbitai]

Walkthrough

Refactors many integration docs to use Docker/Podman Compose: adds/updates compose.yaml files, rewrites usage guides to a compose-centric workflow, normalizes examples (CRATE_HEAP_SIZE=1g), removes explicit single-node flags, and adds small CLI/tool services and helper volumes where needed.

Changes

Cohort / File(s)	Change summary
Compose: new or updated stacks 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/oracle/compose.yaml, docs/integrate/postgresql/compose.yaml, docs/integrate/statsd/compose.yaml, docs/integrate/telegraf/compose.yaml, docs/integrate/opentelemetry/.../compose.yaml	Added or updated Docker/Podman Compose stacks: cratedb with ports+HTTP healthcheck, integration brokers/databases, CLI/tool services (often profiles: ["cli"]), and some added volumes (e.g., uv-cache).
Usage guides → Compose workflow docs/integrate/amqp/usage.md, docs/integrate/collectd/usage-collectd.md, docs/integrate/collectd/usage-telegraf.md, docs/integrate/influxdb/usage.md, docs/integrate/mongodb/usage.md, docs/integrate/mqtt/usage.md, docs/integrate/mysql/usage.md, docs/integrate/oracle/usage.md, docs/integrate/postgresql/usage.md, docs/integrate/statsd/usage.md, docs/integrate/telegraf/usage.md, docs/integrate/opentelemetry/.../usage.md	Replaced per-OS/docker-run instructions with Files/Services/Submit data/Explore data flow using docker compose / podman compose (up/run/exec). Added Podman notes and standardized example table/namespace names (e.g., doc.*_demo).
Auxiliary tooling & envs docs/integrate/opentelemetry/collector/compose.yaml, docs/integrate/opentelemetry/telegraf/compose.yaml, docs/integrate/opentelemetry/collector/.env, docs/integrate/opentelemetry/telegraf/.env, docs/integrate/amqp/compose.yaml, docs/integrate/mqtt/compose.yaml	Introduced auxiliary CLI/tool services (nc, uv, amqpcat, lorrystream, ctk*), added uv-cache volume, and set OTEL env vars (OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_SERVICE_NAME).
Telegraf config & collectd snippets docs/integrate/telegraf/telegraf.conf, docs/integrate/collectd/telegraf.conf, docs/integrate/collectd/collectd-*.conf	Added Telegraf configurations (CPU input, agent defaults, CrateDB output) and collectd-related config snippets; some files gained doc header comments.
Heap size & run flags normalization docs/install/container/docker.rst, docs/admin/troubleshooting/jcmd/docker.md, docs/feature/search/fts/analyzer.md, various docs/integrate/*/*	Changed example CRATE_HEAP_SIZE from 2g → 1g, removed -Cdiscovery.type=single-node in many examples, and simplified/compacted docker run examples.
Formatting / command compaction / minor edits docs/integrate/kafka/docker-python.md, docs/integrate/influxdb/cloud.md, docs/integrate/mongodb/cloud.md, docs/integrate/kafka/index.md, docs/integrate/airflow/getting-started.md, select other pages	Consolidated multi-line commands into single-line forms, minor wording/whitespace fixes, added documentation header links in several files, and small presentation tweaks across integration docs.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant User
  participant Compose as "Docker/Podman Compose"
  participant CrateDB
  participant Broker as "Integration Broker/DB"
  participant Tool as "CLI/Tool (ctk/amqpcat/nc/uv)"

  User->>Compose: docker compose up
  Compose->>CrateDB: start cratedb (HTTP healthcheck)
  Compose->>Broker: start broker/db (depends_on)
  Note over CrateDB,Broker: services wait on cratedb healthcheck

  User->>Compose: docker compose run --rm Tool submit
  Tool->>Broker: produce/ingest data
  Broker->>CrateDB: forward/write data
  User->>Compose: docker compose exec cratedb psql / query
  CrateDB-->>User: query results

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• Integrate/AMQP: Add entry point page, micro tutorial, and category item #248 — overlaps AMQP compose/usage edits touching the same AMQP docs.
• collectd: Index page and two usage guides #330 — related to collectd integration compose/usage changes and files.
• OpenTelemetry: Index page. Usage guides about OTel Collector and Telegraf. #334 — related OpenTelemetry additions (nc/uv services, uv-cache, .env changes).

Suggested labels

refactoring

Suggested reviewers

• bmunkholm
• kneth
• karynzv
• surister

Poem

I hopped through stacks with a cheerful thump,
Compose files lined up in one tidy clump.
One gig of heap, services spin and meet,
Brokers hum, metrics dance to the beat.
A carrot-squeak cheer — docs polished and neat! 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly describes the main change of using Docker and Podman Compose in usage guides and omits unnecessary details, accurately reflecting the PR’s focus on consolidating configuration into compose.yaml files.
Description Check	✅ Passed	The description clearly outlines the motivation for the changes, explaining the benefits of using Docker and Podman Compose to reduce documentation noise while maintaining usability, and it references relevant issues, demonstrating that it stays on topic with the changeset.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ 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 more-docker-compose

---

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.}

[amotl]

psql psql reads like a typo to some. Maybe let's rename the first fragment (Docker Compose service name), which is at our disposal?

[amotl]

Fixed with 6e258d9.

[amotl]

Dito.

[amotl]

Fixed with 6e258d9.

[amotl]

Dito.

[amotl]

Fixed with 6e258d9.

[amotl]

Does it make sense to add a reference URL to the very documentation slot? Relevant are the compose.yaml files and any other configuration files.

[amotl]

Fixed with 1d14227.