Skip to content

Commit

Permalink
Adding changes to compatibility matrix
Browse files Browse the repository at this point in the history
  • Loading branch information
Sowmya viswam authored and Sowmya viswam committed Aug 7, 2024
1 parent c85b035 commit f96c482
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 47 deletions.
19 changes: 5 additions & 14 deletions vcluster/_fragments/distro/compat-k0s.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,8 @@
Compatibility matrix showing which host K8s version (left column) is supported by which vCluster k0s distro versions.
import KubernetesVersions from '@site/vcluster/_partials/deploy/kubernetes-versions.mdx'

| | v1.29.1-k0s.0 | v1.28.2-k0s.0 | v1.27.6-k0s.0 | v1.26.9-k0s.0 |
|------|--------------------|--------------------|--------------------|--------------------|
| 1.29 | :white_check_mark: | :ok: | :ok: | :ok: |
| 1.28 | :ok: | :white_check_mark: | :ok: | :ok: |
| 1.27 | :ok: | :ok: | :white_check_mark: | :ok: |
| 1.26 | :ok: | :ok: | :ok: | :white_check_mark: |
### Host cluster compatibility

The Kubernetes distro of vCluster is completely independent of the Kubernetes distro of the host cluster. This means you can run vCluster using k0s distribution regardless of the distribution type of the host cluster.

Legend:

:warning: : known issue

:white_check_mark: : recommended

:ok: : likely compatible
vCluster should work when deployed on a host cluster with the following supported Kubernetes versions:
<KubernetesVersions/>
18 changes: 5 additions & 13 deletions vcluster/_fragments/distro/compat-k3s.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
Compatibility matrix showing which host K8s version (left column) is supported by which vCluster K3s distro versions.
import KubernetesVersions from '@site/vcluster/_partials/deploy/kubernetes-versions.mdx'

| | v1.29.0-k3s1 | v1.28.5-k3s1 | v1.27.9-k3s1 | v1.26.12-k3s1 |
|------|--------------------|--------------------|--------------------|--------------------|
| 1.29 | :white_check_mark: | :ok: | :ok: | :ok: |
| 1.28 | :ok: | :white_check_mark: | :ok: | :ok: |
| 1.27 | :ok: | :ok: | :white_check_mark: | :ok: |
| 1.26 | :ok: | :ok: | :ok: | :white_check_mark: |
### Host cluster compatibility

The Kubernetes distro of vCluster is completely independent of the Kubernetes distro of the host cluster. This means you can run vCluster using k3s distribution regardless of the distribution type of the host cluster.

Legend:
vCluster should work when deployed on a host cluster with the following supported Kubernetes versions:
<KubernetesVersions/>

:warning: : known issue

:white_check_mark: : recommended

:ok: : likely compatible
29 changes: 18 additions & 11 deletions vcluster/_fragments/distro/compat-k8s.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
Compatibility matrix showing which host K8s version (left column) is supported by which vCluster K8s distro versions.
import KubernetesVersions from '@site/vcluster/_partials/deploy/kubernetes-versions.mdx'

| | v1.29.0 | v1.28.4 | v1.27.8 | v1.26.11 |
|------|--------------------|--------------------|--------------------|--------------------|
| 1.29 | :white_check_mark: | :ok: | :ok: | :ok: |
| 1.28 | :ok: | :white_check_mark: | :ok: | :ok: |
| 1.27 | :ok: | :ok: | :white_check_mark: | :ok: |
| 1.26 | :ok: | :ok: | :ok: | :white_check_mark: |
### Host cluster compatibility

The Kubernetes distro of vCluster is completely independent of the Kubernetes distro of the host cluster. This means you can run vCluster using k8s distribution regardless of the distribution type of the host cluster.

Legend:
vCluster should work when deployed on a host cluster with the following supported Kubernetes versions:
<KubernetesVersions/>

## Kubernetes Compatibility Matrix:

The following matrix shows the compatibility between host and virtual clusters when both are using vanilla Kubernetes. It indicates which versions of vanilla Kubernetes on the host cluster support which versions of vanilla Kubernetes on the virtual cluster.

:warning: : known issue

:white_check_mark: : recommended
| Host K8s ↓ / vCluster k8s → | v1.30 | v1.29 | v1.28 |
|:----------------------------:|:-------:|:-------:|:--------:|
| **v1.30** | ✔️ | ✔️ | ✔️ |
| **v1.29** | ✔️ | ✔️ | ✔️ |
| **v1.28** | ✔️ | ✔️ | ✔️ |


Legend:

:ok: : likely compatible
✔️ : Supported
19 changes: 15 additions & 4 deletions vcluster/_partials/deploy/distros.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
import KubernetesVersions from '@site/vcluster/_partials/deploy/kubernetes-versions.mdx'


vCluster is able to use different Kubernetes distributions as a virtual cluster distribution.

:::warning
After deploying your vCluster, changing the Kubernetes distribution of vCluster is not supported.
:::

By default, the distribution of vCluster is vanilla Kubernetes and is the recommended distribution to use.
### Kubernetes Distros for vCluster

The following distributions are supported for virtual clusters:

- k8s: By default, the vCluster distribution is vanilla Kubernetes, which is the recommended distribution to use.
- [k3s](https://github.com/k3s-io/k3s): A highly available, certified Kubernetes distribution designed for production workloads in unattended, resource-constrained, remote locations or inside IoT appliances.
- [k0s](https://github.com/k0sproject/k0s): An all-inclusive Kubernetes distribution, which is configured with all of the features needed to build a Kubernetes cluster and packaged as a single binary for ease of use. Please note that dual stack networking is not supported with k0s, you will be able to deploy it on a dual stack host cluster, but it will not have all the dual stack features.

**Note:** The Kubernetes distro of vCluster is completely independent of the Kubernetes distro of the host cluster. This means you can run any supported Kubernetes distribution of vCluster regardless of the distribution type of the host cluster.

There are 2 other options of distributions for vCluster.
### Host cluster compatibility

* [k3s](https://github.com/k3s-io/k3s) is a highly available, certified Kubernetes distribution designed for production workloads in unattended, resource-constrained, remote locations or inside IoT appliances.
* [k0s](https://github.com/k0sproject/k0s) is an all-inclusive Kubernetes distribution, which is configured with all of the features needed to build a Kubernetes cluster and packaged as a single binary for ease of use. Please note that dual stack networking is not supported with k0s, you will be able to deploy it on a dual stack host cluster, but it will not have all the dual stack features.
vCluster should work when deployed on a host cluster with the following supported Kubernetes versions:
<KubernetesVersions/>
4 changes: 4 additions & 0 deletions vcluster/_partials/deploy/kubernetes-versions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- v1.30
- v1.29
- v1.28

Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ controlPlane:
enabled: true
```
## Compatiblity matrix
<K0sCompat/>
## Config reference
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ controlPlane:
enabled: true
```
## Compatiblity matrix
<K3sCompat/>
## Config reference
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import DefaultDistroNote from '@site/vcluster/_fragments/default-distro-note.mdx

By default, vCluster uses an embedded SQLite as the [backing store](../backing-store/README.mdx) when you use the K8s distribution.

## Compatiblity matrix

<K8sCompat/>

Expand Down

0 comments on commit f96c482

Please sign in to comment.