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

fix(installation): Hide "Hardware Specification" section in installation.md #2435

Merged
merged 1 commit into from
May 7, 2024
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
1 change: 1 addition & 0 deletions dir.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
path: deploy/license
- title_en: Upgrade Guide
title_cn: 升级指南
collapsed: true
children:
- title_en: Rolling Upgrade
title_cn: 滚动升级
Expand Down
12 changes: 2 additions & 10 deletions en_US/deploy/cluster/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,16 +85,8 @@ To use this feature:

Then EMQX will keep the previous session data associated with the Client ID when the client disconnects. If this client reconnects, EMQX will resume the previous sessions, deliver any messages that were queued during the client's disconnection, and maintain the client's subscriptions.

## Network and Hardware Specifications
## Network Requirements

Below are the network requirements and hardware specifications recommend to run EMQX clusters.

**Network**

Network latency: < 10 ms. The cluster will not be available if the latency is higher than 100 ms.
To ensure optimal performance, the network latency for operating EMQX clusters should be less than 10 milliseconds. The cluster will not be available if the latency is higher than 100 ms.

The core nodes should be under the same private network. In Mria+RLOG mode, it is also recommended to deploy the replicant nodes in the same private network.

**CPU and Memory**

You can use the [Server Estimate](https://www.emqx.com/en/server-estimate) to calculate the CPU and memory resources needed under various connections and Pub&Sub TPS. It is recommended to configure a higher memory of the Core nodes.
26 changes: 13 additions & 13 deletions en_US/deploy/install.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
{% emqxee %}
# Installation EMQX Enterprise
{% endemqxee %}

{% emqxce %}
# Installation EMQX
{% endemqxce %}
# Installation and Migration


This chapter walks you through the basic installation steps for EMQX, the minimum hardware specification, and the file and directory locations to facilitate future configuration and maintenance jobs.

{% emqxee %}

This chapter will also cover how to configure a license for EMQX and how to migrate from EMQX 4.4 to EMQX 5.1.
This chapter also covers how to configure a license for EMQX and how to migrate from EMQX 4.4 to EMQX 5.1.

{% endemqxee %}

{% emqxce %}

This chapter also covers how to migrate from EMQX 4.4 to EMQX 5.1.

{% endemqxce %}

## Installation Environment

The Erlang VM powering EMQX relies on system locale settings to enable Unicode support for various functionalities, including [filenames](https://www.erlang.org/doc/apps/stdlib/unicode_usage.html#unicode-filenames) and [terminal IO](https://www.erlang.org/doc/apps/stdlib/unicode_usage.html#the-interactive-shell) in interactive Erlang shells.
Expand Down Expand Up @@ -82,14 +82,14 @@ sudo update-locale LANG=C.UTF-8

EMQX releases the installation packages for different operating systems or platforms in each release. You may click the links below to download.

- EMQX website: <https://www.emqx.io/downloads>
EMQX website: <https://www.emqx.io/downloads>

You can also download the alpha, beta, or rc versions from our [GitHub pages](https://github.com/emqx/emqx/releases).
{% endemqxce %}

{% emqxee %}

EMQX releases the corresponding Docker image and the installation packages for different operating systems or platforms in each release. You may click the link below to download.
EMQX releases the corresponding Docker image and the installation packages for different operating systems or platforms in each release. You may click the link below to download it.

EMQX website: <https://www.emqx.com/en/try?product=enterprise>

Expand Down Expand Up @@ -128,9 +128,9 @@ The table below lists the operating systems and versions that EMQX supports.

{% endemqxee %}

## Hardware Specification
## <!--Hardware Specification

Depending on the number of client connections, message rate, message size, and enabled features, the minimum hardware specification for EMQX varies.
Depending on the number of client connections, message rate, message size, and enabled features, the minimum hardware specification for EMQX varies.

Below are hardware specifications for running EMQX with simple workloads, supporting 100,000 client connections and 100,000 messages per second of throughput.

Expand All @@ -145,7 +145,7 @@ Below are hardware specifications for running EMQX with simple workloads, suppor

In production environments, you can use the [Server Estimate](https://www.emqx.com/en/server-estimate) calculator to calculate the recommended hardware specification under various maximum connections and message throughput.

:::
::: -->

## Files and Directories

Expand Down
2 changes: 1 addition & 1 deletion en_US/faq/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ The following factors will have an impact on EMQX resource consumption, mainly o

If client devices connect to EMQX through TLS, more CPU resource is required for encryption and decryption. Our suggested solution is to add a load balancer in front of EMQX nodes, the TLS is offloaded at load balance node, connections between load balancer and backend EMQX nodes use plain TCP connections.

You can use our online calculation tool [https://www.emqx.com/en/server-estimate](https://www.emqx.com/en/server-estimate) to estimate the resource consumption.
<!-- You can use our online calculation tool [https://www.emqx.com/en/server-estimate](https://www.emqx.com/en/server-estimate) to estimate the resource consumption.-->

## My connections number is small, do I still need to deploy multiple nodes in production?

Expand Down
16 changes: 11 additions & 5 deletions zh_CN/deploy/install.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
# 概览
# 安装部署和迁移

本章将向您介绍如何下载和安装 EMQX,运行 EMQX 所需满足的最低硬件规则,以及安装完成后 EMQX 所在目录的文件夹结构,以便后续的配置和维护操作。
本章将向您介绍如何下载和安装 EMQX,支持的操作系统和平台,以及安装完成后 EMQX 所在目录的文件夹结构,以便后续的配置和维护操作。

{% emqxee %}

本章还将介绍许可证的配置,以及如何从 EMQX 4.4 迁移至 EMQX 5.1。
本章还介绍了许可证的配置,以及如何从 EMQX 4.4 迁移至 EMQX 5.1。

{% endemqxee %}

{% emqxce %}

本章还介绍了如何从 EMQX 4.4 迁移至 EMQX 5.1。

{% endemqxce %}

## 安装环境

EMQX 所使用的 Erlang 虚拟机依赖于系统区域设置来启用各种功能的 Unicode 支持,包括交互式 Erlang Shell 中的[文件名](https://www.erlang.org/doc/apps/stdlib/unicode_usage.html#unicode-filenames)和[终端 IO](https://www.erlang.org/doc/apps/stdlib/unicode_usage.html#the-interactive-shell)。
Expand Down Expand Up @@ -120,7 +126,7 @@ EMQX 可以跨平台的在多种操作系统和硬件平台上运行,以下是

{% endemqxee %}

## 硬件规格
## <!--硬件规格

EMQX 的硬件要求根据客户端连接数、消息消息速率和消息大小以及启用的功能而异。
下面的最低硬件规格适用于运行 EMQX 并进行简单的功能验证,推荐配置能够支撑 10 万客户端连接以及每秒 10 万条消息吞吐。
Expand All @@ -136,7 +142,7 @@ EMQX 的硬件要求根据客户端连接数、消息消息速率和消息大小

在生产环境中,您可通过我们的[配置估算计算器](https://www.emqx.com/zh/server-estimate)来计算不同连接与消息吞吐下的推荐硬件规格。

:::
:::-->

## 文件和目录

Expand Down
2 changes: 1 addition & 1 deletion zh_CN/faq/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ EMQX 对资源的使用主要有以下的影响因素,每个因素都会对计

另外,如果设备通过 TLS(加密的连接)连接 EMQX,EMQX 会需要额外的资源(主要是 CPU 资源)。推荐方案是在 EMQX 前面部署负载均衡,由负载均衡节点卸载 TLS,实现职责分离。

可参考 [https://www.emqx.com/zh/server-estimate](https://www.emqx.com/zh/server-estimate) 来预估计算资源的使用
<!--可参考 [https://www.emqx.com/zh/server-estimate](https://www.emqx.com/zh/server-estimate) 来预估计算资源的使用-->

## 我的连接数目并不大,EMQX 生产环境部署需要多节点吗?

Expand Down