Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: add note for cluster deployment #1239

Merged
merged 1 commit into from
Oct 25, 2024
Merged

refactor: add note for cluster deployment #1239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/getting-started/installation/greptimedb-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@

The GreptimeDB cluster can run in cluster mode to scale horizontally.

## Deploy the GreptimeDB cluster in Kubernetes

For production environments, we recommend deploying the GreptimeDB cluster in Kubernetes. Please refer to [Deploy on Kubernetes](/user-guide/deployments/deploy-on-kubernetes/overview.md).

## Use Docker Compose

:::tip NOTE
Although Docker Compose is a convenient way to run the GreptimeDB cluster, it is only for development and testing purposes.

For production environments or benchmarking, we recommend using Kubernetes.
:::

### Prerequisites

Using Docker Compose is the easiest way to run the GreptimeDB cluster. Before starting, make sure you have already installed the Docker.
Expand Down Expand Up @@ -33,9 +43,6 @@ docker compose -f ./cluster-with-etcd.yaml down

By default, the data will be stored in `/tmp/greptimedb-cluster-docker-compose`. You also can remove the data directory if you want to clean up the data.

## Deploy the GreptimeDB cluster in Kubernetes

Please refer to [Deploy on Kubernetes](/user-guide/deployments/deploy-on-kubernetes/overview.md).

## Next Steps

Expand Down
14 changes: 10 additions & 4 deletions ...-plugin-content-docs/current/getting-started/installation/greptimedb-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@

GreptimeDB 可以运行于 [cluster](/contributor-guide/overview.md) 模式以支持水平扩展。

## 在 Kubernetes 中部署 GreptimeDB 集群

对于生产环境，我们建议在 Kubernetes 中部署 GreptimeDB 集群。请参考 [在 Kubernetes 上部署](/user-guide/deployments/deploy-on-kubernetes/overview.md)。

## 使用 Docker Compose

:::tip 注意
虽然 Docker Compose 是运行 GreptimeDB 集群的便捷方法，但仅适用于开发和测试目的。

对于生产环境或基准测试，我们建议使用 Kubernetes。
:::

### 前置条件

使用 Docker Compose 是运行 GreptimeDB 集群的最简单方法。开始之前，请确保已经安装了 Docker。
Expand Down Expand Up @@ -35,10 +45,6 @@ docker compose -f ./cluster-with-etcd.yaml down

默认情况下，数据将被存储在 `/tmp/greptimedb-cluster-docker-compose`。如果你想清理数据，也可删除该目录。

## 在 Kubernetes 中部署 GreptimeDB 集群

请参考 [在 Kubernetes 上部署](/user-guide/deployments/deploy-on-kubernetes/overview.md)。

## 下一步

学习如何使用 GreptimeDB：[快速开始](../quick-start.md#连接到-greptimedb)。
Loading