Skip to content

Commit

Permalink
docs: update license config
Browse files Browse the repository at this point in the history
Signed-off-by: Rory Z <[email protected]>
  • Loading branch information
Rory-Z committed Jul 24, 2023
1 parent 0e1d1f8 commit dfdec5e
Show file tree
Hide file tree
Showing 8 changed files with 163 additions and 95 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
127 changes: 80 additions & 47 deletions docs/en_US/tasks/configure-emqx-license.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,62 @@ The following is the relevant configuration of EMQX Custom Resource. You can cho

## Update License

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

+ View License information
```bash
$ pod_name="$(kubectl get pods -l 'apps.emqx.io/instance=emqx,apps.emqx.io/db-role=core' -o json | jq --raw-output '.items[0].metadata.name')"
$ kubectl exec -it ${pod_name} -c emqx -- emqx_ctl license info
```

The following output can be obtained. From the output, we can see the basic information of the license we applied for, including applicant's information, maximum connection supported by the license, and expiration time of the license.
```bash
customer : Evaluation
email : [email protected]
deployment : default
max_connections : 100
start_at : 2023-01-09
expiry_at : 2028-01-08
type : trial
customer_type : 10
expiry : false
```

+ Modify EMQX custom resources to update the License.
```bash
$ kubectl edit emqx emqx-ee
...
spec:
image: emqx/emqx-enterprise:5.1.0
config:
data: |
license {
key = "${new_license_key}"
}
...
```

+ Check if the EMQX cluster license has been updated.
```bash
$ pod_name="$(kubectl get pods -l 'apps.emqx.io/instance=emqx,apps.emqx.io/db-role=core' -o json | jq --raw-output '.items[0].metadata.name')"
$ kubectl exec -it ${pod_name} -c emqx -- emqx_ctl license info
```

It can be seen from the "max_connections" field that the content of the License has been updated, indicating that the EMQX Enterprise Edition License update is successful. If the certificate information is not updated, you can wait for a while as there may be some delay in updating the License.
```bash
customer : Evaluation
email : [email protected]
deployment : default
max_connections : 100000
start_at : 2023-01-09
expiry_at : 2028-01-08
type : trial
customer_type : 10
expiry : false
```
:::
::: tab apps.emqx.io/v1beta4
+ View License Information

```bash
Expand All @@ -143,55 +199,32 @@ The following is the relevant configuration of EMQX Custom Resource. You can cho
expiry : false
```

+ Update License
:::: tabs type:card
::: tab apps.emqx.io/v2alpha2

+ Update License through EMQX Dashboard

Open the browser, enter Dashboard, click Overview and pull down the page to the bottom to see the current license information of the cluster, as shown in the following figure:

![](./assets/configure-emqx-license/emqx-dashboard-license.png)

Then click the **Update License** button to upload the latest License Key content, as shown in the following figure:

![](./assets/configure-emqx-license/emqx-license-upload.png)

Finally, click the **Save** button to save the update. The following picture shows the updated License information:

![](./assets/configure-emqx-license/emqx-license-update.png)
+ Update EMQX Enterprise License Secret

As can be seen from the above figure, the content of the license has been updated, which means that the license has been updated successfully.

:::
::: tab apps.emqx.io/v1beta4

+ Update EMQX Enterprise License Secret

```bash
$ kubectl create secret generic ${your_license_name} --from-file=emqx.lic=${/path/to/license/file} --dry-run -o yaml | kubectl apply -f -
```
```bash
$ kubectl create secret generic ${your_license_name} --from-file=emqx.lic=${/path/to/license/file} --dry-run -o yaml | kubectl apply -f -
```

+ Check whether the EMQX cluster license has been updated
+ Check whether the EMQX cluster license has been updated

```bash
$ kubectl exec -it emqx-ee-0 -c emqx -- emqx_ctl license info
```
```bash
$ kubectl exec -it emqx-ee-0 -c emqx -- emqx_ctl license info
```

You can get information similar to the following. From the `max_connections` field, you can see that the content of the License has been updated, which means that the EMQX Enterprise Edition License has been updated successfully. If the certificate information is not updated, you can wait for a while, the update of the license will be delayed.
You can get information similar to the following. From the `max_connections` field, you can see that the content of the License has been updated, which means that the EMQX Enterprise Edition License has been updated successfully. If the certificate information is not updated, you can wait for a while, the update of the license will be delayed.

