From 9b65818d9d4738f9181c184e0cc9b698d2c8fb13 Mon Sep 17 00:00:00 2001
From: wawlian <xiongfeng0601@gmail.com>
Date: Fri, 21 May 2021 15:52:56 +0800
Subject: [PATCH] add resource and system requirements (#315)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: 籁鸣 <jerry.xf@alibaba-inc.com>
---
 README.md                                   |  4 ++++
 README.zh.md                                |  4 ++++
 docs/resource-and-system-requirements-cn.md | 13 +++++++++++++
 docs/resource-and-system-requirements.md    | 14 ++++++++++++++
 4 files changed, 35 insertions(+)
 create mode 100644 docs/resource-and-system-requirements-cn.md
 create mode 100644 docs/resource-and-system-requirements.md

diff --git a/README.md b/README.md
index 1791b65d5fa..b4c15f8331d 100644
--- a/README.md
+++ b/README.md
@@ -68,6 +68,10 @@ The major OpenYurt components consist of:
   reverse proxy to establish a secure network access between the cloud site control plane and the edge nodes
   that are connected to the intranet.
 
+## Before you begin
+
+[Resource and system requirements](./docs/resource-and-system-requirements.md)
+
 ## Getting started
 
 OpenYurt supports Kubernetes versions up to 1.16. Using higher Kubernetes versions may cause
diff --git a/README.zh.md b/README.zh.md
index 58b5be5365a..fc5ae90d522 100644
--- a/README.zh.md
+++ b/README.zh.md
@@ -48,6 +48,10 @@ OpenYurt 的主要组件包括：
 后者定义了一种新的边缘应用模型以节点池为单位来管理工作负载。
 - **Yurt Tunnel (server/agent)**：`TunnelServer`通过反向代理与在每个边缘节点中运行的 TunnelAgent 守护进程建立连接并以此在公共云的控制平面 与 处于 企业内网（ Intranet ）环境的边缘节点之间建立安全的网络访问。
 
+## 开始之前
+
+[资源和系统要求](./docs/resource-and-system-requirements-cn.md)
+
 ## 开始使用
 OpenYurt 支持最高版本为1.16的 Kubernetes 。使用更高版本的 Kubernetes 可能会导致兼容性问题。
 您可以[手动](docs/tutorial/manually-setup.md)设置 OpenYurt 集群，但是我们建议使用 `yurtctl` 命令行工具启动 OpenYurt 。要快速构建和安装设置 `yurtctl` ，在编译系统已安装了 golang 1.13+ 和 bash 的前提下你可以执行以下命令来完成安装：
diff --git a/docs/resource-and-system-requirements-cn.md b/docs/resource-and-system-requirements-cn.md
new file mode 100644
index 00000000000..6a90170d03e
--- /dev/null
+++ b/docs/resource-and-system-requirements-cn.md
@@ -0,0 +1,13 @@
+
+# 资源和系统要求
+
+## 资源要求
+我们强烈建议生产环境中的worker节点最少具备2核CPU和4GB内存。开发环境该限制可以放宽，但节点资源更少意味着留给workload的可用资源也更少。
+
+## 生产可用的系统和平台
+* CentOS 7.4及以上 (amd64、arm64)
+* Ubuntu 18.04及以上的LTS版本 (amd64、arm64)
+* Fedora 31 (amd64)
+* Debian 9.1 (amd64)
+
+其他的系统和平台可能也是生产可用的，但我们没有在生产环境做过验证，欢迎补充。
\ No newline at end of file
diff --git a/docs/resource-and-system-requirements.md b/docs/resource-and-system-requirements.md
new file mode 100644
index 00000000000..2be95c4db6c
--- /dev/null
+++ b/docs/resource-and-system-requirements.md
@@ -0,0 +1,14 @@
+
+# Resource and System Requirements
+
+## Resource Requirements
+We strongly recommend at least 2 CPUs and 4 GB RAM per worker node in production environment.
+Any less in development environment is ok but will leave little room for your workloads.
+
+## Tested Platforms
+* CentOS 7.4+ (amd64 and arm64)
+* Ubuntu 18.04 LTS+ (amd64 and arm64)
+* Fedora 31 (amd64)
+* Debian 9.1 (amd64)
+
+Other platforms may work well but are not tested in our production environment. Supplements to the list are welcome.