Skip to content

Commit 49411be

Browse files
authored
chore: add command line details (#2130)
1 parent 3b2d2c6 commit 49411be

File tree

8 files changed

+50
-18
lines changed

8 files changed

+50
-18
lines changed

docs/reference/command-lines/overview.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,21 @@ The `greptime` command can start/stop GreptimeDB and pass configuration options.
99

1010
## Install the Greptime CLI
1111

12-
The Greptime CLI comes bundled with the GreptimeDB binary.
13-
After [installing GreptimeDB](/getting-started/installation/overview.md),
14-
you can execute the `./greptime` command within the GreptimeDB directory.
12+
The Greptime CLI is bundled with the GreptimeDB binary.
13+
14+
If you start GreptimeDB using the binary file as described in the [installing GreptimeDB](/getting-started/installation/overview.md) documentation,
15+
you can execute the `./greptime` command from within the GreptimeDB directory.
16+
For convenience, if you prefer to run commands using `greptime` instead of `./greptime`,
17+
consider moving the CLI binary to your system's `bin` directory or adding the binary's path to your `PATH` environment variable.
18+
19+
If you deployed GreptimeDB in Kubernetes, you can access the greptime command line through the frontend pod. Use the following command to enter the pod:
20+
21+
```sh
22+
kubectl exec -it <greptimedb-frontend-pod> -n <namespace> -- /bin/bash
23+
```
24+
25+
Once inside the pod, you can run `greptime help` to see all available commands.
1526

16-
For convenience, if you wish to run commands using `greptime` instead of `./greptime`,
17-
consider moving the CLI binary to your system's `bin` directory or appending the binary's path to your `PATH` environment variable.
1827

1928
## CLI Options
2029

docs/user-guide/ingest-data/for-observability/fluent-bit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Instructions on integrating GreptimeDB with Fluent bit for Promethe
77

88
[Fluent Bit](http://fluentbit.io/) is a fast and lightweight telemetry agent for logs, metrics, and traces for Linux, macOS, Windows, and BSD family operating systems. Fluent Bit has been made with a strong focus on performance to allow the collection and processing of telemetry data from different sources without complexity.
99

10-
You can integrate GreptimeDB as an OUTPUT for Fluent Bit.
10+
You can forward Fluent Bit data to GreptimeDB. This document describes how to configure Fluent Bit to send logs, metrics, and traces to GreptimeDB.
1111

1212
## Http
1313

i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/overview.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,19 @@ description: 介绍 Greptime 命令行工具的安装、使用方法,包括全
1010
## 安装命令行工具
1111

1212
Greptime 命令行工具与 GreptimeDB 二进制文件捆绑在一起。
13-
[安装 GreptimeDB](/getting-started/installation/overview.md)之后,
14-
你可以在 GreptimeDB 的当前目录中执行 `./greptime` 命令。
1513

14+
如果你按照[快速安装 GreptimeDB](/getting-started/installation/overview.md)文档中所述使用二进制文件启动的 GreptimeDB,可以在 GreptimeDB 的当前目录中执行 `./greptime` 命令。
1615
为了方便起见,如果你希望使用 `greptime` 而不是 `./greptime` 来运行命令,
1716
可以将命令行工具的二进制文件移动到系统的 `bin` 目录,或者将二进制文件的路径添加到 `PATH` 环境变量中。
1817

18+
如果你是在 Kubernetes 中部署的 GreptimeDB,可以通过 frontend pod 访问 greptime 命令行工具。使用以下命令进入 pod:
19+
20+
```sh
21+
kubectl exec -it <greptimedb-frontend-pod> -n <namespace> -- /bin/bash
22+
```
23+
24+
进入 pod 后,可以运行 `greptime help` 查看所有可用命令。
25+
1926
## 选项
2027

2128
`help` 命令列出了 `greptime` 所有可用的命令和选项。

i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-observability/fluent-bit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: 将 GreptimeDB 与 Fluent bit 集成以实现 Prometheus Remote Wri
77

88
[Fluent Bit](http://fluentbit.io/) 是一个快速且轻量级的遥测代理,用于 Linux、macOS、Windows 和 BSD 系列操作系统的日志、指标和跟踪。Fluent Bit 专注于性能,允许从不同来源收集和处理遥测数据而不增加复杂性。
99

10-
您可以将 GreptimeDB 集成为 Fluent Bit 的 OUTPUT。本文档介绍如何配置 Fluent Bit 以将日志、指标和跟踪发送到 GreptimeDB。
10+
你可以将 Fluent Bit 数据转发到 GreptimeDB。本文档介绍如何配置 Fluent Bit 以将日志、指标和跟踪发送到 GreptimeDB。
1111

1212
## Http
1313

i18n/zh/docusaurus-plugin-content-docs/version-0.17/reference/command-lines/overview.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,19 @@ description: 介绍 Greptime 命令行工具的安装、使用方法,包括全
1010
## 安装命令行工具
1111

1212
Greptime 命令行工具与 GreptimeDB 二进制文件捆绑在一起。
13-
[安装 GreptimeDB](/getting-started/installation/overview.md)之后,
14-
你可以在 GreptimeDB 的当前目录中执行 `./greptime` 命令。
1513

14+
如果你按照[快速安装 GreptimeDB](/getting-started/installation/overview.md)文档中所述使用二进制文件启动的 GreptimeDB,可以在 GreptimeDB 的当前目录中执行 `./greptime` 命令。
1615
为了方便起见,如果你希望使用 `greptime` 而不是 `./greptime` 来运行命令,
1716
可以将命令行工具的二进制文件移动到系统的 `bin` 目录,或者将二进制文件的路径添加到 `PATH` 环境变量中。
1817

18+
如果你是在 Kubernetes 中部署的 GreptimeDB,可以通过 frontend pod 访问 greptime 命令行工具。使用以下命令进入 pod:
19+
20+
```sh
21+
kubectl exec -it <greptimedb-frontend-pod> -n <namespace> -- /bin/bash
22+
```
23+
24+
进入 pod 后,可以运行 `greptime help` 查看所有可用命令。
25+
1926
## 选项
2027

2128
`help` 命令列出了 `greptime` 所有可用的命令和选项。

i18n/zh/docusaurus-plugin-content-docs/version-0.17/user-guide/ingest-data/for-observability/fluent-bit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: 将 GreptimeDB 与 Fluent bit 集成以实现 Prometheus Remote Wri
77

88
[Fluent Bit](http://fluentbit.io/) 是一个快速且轻量级的遥测代理,用于 Linux、macOS、Windows 和 BSD 系列操作系统的日志、指标和跟踪。Fluent Bit 专注于性能,允许从不同来源收集和处理遥测数据而不增加复杂性。
99

10-
您可以将 GreptimeDB 集成为 Fluent Bit 的 OUTPUT。本文档介绍如何配置 Fluent Bit 以将日志、指标和跟踪发送到 GreptimeDB。
10+
你可以将 Fluent Bit 数据转发到 GreptimeDB。本文档介绍如何配置 Fluent Bit 以将日志、指标和跟踪发送到 GreptimeDB。
1111

1212
## Http
1313

versioned_docs/version-0.17/reference/command-lines/overview.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,21 @@ The `greptime` command can start/stop GreptimeDB and pass configuration options.
99

1010
## Install the Greptime CLI
1111

12-
The Greptime CLI comes bundled with the GreptimeDB binary.
13-
After [installing GreptimeDB](/getting-started/installation/overview.md),
14-
you can execute the `./greptime` command within the GreptimeDB directory.
12+
The Greptime CLI is bundled with the GreptimeDB binary.
13+
14+
If you start GreptimeDB using the binary file as described in the [installing GreptimeDB](/getting-started/installation/overview.md) documentation,
15+
you can execute the `./greptime` command from within the GreptimeDB directory.
16+
For convenience, if you prefer to run commands using `greptime` instead of `./greptime`,
17+
consider moving the CLI binary to your system's `bin` directory or adding the binary's path to your `PATH` environment variable.
18+
19+
If you deployed GreptimeDB in Kubernetes, you can access the greptime command line through the frontend pod. Use the following command to enter the pod:
20+
21+
```sh
22+
kubectl exec -it <greptimedb-frontend-pod> -n <namespace> -- /bin/bash
23+
```
24+
25+
Once inside the pod, you can run `greptime help` to see all available commands.
1526

16-
For convenience, if you wish to run commands using `greptime` instead of `./greptime`,
17-
consider moving the CLI binary to your system's `bin` directory or appending the binary's path to your `PATH` environment variable.
1827

1928
## CLI Options
2029

versioned_docs/version-0.17/user-guide/ingest-data/for-observability/fluent-bit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Instructions on integrating GreptimeDB with Fluent bit for Promethe
77

88
[Fluent Bit](http://fluentbit.io/) is a fast and lightweight telemetry agent for logs, metrics, and traces for Linux, macOS, Windows, and BSD family operating systems. Fluent Bit has been made with a strong focus on performance to allow the collection and processing of telemetry data from different sources without complexity.
99

10-
You can integrate GreptimeDB as an OUTPUT for Fluent Bit.
10+
You can forward Fluent Bit data to GreptimeDB. This document describes how to configure Fluent Bit to send logs, metrics, and traces to GreptimeDB.
1111

1212
## Http
1313

0 commit comments

Comments
 (0)