Skip to content

Commit

Permalink
docs: update core and replicant configuratin
Browse files Browse the repository at this point in the history
  • Loading branch information
jacky-xbb committed Aug 9, 2023
1 parent 2b841e9 commit ffc94d9
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/en_US/getting-started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ Before deploying EMQX Operator, please confirm that the following components hav

Or you can follow the [cert-manager installation guide](https://cert-manager.io/docs/installation/) to install it.

::: warning
If you install cert-manager on Google Kubernetes Engine (GKE) with default configuration may cause bootstrapping issues. Therefore, by adding the configuration of `--set global.leaderElection.namespace=cert-manager`, configure to use a different namespace in leader election. Please check [cert-manager compatibility](https://cert-manager.io/docs/installation/compatibility/)
:::
::: warning
If you install cert-manager on Google Kubernetes Engine (GKE) with default configuration may cause bootstrapping issues. Therefore, by adding the configuration of `--set global.leaderElection.namespace=cert-manager`, configure to use a different namespace in leader election. Please check [cert-manager compatibility](https://cert-manager.io/docs/installation/compatibility/)
:::


2. Install the EMQX Operator with the command below:
Expand Down
6 changes: 3 additions & 3 deletions docs/en_US/tasks/configure-emqx-core-replicant.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ There must be at least one Core node in the EMQX cluster. For the purpose of hig
image: emqx:5.1
coreTemplate:
spec:
replicas: 3
replicas: 2
resources:
requests:
cpu: 250m
Expand All @@ -43,13 +43,13 @@ There must be at least one Core node in the EMQX cluster. For the purpose of hig
resources:
requests:
cpu: 250m
memory: 512Mi
memory: 1Gi
dashboardServiceTemplate:
spec:
type: LoadBalancer
```
> In the YAML above, we declared that this is an EMQX cluster consisting of three Core nodes and three Replicant nodes. Core nodes require a minimum of 256Mi of memory, and Replicant nodes require a minimum of 512Mi of memory. In actual business, the Replicant node will accept all client requests, so the resources required by the Replicant node will be higher.
> In the YAML above, we declared that this is an EMQX cluster consisting of two Core nodes and three Replicant nodes. Core nodes require a minimum of 512Mi of memory, and Replicant nodes require a minimum of 1Gi of memory. You can adjust according to the actual business load. In actual business, the Replicant node will accept all client requests, so the resources required by the Replicant node will be higher.
+ Wait for the EMQX cluster to be ready, you can check the status of EMQX cluster through `kubectl get` command, please make sure `STATUS` is `Running`, this may take some time

Expand Down
6 changes: 3 additions & 3 deletions docs/zh_CN/tasks/configure-emqx-core-replicant.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ EMQX 集群中至少要有一个 Core 节点,出于高可用的目的,EMQX O
image: emqx:5.1
coreTemplate:
spec:
replicas: 3
replicas: 2
resources:
requests:
cpu: 250m
Expand All @@ -43,13 +43,13 @@ EMQX 集群中至少要有一个 Core 节点,出于高可用的目的,EMQX O
resources:
requests:
cpu: 250m
memory: 512Mi
memory: 1Gi
dashboardServiceTemplate:
spec:
type: LoadBalancer
```
> 上文的 YAML 中,我们声明了这是一个由三个 Core 节点和三个 Replicant 节点组成的 EMQX 集群。Core 节点最低需要 256Mi 内存 ,Replicant 节点最低需要512Mi 内存。在实际业务中,Replicant 节点会接受全部的客户端请求,所以 Replicant 节点需要的资源会更高一些。
> 上文的 YAML 中,我们声明了这是一个由二个 Core 节点和三个 Replicant 节点组成的 EMQX 集群。Core 节点最低需要 512Mi 内存 ,Replicant 节点最低需要 1Gi 内存。你可以根据实际的业务负载进行调整。在实际业务中,Replicant 节点会接受全部的客户端请求,所以 Replicant 节点需要的资源会更高一些。
+ 等待 EMQX 集群就绪,可以通过 `kubectl get` 命令查看 EMQX 集群的状态,请确保 `STATUS` 为 `Running`,这个可能需要一些时间

Expand Down

0 comments on commit ffc94d9

Please sign in to comment.