# sealos

**Repository Path**: improvecoding/sealos

## Basic Information

- **Project Name**: sealos
- **Description**: sealos旨在做一个简单干净轻量级稳定的kubernetes安装工具，能很好的支持高可用安装
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: release-v3.3.9
- **Homepage**: https://www.oschina.net/p/sealos
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 42
- **Created**: 2022-03-10
- **Last Updated**: 2022-03-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/fanux/sealos)
  [![Build Status](https://github.com/fanux/sealos/actions/workflows/release.yml/badge.svg)](https://github.com/fanux/sealos/actions)

# Introduction
Build a production kubernetes HA cluster.

![](docs/images/arch.png)

* Every node config a ipvs proxy for masters LB, so we needn't haproxy or keepalived any more.
* Then run a [lvscare](https://github.com/fanux/lvscare) as a staic pod to check apiserver is aviliable. `/etc/kubernetes/manifests/sealyun-lvscare.yaml`
* 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, CPU Architecture

- Debian 9+,  x86_64/ arm64
- Ubuntu 16.04， 18.04， 20.04 ,  x86_64/ arm64
- Centos/RHEL 7.6+,  x86_64/ arm64
- 99% systemd manage linux system， x86_64/ arm64
- Kylin arm64

## kubernetes Versions

- 1.16+
- 1.17+
- 1.18+
- 1.19+
- 1.20+
- 1.21+
- 1.22+

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

## Requirements and Recommendations

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

- OS requirements
   - SSH can access to all nodes.
   - hostname is unique, and satisfied kubernetes requirements.
   - Time synchronization for all nodes.
   - if network card has a stranger 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 conflict with dns cidr, we recommend you install kubernetes init flag to add  `--podcidr`  to avoid 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.
- Kernel requirements:
  - When cni components choose cilium, the kernel version must not be lower than 5.4

# 🚀 Quick Start

> Environmental information

Hostname|IP Address
---|---
master0|192.168.0.2
master1|192.168.0.3
master2|192.168.0.4
node0|192.168.0.5

Server password：123456

**kubernetes .0, the version is not recommended for production environment!!!**

> Just prepare the server and execute the following command on any server

```sh
# download and install sealos, sealos is a binary tool of golang, just download and copy directly to the bin directory, the release page can also be downloaded
$ wget -c https://sealyun.oss-cn-beijing.aliyuncs.com/latest/sealos && \
    chmod +x sealos && mv sealos /usr/bin

# download offline resource pack
$ wget -c https://sealyun.oss-cn-beijing.aliyuncs.com/05a3db657821277f5f3b92d834bbaf98-v1.22.0/kube1.22.0.tar.gz

# Install a three-master kubernetes cluster
$ sealos init --passwd '123456' \
	--master 192.168.0.2  --master 192.168.0.3  --master 192.168.0.4  \
	--node 192.168.0.5 \
	--pkg-url /root/kube1.22.0.tar.gz \
	--version v1.22.0
```

> Parameter meaning

| parameter | meaning                                                                                                      | example                 |
|-----------|--------------------------------------------------------------------------------------------------------------|-------------------------|
| passwd    | server password                                                                                              | 123456                  |
| master    | k8s master IP Address                                                                                        | 192.168.0.2             |
| node      | k8s node IP Address                                                                                          | 192.168.0.3             |
| pkg-url   | offline resource package address, support downloading to local or a remote address                           | /root/kube1.22.0.tar.gz |
| version   | [Resource pack](https://www.sealyun.com/goodsDetail?type=cloud_kernel&name=kubernetes) Corresponding version | v1.22.0                 |


> add master

```shell script
🐳 → sealos join --master 192.168.0.6 --master 192.168.0.7
🐳 → sealos join --master 192.168.0.6-192.168.0.9  # or multiple consecutive IPs
```

> add node

```shell script
🐳 → sealos join --node 192.168.0.6 --node 192.168.0.7
🐳 → sealos join --node 192.168.0.6-192.168.0.9  # or multiple consecutive IPs
```

> delete the specified master

```shell script
🐳 → sealos clean --master 192.168.0.6 --master 192.168.0.7
🐳 → sealos clean --master 192.168.0.6-192.168.0.9  # or multiple consecutive IPs
```

> Delete the specified node

```shell script
🐳 → sealos clean --node 192.168.0.6 --node 192.168.0.7
🐳 → sealos clean --node 192.168.0.6-192.168.0.9  # or multiple consecutive IPs
```

> clean up the cluster

```shell script
🐳 → sealos clean --all
```

# ✅ Feature

- [x] Support ARM version offline package, v1.20 version offline package supports containerd integration, completely abandon docker
- [x] 99 years certificate, support cluster backup and upgrade
- [x] Does not rely on ansible haproxy keepalived, a binary tool, 0 dependencies
- [x] Offline installation, different versions of kubernetes download corresponding to different versions [Resource pack](https://www.sealyun.com/goodsDetail?type=cloud_kernel&name=kubernetes), Offline package contains all binary files configuration files and images
- [x] High-availability local LIB implemented through ipvs, which takes up less resources, is stable and reliable, and is similar to the implementation of kube-proxy
- [x] Almost compatible with all environments that support systemd x86_64 architecture
- [x] Easily add and delete cluster nodes
- [x] Thousands of users use sealos in the online environment, which is stable and reliable
- [x] The resource pack is placed on Alibaba Cloud OSS, so you don’t have to worry about network speed anymore
- [x] dashboard ingress prometheus apps offline packaging, a key installation

# 📊 Stats

![Alt](https://repobeats.axiom.co/api/embed/10ce83c1d8452210bc4a0b5a5df9d59bbc35d889.svg "Repobeats analytics image")


[简体中文](README.md)

[More offline packages](https://sealyun.com)