diff --git a/docs/zh/05-get-started/01-docker.md b/docs/zh/05-get-started/01-docker.md index 72b4603dda2a078d04427290c560c9818f19915e..9ff67fa604688d97adb9c685596771c0494f6ee0 100644 --- a/docs/zh/05-get-started/01-docker.md +++ b/docs/zh/05-get-started/01-docker.md @@ -1,4 +1,5 @@ --- +sidebar_label: Docker title: 通过 Docker 快速体验 TDengine --- diff --git a/docs/zh/05-get-started/03-package.md b/docs/zh/05-get-started/03-package.md index e6810ec9b66b3ad339ae1941b18e917eaaefc541..7af29deceee6413e689e078b8e2300392df46aed 100644 --- a/docs/zh/05-get-started/03-package.md +++ b/docs/zh/05-get-started/03-package.md @@ -1,6 +1,6 @@ --- -title: 安装包 -description: 使用安装包安装和卸载 +sidebar_label: 安装包 +title: 使用安装包安装和卸载 --- import Tabs from "@theme/Tabs"; @@ -174,7 +174,7 @@ install.sh 安装脚本在执行过程中，会通过命令行交互界面询问 -内容TBD +内容 TBD @@ -218,21 +218,22 @@ taosKeeper is removed successfully! :::info + - TDengine 提供了多种安装包，但最好不要在一个系统上同时使用 tar.gz 安装包和 deb 或 rpm 安装包。否则会相互影响，导致在使用时出现问题。 - 对于 deb 包安装后，如果安装目录被手工误删了部分，出现卸载、或重新安装不能成功。此时，需要清除 TDengine 包的安装信息，执行如下命令： - ``` - $ sudo rm -f /var/lib/dpkg/info/tdengine* - ``` + ``` + $ sudo rm -f /var/lib/dpkg/info/tdengine* + ``` 然后再重新进行安装就可以了。 - 对于 rpm 包安装后，如果安装目录被手工误删了部分，出现卸载、或重新安装不能成功。此时，需要清除 TDengine 包的安装信息，执行如下命令： - ``` - $ sudo rpm -e --noscripts tdengine - ``` + ``` + $ sudo rpm -e --noscripts tdengine + ``` 然后再重新进行安装就可以了。 @@ -272,50 +273,24 @@ lrwxrwxrwx 1 root root 13 Feb 22 09:34 log -> /var/log/taos/ 如果是更新安装，当缺省配置文件（ /etc/taos/taos.cfg ）存在时，仍然使用已有的配置文件，安装包中携带的配置文件修改为 taos.cfg.orig 保存在 /usr/local/taos/cfg/ 目录，可以作为设置配置参数的参考样例；如果不存在配置文件，就使用安装包中自带的配置文件。 -## 启动和停止 - -TDengine 使用 Linux 系统的 systemd/systemctl/service 来管理系统的启动和、停止、重启操作。TDengine 的服务进程是 taosd，默认情况下 TDengine 在系统启动后将自动启动。DBA 可以通过 systemd/systemctl/service 手动操作停止、启动、重新启动服务。 - -以 systemctl 为例，命令如下： - -- 启动服务进程：`systemctl start taosd` - -- 停止服务进程：`systemctl stop taosd` - -- 重启服务进程：`systemctl restart taosd` - -- 查看服务状态：`systemctl status taosd` - -注意：TDengine 在 2.4 版本之后包含一个独立组件 taosAdapter 需要使用 systemctl 命令管理 taosAdapter 服务的启动和停止。 - -如果服务进程处于活动状态，则 status 指令会显示如下的相关信息： - - ``` - Active: active (running) - ``` - -如果后台服务进程处于停止状态，则 status 指令会显示如下的相关信息： - - ``` - Active: inactive (dead) - ``` - ## 升级 + 升级分为两个层面：升级安装包 和 升级运行中的实例。 升级安装包请遵循前述安装和卸载的步骤先卸载旧版本再安装新版本。 升级运行中的实例则要复杂得多，首先请注意版本号，TDengine 的版本号目前分为四段，如 2.4.0.14 和 2.4.0.16，只有前三段版本号一致（即只有第四段版本号不同）才能把一个运行中的实例进行升级。升级步骤如下： + - 停止数据写入 - 确保所有数据落盘，即写入时序数据库 - 停止 TDengine 集群 - 卸载旧版本并安装新版本 - 重新启动 TDengine 集群 -- 进行简单的查询操作确认旧数据没有丢失 +- 进行简单的查询操作确认旧数据没有丢失 - 进行简单的写入操作确认 TDengine 集群可用 - 重新恢复业务数据的写入 :::warning TDengine 不保证低版本能够兼容高版本的数据，所以任何时候都不推荐降级 -::: \ No newline at end of file +::: diff --git a/docs/zh/05-get-started/06-first-use.md b/docs/zh/05-get-started/06-first-use.md index 270ea8f7a557c54189a10296facb63d8f8eaccc1..db54ce5af9a9ecdf4d7a1beb4fe6ebd80522316b 100644 --- a/docs/zh/05-get-started/06-first-use.md +++ b/docs/zh/05-get-started/06-first-use.md @@ -1,6 +1,6 @@ --- -title: 开始使用 -description: '使用 TDengine' +sidebar_labe: 开始使用 +title: 快速体验 TDengine --- import Tabs from "@theme/Tabs"; @@ -24,15 +24,15 @@ systemctl status taosd 如果服务进程处于活动状态，则 status 指令会显示如下的相关信息： - ``` - Active: active (running) - ``` +``` +Active: active (running) +``` 如果后台服务进程处于停止状态，则 status 指令会显示如下的相关信息： - ``` - Active: inactive (dead) - ``` +``` +Active: inactive (dead) +``` 如果 TDengine 服务正常工作，那么您可以通过 TDengine 的命令行程序 `taos` 来访问并体验 TDengine。 @@ -47,6 +47,7 @@ systemctl 命令汇总： - 查看服务状态：`systemctl status taosd` :::info + - systemctl 命令需要 _root_ 权限来运行，如果您非 _root_ 用户，请在命令前添加 sudo 。 - `systemctl stop taosd` 指令在执行后并不会马上停止 TDengine 服务，而是会等待系统中必要的落盘工作正常完成。在数据量很大的情况下，这可能会消耗较长时间。 - 如果系统中不支持 `systemd`，也可以用手动运行 `/usr/local/taos/bin/taosd` 方式启动 TDengine 服务。 diff --git a/docs/zh/10-deployment/01-deploy.md b/docs/zh/10-deployment/01-deploy.md index 947ca61fe1392e67dc27074a7f51af95e7d21aaf..c009299a32677f5c9453c824530ae2c2d26c0050 100644 --- a/docs/zh/10-deployment/01-deploy.md +++ b/docs/zh/10-deployment/01-deploy.md @@ -1,4 +1,5 @@ --- +sidebar_label: 部署集群 title: 集群部署和管理 --- @@ -72,15 +73,16 @@ serverPort 6030 按照《立即开始》里的步骤，启动第一个数据节点，例如 h1.taosdata.com，然后执行 taos，启动 taos shell，从 shell 里执行命令“SHOW DNODES”，如下所示： ``` + Welcome to the TDengine shell from Linux, Client Version:3.0.0.0 Copyright (c) 2022 by TAOS Data, Inc. All rights reserved. Server is Enterprise trial Edition, ver:3.0.0.0 and will never expire. taos> show dnodes; - id | endpoint | vnodes | support_vnodes | status | create_time | note | +id | endpoint | vnodes | support_vnodes | status | create_time | note | ============================================================================================================================================ - 1 | h1.taosdata.com:6030 | 0 | 1024 | ready | 2022-07-16 10:50:42.673 | | +1 | h1.taosdata.com:6030 | 0 | 1024 | ready | 2022-07-16 10:50:42.673 | | Query OK, 1 rows affected (0.007984s) taos> @@ -196,4 +198,3 @@ DROP DNODE dnodeId; dnodeID 是集群自动分配的，不得人工指定。它在生成时是递增的，不会重复。 ::: - diff --git a/docs/zh/10-deployment/03-k8s.md b/docs/zh/10-deployment/03-k8s.md index 2ca28abe8688c80e4a5d8215563c53948578e7eb..1f5b28f623adc6dcb7bb6c7c0b8ceb46c6854003 100644 --- a/docs/zh/10-deployment/03-k8s.md +++ b/docs/zh/10-deployment/03-k8s.md @@ -1,4 +1,5 @@ --- +sidebar_labe: Kubernetes title: 在 Kubernetes 上部署 TDengine 集群 --- @@ -402,7 +403,7 @@ Query OK, 4 row(s) in set (0.001236s) ### 错误二 -TDengine集群会持有 replica 参数，如果缩容后的节点数小于这个值，集群将无法使用： +TDengine 集群会持有 replica 参数，如果缩容后的节点数小于这个值，集群将无法使用： 创建一个库使用 replica 参数为 2，插入部分数据： @@ -410,7 +411,7 @@ TDengine集群会持有 replica 参数，如果缩容后的节点数小于这个 kubectl exec -i -t tdengine-0 -- \ taos -s \ "create database if not exists test replica 2; - use test; + use test; create table if not exists t1(ts timestamp, n int); insert into t1 values(now, 1)(now+1s, 2);" @@ -424,7 +425,7 @@ kubectl scale statefulsets tdengine --replicas=1 ``` -在taos shell中的所有数据库操作将无法成功。 +在 taos shell 中的所有数据库操作将无法成功。 ``` taos> show dnodes; @@ -448,4 +449,4 @@ taos> insert into t1 values(now, 3); DB error: Unable to resolve FQDN (0.013874s) -``` \ No newline at end of file +``` diff --git a/docs/zh/10-deployment/05-helm.md b/docs/zh/10-deployment/05-helm.md index 926b71c500ce17d4a244f558b4b38460e9cd7f43..86abe20a55499cd256d17cfd0e75c9ba0d538644 100644 --- a/docs/zh/10-deployment/05-helm.md +++ b/docs/zh/10-deployment/05-helm.md @@ -1,4 +1,5 @@ --- +sidebar_labe: Helm title: 使用 Helm 部署 TDengine 集群 --- @@ -18,14 +19,14 @@ Helm 会使用 kubectl 和 kubeconfig 的配置来操作 Kubernetes，可以参 ## 安装 TDengine Chart -TDengine Chart 尚未发布到 Helm 仓库，当前可以从GitHub直接下载： +TDengine Chart 尚未发布到 Helm 仓库，当前可以从 GitHub 直接下载： ```bash wget https://github.com/taosdata/TDengine-Operator/raw/main/helm/tdengine-0.3.0.tgz ``` -获取当前Kubernetes的存储类： +获取当前 Kubernetes 的存储类： ```bash kubectl get storageclass @@ -34,7 +35,7 @@ kubectl get storageclass 在 minikube 默认为 standard. -之后，使用helm命令安装： +之后，使用 helm 命令安装： ```bash helm install tdengine tdengine-0.3.0.tgz \ @@ -52,7 +53,7 @@ helm install tdengine tdengine-0.3.0.tgz \ ``` -部署成功后，TDengine Chart将会输出操作TDengine的说明： +部署成功后，TDengine Chart 将会输出操作 TDengine 的说明： ```bash export POD_NAME=$(kubectl get pods --namespace default \ @@ -79,13 +80,14 @@ kubectl --namespace default exec $POD_NAME -- \ TDengine 支持 `values.yaml` 自定义。 -通过 helm show values可以获取TDengine Chart支持的全部values列表： +通过 helm show values 可以获取 TDengine Chart 支持的全部 values 列表： + ```bash helm show values tdengine-0.3.0.tgz ``` -你可以将结果保存为 values.yaml，之后可以修改其中的各项参数，如 replica 数量，存储类名称，容量大小，TDengine 配置等，然后使用如下命令安装TDengine集群： +你可以将结果保存为 values.yaml，之后可以修改其中的各项参数，如 replica 数量，存储类名称，容量大小，TDengine 配置等，然后使用如下命令安装 TDengine 集群： ```bash helm install tdengine tdengine-0.3.0.tgz -f values.yaml @@ -112,7 +114,26 @@ service: type: ClusterIP ports: # TCP range required - tcp: [6030,6031,6032,6033,6034, 6035,6036,6037,6038, 6039, 6040, 6041, 6042, 6043, 6044, 6045, 6060] + tcp: + [ + 6030, + 6031, + 6032, + 6033, + 6034, + 6035, + 6036, + 6037, + 6038, + 6039, + 6040, + 6041, + 6042, + 6043, + 6044, + 6045, + 6060, + ] # UDP range 6030-6039 udp: [6030, 6031, 6032, 6033, 6034, 6035, 6036, 6037, 6038, 6039] @@ -161,7 +182,6 @@ clusterDomainSuffix: "" # # Btw, keep quotes "" around the value like below, even the value will be number or not. taoscfg: - # number of replications, for cluster only TAOS_REPLICA: "1" @@ -360,14 +380,13 @@ taoscfg: # -1 no limit (default) # 0 no query allowed, queries are disabled #TAOS_QUERY_BUFFER_SIZE: "-1" - ``` ## 扩容 -关于扩容可参考上一节的说明，有一些额外的操作需要从helm的部署中获取。 +关于扩容可参考上一节的说明，有一些额外的操作需要从 helm 的部署中获取。 -首先，从部署中获取StatefulSet的名称。 +首先，从部署中获取 StatefulSet 的名称。 ```bash export STS_NAME=$(kubectl get statefulset \ @@ -376,14 +395,14 @@ export STS_NAME=$(kubectl get statefulset \ ``` -扩容操作极其简单，增加replica即可。以下命令将TDengine扩充到三节点： +扩容操作极其简单，增加 replica 即可。以下命令将 TDengine 扩充到三节点： ```bash kubectl scale --replicas 3 statefulset/$STS_NAME ``` -使用命令 `show dnodes` 和 `show mnodes` 检查是否扩容成功。 +使用命令 `show dnodes` 和 `show mnodes` 检查是否扩容成功。 ## 缩容 @@ -392,7 +411,7 @@ kubectl scale --replicas 3 statefulset/$STS_NAME ::: -获取需要缩容的dnode列表，并手动Drop。 +获取需要缩容的 dnode 列表，并手动 Drop。 ```bash kubectl --namespace default exec $POD_NAME -- \ @@ -405,11 +424,11 @@ kubectl --namespace default exec $POD_NAME -- taos -s 'drop dnode "