```bash
customer : cloudnative
email : [email protected]
max_connections : 100000
original_max_connections : 100000
issued_at : 2022-11-21 02:49:35
expiry_at : 2022-12-01 02:49:35
vendor : EMQ Technologies Co., Ltd.
version : 4.4.14
type : official
customer_type : 2
expiry : false
```
:::
::::
```bash
customer : cloudnative
email : [email protected]
max_connections : 100000
original_max_connections : 100000
issued_at : 2022-11-21 02:49:35
expiry_at : 2022-12-01 02:49:35
vendor : EMQ Technologies Co., Ltd.
version : 4.4.14
type : official
customer_type : 2
expiry : false
```
:::
::::
Binary file not shown.
Binary file not shown.
Binary file not shown.
131 changes: 83 additions & 48 deletions docs/zh_CN/tasks/configure-emqx-license.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ EMQX 企业版 License 可以在 EMQ 官网免费申请:[申请 EMQX 企业版
config:
data: |
license {
key = "..."
key = "${your_license_key}"
}
image: emqx/emqx-enterprise:5.1.0
listenersServiceTemplate:
Expand Down Expand Up @@ -125,6 +125,64 @@ EMQX 企业版 License 可以在 EMQ 官网免费申请:[申请 EMQX 企业版

## 更新 License

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

+ 查看 License 信息

```bash
$ pod_name="$(kubectl get pods -l 'apps.emqx.io/instance=emqx,apps.emqx.io/db-role=core' -o json | jq --raw-output '.items[0].metadata.name')"
$ kubectl exec -it ${pod_name} -c emqx -- emqx_ctl license info
```

可以获取到如下输出,从输出结果可以看到我们申请的 License 的基本信息,包括申请人的信息和 License 支持最大连接数以及 License 过期时间等。
```bash
customer : Evaluation
email : [email protected]
deployment : default
max_connections : 100
start_at : 2023-01-09
expiry_at : 2028-01-08
type : trial
customer_type : 10
expiry : false
```

+ 修改 EMQX 自定义资源以更新 License
```bash
$ kubectl edit emqx emqx-ee
...
spec:
image: emqx/emqx-enterprise:5.1.0
config:
data: |
license {
key = "${new_license_key}"
}
...
```

+ 查看 EMQX 集群 License 是否被更新

```bash
$ pod_name="$(kubectl get pods -l 'apps.emqx.io/instance=emqx,apps.emqx.io/db-role=core' -o json | jq --raw-output '.items[0].metadata.name')"
$ kubectl exec -it ${pod_name} -c emqx -- emqx_ctl license info
```
可以获取到类似如下的信息,从获取到 `max_connections` 字段可以看出 License 的内容已经更新,则说明 EMQX 企业版 License 更新成功。若证书信息没有更新,可以等待一会,License 的更新会有些时延。

```bash
customer : Evaluation
email : [email protected]
deployment : default
max_connections : 100000
start_at : 2023-01-09
expiry_at : 2028-01-08
type : trial
customer_type : 10
expiry : false
```
:::
::: tab apps.emqx.io/v1beta4
+ 查看 License 信息

```bash
Expand All @@ -145,54 +203,31 @@ EMQX 企业版 License 可以在 EMQ 官网免费申请:[申请 EMQX 企业版
expiry : false
```

+ 更新 License
:::: tabs type:card
::: tab apps.emqx.io/v2alpha2

+ 通过 EMQX Dashboard 更新 License

打开浏览器,进入 Dashboard 点击 Overview 将页面下拉到底部可以看到集群当前的 License 信息,如下图所示:

![](./assets/configure-emqx-license/emqx-dashboard-license.png)

然后点击 **Update License** 按钮上传最新的 License Key 内容,如下图所示:

![](./assets/configure-emqx-license/emqx-license-upload.png)
+ 更新 EMQX 企业版 License Secret

最后点击 **Save** 按钮保存更新,下图是更新后的 License 信息:

![](./assets/configure-emqx-license/emqx-license-update.png)

从上面的图中可以看出,License 的内容已经更新,则说明 License 更新成功。

:::
::: tab apps.emqx.io/v1beta4
```bash
$ kubectl create secret generic ${your_license_name} --from-file=emqx.lic=${/path/to/license/file} --dry-run -o yaml | kubectl apply -f -
```
+ 查看 EMQX 集群 License 是否被更新

+ 更新 EMQX 企业版 License Secret
```bash
$ kubectl exec -it emqx-ee-0 -c emqx -- emqx_ctl license info
```

```bash
$ kubectl create secret generic ${your_license_name} --from-file=emqx.lic=${/path/to/license/file} --dry-run -o yaml | kubectl apply -f -
```
+ 查看 EMQX 集群 License 是否被更新
可以获取到类似如下的信息,从获取到 `max_connections` 字段可以看出 License 的内容已经更新,则说明 EMQX 企业版 License 更新成功。若证书信息没有更新,可以等待一会,License 的更新会有些时延。

```bash
$ kubectl exec -it emqx-ee-0 -c emqx -- emqx_ctl license info
```

可以获取到类似如下的信息,从获取到 `max_connections` 字段可以看出 License 的内容已经更新,则说明 EMQX 企业版 License 更新成功。若证书信息没有更新,可以等待一会,License 的更新会有些时延。

```bash
customer : cloudnative
email : [email protected]
max_connections : 100000
original_max_connections : 100000
issued_at : 2022-11-21 02:49:35
expiry_at : 2022-12-01 02:49:35
vendor : EMQ Technologies Co., Ltd.
version : 4.4.14
type : official
customer_type : 2
expiry : false
```
:::
::::
```bash
customer : cloudnative
email : [email protected]
max_connections : 100000
original_max_connections : 100000
issued_at : 2022-11-21 02:49:35
expiry_at : 2022-12-01 02:49:35
vendor : EMQ Technologies Co., Ltd.
version : 4.4.14
type : official
customer_type : 2
expiry : false
```
:::
::::

0 comments on commit dfdec5e

Please sign in to comment.