Skip to content

Commit

Permalink
Prepare for 2.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
@popduke
popduke committed Dec 15, 2023
1 parent 4bd760d commit cb53daa
Show file tree
Hide file tree
Showing 71 changed files with 81 additions and 71 deletions.
8 changes: 7 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,15 @@ And you can contribute to the documentation in the GitHub repository [bifromq-do

### Docker
```
docker run -d --name bifromq -p 1883:1883 bifromq/bifromq:latest
docker run -d -m <MEM_LIMIT> -e MEM_LIMIT='<MEM_LIMIT_IN_BYTES>' --name bifromq -p 1883:1883 bifromq/bifromq:latest
```

Substitute `<MEM_LIMIT>` and `<MEM_LIMIT_IN_BYTES>` with the actual memory allocation for the Docker process, for
example, `2G` for `<MEM_LIMIT>` and `2147483648` for `<MEM_LIMIT_IN_BYTES>`. If not specified, BifroMQ defaults to using
the hosting server's physical memory for determining JVM parameters. This can result in the Docker process being
terminated by the host's Out-of-Memory (OOM) Killer. Refer to [here](https://bifromq.io/docs/deploy/deploy_with_docker/)
for more information.

### Build from source

#### Prerequisites
Expand Down
6 changes: 5 additions & 1 deletion README.zh_Hans.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,13 @@ BifroMQ 是一个高性能的分布式 MQTT Broker 消息中间件实现，无

### Docker
```
docker run -d --name bifromq -p 1883:1883 bifromq/bifromq:latest
docker run -d -m <MEM_LIMIT> -e MEM_LIMIT='<MEM_LIMIT_IN_BYTES>' --name bifromq -p 1883:1883 bifromq/bifromq:latest
```

将`<MEM_LIMIT>`和`<MEM_LIMIT_IN_BYTES>`替换为 Docker 进程的实际内存分配，例如，使用`2G`替换`<MEM_LIMIT>`，使用 `2147483648`
替换`<MEM_LIMIT_IN_BYTES>`。如果未指定这些值，BifroMQ 默认使用宿主服务器的物理内存来确定JVM参数。这可能导致 Docker
进程被宿主机的OOM Killer终止，更多供信息[参考](https://bifromq.io/docs/deploy/deploy_with_docker/)。

### 从源码构建

#### 预备条件
Expand Down
2 changes: 1 addition & 1 deletion base-cluster/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<parent>
<artifactId>bifromq-parent</artifactId>
<groupId>com.baidu.bifromq</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-cluster</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-crdt/base-crdt-service/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>base-crdt</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion base-crdt/base-crdt-store/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>base-crdt</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-crdt-store</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-crdt/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-parent</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<packaging>pom</packaging>

Expand Down
2 changes: 1 addition & 1 deletion base-env/base-env-provider-spi/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>base-env</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-env-provider-spi</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-env/base-env-provider/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>base-env</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-env-provider</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-env/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-parent</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion base-hlc/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-parent</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-hlc</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-hookloader/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-parent</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-hookloader</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-kv/base-kv-local-engine/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>base-kv</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-kv-local-engine</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-kv/base-kv-raft-type/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>base-kv</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-kv-raft-type</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-kv/base-kv-raft/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>base-kv</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-kv-raft</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-kv/base-kv-store-balance-controller/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<artifactId>base-kv</artifactId>
<groupId>com.baidu.bifromq</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion base-kv/base-kv-store-balance-spi/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<artifactId>base-kv</artifactId>
<groupId>com.baidu.bifromq</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion base-kv/base-kv-store-client/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>base-kv</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-kv-store-client</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-kv/base-kv-store-rpc-definition/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>base-kv</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-kv-store-rpc-definition</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-kv/base-kv-store-server/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>base-kv</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-kv-store-server</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-kv/base-kv-type-proto/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>base-kv</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-kv-type-proto</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-kv/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<artifactId>bifromq-parent</artifactId>
<groupId>com.baidu.bifromq</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<packaging>pom</packaging>

Expand Down
2 changes: 1 addition & 1 deletion base-logger/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-parent</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-logger</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-rpc/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<artifactId>bifromq-parent</artifactId>
<groupId>com.baidu.bifromq</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>base-rpc</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion base-scheduler/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<artifactId>bifromq-parent</artifactId>
<groupId>com.baidu.bifromq</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion bifromq-apiserver/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-parent</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>bifromq-apiserver</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bifromq-common-type/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<artifactId>bifromq-parent</artifactId>
<groupId>com.baidu.bifromq</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion bifromq-dist/bifromq-dist-client/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-dist</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>bifromq-dist-client</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bifromq-dist/bifromq-dist-coproc-proto/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-parent</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion bifromq-dist/bifromq-dist-rpc-definition/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-dist</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion bifromq-dist/bifromq-dist-server/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-dist</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>bifromq-dist-server</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bifromq-dist/bifromq-dist-spi/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-dist</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>bifromq-dist-spi</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bifromq-dist/bifromq-dist-worker/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-dist</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>bifromq-dist-worker</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bifromq-dist/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<artifactId>bifromq-parent</artifactId>
<groupId>com.baidu.bifromq</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion bifromq-inbox/bifromq-inbox-client/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-inbox</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>bifromq-inbox-client</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bifromq-inbox/bifromq-inbox-coproc-proto/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-inbox</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>bifromq-inbox-coproc-proto</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bifromq-inbox/bifromq-inbox-gc/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<artifactId>bifromq-inbox</artifactId>
<groupId>com.baidu.bifromq</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion bifromq-inbox/bifromq-inbox-rpc-definition/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-inbox</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>bifromq-inbox-rpc-definition</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bifromq-inbox/bifromq-inbox-server/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-inbox</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion bifromq-inbox/bifromq-inbox-store/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-inbox</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>bifromq-inbox-store</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bifromq-inbox/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<artifactId>bifromq-parent</artifactId>
<groupId>com.baidu.bifromq</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<packaging>pom</packaging>

Expand Down
2 changes: 1 addition & 1 deletion bifromq-metrics/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<artifactId>bifromq-parent</artifactId>
<groupId>com.baidu.bifromq</groupId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion bifromq-mqtt/bifromq-mqtt-broker-client/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>com.baidu.bifromq</groupId>
<artifactId>bifromq-mqtt</artifactId>
<version>2.1.0-SNAPSHOT</version>
<version>2.1.0</version>
</parent>

<artifactId>bifromq-mqtt-broker-client</artifactId>
Expand Down
Loading

0 comments on commit cb53daa

Please sign in to comment.