Skip to content

Commit

Permalink
k3s support version doc (#4455)
Browse files Browse the repository at this point in the history
  • Loading branch information
bxy4543 authored Jan 3, 2024
1 parent e87219f commit 07fdde5
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -156,25 +156,33 @@ $ sealos run kubernetes.tar

It's advised to use Containerd as the container runtime interface (CRI) in Kubernetes clusters. Containerd stands out for its lightweight structure and high efficiency, and it's fully compatible with Docker. Kubernetes images that utilize Containerd benefit from enhanced performance and optimized resource usage. Here are the specific supported versions:

| Kubernetes Version | Required Sealos Version | CRI Version | Cluster Image Version |
| ------------------ | ----------------------- | ----------- | -------------------------------- |
| `<1.25` | `>=v4.0.0` | v1alpha2 | labring/kubernetes:v1.24.0 |
| `>=1.25` | `>=v4.1.0` | v1alpha2 | labring/kubernetes:v1.25.0 |
| `>=1.26` | `>=v4.1.4-rc3` | v1 | labring/kubernetes:v1.26.0 |
| `>=1.27` | `>=v4.2.0-alpha3` | v1 | labring/kubernetes:v1.27.0 |
| Kubernetes Version | Required Sealos Version | CRI Version | Cluster Image Version |
| ------------------ | ----------------------- | ----------- |----------------------------|
| `<1.25` | `>=v4.0.0` | v1alpha2 | labring/kubernetes:v1.24.0 |
| `>=1.25` | `>=v4.1.0` | v1alpha2 | labring/kubernetes:v1.25.0 |
| `>=1.26` | `>=v4.1.4-rc3` | v1 | labring/kubernetes:v1.26.0 |
| `>=1.27` | `>=v4.2.0-alpha3` | v1 | labring/kubernetes:v1.27.0 |
| `>=1.28` | `>=v5.0.0` | v1 | labring/kubernetes:v1.28.0 |

The choice of Sealos and CRI versions is dependent on the Kubernetes version in question. For instance, Kubernetes v1.26.0 would require Sealos v4.1.4-rc3 or newer, along with the v1 CRI version.

### Kubernetes Compatibility with Docker

Alternatively, Docker can also be used as the container runtime. The following table provides a breakdown of compatible Kubernetes versions with their corresponding Sealos and CRI versions for Docker-based setups:

| Kubernetes Version | Required Sealos Version | CRI Version | Cluster Image Version |
| ------------------ | ----------------------- | ----------- | -------------------------------------- |
| `<1.25` | `>=v4.0.0` | v1alpha2 | labring/kubernetes-docker:v1.24.0 |
| `>=1.25` | `>=v4.1.0` | v1alpha2 | labring/kubernetes-docker:v1.25.0 |
| `>=1.26` | `>=v4.1.4-rc3` | v1 | labring/kubernetes-docker:v1.26.0 |
| `>=1.27` | `>=v4.2.0-alpha3` | v1 | labring/kubernetes-docker:v1.27.0 |
| Kubernetes Version | Required Sealos Version | CRI Version | Cluster Image Version |
|--------------------|-------------------------| ----------- |-----------------------------------|
| `<1.25` | `>=v4.0.0` | v1alpha2 | labring/kubernetes-docker:v1.24.0 |
| `>=1.25` | `>=v4.1.0` | v1alpha2 | labring/kubernetes-docker:v1.25.0 |
| `>=1.26` | `>=v4.1.4-rc3` | v1 | labring/kubernetes-docker:v1.26.0 |
| `>=1.27` | `>=v4.2.0-alpha3` | v1 | labring/kubernetes-docker:v1.27.0 |
| `>=1.28` | `>=v5.0.0` | v1 | labring/kubernetes-docker:v1.28.0 |

### k3s Compatibility with Containerd

| Kubernetes Version | Required Sealos Version | Cluster Image Version |
|--------------------|-------------------------|-----------------------|
| `>=1.24` | `>=v5.0.0` | labring/k3s:v1.24.0 |

As with the Containerd setup, the appropriate Sealos and CRI versions must be matched with the specific version of Kubernetes being used. For a Kubernetes v1.26.0 setup, this means selecting Sealos v4.1.4-rc3 or later, and a v1 CRI version.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ $ sealos run kubernetes.tar # 单机安装,集群安装同理
| `>=1.25` | `>=v4.1.0` | v1alpha2 | labring/kubernetes:v1.25.0 |
| `>=1.26` | `>=v4.1.4-rc3` | v1 | labring/kubernetes:v1.26.0 |
| `>=1.27` | `>=v4.2.0-alpha3` | v1 | labring/kubernetes:v1.27.0 |
| `>=1.28` | `>=v5.0.0` | v1 | labring/kubernetes:v1.28.0 |

根据 Kubernetes 版本的不同,您可以选择不同的 Sealos 版本和 CRI 版本。例如,如果您要使用 Kubernetes v1.26.0 版本,您可以选择 sealos v4.1.4-rc3 及更高版本,并使用 v1 CRI 版本。

Expand All @@ -175,9 +176,17 @@ $ sealos run kubernetes.tar # 单机安装,集群安装同理
| `>=1.25` | `>=v4.1.0` | v1alpha2 | labring/kubernetes-docker:v1.25.0 |
| `>=1.26` | `>=v4.1.4-rc3` | v1 | labring/kubernetes-docker:v1.26.0 |
| `>=1.27` | `>=v4.2.0-alpha3` | v1 | labring/kubernetes-docker:v1.27.0 |
| `>=1.28` | `>=v5.0.0` | v1 | labring/kubernetes-docker:v1.28.0 |


与支持 Containerd 的 Kubernetes 镜像类似,您可以根据 Kubernetes 版本的不同选择不同的 Sealos 版本和 CRI 版本。例如,如果您要使用 Kubernetes v1.26.0 版本,您可以选择 sealos v4.1.4-rc3 及更高版本,并使用 v1 CRI 版本。

### 支持 Containerd 的 k3s

| K8s 版本 | Sealos 版本 | 集群镜像版本 |
|----------|------------| --------------------------------- |
| `>=1.24` | `>=v5.0.0` | labring/kubernetes-docker:v1.24.0 |

## 总结

您可以根据自己的需求和偏好,在不同的镜像类型和版本中进行选择。同时,不要忘记查看 [更新日志](https://github.com/labring/sealos/blob/main/CHANGELOG/CHANGELOG.md),以了解各个版本的更新内容和修复问题。

0 comments on commit 07fdde5

Please sign in to comment.