From 32c5e8714d63a7a104392d9e3f85ae9913ca7af9 Mon Sep 17 00:00:00 2001 From: hongming Date: Thu, 17 Aug 2023 13:39:51 +0800 Subject: [PATCH] update README.md (#5885) --- README.md | 105 +++++++++++++++++++++++++++++++++++++++------------ README_zh.md | 38 +++++++++++++++---- 2 files changed, 111 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 9d105ed98..16b19c47e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ good first issue follow on Twitter - +

@@ -22,9 +22,15 @@ > English | [中文](README_zh.md) -[KubeSphere](https://kubesphere.io/) is a **distributed operating system for cloud-native application management**, using [Kubernetes](https://kubernetes.io) as its kernel. It provides a plug-and-play architecture, allowing third-party applications to be seamlessly integrated into its ecosystem. KubeSphere is also a multi-tenant container platform with full-stack automated IT operation and streamlined DevOps workflows. It provides developer-friendly wizard web UI, helping enterprises to build out a more robust and feature-rich platform, which includes most common functionalities needed for enterprise Kubernetes strategy, see [Feature List](#features) for details. +[KubeSphere](https://kubesphere.io/) is a **distributed operating system for cloud-native application management**, +using [Kubernetes](https://kubernetes.io) as its kernel. It provides a plug-and-play architecture, allowing third-party +applications to be seamlessly integrated into its ecosystem. KubeSphere is also a multi-tenant container platform with +full-stack automated IT operation and streamlined DevOps workflows. It provides developer-friendly wizard web UI, +helping enterprises to build out a more robust and feature-rich platform, which includes most common functionalities +needed for enterprise Kubernetes strategy, see [Feature List](#features) for details. -The following screenshots give a close insight into KubeSphere. Please check [What is KubeSphere](https://kubesphere.io/docs/introduction/what-is-kubesphere/) for further information. +The following screenshots give a close insight into KubeSphere. Please +check [What is KubeSphere](https://kubesphere.io/docs/introduction/what-is-kubesphere/) for further information. @@ -47,9 +53,12 @@ The following screenshots give a close insight into KubeSphere. Please check [Wh ## Demo environment -🎮 [KubeSphere Lite](https://kubesphere.cloud/en/console/managed-cluster/) provides you with free, stable, and out-of-the-box managed cluster service. After registration and login, you can easily create a K8s cluster with KubeSphere installed in only 5 seconds and experience feature-rich KubeSphere. +🎮 [KubeSphere Lite](https://kubesphere.cloud/en/console/managed-cluster/) provides you with free, stable, and +out-of-the-box managed cluster service. After registration and login, you can easily create a K8s cluster with +KubeSphere installed in only 5 seconds and experience feature-rich KubeSphere. 🖥 You can view the [Demo Video](https://youtu.be/YxZ1YUv0CYs) to get started with KubeSphere. + ## Features
@@ -107,10 +116,11 @@ The following screenshots give a close insight into KubeSphere. Please check [Wh Create GPU workloads on the GUI, schedule GPU resources, and manage GPU resource quotas by tenant.
- ## Architecture -KubeSphere uses a loosely-coupled architecture that separates the [frontend](https://github.com/kubesphere/console) from the [backend](https://github.com/kubesphere/kubesphere). External systems can access the components of the backend through the REST APIs. +KubeSphere uses a loosely-coupled architecture that separates the [frontend](https://github.com/kubesphere/console) from +the [backend](https://github.com/kubesphere/kubesphere). External systems can access the components of the backend +through the REST APIs. ![Architecture](docs/images/architecture.png) @@ -118,66 +128,113 @@ KubeSphere uses a loosely-coupled architecture that separates the [frontend](htt ## Latest release -🎉 KubeSphere 3.3.2 was released! It brings enhancements and better user experience, see the [Release Notes For 3.3.2](https://kubesphere.io/docs/release/release-v332/) for the updates. +🎉 KubeSphere v3.4.0 was released! It brings enhancements and better user experience, see +the [Release Notes For 3.4.0](https://kubesphere.io/docs/release/release-v340/) for the updates. + +#### Component supported versions table + +| Component | Version | K8s supported version | +|----------------|-------------------------------------------------------------------------------|-------------------------------| +| Alerting | N/A | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Auditing | v0.2.0 | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Monitoring | N/A | 1.21,1.22,1.23,1.24,1.25,1.26 | +| DevOps | v3.4.0 | 1.21,1.22,1.23 | +| EdgeRuntime | v1.13.0 | 1.21,1.22,1.23 | +| Events | N/A | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Logging | opensearch：v2.6.0
fluentbit-operator: v0.14.0
fluent-bit-tag: v1.9.4 | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Metrics Server | v0.4.2 | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Network | N/A | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Notification | v2.3.0 | 1.21,1.22,1.23,1.24,1.25,1.26 | +| AppStore | N/A | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Storage | pvc-autoresizer: v0.3.0
storageclass-accessor: v0.2.2 | 1.21,1.22,1.23,1.24,1.25,1.26 | +| ServiceMesh | Istio: v1.14.6 | 1.21,1.22,1.23,1.24 | +| Gateway | Ingress NGINX Controller: v1.3.1 | 1.21,1.22,1.23,1.24 | + + ## Installation -KubeSphere can run anywhere from on-premise datacenter to any cloud to edge. In addition, it can be deployed on any version-compatible Kubernetes cluster. The installer will start a minimal installation by default, you can [enable other pluggable components before or after installation](https://kubesphere.io/docs/quick-start/enable-pluggable-components/). +KubeSphere can run anywhere from on-premise datacenter to any cloud to edge. In addition, it can be deployed on any +version-compatible Kubernetes cluster. The installer will start a minimal installation by default, you +can [enable other pluggable components before or after installation](https://kubesphere.io/docs/quick-start/enable-pluggable-components/). + ### Quick start + #### Installing on K8s/K3s -Ensure that your cluster has installed Kubernetes v1.19.x, v1.20.x, v1.21.x, * v1.22.x, * v1.23.x, or * v1.24.x. For Kubernetes versions with an asterisk, some features of edge nodes may be unavailable due to incompatibility. Therefore, if you want to use edge nodes, you are advised to install Kubernetes v1.21.x or earlier. +Ensure that your cluster has installed Kubernetes v1.21.x, v1.22.x, v1.23.x, * v1.24.x, * v1.25.x, or * v1.26.x. For Kubernetes versions with an asterisk, some features may be unavailable due to incompatibility. + Run the following commands to install KubeSphere on an existing Kubernetes cluster: ```yaml -kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.3.1/kubesphere-installer.yaml - -kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.3.1/cluster-configuration.yaml +kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.4.0/kubesphere-installer.yaml + +kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.4.0/cluster-configuration.yaml ``` + #### All-in-one -👨‍💻 No Kubernetes? You can use [KubeKey](https://github.com/kubesphere/kubekey) to install both KubeSphere and Kubernetes/K3s in single-node mode on your Linux machine. Let's take K3s as an example: +👨‍💻 No Kubernetes? You can use [KubeKey](https://github.com/kubesphere/kubekey) to install both KubeSphere and +Kubernetes/K3s in single-node mode on your Linux machine. Let's take K3s as an example: ```yaml # Download KubeKey -curl -sfL https://get-kk.kubesphere.io | VERSION=v2.3.0 sh - +curl -sfL https://get-kk.kubesphere.io | VERSION=v3.0.10 sh - # Make kk executable chmod +x kk # Create a cluster -./kk create cluster --with-kubernetes v1.21.4-k3s --with-kubesphere v3.3.1 +./kk create cluster --with-kubernetes v1.24.14 --container-manager containerd --with-kubesphere v3.4.0 ``` -You can run the following command to view the installation logs. After KubeSphere is successfully installed, you can access the KubeSphere web console at `http://IP:30880` and log in using the default administrator account (admin/P@88w0rd). +You can run the following command to view the installation logs. After KubeSphere is successfully installed, you can +access the KubeSphere web console at `http://IP:30880` and log in using the default administrator account ( +admin/P@88w0rd). ```yaml kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l 'app in (ks-install, ks-installer)' -o jsonpath='{.items[0].metadata.name}') -f ``` + ### KubeSphere for hosted Kubernetes services -KubeSphere is hosted on the following cloud providers, and you can try KubeSphere by one-click installation on their hosted Kubernetes services. +KubeSphere is hosted on the following cloud providers, and you can try KubeSphere by one-click installation on their +hosted Kubernetes services. - [KubeSphere for Amazon EKS](https://aws.amazon.com/quickstart/architecture/qingcloud-kubesphere/) - [KubeSphere for Azure AKS](https://market.azure.cn/marketplace/apps/qingcloud.kubesphere) - [KubeSphere for DigitalOcean Kubernetes](https://marketplace.digitalocean.com/apps/kubesphere) - [KubeSphere on QingCloud AppCenter(QKE)](https://www.qingcloud.com/products/kubesphereqke) -You can also install KubeSphere on other hosted Kubernetes services within minutes, see the [step-by-step guides](https://kubesphere.io/docs/installing-on-kubernetes/) to get started. +You can also install KubeSphere on other hosted Kubernetes services within minutes, see +the [step-by-step guides](https://kubesphere.io/docs/installing-on-kubernetes/) to get started. + +> 👨‍💻 No internet access? Refer to +> +the [Air-gapped Installation on Kubernetes](https://kubesphere.io/docs/installing-on-kubernetes/on-prem-kubernetes/install-ks-on-linux-airgapped/) +> +or [Air-gapped Installation on Linux](https://kubesphere.io/docs/installing-on-linux/introduction/air-gapped-installation/) +> for instructions on how to use private registry to install KubeSphere. -> 👨‍💻 No internet access? Refer to the [Air-gapped Installation on Kubernetes](https://kubesphere.io/docs/installing-on-kubernetes/on-prem-kubernetes/install-ks-on-linux-airgapped/) or [Air-gapped Installation on Linux](https://kubesphere.io/docs/installing-on-linux/introduction/air-gapped-installation/) for instructions on how to use private registry to install KubeSphere. ## Guidance, discussion, contribution, and support -We :heart: your contribution. The [community](https://github.com/kubesphere/community) walks you through how to get started contributing KubeSphere. The [development guide](https://github.com/kubesphere/community/tree/master/developer-guide/development) explains how to set up development environment. +We :heart: your contribution. The [community](https://github.com/kubesphere/community) walks you through how to get +started contributing KubeSphere. +The [development guide](https://github.com/kubesphere/community/tree/master/developer-guide/development) explains how to +set up development environment. -- [Slack Channel](https://join.slack.com/t/kubesphere/shared_invite/enQtNTE3MDIxNzUxNzQ0LTZkNTdkYWNiYTVkMTM5ZThhODY1MjAyZmVlYWEwZmQ3ODQ1NmM1MGVkNWEzZTRhNzk0MzM5MmY4NDc3ZWVhMjE) +- [Slack Channel](https://join.slack.com/t/kubesphere/shared_invite/zt-219hq0b5y-el~FMRrJxGM1Egf5vX6QiA) - [Youtube](https://www.youtube.com/channel/UCyTdUQUYjf7XLjxECx63Hpw) - [Twitter](https://twitter.com/KubeSphere) -:hugs: Please submit any KubeSphere bugs, issues, and feature requests to [KubeSphere GitHub Issue](https://github.com/kubesphere/kubesphere/issues). +:hugs: Please submit any KubeSphere bugs, issues, and feature requests +to [KubeSphere GitHub Issue](https://github.com/kubesphere/kubesphere/issues). -:heart_decoration: The KubeSphere team also provides efficient official ticket support to respond in hours. For more information, click [KubeSphere Online Support](https://kubesphere.cloud/en/ticket/). +:heart_decoration: The KubeSphere team also provides efficient official ticket support to respond in hours. For more +information, click [KubeSphere Online Support](https://kubesphere.cloud/en/ticket/). ## Who are using KubeSphere -The [user case studies](https://kubesphere.io/case/) page includes the user list of the project. You can [leave a comment](https://github.com/kubesphere/kubesphere/issues/4123) to let us know your use case. +The [user case studies](https://kubesphere.io/case/) page includes the user list of the project. You +can [leave a comment](https://github.com/kubesphere/kubesphere/issues/4123) to let us know your use case. + ## Landscapes

diff --git a/README_zh.md b/README_zh.md index e6a2e855d..1fb7ef7f3 100644 --- a/README_zh.md +++ b/README_zh.md @@ -11,7 +11,7 @@ good first issue follow on Twitter - +

@@ -118,19 +118,41 @@ KubeSphere 使用前后端分离的架构，将 [前端](https://github.com/kube ## 最新版本 -🎉 KubeSphere 3.3.2 全新发布！！多项功能与体验优化，带来更好的产品体验，详见 [v3.3.2 版本说明](https://kubesphere.io/zh/docs/release/release-v332/) 。 +🎉 KubeSphere 3.4.0 全新发布！！多项功能与体验优化，带来更好的产品体验，详见 [v3.4.0 版本说明](https://kubesphere.io/zh/docs/release/release-v340/) 。 + +#### 组件支持版本列表 + +| Component | Version | K8s supported version | +|----------------|-------------------------------------------------------------------------------|-------------------------------| +| Alerting | N/A | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Auditing | v0.2.0 | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Monitoring | N/A | 1.21,1.22,1.23,1.24,1.25,1.26 | +| DevOps | v3.4.0 | 1.21,1.22,1.23 | +| EdgeRuntime | v1.13.0 | 1.21,1.22,1.23 | +| Events | N/A | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Logging | opensearch：v2.6.0
fluentbit-operator: v0.14.0
fluent-bit-tag: v1.9.4 | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Metrics Server | v0.4.2 | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Network | N/A | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Notification | v2.3.0 | 1.21,1.22,1.23,1.24,1.25,1.26 | +| AppStore | N/A | 1.21,1.22,1.23,1.24,1.25,1.26 | +| Storage | pvc-autoresizer: v0.3.0
storageclass-accessor: v0.2.2 | 1.21,1.22,1.23,1.24,1.25,1.26 | +| ServiceMesh | Istio: v1.14.6 | 1.21,1.22,1.23,1.24 | +| Gateway | Ingress NGINX Controller: v1.3.1 + ## 安装 KubeSphere 支持在任意平台运行，从本地数据中心到混合多云再走向边缘。此外，KubeSphere 可以部署在任何版本兼容的 Kubernetes 集群上。Installer 默认将执行最小化安装，您可以在安装前或安装后自定义[安装可插拔功能组件](https://kubesphere.io/zh/docs/quick-start/enable-pluggable-components/)。 ### 快速入门 #### 在 K8s/K3s 上安装 -请确保您的集群已经安装 Kubernetes v1.19.x、v1.20.x、v1.21.x、* v1.22.x、* v1.23.x 或 * v1.24.x。带星号的版本可能出现边缘节点部分功能不可用的情况。因此，如需使用边缘节点，推荐安装 Kubernetes v1.21.x 及之前的版本。运行以下命令以在现有 Kubernetes 集群上安装 KubeSphere： +请确保您的集群已经安装 Kubernetes v1.21.x, v1.22.x, v1.23.x, * v1.24.x, * v1.25.x, 或 * v1.26.x。带星号的版本可能出现边缘节点部分功能不可用的情况。 + +运行以下命令以在现有 Kubernetes 集群上安装 KubeSphere： ```yaml -kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.3.1/kubesphere-installer.yaml +kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.4.0/kubesphere-installer.yaml -kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.3.1/cluster-configuration.yaml +kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.4.0/cluster-configuration.yaml ``` #### All-in-one（Linux 单节点安装） @@ -138,11 +160,11 @@ kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3 ```yaml # 下载 KubeKey -curl -sfL https://get-kk.kubesphere.io | VERSION=v2.3.0 sh - +curl -sfL https://get-kk.kubesphere.io | VERSION=v3.0.10 sh - # 为 kk 赋予可执行权限 chmod +x kk # 创建集群 -./kk create cluster --with-kubernetes v1.21.4-k3s --with-kubesphere v3.3.1 +./kk create cluster --with-kubernetes v1.24.14 --container-manager containerd --with-kubesphere v3.4.0 ``` 可使用以下命令查看安装日志。如果安装成功，可使用 `http://IP:30880` 访问 KubeSphere Console，管理员登录帐密为 `admin/P@88w0rd`。 @@ -170,7 +192,7 @@ KubeSphere 托管在以下云供应商上，您可以通过在其托管的 Kuber - [中文论坛](https://kubesphere.com.cn/forum/) - [社区微信群（见官网底部）](https://kubesphere.com.cn/) -- [Slack Channel](https://join.slack.com/t/kubesphere/shared_invite/enQtNTE3MDIxNzUxNzQ0LTZkNTdkYWNiYTVkMTM5ZThhODY1MjAyZmVlYWEwZmQ3ODQ1NmM1MGVkNWEzZTRhNzk0MzM5MmY4NDc3ZWVhMjE) +- [Slack Channel](https://join.slack.com/t/kubesphere/shared_invite/zt-219hq0b5y-el~FMRrJxGM1Egf5vX6QiA) - [Bilibili](https://space.bilibili.com/438908638) - [Twitter](https://twitter.com/KubeSphere)