Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -159,4 +159,29 @@ Notice:
2. In this docker-compose file,`iotdb-2` should be replace with the real IP or hostname of each node to generate docker compose files in the other nodes.
3. The services would talk with each other, so they need map the /etc/hosts file or add the `extra_hosts` to the docker compose file.
4. We must start the IoTDB services of `iotdb-1` first at the first time of starting.
5. Stop and remove all the IoTDB services and clean up the `data` and `logs` directories of the 3 nodes,then start the cluster again.
5. Stop and remove all the IoTDB services and clean up the `data` and `logs` directories of the 3 nodes,then start the cluster again.


## Configuration
All configuration files are in the directory of `conf`.
The elements of environment in docker-compose file is the configurations of IoTDB.
If you'd changed the configurations files in conf, please map the directory of `conf` in docker-compose file.


### log level
The conf directory contains log configuration files, namely logback-confignode.xml and logback-datanode.xml.


### memory set
The conf directory contains memory configuration files, namely confignode-env.sh and datanode-env.sh. JVM heap size uses ON_HEAP_MEMORY and JVM direct memroy uses OFF_HEAP_MEMORY. e.g. `ON_HEAP_MEMORY=8G, OFF_HEAP_MEMORY=2G`

## upgrade IoTDB
1. Downloads the newer IoTDB docker image from docker hub
2. Update the image of docker-compose file
3. Stop the IoTDB docker containers with the commands of docker stop and docker rm.
4. Start IoTDB with `docker-compose -f docker-compose-standalone.yml up -d`

## boot automatically
1. Add `restart: always` to every service of IoTDB in docker-compose file
2. Set docker service to boot automatically
e.g. in CentOS: `systemctl enable docker`
24 changes: 24 additions & 0 deletions src/UserGuide/V1.0.x/QuickStart/WayToGetIoTDB.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,3 +208,27 @@ Notice:
3. The services would talk with each other, so they need map the /etc/hosts file or add the `extra_hosts` to the docker compose file.
4. We must start the IoTDB services of `iotdb-1` first at the first time of starting.
5. Stop and remove all the IoTDB services and clean up the `data` and `logs` directories of the 3 nodes,then start the cluster again.

## Configuration
All configuration files are in the directory of `conf`.
The elements of environment in docker-compose file is the configurations of IoTDB.
If you'd changed the configurations files in conf, please map the directory of `conf` in docker-compose file.


### log level
The conf directory contains log configuration files, namely logback-confignode.xml and logback-datanode.xml.


### memory set
The conf directory contains memory configuration files, namely confignode-env.sh and datanode-env.sh. JVM heap size uses MAX_HEAP_SIZE and HEAP_NEWSIZE, and JVM direct memroy uses MAX_DIRECT_MEMORY_SIZE. e.g. `MAX_HEAP_SIZE=8G, HEAP_NEWSIZE=8G, MAX_DIRECT_MEMORY_SIZE=2G`

## upgrade IoTDB
1. Downloads the newer IoTDB docker image from docker hub
2. Update the image of docker-compose file
3. Stop the IoTDB docker containers with the commands of docker stop and docker rm.
4. Start IoTDB with `docker-compose -f docker-compose-standalone.yml up -d`

## boot automatically
1. Add `restart: always` to every service of IoTDB in docker-compose file
2. Set docker service to boot automatically
e.g. in CentOS: `systemctl enable docker`
25 changes: 25 additions & 0 deletions src/UserGuide/V1.1.x/QuickStart/WayToGetIoTDB.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,3 +209,28 @@ Notice:
3. The services would talk with each other, so they need map the /etc/hosts file or add the `extra_hosts` to the docker compose file.
4. We must start the IoTDB services of `iotdb-1` first at the first time of starting.
5. Stop and remove all the IoTDB services and clean up the `data` and `logs` directories of the 3 nodes,then start the cluster again.


## Configuration
All configuration files are in the directory of `conf`.
The elements of environment in docker-compose file is the configurations of IoTDB.
If you'd changed the configurations files in conf, please map the directory of `conf` in docker-compose file.


### log level
The conf directory contains log configuration files, namely logback-confignode.xml and logback-datanode.xml.


