Skip to content

Commit

Permalink
chore: rename ceresdb to horaedb (#108)
Browse files Browse the repository at this point in the history
  • Loading branch information
chunshao90 committed Nov 20, 2023
1 parent 6f50019 commit 0918197
Show file tree
Hide file tree
Showing 98 changed files with 583 additions and 583 deletions.
8 changes: 4 additions & 4 deletions README-CN.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## CeresDB 文档
## HoraeDB 文档

欢迎来到 CeresDB 文档仓库!
这个仓库存放的是[CeresDB 文档网站](https://docs.ceresdb.io)的源文件,文档网站使用 mdbook 工具生成。
欢迎来到 HoraeDB 文档仓库!
这个仓库存放的是[HoraeDB 文档网站](https://ceresdb.github.io/docs)的源文件,文档网站使用 mdbook 工具生成。
本仓库的所有文件均使用标准 markdown 语法编写。

## Contributing

欢迎大家加入到 CeresDB 文档建设中,一起把文档做的更好更全。如果你遇到了 CeresDB 的文档问题,可随时
欢迎大家加入到 HoraeDB 文档建设中,一起把文档做的更好更全。如果你遇到了 HoraeDB 的文档问题,可随时

-[issue](https://github.com/CeresDB/docs/issues) 来反馈,或者
- 直接提交 [Pull Request](https://github.com/CeresDB/docs/pulls) 来进行修改。
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## CeresDB Documentation
## HoraeDB Documentation

Welcome to CeresDB documentation!
Welcome to HoraeDB documentation!

This repository stores all the source files of [CeresDB docs website](https://docs.ceresdb.io), the website is generated with [mdbook](https://rust-lang.github.io/mdBook/).
This repository stores all the source files of [HoraeDB docs website](https://ceresdb.github.io/docs), the website is generated with [mdbook](https://rust-lang.github.io/mdBook/).

**All files are written in standard markdown.**

## Contributing

We very much welcome any contributions from the community to make CeresDB documentation better.
We very much welcome any contributions from the community to make HoraeDB documentation better.

You can

Expand Down
10 changes: 5 additions & 5 deletions docs/book.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[book]
authors = ["CeresDB Authors"]
authors = ["HoraeDB Authors"]
language = "en"
multilingual = true
src = "src/en"
title = "CeresDB Documentation"
title = "HoraeDB Documentation"

[build]
use-default-preprocessors = false
Expand All @@ -13,15 +13,15 @@ use-default-preprocessors = false
[[output.i18n.translations]]
src = "src/cn"
language = "cn"
translators = ["CeresDB Authors"]
title = "CeresDB 文档"
translators = ["HoraeDB Authors"]
title = "HoraeDB 文档"

[output.random]
command = "/bin/bash ../../move.sh"

[output.html]
cname = "docs.ceresdb.io"
git-repository-url = "https://github.com/CeresDB/ceresdb"
git-repository-url = "https://github.com/CeresDB/horaedb"
edit-url-template = "https://github.com/CeresDB/docs/edit/main/docs/{path}"
additional-css = ["style.css"]
additional-js = ["sidebar.js"]
Expand Down
4 changes: 2 additions & 2 deletions docs/src/cn/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# 简介

- [什么是 CeresDB](about.md)
- [什么是 HoraeDB](about.md)
- [快速开始](quick_start.md)

# 用户手册
Expand Down Expand Up @@ -37,7 +37,7 @@
- [系统表](operation/system_table.md)
- [黑名单](operation/block_list.md)
- [监控](operation/observability.md)
- [CeresMeta](operation/ceresmeta.md)
- [HoraeMeta](operation/horaemeta.md)
- [周边生态](ecosystem/README.md)
- [Prometheus](ecosystem/prometheus.md)
- [InfluxDB](ecosystem/influxdb.md)
Expand Down
18 changes: 9 additions & 9 deletions docs/src/cn/about.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
![CeresDB](https://github.com/CeresDB/ceresdb/raw/main/docs/logo/CeresDB.png)
![HoraeDB](https://github.com/CeresDB/horaedb/raw/main/docs/logo/CeresDB.png)

![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)
[![CI](https://github.com/CeresDB/ceresdb/actions/workflows/ci.yml/badge.svg)](https://github.com/CeresDB/ceresdb/actions/workflows/ci.yml)
[![OpenIssue](https://img.shields.io/github/issues/CeresDB/ceresdb)](https://github.com/CeresDB/ceresdb/issues)
[![CI](https://github.com/CeresDB/horaedb/actions/workflows/ci.yml/badge.svg)](https://github.com/CeresDB/horaedb/actions/workflows/ci.yml)
[![OpenIssue](https://img.shields.io/github/issues/CeresDB/horaedb)](https://github.com/CeresDB/horaedb/issues)
[![Slack](https://badgen.net/badge/Slack/Join%20CeresDB/0abd59?icon=slack)](https://join.slack.com/t/ceresdbcommunity/shared_invite/zt-1dcbv8yq8-Fv8aVUb6ODTL7kxbzs9fnA)
[![Docker](https://img.shields.io/docker/v/ceresdb/ceresdb-server?logo=docker)](https://hub.docker.com/r/ceresdb/ceresdb-server)

CeresDB 是一款高性能、分布式的云原生时序数据库。
HoraeDB 是一款高性能、分布式的云原生时序数据库。

# 愿景

在经典的时序数据库中,`Tag` 列(InfluxDB 称为 `Tag`,Prometheus 称为 `Label`)通常使用倒排来进行索引。
我们发现在不同的情况下,`Tag` 的基数差异很大。在某些情况下,`Tag` 的基数非常高,存储和检索倒排索引的成本非常高。
同时,我们发现分析型数据库经常使用的扫描+剪枝可以很好地处理这些场景。

CeresDB 的基础设计思想是采用混合存储格式和相应的查询方法,以便在处理时序和分析场景时都获得更好的性能。
HoraeDB 的基础设计思想是采用混合存储格式和相应的查询方法,以便在处理时序和分析场景时都获得更好的性能。

# 如何使用 CeresDB
# 如何使用 HoraeDB

- 查看 [快速开始](quick_start.md) 掌握快速使用 CeresDB 的方式
- CeresDB 支持的数据模型请查看 [Data Model](sql/model/README.md)
- 查看 [快速开始](quick_start.md) 掌握快速使用 HoraeDB 的方式
- HoraeDB 支持的数据模型请查看 [Data Model](sql/model/README.md)
- SQL 使用相关请查看 [SQL](sql/README.md)
- CeresDB 支持的相关 SDK 请查看 [SDK](sdk/README.md)
- HoraeDB 支持的相关 SDK 请查看 [SDK](sdk/README.md)
6 changes: 3 additions & 3 deletions docs/src/cn/cluster_deployment/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 集群部署

[快速开始](../quick_start.md)部分我们已经介绍过单机版本 CeresDB 的部署。
[快速开始](../quick_start.md)部分我们已经介绍过单机版本 HoraeDB 的部署。

除此之外,CeresDB 作为一个分布式时序数据库,多个 CeresDB 实例能够以集群的方式提供可伸缩和高可用的数据服务。
除此之外,HoraeDB 作为一个分布式时序数据库,多个 HoraeDB 实例能够以集群的方式提供可伸缩和高可用的数据服务。

由于目前 CeresDB 对于 Kubernetes 的支持还在开发之中,目前 CeresDB 集群部署只能通过手动完成,集群部署的模式主要有两种,两者的区别在于是否需要部署 CeresMeta,对于 `NoMeta` 的模式,我们仅建议在测试场景下使用。
由于目前 HoraeDB 对于 Kubernetes 的支持还在开发之中,目前 HoraeDB 集群部署只能通过手动完成,集群部署的模式主要有两种,两者的区别在于是否需要部署 HoraeMeta,对于 `NoMeta` 的模式,我们仅建议在测试场景下使用。

- [NoMeta 模式(仅供测试使用)](no_meta.md)
- [WithMeta 模式](with_meta.md)
62 changes: 31 additions & 31 deletions docs/src/cn/cluster_deployment/no_meta.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

# NoMeta 模式

本章介绍如何部署一个静态(无 CeresMeta)的 CeresDB 集群。
本章介绍如何部署一个静态(无 HoraeMeta)的 HoraeDB 集群。

在没有 CeresMeta 的情况下,利用 CeresDB 服务端针对表名提供了可配置的路由功能即可实现集群化部署,为此我们需要提供一个包含路由规则的正确配置。根据这个配置,请求会被发送到集群中的每个 CeresDB 实例。
在没有 HoraeMeta 的情况下,利用 HoraeDB 服务端针对表名提供了可配置的路由功能即可实现集群化部署,为此我们需要提供一个包含路由规则的正确配置。根据这个配置,请求会被发送到集群中的每个 HoraeDB 实例。

## 目标

本文的目标是:在同一台机器上部署一个集群,这个集群包含两个 CeresDB 实例。
本文的目标是:在同一台机器上部署一个集群,这个集群包含两个 HoraeDB 实例。

如果想要部署一个更大规模的集群,参考此方案也可以进行部署。

## 准备配置文件

### 基础配置

CeresDB 的基础配置如下:
HoraeDB 的基础配置如下:

```toml
[server]
Expand All @@ -28,20 +28,20 @@ grpc_port = 8831
level = "info"

[tracing]
dir = "/tmp/ceresdb"
dir = "/tmp/horaedb"

[analytic.storage.object_store]
type = "Local"
data_dir = "/tmp/ceresdb"
data_dir = "/tmp/horaedb"

[analytic.wal]
type = "RocksDB"
data_dir = "/tmp/ceresdb"
data_dir = "/tmp/horaedb"
```

为了在同一个机器上部署两个实例,我们需要为每个实例配置不同的服务端口和数据目录。

实例 `CeresDB_0` 的配置如下:
实例 `HoraeDB_0` 的配置如下:

```toml
[server]
Expand All @@ -53,18 +53,18 @@ grpc_port = 8831
level = "info"

[tracing]
dir = "/tmp/ceresdb_0"
dir = "/tmp/horaedb_0"

[analytic.storage.object_store]
type = "Local"
data_dir = "/tmp/ceresdb_0"
data_dir = "/tmp/horaedb_0"

[analytic.wal]
type = "RocksDB"
data_dir = "/tmp/ceresdb_0"
data_dir = "/tmp/horaedb_0"
```

实例 `CeresDB_1` 的配置如下:
实例 `HoraeDB_1` 的配置如下:

```toml
[server]
Expand All @@ -76,15 +76,15 @@ grpc_port = 18831
level = "info"

[tracing]
dir = "/tmp/ceresdb_1"
dir = "/tmp/horaedb_1"

[analytic.storage.object_store]
type = "Local"
data_dir = "/tmp/ceresdb_1"
data_dir = "/tmp/horaedb_1"

[analytic.wal]
type = "RocksDB"
data_dir = "/tmp/ceresdb_1"
data_dir = "/tmp/horaedb_1"
```

### Schema 和 Shard
Expand Down Expand Up @@ -126,8 +126,8 @@ port = 18831

上述的配置中,定义了两个 `Schema`

- `public_0` 有两个分片在 `CeresDB_0` 实例上。
- `public_1` 有两个分片同时在 `CeresDB_0``CeresDB_1` 实例上。
- `public_0` 有两个分片在 `HoraeDB_0` 实例上。
- `public_1` 有两个分片同时在 `HoraeDB_0``HoraeDB_1` 实例上。

### 路由规则

Expand All @@ -140,7 +140,7 @@ prefix = 'prod_'
shard = 0
```

在这个规则里,`public_0` 中表名以 `prod_` 为前缀的所有表属于,相关操作会被路由到 `shard_0` 也就是 `CeresDB_0` 实例。 `public_0` 中其他的表会以 hash 的方式路由到 `shard_0``shard_1`.
在这个规则里,`public_0` 中表名以 `prod_` 为前缀的所有表属于,相关操作会被路由到 `shard_0` 也就是 `HoraeDB_0` 实例。 `public_0` 中其他的表会以 hash 的方式路由到 `shard_0``shard_1`.

在前缀规则之外,我们也可以定义一个 hash 规则:

Expand All @@ -150,10 +150,10 @@ schema = 'public_1'
shards = [0, 1]
```

这个规则告诉 CeresDB, `public_1` 的所有表会被路由到 `public_1``shard_0` and `shard_1`, 也就是 `CeresDB0``CeresDB_1`.
这个规则告诉 HoraeDB, `public_1` 的所有表会被路由到 `public_1``shard_0` and `shard_1`, 也就是 `HoraeDB0``HoraeDB_1`.
实际上如果没有定义 `public_1` 的路由规则,这是默认的路由行为。

`CeresDB_0``CeresDB_1` 实例完整的配置文件如下:
`HoraeDB_0``HoraeDB_1` 实例完整的配置文件如下:

```toml
[server]
Expand All @@ -165,15 +165,15 @@ grpc_port = 8831
level = "info"

[tracing]
dir = "/tmp/ceresdb_0"
dir = "/tmp/horaedb_0"

[analytic.storage.object_store]
type = "Local"
data_dir = "/tmp/ceresdb_0"
data_dir = "/tmp/horaedb_0"

[analytic.wal]
type = "RocksDB"
data_dir = "/tmp/ceresdb_0"
data_dir = "/tmp/horaedb_0"

[cluster_deployment]
mode = "NoMeta"
Expand Down Expand Up @@ -215,15 +215,15 @@ grpc_port = 18831
level = "info"

[tracing]
dir = "/tmp/ceresdb_1"
dir = "/tmp/horaedb_1"

[analytic.storage.object_store]
type = "Local"
data_dir = "/tmp/ceresdb_1"
data_dir = "/tmp/horaedb_1"

[analytic.wal]
type = "RocksDB"
data_dir = "/tmp/ceresdb_1"
data_dir = "/tmp/horaedb_1"

[cluster_deployment]
mode = "NoMeta"
Expand Down Expand Up @@ -258,15 +258,15 @@ port = 18831
我们给这两份不同的配置文件分别命名为 `config_0.toml``config_1.toml`
但是在实际环境中不同的实例可以部署在不同的服务器上,也就是说,不同的实例没有必要设置不同的服务端口和数据目录,这种情况下实例的配置可以使用同一份配置文件。

## 启动 CeresDB
## 启动 HoraeDB

配置准备好后,我们就可以开始启动 CeresDB 容器了。
配置准备好后,我们就可以开始启动 HoraeDB 容器了。

启动命令如下:

```shell
sudo docker run -d -t --name ceresdb_0 -p 5440:5440 -p 8831:8831 -v $(pwd)/config_0.toml:/etc/ceresdb/ceresdb.toml ceresdb/ceresdb-server
sudo docker run -d -t --name ceresdb_1 -p 15440:15440 -p 18831:18831 -v $(pwd)/config_1.toml:/etc/ceresdb/ceresdb.toml ceresdb/ceresdb-server
sudo docker run -d -t --name horaedb_0 -p 5440:5440 -p 8831:8831 -v $(pwd)/config_0.toml:/etc/ceresdb/ceresdb.toml ceresdb/ceresdb-server
sudo docker run -d -t --name horaedb_1 -p 15440:15440 -p 18831:18831 -v $(pwd)/config_1.toml:/etc/ceresdb/ceresdb.toml ceresdb/ceresdb-server
```

容器启动成功后,两个实例的 CeresDB 集群就搭建完成了,可以开始提供读写服务。
容器启动成功后,两个实例的 HoraeDB 集群就搭建完成了,可以开始提供读写服务。
2 changes: 1 addition & 1 deletion docs/src/cn/cluster_deployment/platform.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
作为一个开源的数据库,CeresDB 可以部署在基于英特尔 /ARM 架构的服务器,以及常见的虚拟环境。
作为一个开源的数据库,HoraeDB 可以部署在基于英特尔 /ARM 架构的服务器,以及常见的虚拟环境。

| OS | status |
| :------------------------------------------------: | :----: |
Expand Down
Loading

0 comments on commit 0918197

Please sign in to comment.