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

add resource and system requirements #315

Merged
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 的前提下你可以执行以下命令来完成安装:
Expand Down
13 changes: 13 additions & 0 deletions docs/resource-and-system-requirements-cn.md
Original file line number Diff line number Diff line change
@@ -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)

其他的系统和平台可能也是生产可用的,但我们没有在生产环境做过验证,欢迎补充。
14 changes: 14 additions & 0 deletions docs/resource-and-system-requirements.md
Original file line number Diff line number Diff line change
@@ -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.