### memory set
The conf directory contains memory configuration files, namely confignode-env.sh and datanode-env.sh. JVM heap size uses MAX_HEAP_SIZE and HEAP_NEWSIZE, and JVM direct memroy uses MAX_DIRECT_MEMORY_SIZE. e.g. `MAX_HEAP_SIZE=8G, HEAP_NEWSIZE=8G, MAX_DIRECT_MEMORY_SIZE=2G`

## upgrade IoTDB
1. Downloads the newer IoTDB docker image from docker hub
2. Update the image of docker-compose file
3. Stop the IoTDB docker containers with the commands of docker stop and docker rm.
4. Start IoTDB with `docker-compose -f docker-compose-standalone.yml up -d`

## boot automatically
1. Add `restart: always` to every service of IoTDB in docker-compose file
2. Set docker service to boot automatically
e.g. in CentOS: `systemctl enable docker`
36 changes: 30 additions & 6 deletions src/UserGuide/V1.2.x/Deployment-and-Maintenance/Docker-Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Add environments of docker to update the configurations of Apache IoTDB.

```shell
# get IoTDB official image
docker pull apache/iotdb:1.1.0-standalone
docker pull apache/iotdb:1.2.0-standalone
# create docker bridge network
docker network create --driver=bridge --subnet=172.18.0.0/16 --gateway=172.18.0.1 iotdb
# create docker container
Expand All @@ -48,7 +48,7 @@ docker run -d --name iotdb-service \
-e dn_schema_region_consensus_port=10750 \
-e dn_data_region_consensus_port=10760 \
-e dn_rpc_port=6667 \
apache/iotdb:1.1.0-standalone
apache/iotdb:1.2.0-standalone
# execute SQL
docker exec -ti iotdb-service /iotdb/sbin/start-cli.sh -h iotdb-service
```
Expand All @@ -67,7 +67,7 @@ Notice:The confignode service would fail when restarting this container if the
version: "3"
services:
iotdb-service:
image: apache/iotdb:1.1.0-standalone
image: apache/iotdb:1.2.0-standalone
hostname: iotdb-service
container_name: iotdb-service
ports:
Expand Down Expand Up @@ -108,7 +108,7 @@ Here is the docker-compose file of iotdb-2, as the sample:
version: "3"
services:
iotdb-confignode:
image: apache/iotdb:1.1.0-confignode
image: apache/iotdb:1.2.0-confignode
container_name: iotdb-confignode
environment:
- cn_internal_address=iotdb-2
Expand All @@ -127,7 +127,7 @@ services:
network_mode: "host"

iotdb-datanode:
image: apache/iotdb:1.1.0-datanode
image: apache/iotdb:1.2.0-datanode
container_name: iotdb-datanode
environment:
- dn_rpc_address=iotdb-2
Expand Down Expand Up @@ -155,4 +155,28 @@ Notice:
2. In this docker-compose file,`iotdb-2` should be replace with the real IP or hostname of each node to generate docker compose files in the other nodes.
3. The services would talk with each other, so they need map the /etc/hosts file or add the `extra_hosts` to the docker compose file.
4. We must start the IoTDB services of `iotdb-1` first at the first time of starting.
5. Stop and remove all the IoTDB services and clean up the `data` and `logs` directories of the 3 nodes,then start the cluster again.
5. Stop and remove all the IoTDB services and clean up the `data` and `logs` directories of the 3 nodes,then start the cluster again.


## Configuration
All configuration files are in the directory of `conf`.
The elements of environment in docker-compose file is the configurations of IoTDB.
If you'd changed the configurations files in conf, please map the directory of `conf` in docker-compose file.


### log level
The conf directory contains log configuration files, namely logback-confignode.xml and logback-datanode.xml.

### memory set
The conf directory contains memory configuration files, namely confignode-env.sh and datanode-env.sh. JVM heap size uses MAX_HEAP_SIZE and HEAP_NEWSIZE, and JVM direct memroy uses MAX_DIRECT_MEMORY_SIZE. e.g. `MAX_HEAP_SIZE=8G, HEAP_NEWSIZE=8G, MAX_DIRECT_MEMORY_SIZE=2G`

## upgrade IoTDB
1. Downloads the newer IoTDB docker image from docker hub
2. Update the image of docker-compose file
3. Stop the IoTDB docker containers with the commands of docker stop and docker rm.
4. Start IoTDB with `docker-compose -f docker-compose-standalone.yml up -d`

