Skip to content

Commit

Permalink
add requirements and recommendations
Browse files Browse the repository at this point in the history
Signed-off-by: oldthreefeng <louisehong4168@gmail.com>
  • Loading branch information
oldthreefeng committed Jan 21, 2021
1 parent 9ec95b9 commit 57caaca
Show file tree
Hide file tree
Showing 3 changed files with 113 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,43 @@

[English Docs](/README_en.md)

# 支持的环境

## Linux 发行版, CPU架构

- Ubuntu 16.04, 18.04, 20.04 , x86_64/ arm64
- Centos/RHEL 7.6+, x86_64/ arm64
- Kylin arm64

## kubernetes 版本

- 1.16+
- 1.17+
- 1.18+
- 1.19+
- 1.20+

更多版本支持, 详细查看[sealyun.com](https://www.sealyun.com)

## 要求和建议

- 最低资源要求
- 2 vCpu
- 4G Ram
- 40G+ 存储

- 操作系统要求
- ssh 可以访问各安装节点
- 各节点主机名不相同,并满足kubernetes的主机名要求。
- 各节点时间同步
- 网卡名称如果是(eth.*|en.*|em.*)等奇怪的网卡, 建议修改成规范的网卡名称
- kubernetes1.20+ 使用containerd作为cri. 不需要用户安装docker/containerd. sealos会安装1.3.9版本containerd。
- kubernetes1.19及以下 使用docker作为cri。 也不需要用户安装docker。 sealos会安装1.19.03版本docker
- 网络和 DNS 要求:
- 确保 /etc/resolv.conf 中的 DNS 地址可用。否则,可能会导致群集中coredns异常。
- 如果使用阿里云/华为云主机部署。 默认的pod网段会和阿里云的dns网段冲突, 建议自定义修改pod网段, 在init的时候指定`--podcidr` 来修改。
- sealos 默认会关闭防火墙, 如果需要打开防火墙, 建议手动放行相关的端口。

# 🚀 快速开始

> 环境信息
Expand Down
38 changes: 38 additions & 0 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,44 @@ Build a production kubernetes HA cluster.
* If any master is down, lvscare will remove the ipvs realserver, when master recover it will add it back.
* Sealos will send package and apply install commands, so we needn't ansible.

# Supported Environment

## Linux Distributions

- Ubuntu 16.04, 18.04, 20.04 , x86_64/ arm64
- Centos/RHEL 7.6+, x86_64/ arm64
- Kylin arm64

## kubernetes Versions

- 1.16+
- 1.17+
- 1.18+
- 1.19+
- 1.20+

Looking for more supported versions,[sealyun.com](https://www.sealyun.com)
sealos is currently supported the latest k8s 1.20+

## Requirements and Recommendations

- Minimum resource requirements
- 2 vCpu
- 4G RAM
- 40G+ Storage

- OS requirements
- SSH can access to all nodes.
- hostname is uniq ,and satisfied kubernetes requirements。
- Time synchronization for all nodes.
- network Iface has unhave name, change it to (eth.*|en.*|em.*)
- kubernetes1.20+, use containerd for default cri. user should not to install containerd or docker-ce. sealos will do it
- kubernetes1.19-, use docker for default cri. user should not to install docker-ce. sealos will do it for you
- Networking and DNS requirements:
- Make sure the DNS address in /etc/resolv.conf is available. Otherwise, it may cause some issues of DNS in cluster。
- if you use aliyun/huawei cloud to deploy kubernetes 。 default pod cidr is confilct with dns cidr, we recommand you install kubernetes init flag to add `--podcidr` to aviod this problem。
- sealos default to disable firewalld ,It's recommended that you turn off the firewall. if you want to use firewalld , remember to allow kubernetes port traffic。

# Quick Start
## PreInstall
* Install and start docker
Expand Down
38 changes: 38 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,44 @@

[English Docs](/README_en.md)


# 支持的环境

## Linux 发行版, CPU架构

- Ubuntu 16.04, 18.04, 20.04 , x86_64/ arm64
- Centos/RHEL 7.6+, x86_64/ arm64
- Kylin arm64

## kubernetes 版本

- 1.16+
- 1.17+
- 1.18+
- 1.19+
- 1.20+

更多版本支持, 详细查看[sealyun.com](https://www.sealyun.com)

## 要求和建议

- 最低资源要求
- 2 vCpu
- 4G Ram
- 40G+ 存储

- 操作系统要求
- ssh 可以访问各安装节点
- 各节点主机名不相同,并满足kubernetes的主机名要求。
- 各节点时间同步
- 网卡名称如果是(eth.*|en.*|em.*)等奇怪的网卡, 建议修改成规范的网卡名称
- kubernetes1.20+ 使用containerd作为cri. 不需要用户安装docker/containerd. sealos会安装1.3.9版本containerd。
- kubernetes1.19及以下 使用docker作为cri。 也不需要用户安装docker。 sealos会安装1.19.03版本docker
- 网络和 DNS 要求:
- 确保 /etc/resolv.conf 中的 DNS 地址可用。否则,可能会导致群集中coredns异常。
- 如果使用阿里云/华为云主机部署。 默认的pod网段会和阿里云的dns网段冲突, 建议自定义修改pod网段, 在init的时候指定`--podcidr` 来修改。
- sealos 默认会关闭防火墙, 如果需要打开防火墙, 建议手动放行相关的端口。

# 🚀 快速开始

> 环境信息
Expand Down

0 comments on commit 57caaca

Please sign in to comment.