Skip to content

Commit

Permalink
docs: update cert-manager installation
Browse files Browse the repository at this point in the history
  • Loading branch information
jacky-xbb committed Aug 9, 2023
1 parent 1f393f7 commit 2b841e9
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 58 deletions.
18 changes: 0 additions & 18 deletions docs/en_US/deployment/on-gcp-gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,6 @@ Before you begin, you must have the following:

- To install EMQX Operator, please refer to [Install EMQX Operator](../getting-started/getting-started.md)


## Install cert-manager

```yaml
$ helm repo add jetstack https://charts.jetstack.io
$ helm repo update
$ helm install \
cert-manager jetstack/cert-manager \
--namespace cert-manager \
--create-namespace \
--set installCRDs=true \
--set global.leaderElection.namespace=cert-manager
```

::: warning
The default configuration of installing cert-manager may cause bootstrapping issues. Therefore, by using the configuration of `global.leaderElection.namespacer`, `cert-manager` is configured to use a different namespace in leader election.
:::

## Quickly deploying an EMQX cluster

Here are the relevant configurations for EMQX Custom Resource. You can choose the corresponding APIVersion based on the version of EMQX you wish to deploy. For specific compatibility relationships, please refer to [EMQX Operator Compatibility](../index.md):
Expand Down
2 changes: 1 addition & 1 deletion docs/en_US/getting-started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ 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. Please check [GKE deployment document](../deployment/on-gcp-gke.md).
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/)
:::


Expand Down
14 changes: 3 additions & 11 deletions docs/en_US/tasks/configure-emqx-core-replicant.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ There must be at least one Core node in the EMQX cluster. For the purpose of hig
replicas: 3
resources:
requests:
cpu: 100m
memory: 256Mi
cpu: 250m
memory: 512Mi
replicantTemplate:
spec:
replicas: 3
resources:
requests:
cpu: 100m
cpu: 250m
memory: 512Mi
dashboardServiceTemplate:
spec:
Expand All @@ -51,14 +51,6 @@ There must be at least one Core node in the EMQX cluster. For the purpose of hig
> 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.
::: warning
If you want to request CPU and memory resources Google Kubernetes Engine (GKE) , you need to ensure that the CPU is greater than or equal to 250m and the memory is greater than or equal to 512M on both of core and replicant nodes.
- [Resource requests in Autopilot](https://cloud.google.com/kubernetes-engine/docs/concepts/autopilot-resource-requests)
:::
+ 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

```bash
Expand Down
18 changes: 0 additions & 18 deletions docs/zh_CN/deployment/on-gcp-gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,6 @@ EMQX 是一款高性能的开源分布式物联网 MQTT 消息服务器,它提

- 要安装 EMQX Operator,请参考 [安装 EMQX Operator](../getting-started/getting-started.md)

## 安装 cert-manager

```yaml
$ helm repo add jetstack https://charts.jetstack.io
$ helm repo update
$ helm install \
cert-manager jetstack/cert-manager \
--namespace cert-manager \
--create-namespace \
--set installCRDs=true \
--set global.leaderElection.namespace=cert-manager
```

::: warning
默认配置安装 cert-manager 可能会导致 bootstrapping 问题。所以通过 `global.leaderElection.namespacer` 这个配置将 `cert-manager` 配置为在 leader 选举中使用不同的命名空间。
:::


## 快速部署 EMQX 集群

以下是 EMQX 自定义资源的相关配置。您可以根据您希望部署的 EMQX 版本选择相应的 APIVersion。有关具体的兼容关系,请参阅 [EMQX Operator 兼容性](../index.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/getting-started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
或者按照 [cert-manager 安装指南](https://cert-manager.io/docs/installation/)来安装它。

::: warning
如果您在Google Kubernetes Engine(GKE)上安装它。那么通过默认配置安装可能会导致 bootstraping 问题。请查看 [GKE 部署文档](../deployment/on-gcp-gke.md)。
如果您在Google Kubernetes Engine(GKE)上安装它。那么通过默认配置安装可能会导致 bootstraping 问题。所以通过增加 `--set global.leaderElection.namespace=cert-manager` 这个配置为 leader 选举使用不同的命名空间。查看 [cert-manager 兼容性](https://cert-manager.io/docs/installation/compatibility/)
:::

2. 运行以下命令来安装 EMQX Operator。
Expand Down
12 changes: 3 additions & 9 deletions docs/zh_CN/tasks/configure-emqx-core-replicant.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ EMQX 集群中至少要有一个 Core 节点,出于高可用的目的,EMQX O
replicas: 3
resources:
requests:
cpu: 100m
memory: 256Mi
cpu: 250m
memory: 512Mi
replicantTemplate:
spec:
replicas: 3
resources:
requests:
cpu: 100m
cpu: 250m
memory: 512Mi
dashboardServiceTemplate:
spec:
Expand All @@ -51,12 +51,6 @@ EMQX 集群中至少要有一个 Core 节点,出于高可用的目的,EMQX O
> 上文的 YAML 中,我们声明了这是一个由三个 Core 节点和三个 Replicant 节点组成的 EMQX 集群。Core 节点最低需要 256Mi 内存 ,Replicant 节点最低需要512Mi 内存。在实际业务中,Replicant 节点会接受全部的客户端请求,所以 Replicant 节点需要的资源会更高一些。
::: warning
如果要在 Google Kubernetes Engine (GKE) 请求 cpu 和 memory 资源,需要保证在 core 和 replicant 节点上的 cpu 大于等于 250m,memory 大于等于 512M
- [Autopilot 中的资源请求](https://cloud.google.com/kubernetes-engine/docs/concepts/autopilot-resource-requests?hl=zh-cn)
:::
+ 等待 EMQX 集群就绪,可以通过 `kubectl get` 命令查看 EMQX 集群的状态,请确保 `STATUS` 为 `Running`,这个可能需要一些时间

```
Expand Down

0 comments on commit 2b841e9

Please sign in to comment.