## boot automatically
1. Add `restart: always` to every service of IoTDB in docker-compose file
2. Set docker service to boot automatically
e.g. in CentOS: `systemctl enable docker`
Original file line number Diff line number Diff line change
Expand Up @@ -159,4 +159,29 @@ Notice:
2. In this docker-compose file,`iotdb-2` should be replace with the real IP or hostname of each node to generate docker compose files in the other nodes.
3. The services would talk with each other, so they need map the /etc/hosts file or add the `extra_hosts` to the docker compose file.
4. We must start the IoTDB services of `iotdb-1` first at the first time of starting.
5. Stop and remove all the IoTDB services and clean up the `data` and `logs` directories of the 3 nodes,then start the cluster again.
5. Stop and remove all the IoTDB services and clean up the `data` and `logs` directories of the 3 nodes,then start the cluster again.


## Configuration
All configuration files are in the directory of `conf`.
The elements of environment in docker-compose file is the configurations of IoTDB.
If you'd changed the configurations files in conf, please map the directory of `conf` in docker-compose file.


### log level
The conf directory contains log configuration files, namely logback-confignode.xml and logback-datanode.xml.


### memory set
The conf directory contains memory configuration files, namely confignode-env.sh and datanode-env.sh. JVM heap size uses ON_HEAP_MEMORY and JVM direct memroy uses OFF_HEAP_MEMORY. e.g. `ON_HEAP_MEMORY=8G, OFF_HEAP_MEMORY=2G`

## upgrade IoTDB
1. Downloads the newer IoTDB docker image from docker hub
2. Update the image of docker-compose file
3. Stop the IoTDB docker containers with the commands of docker stop and docker rm.
4. Start IoTDB with `docker-compose -f docker-compose-standalone.yml up -d`

## boot automatically
1. Add `restart: always` to every service of IoTDB in docker-compose file
2. Set docker service to boot automatically
e.g. in CentOS: `systemctl enable docker`
Original file line number Diff line number Diff line change
Expand Up @@ -156,4 +156,26 @@ services:
2. 上面docker-compose文件中,`iotdb-2`需要替换为每个节点的 hostname、域名或者IP地址。
3. 需要映射`/etc/hosts`,文件内配置了 iotdb-1、iotdb-2、iotdb-3 与IP的映射。或者可以在 docker-compose 文件中增加 `extra_hosts` 配置。
4. 首次启动时,必须首先启动 `iotdb-1`。
5. 如果部署失败要重新部署集群,必须将所有节点上的IoTDB服务停止并删除,然后清除`data`和`logs`文件夹后,再启动。
5. 如果部署失败要重新部署集群,必须将所有节点上的IoTDB服务停止并删除,然后清除`data`和`logs`文件夹后,再启动。

## 配置
IoTDB 的配置文件,都在安装目录的conf目录下。
IoTDB 本身配置都可以在 docker-compose 文件的 environment 中进行配置。
如果对日志和内存进行了自定义配置,那么需要将`conf`目录映射出来。

### 修改日志级别
日志配置文件为 logback-confignode.xml 和 logback-datanode.xml,可以根据需要进行精细配置。

### 修改内存配置
内存配置文件为 confignode-env.sh 和 datanode-env.sh。堆内存 ON_HEAP_MEMORY, 堆外内存 OFF_HEAP_MEMORY。例如:`ON_HEAP_MEMORY=8G, OFF_HEAP_MEMORY=2G`

## 升级
1. 获取新的镜像
2. 修改 docker-compose 文件的 image
3. 使用 docker stop 和 docker rm 命令,停止运行的 docker 容器
4. 启动 IoTDB: `docker-compose -f docker-compose-standalone.yml up -d`

## 设置开机自启动
1. 修改 docker-compose 文件,每个docker 容器配置:`restart: always`
2. 将 docker 服务设置为开机自启动
以 CentOS 操作系统为例: `systemctl enable docker`
22 changes: 22 additions & 0 deletions src/zh/UserGuide/V1.0.x/QuickStart/WayToGetIoTDB.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,3 +209,25 @@ services:
3. 需要映射`/etc/hosts`,文件内配置了 iotdb-1、iotdb-2、iotdb-3 与IP的映射。或者可以在 docker-compose 文件中增加 `extra_hosts` 配置。
4. 首次启动时,必须首先启动 `iotdb-1`。
5. 如果部署失败要重新部署集群,必须将所有节点上的IoTDB服务停止并删除,然后清除`data`和`logs`文件夹后,再启动。

