Skip to content

Commit

Permalink
docs: use version variable in v0.7
Browse files Browse the repository at this point in the history
  • Loading branch information
nicecui committed May 16, 2024
1 parent f5d1f07 commit f8dcfe4
Show file tree
Hide file tree
Showing 13 changed files with 39 additions and 43 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,11 @@ Make sure the [Docker](https://www.docker.com/) is already installed. If not, yo
docker run -p 4000-4003:4000-4003 \
-p 4242:4242 -v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb standalone start \
greptime/greptimedb:<%greptimedb-version%> standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003 \
--opentsdb-addr 0.0.0.0:4242
--postgres-addr 0.0.0.0:4003
```

The data will be stored in the `greptimedb/` directory in your current directory.
Expand All @@ -66,12 +65,11 @@ You can:
docker run --security-opt seccomp=unconfined -p 4000-4003:4000-4003 \
-p 4242:4242 -v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb standalone start \
greptime/greptimedb:<%greptimedb-version%> standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003 \
--opentsdb-addr 0.0.0.0:4242
--postgres-addr 0.0.0.0:4003
```

2. Upgrade the Docker version to v23.0.0 or higher;
Expand Down
5 changes: 2 additions & 3 deletions docs/v0.7/en/getting-started/quick-start/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,14 @@ services:
- 3000:3000

greptime:
image: greptime/greptimedb:latest
image: greptime/greptimedb:<%greptimedb-version%>
container_name: greptimedb
ports:
- 4000:4000
- 4001:4001
- 4002:4002
- 4003:4003
- 4242:4242
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003 --opentsdb-addr 0.0.0.0:4242"
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003"
volumes:
- ./greptimedb:/tmp/greptimedb

Expand Down
9 changes: 4 additions & 5 deletions docs/v0.7/en/getting-started/quick-start/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,20 +40,19 @@ services:
- 3000:3000
greptime:
image: greptime/greptimedb:latest
image: greptime/greptimedb:<%greptimedb-version%>
container_name: greptimedb
ports:
- 4000:4000
- 4001:4001
- 4002:4002
- 4003:4003
- 4242:4242
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003 --opentsdb-addr 0.0.0.0:4242"
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003"
volumes:
- ./greptimedb:/tmp/greptimedb
prometheus:
image: prom/prometheus:latest
image: prom/prometheus:<%prometheus-version%>
container_name: prometheus
depends_on:
- node_exporter
Expand All @@ -63,7 +62,7 @@ services:
- ./prometheus.yml:/etc/prometheus/prometheus.yml:ro
node_exporter:
image: quay.io/prometheus/node-exporter:latest
image: quay.io/prometheus/node-exporter:<%node-exporter-version%>
container_name: node_exporter_local
ports:
- 9100:9100
Expand Down
7 changes: 3 additions & 4 deletions docs/v0.7/en/getting-started/quick-start/vector.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,19 @@ services:
- 3000:3000

greptime:
image: greptime/greptimedb:latest
image: greptime/greptimedb:<%greptimedb-version%>
container_name: greptimedb
ports:
- 4000:4000
- 4001:4001
- 4002:4002
- 4003:4003
- 4242:4242
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003 --opentsdb-addr 0.0.0.0:4242"
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003"
volumes:
- ./greptimedb:/tmp/greptimedb

vector:
image: timberio/vector:0.33.0-debian
image: timberio/vector:<%vector-version%>
container_name: vector
ports:
- 8686:8686
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.7/en/user-guide/client-libraries/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ concurrent-safe library that is easy to use with the metric struct.
Use the following command to install the GreptimeDB client library for Go:

```shell
go get -u github.com/GreptimeTeam/greptimedb-ingester-go
go get -u github.com/GreptimeTeam/greptimedb-ingester-go@<%go-sdk-version%>
```

Import the library in your code:
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.7/en/user-guide/client-libraries/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ dependencies list:
<dependency>
<groupId>io.greptime</groupId>
<artifactId>ingester-all</artifactId>
<version>${latest_version}</version>
<version><%java-sdk-version%></version>
</dependency>
```

Expand Down
6 changes: 6 additions & 0 deletions docs/v0.7/variates.yml
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
grafana-version: 9.5.15
greptimedb-version: v0.7.2
vector-version: 0.33.0-debian
prometheus-version: v2.52.0
node-exporter-version: v1.8.0
go-sdk-version: v0.5.0
java-sdk-version: 0.7.3
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,11 @@ curl -fsSL \
docker run -p 4000-4003:4000-4003 \
-p 4242:4242 -v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb standalone start \
greptime/greptimedb:<%greptimedb-version%> standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003 \
--opentsdb-addr 0.0.0.0:4242
--postgres-addr 0.0.0.0:4003
```

数据将会存储在当前目录下的 `greptimedb/` 目录中。
Expand All @@ -69,12 +68,11 @@ greptime/greptimedb standalone start \
docker run --security-opt seccomp=unconfined -p 4000-4003:4000-4003 \
-p 4242:4242 -v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb standalone start \
greptime/greptimedb:<%greptimedb-version%> standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003 \
--opentsdb-addr 0.0.0.0:4242
--postgres-addr 0.0.0.0:4003
```

2. 将 Docker 版本升级到 v23.0.0 或更高;
Expand Down
7 changes: 3 additions & 4 deletions docs/v0.7/zh/getting-started/quick-start/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,20 @@
```yaml
services:
grafana:
image: grafana/grafana-oss:9.5.15
image: grafana/grafana-oss:<%grafana-version%>
container_name: grafana
ports:
- 3000:3000

greptime:
image: greptime/greptimedb:latest
image: greptime/greptimedb:<%greptimedb-version%>
container_name: greptimedb
ports:
- 4000:4000
- 4001:4001
- 4002:4002
- 4003:4003
- 4242:4242
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003 --opentsdb-addr 0.0.0.0:4242"
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003"
volumes:
- ./greptimedb:/tmp/greptimedb

Expand Down
11 changes: 5 additions & 6 deletions docs/v0.7/zh/getting-started/quick-start/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,26 +34,25 @@ remote_write:
```yaml
services:
grafana:
image: grafana/grafana-oss:9.5.15
image: grafana/grafana-oss:<%grafana-version%>
container_name: grafana
ports:
- 3000:3000
greptime:
image: greptime/greptimedb:latest
image: greptime/greptimedb:<%greptimedb-version%>
container_name: greptimedb
ports:
- 4000:4000
- 4001:4001
- 4002:4002
- 4003:4003
- 4242:4242
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003 --opentsdb-addr 0.0.0.0:4242"
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003"
volumes:
- ./greptimedb:/tmp/greptimedb
prometheus:
image: prom/prometheus:latest
image: prom/prometheus:<%prometheus-version%>
container_name: prometheus
depends_on:
- node_exporter
Expand All @@ -63,7 +62,7 @@ services:
- ./prometheus.yml:/etc/prometheus/prometheus.yml:ro
node_exporter:
image: quay.io/prometheus/node-exporter:latest
image: quay.io/prometheus/node-exporter:<%node-exporter-version%>
container_name: node_exporter_local
ports:
- 9100:9100
Expand Down
9 changes: 4 additions & 5 deletions docs/v0.7/zh/getting-started/quick-start/vector.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,25 @@ dbname = "public"
```yaml
services:
grafana:
image: grafana/grafana-oss:9.5.15
image: grafana/grafana-oss:<%grafana-version%>
container_name: grafana
ports:
- 3000:3000

greptime:
image: greptime/greptimedb:latest
image: greptime/greptimedb:<%greptimedb-version%>
container_name: greptimedb
ports:
- 4000:4000
- 4001:4001
- 4002:4002
- 4003:4003
- 4242:4242
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003 --opentsdb-addr 0.0.0.0:4242"
command: "standalone start --http-addr 0.0.0.0:4000 --rpc-addr 0.0.0.0:4001 --mysql-addr 0.0.0.0:4002 --postgres-addr 0.0.0.0:4003"
volumes:
- ./greptimedb:/tmp/greptimedb

vector:
image: timberio/vector:0.33.0-debian
image: timberio/vector:<%vector-version%>
container_name: vector
ports:
- 8686:8686
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.7/zh/user-guide/client-libraries/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ GreptimeDB 提供的 Go Ingest SDK 是一个轻量级、并发安全的库,使
使用下方的命令安装 Go Ingest SDK:

```shell
go get -u github.com/GreptimeTeam/greptimedb-ingester-go
go get -u github.com/GreptimeTeam/greptimedb-ingester-go@<%go-sdk-version%>
```

引入到代码中:
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.7/zh/user-guide/client-libraries/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ GreptimeDB 提供的 Java ingester SDK 是一个轻量级库,具有以下特
<dependency>
<groupId>io.greptime</groupId>
<artifactId>ingester-all</artifactId>
<version>${latest_version}</version>
<version><%java-sdk-version%></version>
</dependency>
```

Expand Down

0 comments on commit f8dcfe4

Please sign in to comment.