Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update GCP #903

Merged
merged 8 commits into from
Aug 9, 2023
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
16 changes: 5 additions & 11 deletions docs/en_US/deployment/on-gcp-gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,16 @@ Before you begin, you must have the following:

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

::: warning
For installing `cert-manager` on Google Kubernetes Engine, see the official documentation:
## Quickly deploying an EMQX cluster

- [GKE Autopilot](https://cert-manager.io/docs/installation/compatibility/#gke-autopilot)
- [Private GKE Cluster](https://cert-manager.io/docs/installation/compatibility/#gke)
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):

Remember to install CRDs when running `helm` with the `--set installCRDs=true` flag.
::: warning
If you want to request CPU and memory resources, you need to ensure that the CPU is greater than or equal to 250m and the memory is greater than or equal to 512M.

More information can be found at [cert-manager](https://cert-manager.io).
- [Resource requests in Autopilot](https://cloud.google.com/kubernetes-engine/docs/concepts/autopilot-resource-requests)
jacky-xbb marked this conversation as resolved.
Show resolved Hide resolved
:::


## 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):

:::: tabs type:card
::: tab apps.emqx.io/v2beta1

Expand Down
5 changes: 5 additions & 0 deletions docs/en_US/getting-started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ 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/)
:::


2. Install the EMQX Operator with the command below:

```bash
Expand Down
12 changes: 6 additions & 6 deletions docs/en_US/tasks/configure-emqx-core-replicant.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,24 @@ 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: 100m
memory: 256Mi
cpu: 250m
memory: 512Mi
replicantTemplate:
spec:
replicas: 3
resources:
requests:
cpu: 100m
memory: 512Mi
cpu: 250m
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
15 changes: 5 additions & 10 deletions docs/zh_CN/deployment/on-gcp-gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,16 @@ EMQX 是一款高性能的开源分布式物联网 MQTT 消息服务器,它提

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

::: warning
要在 Google Kubernetes Engine 上安装 `cert-manager`,请参阅官方文档:
## 快速部署 EMQX 集群

- [GKE Autopilot](https://cert-manager.io/docs/installation/compatibility/#gke-autopilot)
- [Private GKE Cluster](https://cert-manager.io/docs/installation/compatibility/#gke)
以下是 EMQX 自定义资源的相关配置。您可以根据您希望部署的 EMQX 版本选择相应的 APIVersion。有关具体的兼容关系,请参阅 [EMQX Operator 兼容性](../index.md):

运行 `helm` 命令时,请记得使用 `--set installCRDs=true` 标志安装 CRD。
::: warning
如果要请求 cpu 和 memory 资源,需要保证 cpu 大于等于 250m,memory 大于等于 512M

更多信息请访问 [cert-manager](https://cert-manager.io)。
- [Autopilot 中的资源请求](https://cloud.google.com/kubernetes-engine/docs/concepts/autopilot-resource-requests?hl=zh-cn)
:::

## 快速部署 EMQX 集群

以下是 EMQX 自定义资源的相关配置。您可以根据您希望部署的 EMQX 版本选择相应的 APIVersion。有关具体的兼容关系,请参阅 [EMQX Operator 兼容性](../index.md):

:::: tabs type:card
::: tab apps.emqx.io/v2beta1

Expand Down
4 changes: 4 additions & 0 deletions docs/zh_CN/getting-started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@

或者按照 [cert-manager 安装指南](https://cert-manager.io/docs/installation/)来安装它。

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

2. 运行以下命令来安装 EMQX Operator。

```bash
Expand Down
12 changes: 6 additions & 6 deletions docs/zh_CN/tasks/configure-emqx-core-replicant.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,24 @@ EMQX 集群中至少要有一个 Core 节点,出于高可用的目的,EMQX O
image: emqx:5.1
coreTemplate:
spec:
replicas: 3
replicas: 2
resources:
requests:
cpu: 100m
memory: 256Mi
cpu: 250m
memory: 512Mi
replicantTemplate:
spec:
replicas: 3
resources:
requests:
cpu: 100m
memory: 512Mi
cpu: 250m
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
Loading