## 配置
IoTDB 的配置文件,都在安装目录的conf目录下。
IoTDB 本身配置都可以在 docker-compose 文件的 environment 中进行配置。
如果对日志和内存进行了自定义配置,那么需要将`conf`目录映射出来。

### 修改日志级别
日志配置文件为 logback-confignode.xml 和 logback-datanode.xml,可以根据需要进行精细配置。

### 修改内存配置
内存配置文件为 confignode-env.sh 和 datanode-env.sh。堆内存 MAX_HEAP_SIZE 和 HEAP_NEWSIZE, 堆外内存 MAX_DIRECT_MEMORY_SIZE。例如:`MAX_HEAP_SIZE=8G, HEAP_NEWSIZE=8G, MAX_DIRECT_MEMORY_SIZE=2G`

## 升级
1. 获取新的镜像
2. 修改 docker-compose 文件的 image
3. 使用 docker stop 和 docker rm 命令,停止运行的 docker 容器
4. 启动 IoTDB: `docker-compose -f docker-compose-standalone.yml up -d`

## 设置开机自启动
1. 修改 docker-compose 文件,每个docker 容器配置:`restart: always`
2. 将 docker 服务设置为开机自启动
以 CentOS 操作系统为例: `systemctl enable docker`
22 changes: 22 additions & 0 deletions src/zh/UserGuide/V1.1.x/QuickStart/WayToGetIoTDB.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,3 +210,25 @@ services:
3. 需要映射`/etc/hosts`,文件内配置了 iotdb-1、iotdb-2、iotdb-3 与IP的映射。或者可以在 docker-compose 文件中增加 `extra_hosts` 配置。
4. 首次启动时,必须首先启动 `iotdb-1`。
5. 如果部署失败要重新部署集群,必须将所有节点上的IoTDB服务停止并删除,然后清除`data`和`logs`文件夹后,再启动。

## 配置
IoTDB 的配置文件,都在安装目录的conf目录下。
IoTDB 本身配置都可以在 docker-compose 文件的 environment 中进行配置。
如果对日志和内存进行了自定义配置,那么需要将`conf`目录映射出来。

### 修改日志级别
日志配置文件为 logback-confignode.xml 和 logback-datanode.xml,可以根据需要进行精细配置。

### 修改内存配置
内存配置文件为 confignode-env.sh 和 datanode-env.sh。堆内存 MAX_HEAP_SIZE 和 HEAP_NEWSIZE, 堆外内存 MAX_DIRECT_MEMORY_SIZE。例如:`MAX_HEAP_SIZE=8G, HEAP_NEWSIZE=8G, MAX_DIRECT_MEMORY_SIZE=2G`

## 升级
1. 获取新的镜像
2. 修改 docker-compose 文件的 image
3. 使用 docker stop 和 docker rm 命令,停止运行的 docker 容器
4. 启动 IoTDB

## 设置开机自启动
1. 修改 docker-compose 文件,每个docker 容器配置:`restart: always`
2. 将 docker 服务设置为开机自启动
以 CentOS 操作系统为例: `systemctl enable docker`
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Apache IoTDB 的配置项以环境变量形式添加到容器内。

```shell
# 获取镜像
docker pull apache/iotdb:1.1.0-standalone
docker pull apache/iotdb:1.2.0-standalone
# 创建 docker bridge 网络
docker network create --driver=bridge --subnet=172.18.0.0/16 --gateway=172.18.0.1 iotdb
# 创建 docker 容器
Expand All @@ -49,7 +49,7 @@ docker run -d --name iotdb-service \
-e dn_schema_region_consensus_port=10750 \
-e dn_data_region_consensus_port=10760 \
-e dn_rpc_port=6667 \
apache/iotdb:1.1.0-standalone
apache/iotdb:1.2.0-standalone
# 尝试使用命令行执行SQL
docker exec -ti iotdb-service /iotdb/sbin/start-cli.sh -h iotdb-service
```
Expand All @@ -66,7 +66,7 @@ $IOTDB_HOME/sbin/start-cli.sh -h <主机IP/hostname> -p 6667
version: "3"
services:
iotdb-service:
image: apache/iotdb:1.1.0-standalone
image: apache/iotdb:1.2.0-standalone
hostname: iotdb-service
container_name: iotdb-service
ports:
Expand Down Expand Up @@ -106,7 +106,7 @@ networks:
version: "3"
services:
iotdb-confignode:
image: apache/iotdb:1.1.0-confignode
image: apache/iotdb:1.2.0-confignode
container_name: iotdb-confignode
environment:
- cn_internal_address=iotdb-2
Expand All @@ -125,7 +125,7 @@ services:
network_mode: "host"

