diff --git a/content/en/common/container-runtime-requirements.md b/content/en/common/container-runtime-requirements.md new file mode 100644 index 000000000..4cad9c7b0 --- /dev/null +++ b/content/en/common/container-runtime-requirements.md @@ -0,0 +1,12 @@ +--- +_build: + render: false +--- + +| Supported Container Runtime | Version | +| ------------------------------------------- | ------- | +| Docker | 19.3.8+ | +| containerd (experimental, not fully tested) | Latest | +| CRI-O (experimental, not fully tested) | Latest | +| iSula (experimental, not fully tested) | Latest | + diff --git a/content/en/common/csi-plugins.md b/content/en/common/csi-plugins.md new file mode 100644 index 000000000..ea8a25c25 --- /dev/null +++ b/content/en/common/csi-plugins.md @@ -0,0 +1,13 @@ +--- +_build: + render: false +--- + +Kubernetes has announced that in-tree volume plugins will be removed from Kubernetes in version 1.21. For more information, see [Kubernetes In-Tree to CSI Volume Migration Moves to Beta](https://kubernetes.io/blog/2019/12/09/kubernetes-1-17-feature-csi-migration-beta/). Therefore, it is recommended that you install CSI plugins instead. + +Supported CSI plugins: + +- [neonsan-csi](https://github.com/yunify/qingstor-csi) +- {{< contentLink "docs/installing-on-linux/persistent-storage-configurations/install-qingcloud-csi/" "qingcloud-csi" >}} +- {{< contentLink "docs/installing-on-linux/persistent-storage-configurations/install-ceph-csi-rbd/" "ceph-csi" >}} +- {{< contentLink "docs/installing-on-linux/persistent-storage-configurations/install-nfs-client/" "nfs-client-provisioner" >}} \ No newline at end of file diff --git a/content/en/common/dependency-requirements.md b/content/en/common/dependency-requirements.md new file mode 100644 index 000000000..c757ad80b --- /dev/null +++ b/content/en/common/dependency-requirements.md @@ -0,0 +1,11 @@ +--- +_build: + render: false +--- + +| Dependency | Kubernetes Version ≥ 1.18 | Kubernetes Version < 1.18 | +| ----------- | ------------------------- | ------------------------- | +| `socat` | Required | Optional but recommended | +| `conntrack` | Required | Optional but recommended | +| `ebtables` | Optional but recommended | Optional but recommended | +| `ipset` | Optional but recommended | Optional but recommended | diff --git a/content/en/common/kubernetes-versions.md b/content/en/common/kubernetes-versions.md new file mode 100644 index 000000000..9d61eca69 --- /dev/null +++ b/content/en/common/kubernetes-versions.md @@ -0,0 +1,10 @@ +--- +_build: + render: false +--- + +| Installation Tool | KubeSphere version | Supported Kubernetes versions | +| ----------------- | ------------------ | ------------------------------------------------------------ | +| KubeKey | v3.1.0 | v1.17.0, v1.17.4, v1.17.5, v1.17.6, v1.17.7, v1.17.8, v1.17.9, v1.18.3, v1.18.5, v1.18.6, v1.18.8, v1.19.0, v1.19.8, v1.19.9, v1.20.4 | +| ks-installer | v3.1.0 | v1.17.x, v1.18.x, v1.19.x, v1.20.x | + diff --git a/content/en/common/network-requirements.md b/content/en/common/network-requirements.md new file mode 100644 index 000000000..5ea9f570f --- /dev/null +++ b/content/en/common/network-requirements.md @@ -0,0 +1,8 @@ +--- +_build: + render: false +--- + +- Make sure the DNS address in `/etc/resolv.conf` is available. Otherwise, it may cause some issues of DNS in the cluster. +- If your network configuration uses firewall rules or security groups, you must ensure infrastructure components can communicate with each other through specific ports. It is recommended that you turn off the firewall. For more information, see {{< contentLink "docs/installing-on-linux/introduction/port-firewall/" "Port Requirements" >}}. +- Supported CNI plugins: Calico and Flannel. Others (such as Cilium and Kube-OVN) may also work but note that they have not been fully tested. \ No newline at end of file diff --git a/content/en/common/system-requirements.md b/content/en/common/system-requirements.md new file mode 100644 index 000000000..cf9af96aa --- /dev/null +++ b/content/en/common/system-requirements.md @@ -0,0 +1,13 @@ +--- +_build: + render: false +--- + +| System | Minimum Requirements (Each node) | +| ------------------------------------------------------------ | ------------------------------------------- | +| **Ubuntu** *16.04, 18.04* | CPU: 2 Cores, Memory: 4 G, Disk Space: 40 G | +| **Debian** *Buster, Stretch* | CPU: 2 Cores, Memory: 4 G, Disk Space: 40 G | +| **CentOS** *7*.x | CPU: 2 Cores, Memory: 4 G, Disk Space: 40 G | +| **Red Hat Enterprise Linux** *7* | CPU: 2 Cores, Memory: 4 G, Disk Space: 40 G | +| **SUSE Linux Enterprise Server** *15* **/openSUSE Leap** *15.2* | CPU: 2 Cores, Memory: 4 G, Disk Space: 40 G | + diff --git a/content/en/docs/reference/environment-requirements.md b/content/en/docs/reference/environment-requirements.md new file mode 100644 index 000000000..f0c7b43e8 --- /dev/null +++ b/content/en/docs/reference/environment-requirements.md @@ -0,0 +1,37 @@ +--- +title: "Environment Requirements" +keywords: 'KubeSphere, Kubernetes, docker, cluster, configuration' +description: 'Understand the environment requirements for KubeSphere.' +linkTitle: "Environment Requirements" +weight: 17500 +--- + +This page summarizes the some requirements for installing and using KubeSphere. + +## System Requirements + +{{< content "common/system-requirements.md" >}} + +## Dependency Requirements + +{{< content "common/dependency-requirements.md" >}} + +## Container Runtime Requirements + +{{< content "common/container-runtime-requirements.md" >}} + +## Network Requirements + +{{< content "common/network-requirements.md" >}} + +## Supported Kubernetes Versions + +{{< content "common/kubernetes-versions.md" >}} + +## Supported CSI Plugins + +{{< content "common/csi-plugins.md" >}} + +## Supported Web Browsers for Accessing the Console + +![console-browser](/images/docs/reference/environment-requirements/console-browser.png) \ No newline at end of file diff --git a/static/images/docs/reference/environment-requirements/console-browser.png b/static/images/docs/reference/environment-requirements/console-browser.png new file mode 100644 index 000000000..0d56322c8 Binary files /dev/null and b/static/images/docs/reference/environment-requirements/console-browser.png differ