Skip to content

Commit 1320ecb

Browse files
committed
Usage guides: Compose: Use different name for service vs. program
When they are identical, they might as a typo to some.
1 parent 563a15d commit 1320ecb

File tree

11 files changed

+12
-21
lines changed

11 files changed

+12
-21
lines changed

docs/integrate/collectd/compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,6 @@ services:
3636
depends_on:
3737
- cratedb
3838

39-
psql:
39+
postgresql:
4040
image: docker.io/postgres:18
4141
profiles: ["cli"]

docs/integrate/collectd/usage-collectd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To send the collected data to CrateDB, collectd is configured to load its
3838

3939
Create a database table that stores collected metrics.
4040
```shell
41-
docker compose run --rm --no-TTY psql psql "postgresql://crate:crate@cratedb:5432/" <<SQL
41+
docker compose run --rm --no-TTY postgresql psql "postgresql://crate:crate@cratedb:5432/" <<SQL
4242
CREATE TABLE doc.collectd_data (
4343
p_time timestamp with time zone,
4444
p_host TEXT,
@@ -59,7 +59,7 @@ SQL
5959
After the first scraping interval, metrics will show up in the
6060
designated table in CrateDB, ready to be inspected.
6161
```shell
62-
docker compose run --rm --no-TTY psql psql "postgresql://crate:crate@cratedb:5432/" -c "SELECT * FROM doc.collectd_data ORDER BY p_time LIMIT 5;"
62+
docker compose run --rm --no-TTY postgresql psql "postgresql://crate:crate@cratedb:5432/" -c "SELECT * FROM doc.collectd_data ORDER BY p_time LIMIT 5;"
6363
```
6464
```psql
6565
p_time | p_host | p_plugin | p_plugin_instance | p_type | p_type_instance | p_value_names | p_type_names | p_values | month

docs/integrate/collectd/usage-telegraf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To send the collected data to Telegraf, collectd is configured to load its
4141
After the first scraping interval, metrics will show up in the
4242
designated table in CrateDB, ready to be inspected.
4343
```shell
44-
docker compose run --rm --no-TTY psql psql "postgresql://crate:crate@cratedb:5432/" -c "SELECT * FROM doc.metrics LIMIT 5;"
44+
docker compose run --rm --no-TTY postgresql psql "postgresql://crate:crate@cratedb:5432/" -c "SELECT * FROM doc.metrics LIMIT 5;"
4545
```
4646
```psql
4747
hash_id | timestamp | name | tags | fields | day

docs/integrate/influxdb/compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ services:
2525
DOCKER_INFLUXDB_INIT_BUCKET: testdrive
2626
DOCKER_INFLUXDB_INIT_ADMIN_TOKEN: token
2727

28-
ctk:
28+
cratedb-toolkit:
2929
image: ghcr.io/crate/cratedb-toolkit:latest
3030
profiles: ["cli"]

docs/integrate/influxdb/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ docker compose exec influxdb influx write --bucket=testdrive --org=example --tok
6767
Invoke the data transfer pipeline, importing data from
6868
InfluxDB bucket/measurement into CrateDB schema/table.
6969
```shell
70-
docker compose run --rm --no-TTY ctk ctk load table "influxdb2://example:token@influxdb:8086/testdrive/demo" --cluster-url="crate://crate@cratedb:4200/doc/influxdb_demo"
70+
docker compose run --rm --no-TTY cratedb-toolkit ctk load table "influxdb2://example:token@influxdb:8086/testdrive/demo" --cluster-url="crate://crate@cratedb:4200/doc/influxdb_demo"
7171
```
7272

7373
## Explore data

docs/integrate/mongodb/compose.yaml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,6 @@ services:
1818
ports:
1919
- "27017:27017/tcp"
2020

21-
ctk:
21+
cratedb-toolkit:
2222
image: ghcr.io/crate/cratedb-toolkit:latest
2323
profiles: ["cli"]
24-
25-
mongosh:
26-
image: docker.io/mongo:latest
27-
command: mongosh
28-
profiles: ["cli"]

docs/integrate/mongodb/usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ docker compose up
3232

3333
Insert a record into a MongoDB collection; you can repeat this step as needed.
3434
```shell
35-
docker compose run --rm --no-TTY mongosh mongosh --host mongodb --db test --eval 'db.demo.insert({"temperature": 42.84, "humidity": 83.1})'
35+
docker compose run --rm --no-TTY mongodb mongosh --host mongodb --db test --eval 'db.demo.insert({"temperature": 42.84, "humidity": 83.1})'
3636
```
3737

3838
Invoke the data transfer pipeline.
3939
```shell
40-
docker compose run --rm --no-TTY ctk ctk load table "mongodb://mongodb/test/demo" --cluster-url="crate://cratedb/doc/mongodb_demo"
40+
docker compose run --rm --no-TTY cratedb-toolkit ctk load table "mongodb://mongodb/test/demo" --cluster-url="crate://cratedb/doc/mongodb_demo"
4141
```
4242

4343
## Explore data

docs/integrate/postgresql/compose.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,6 @@ services:
2222
ports:
2323
- "6432:5432/tcp"
2424

25-
psql:
26-
image: docker.io/postgres:latest
27-
profiles: ["cli"]
28-
2925
ctk-ingest:
3026
image: ghcr.io/crate/cratedb-toolkit-ingest:latest
3127
profiles: ["cli"]

docs/integrate/postgresql/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ authentication/TLS.
4242

4343
Write a few sample records to PostgreSQL.
4444
```shell
45-
docker compose run --rm --no-TTY psql psql "postgresql://postgres:postgres@postgresql:5432/" <<SQL
45+
docker compose run --rm --no-TTY postgresql psql "postgresql://postgres:postgres@postgresql:5432/" <<SQL
4646
CREATE DATABASE test;
4747
\connect test;
4848
CREATE TABLE IF NOT EXISTS demo (id BIGINT, data JSONB);

docs/integrate/statsd/compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ services:
2626
image: docker.io/toolbelt/netcat:2025-08-23
2727
profiles: ["cli"]
2828

29-
psql:
29+
postgresql:
3030
image: docker.io/postgres:18
3131
profiles: ["cli"]

0 commit comments

Comments
 (0)