iotdb-datanode:
image: apache/iotdb:1.1.0-datanode
image: apache/iotdb:1.2.0-datanode
container_name: iotdb-datanode
environment:
- dn_rpc_address=iotdb-2
Expand Down Expand Up @@ -153,4 +153,27 @@ services:
2. 上面docker-compose文件中,`iotdb-2`需要替换为每个节点的 hostname、域名或者IP地址。
3. 需要映射`/etc/hosts`,文件内配置了 iotdb-1、iotdb-2、iotdb-3 与IP的映射。或者可以在 docker-compose 文件中增加 `extra_hosts` 配置。
4. 首次启动时,必须首先启动 `iotdb-1`。
5. 如果部署失败要重新部署集群,必须将所有节点上的IoTDB服务停止并删除,然后清除`data`和`logs`文件夹后,再启动。
5. 如果部署失败要重新部署集群,必须将所有节点上的IoTDB服务停止并删除,然后清除`data`和`logs`文件夹后,再启动。


## 配置
IoTDB 的配置文件,都在安装目录的conf目录下。
IoTDB 本身配置都可以在 docker-compose 文件的 environment 中进行配置。
如果对日志和内存进行了自定义配置,那么需要将`conf`目录映射出来。

### 修改日志级别
日志配置文件为 logback-confignode.xml 和 logback-datanode.xml,可以根据需要进行精细配置。

### 修改内存配置
内存配置文件为 confignode-env.sh 和 datanode-env.sh。堆内存 MAX_HEAP_SIZE 和 HEAP_NEWSIZE, 堆外内存 MAX_DIRECT_MEMORY_SIZE。例如:`MAX_HEAP_SIZE=8G, HEAP_NEWSIZE=8G, MAX_DIRECT_MEMORY_SIZE=2G`

## 升级
1. 获取新的镜像
2. 修改 docker-compose 文件的 image
3. 使用 docker stop 和 docker rm 命令,停止运行的 docker 容器
4. 启动 IoTDB

## 设置开机自启动
1. 修改 docker-compose 文件,每个docker 容器配置:`restart: always`
2. 将 docker 服务设置为开机自启动
以 CentOS 操作系统为例: `systemctl enable docker`
Original file line number Diff line number Diff line change
Expand Up @@ -156,4 +156,27 @@ services:
2. 上面docker-compose文件中,`iotdb-2`需要替换为每个节点的 hostname、域名或者IP地址。
3. 需要映射`/etc/hosts`,文件内配置了 iotdb-1、iotdb-2、iotdb-3 与IP的映射。或者可以在 docker-compose 文件中增加 `extra_hosts` 配置。
4. 首次启动时,必须首先启动 `iotdb-1`。
5. 如果部署失败要重新部署集群,必须将所有节点上的IoTDB服务停止并删除,然后清除`data`和`logs`文件夹后,再启动。
5. 如果部署失败要重新部署集群,必须将所有节点上的IoTDB服务停止并删除,然后清除`data`和`logs`文件夹后,再启动。


## 配置
IoTDB 的配置文件,都在安装目录的conf目录下。
IoTDB 本身配置都可以在 docker-compose 文件的 environment 中进行配置。
如果对日志和内存进行了自定义配置,那么需要将`conf`目录映射出来。

### 修改日志级别
日志配置文件为 logback-confignode.xml 和 logback-datanode.xml,可以根据需要进行精细配置。

### 修改内存配置
内存配置文件为 confignode-env.sh 和 datanode-env.sh。堆内存 ON_HEAP_MEMORY, 堆外内存 OFF_HEAP_MEMORY。例如:`ON_HEAP_MEMORY=8G, OFF_HEAP_MEMORY=2G`

## 升级
1. 获取新的镜像
2. 修改 docker-compose 文件的 image
3. 使用 docker stop 和 docker rm 命令,停止运行的 docker 容器
4. 启动 IoTDB

## 设置开机自启动
1. 修改 docker-compose 文件,每个docker 容器配置:`restart: always`
2. 将 docker 服务设置为开机自启动
以 CentOS 操作系统为例: `systemctl enable docker`