From 174a20f941c024c2ab2041f7b0f7f1a2bd3a8ef0 Mon Sep 17 00:00:00 2001 From: FeynmanZhou Date: Thu, 3 Sep 2020 07:58:21 +0800 Subject: [PATCH] manually sync /en to /zh Signed-off-by: FeynmanZhou --- content/zh/docs/_index.md | 4 +- .../install-kubesphere-on-aks.md | 22 +- .../install-kubesphere-on-do.md | 2 +- .../install-kubesphere-on-eks.md | 2 +- .../install-kubesphere-on-gke.md | 23 +- .../install-kubesphere-on-oke.md | 2 +- .../introduction/overview.md | 8 +- .../installing-on-linux/introduction/intro.md | 4 +- .../introduction/multioverview.md | 14 +- .../install-kubesphere-on-vmware-vsphere.md | 18 +- .../public-cloud/install-ks-on-azure-vms.md | 90 ++++---- .../kubesphere-on-qingcloud-instance.md | 26 ++- content/zh/docs/introduction/_index.md | 12 +- .../zh/docs/pluggable-components/_index.md | 39 +++- .../alerting-notification.md | 157 ++++++++++++++ .../zh/docs/pluggable-components/app-store.md | 7 +- .../pluggable-components/auditing-logs.md | 8 +- .../zh/docs/pluggable-components/devops.md | 8 +- .../zh/docs/pluggable-components/events.md | 202 ++++++++++++++++++ .../zh/docs/pluggable-components/logging.md | 10 +- .../pluggable-components/network-policy.md | 119 +++++++++++ .../zh/docs/pluggable-components/overview.md | 10 + .../docs/pluggable-components/release-v200.md | 92 -------- .../pluggable-components/release-v2001.md | 92 -------- .../docs/pluggable-components/release-v300.md | 10 - .../docs/pluggable-components/service-mesh.md | 8 +- content/zh/docs/quick-start/_index.md | 14 +- .../docs/quick-start/all-in-one-on-linux.md | 16 +- .../enable-pluggable-components.md | 16 +- .../quick-start/minimal-kubesphere-on-k8s.md | 23 +- content/zh/docs/release/_index.md | 29 ++- content/zh/docs/release/release-v300.md | 53 +++-- content/zh/docs/upgrade/upgrade-overview.md | 2 +- 33 files changed, 736 insertions(+), 406 deletions(-) create mode 100644 content/zh/docs/pluggable-components/alerting-notification.md create mode 100644 content/zh/docs/pluggable-components/events.md create mode 100644 content/zh/docs/pluggable-components/network-policy.md create mode 100644 content/zh/docs/pluggable-components/overview.md delete mode 100644 content/zh/docs/pluggable-components/release-v200.md delete mode 100644 content/zh/docs/pluggable-components/release-v2001.md delete mode 100644 content/zh/docs/pluggable-components/release-v300.md diff --git a/content/zh/docs/_index.md b/content/zh/docs/_index.md index 97501485f..38c1f5987 100644 --- a/content/zh/docs/_index.md +++ b/content/zh/docs/_index.md @@ -7,12 +7,12 @@ LinkTitle: "Documentation" section1: title: KubeSphere Documentation - content: Learn how to build and manage cloud native applications using KubeSphere Container Platform. Get documentation, example code, tutorials, and more. + content: Learn how to build and manage cloud-native applications using KubeSphere Container Platform. Get documentation, example code, tutorials, and more. image: /images/docs/banner.png section3: title: Run KubeSphere and Kubernetes Stack from the Cloud Service - description: Cloud Providers are providing KubeSphere as a cloud-hosted service for users, help you to create an highly available cluster within minutes via several clicks. These services will be available in September, 2020. + description: Cloud Providers are providing KubeSphere as a cloud-hosted service for users, helping you to create a highly available cluster within minutes via several clicks. These services will be available starting from September 2020. list: - image: /images/docs/aws.jpg content: AWS Quickstart diff --git a/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-aks.md b/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-aks.md index e2bb0b57e..a78207716 100644 --- a/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-aks.md +++ b/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-aks.md @@ -8,7 +8,7 @@ weight: 2270 This guide walks you through the steps of deploying KubeSphere on [Azure Kubernetes Service](https://docs.microsoft.com/en-us/azure/aks/). -## Prepare a AKS cluster +## Prepare an AKS cluster Azure can help you implement infrastructure as code by providing resource deployment automation options. Commonly adopted tools include [ARM templates](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/overview) and [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/what-is-azure-cli?view=azure-cli-latest). In this guide, we will use Azure CLI to create all the resources that are needed for the installation of KubeSphere. @@ -28,7 +28,7 @@ An Azure resource group is a logical group in which Azure resources are deployed az group create --name KubeSphereRG --location westus ``` -### Create a AKS Cluster +### Create an AKS Cluster Use the command `az aks create` to create an AKS cluster. The following example creates a cluster named `KuberSphereCluster` with three nodes. This will take several minutes to complete. ```bash @@ -71,23 +71,9 @@ To start deploying KubeSphere, use the following command. ```bash kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml ``` -Download the cluster-configuration.yaml as below and you can customize the configuration. You can also enable pluggable components by setting the `enabled` property to `true` in this file. ```bash -wget https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml +kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml ``` -As `metrics-server` is already installed on AKS, you need to disable the component in the cluster-configuration.yaml file by changing `true` to `false` for `enabled`. -```bash -kebesphere@Azure:~$ vim ./cluster-configuration.yaml ---- - metrics_server: # (CPU: 56 m, Memory: 44.35 MiB) Whether to install metrics-server. IT enables HPA (Horizontal Pod Autoscaler). - enabled: false ---- -``` -The installation process will start after the cluster configuration is applied through the following command: -```bash -kubectl apply -f ./cluster-configuration.yaml -``` - You can inspect the logs of installation through the following command: ```bash @@ -128,4 +114,4 @@ ks-console LoadBalancer 10.0.181.93 13.86.xxx.xxx 80:30194/TCP 13m ``` ## Enable Pluggable Components (Optional) -The example above demonstrates the process of a default minimal installation. For pluggable components, you can enable them either before or after the installation. See [Enable Pluggable Components](https://github.com/kubesphere/ks-installer#enable-pluggable-components) for details. \ No newline at end of file +The example above demonstrates the process of a default minimal installation. For pluggable components, you can enable them either before or after the installation. See [Enable Pluggable Components](../../../pluggable-components/) for details. \ No newline at end of file diff --git a/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-do.md b/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-do.md index 704665fdc..c22c348ab 100644 --- a/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-do.md +++ b/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-do.md @@ -123,4 +123,4 @@ Now that KubeSphere is installed, you can access the web console of KubeSphere b ## Enable Pluggable Components (Optional) -The example above demonstrates the process of a default minimal installation. To enable other components in KubeSphere, see Enable Pluggable Components for more details. +The example above demonstrates the process of a default minimal installation. To enable other components in KubeSphere, see [Enable Pluggable Components](../../../pluggable-components/) for more details. diff --git a/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-eks.md b/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-eks.md index 9113157e3..eaa395fed 100644 --- a/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-eks.md +++ b/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-eks.md @@ -169,4 +169,4 @@ kubectl get svc -nkubesphere-system ## Enable Pluggable Components (Optional) -The example above demonstrates the process of a default minimal installation. To enable other components in KubeSphere, see Enable Pluggable Components for more details. +The example above demonstrates the process of a default minimal installation. To enable other components in KubeSphere, see [Enable Pluggable Components](../../../pluggable-components/) for more details. diff --git a/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-gke.md b/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-gke.md index 82191080d..f380843a0 100644 --- a/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-gke.md +++ b/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-gke.md @@ -51,26 +51,8 @@ This guide walks you through the steps of deploying KubeSphere on [Google Kubern kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml ``` -- Create a local cluster-configuration.yaml. - ```bash -vi cluster-configuration.yaml -``` - -- Copy all the content in this [file](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml) and paste it to your local cluster-configuration.yaml. Navigate to `metrics_server`, and change `true` to `false` for `enabled`. - -![change-metrics-server](https://ap3.qingstor.com/kubesphere-website/docs/true-false.png) - -{{< notice warning >}} - -Metrics Server is already installed on GKE. If you do not disable `metrics_server` in the cluster-configuration.yaml file, it will cause an issue and stop the installation process. - -{{}} - -- Save the file when you finish. Execute the following command to start installation: - -```bash -kubectl apply -f cluster-configuration.yaml +kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml ``` - Inspect the logs of installation: @@ -128,5 +110,4 @@ Instead of changing the service type to `LoadBalancer`, you can also access Kube ## Enable Pluggable Components (Optional) -The example above demonstrates the process of a default minimal installation. To enable other components in KubeSphere, see Enable Pluggable Components for more details. - +The example above demonstrates the process of a default minimal installation. To enable other components in KubeSphere, see [Enable Pluggable Components](../../../pluggable-components/) for more details. \ No newline at end of file diff --git a/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-oke.md b/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-oke.md index b9acfbddf..03e8013e0 100644 --- a/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-oke.md +++ b/content/zh/docs/installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-oke.md @@ -148,5 +148,5 @@ kubectl get svc -n kubesphere-system ## Enable Pluggable Components (Optional) -The example above demonstrates the process of a default minimal installation. To enable other components in KubeSphere, see Enable Pluggable Components for more details. +The example above demonstrates the process of a default minimal installation. To enable other components in KubeSphere, see [Enable Pluggable Components](../../../pluggable-components/) for more details. diff --git a/content/zh/docs/installing-on-kubernetes/introduction/overview.md b/content/zh/docs/installing-on-kubernetes/introduction/overview.md index 2352c730f..8b8743279 100644 --- a/content/zh/docs/installing-on-kubernetes/introduction/overview.md +++ b/content/zh/docs/installing-on-kubernetes/introduction/overview.md @@ -45,12 +45,6 @@ If your server has trouble accessing GitHub, you can copy the content in [kubesp kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f ``` -{{< notice tip >}} - -In some environments, you may find the installation process stopped by issues related to `metrics_server`, as some cloud providers have already installed metrics server in their platform. In this case, please manually create a local cluster-configuration.yaml file (copy the [content](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml) to it). In this file, disable `metrics_server` by changing `true` to `false` for `enabled`, and use `kubectl apply -f cluster-configuration.yaml` to execute it. - -{{}} - - Use `kubectl get pod --all-namespaces` to see whether all pods are running normally in relevant namespaces of KubeSphere. If they are, check the port (30880 by default) of the console through the following command: ```bash @@ -63,7 +57,7 @@ kubectl get svc/ks-console -n kubesphere-system ## Enable Pluggable Components (Optional) -If you start with a default minimal installation, refer to Enable Pluggable Components to install other components. +If you start with a default minimal installation, refer to [Enable Pluggable Components](../../../pluggable-components/) to install other components. {{< notice tip >}} diff --git a/content/zh/docs/installing-on-linux/introduction/intro.md b/content/zh/docs/installing-on-linux/introduction/intro.md index 18b7733a4..ddf405593 100644 --- a/content/zh/docs/installing-on-linux/introduction/intro.md +++ b/content/zh/docs/installing-on-linux/introduction/intro.md @@ -45,7 +45,7 @@ Three scenarios to use KubeKey: {{< notice note >}} -If you have existing Kubernetes clusters, please refer to [Installing on Kubernetes](https://kubesphere-v3.netlify.app/docs/installing-on-kubernetes/). +If you have existing Kubernetes clusters, please refer to [Installing on Kubernetes](https://kubesphere.io/docs/installing-on-kubernetes/). {{}} @@ -75,7 +75,7 @@ For more information, see HA Cluster Configuration. You can also see the specifi ## Overview of Pluggable Components -KubeSphere has decoupled some core feature components since v2.1.0. These components are designed to be pluggable, which means you can enable any of them both before and after the installation. By default, KubeKey does not install these pluggable components. For more information, see Enable Pluggable Components. +KubeSphere has decoupled some core feature components since v2.1.0. These components are designed to be pluggable, which means you can enable any of them both before and after the installation. By default, KubeKey does not install these pluggable components. For more information, see [Enable Pluggable Components](../../../pluggable-components/). ![Pluggable Components](https://pek3b.qingstor.com/kubesphere-docs/png/20191207140846.png) diff --git a/content/zh/docs/installing-on-linux/introduction/multioverview.md b/content/zh/docs/installing-on-linux/introduction/multioverview.md index 7e2f8f9a9..fbc9c4d58 100644 --- a/content/zh/docs/installing-on-linux/introduction/multioverview.md +++ b/content/zh/docs/installing-on-linux/introduction/multioverview.md @@ -81,24 +81,22 @@ This example includes three hosts as below with the master node serving as the t ## Step 2: Download KubeKey -As below, you can either download the binary file. - -Download the Installer for KubeSphere v3.0.0. +Follow the step below to download KubeKey. {{< tabs >}} -{{< tab "For users with poor network to GitHub" >}} +{{< tab "For users with poor network connections to GitHub" >}} -For users in China, you can download the installer using this link. +Download KubeKey using the following command: ```bash wget https://kubesphere.io/kubekey/releases/v1.0.0 ``` {{}} -{{< tab "For users with good network to GitHub" >}} +{{< tab "For users with good network connections to GitHub" >}} -For users with good network to GitHub, you can download it from [GitHub Release Page](https://github.com/kubesphere/kubekey/releases/tag/v1.0.0) or use the following link directly. +Download KubeKey from [GitHub Release Page](https://github.com/kubesphere/kubekey/releases/tag/v1.0.0) or use the following command directly. ```bash wget https://github.com/kubesphere/kubekey/releases/download/v1.0.0/kubekey-v1.0.0-linux-amd64.tar.gz @@ -223,7 +221,7 @@ hosts: {{< notice tip >}} - You can enable the multi-cluster feature by editing the configuration file. For more information, see Multi-cluster Management. -- You can also select the components you want to install. For more information, see Enable Pluggable Components. For an example of a complete config-sample.yaml file, see [this file](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md). +- You can also select the components you want to install. For more information, see [Enable Pluggable Components](../../../pluggable-components/). For an example of a complete config-sample.yaml file, see [this file](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md). {{}} diff --git a/content/zh/docs/installing-on-linux/on-premises/install-kubesphere-on-vmware-vsphere.md b/content/zh/docs/installing-on-linux/on-premises/install-kubesphere-on-vmware-vsphere.md index 7befd94ac..9896a20f0 100644 --- a/content/zh/docs/installing-on-linux/on-premises/install-kubesphere-on-vmware-vsphere.md +++ b/content/zh/docs/installing-on-linux/on-premises/install-kubesphere-on-vmware-vsphere.md @@ -267,28 +267,32 @@ Or use `systemctl status -l keepalived` command to view systemctl status -l keepalived ``` -## Get the Installer Excutable File +## Download KubeKey -Download the Installer for KubeSphere v3.0.0. +[Kubekey](https://github.com/kubesphere/kubekey) is the next-gen installer which provides an easy, fast and flexible way to install Kubernetes and KubeSphere v3.0.0. + +Follow the step below to download KubeKey. {{< tabs >}} -{{< tab "For users with poor network to GitHub" >}} +{{< tab "For users with poor network connections to GitHub" >}} -For users in China, you can download the installer using this link. +Download KubeKey using the following command: ```bash wget https://kubesphere.io/kubekey/releases/v1.0.0 ``` + {{}} -{{< tab "For users with good network to GitHub" >}} +{{< tab "For users with good network connections to GitHub" >}} -For users with good network to GitHub, you can download it from [GitHub Release Page](https://github.com/kubesphere/kubekey/releases/tag/v1.0.0) or use the following link directly. +Download KubeKey from [GitHub Release Page](https://github.com/kubesphere/kubekey/releases/tag/v1.0.0) or use the following command directly. ```bash wget https://github.com/kubesphere/kubekey/releases/download/v1.0.0/kubekey-v1.0.0-linux-amd64.tar.gz ``` + {{}} {{}} @@ -500,4 +504,4 @@ You will be able to use default account and password `admin / P@88w0rd` to log i ![](/images/docs/vsphere/login.png) #### Enable Pluggable Components (Optional) -The example above demonstrates the process of a default minimal installation. To enable other components in KubeSphere, see [Enable Pluggable Components for more details](https://github.com/kubesphere/ks-installer#enable-pluggable-components). +The example above demonstrates the process of a default minimal installation. To enable other components in KubeSphere, see [Enable Pluggable Components](../../../pluggable-components/) for more details. diff --git a/content/zh/docs/installing-on-linux/public-cloud/install-ks-on-azure-vms.md b/content/zh/docs/installing-on-linux/public-cloud/install-ks-on-azure-vms.md index 8d925a9a5..f1fff9857 100644 --- a/content/zh/docs/installing-on-linux/public-cloud/install-ks-on-azure-vms.md +++ b/content/zh/docs/installing-on-linux/public-cloud/install-ks-on-azure-vms.md @@ -1,38 +1,40 @@ --- title: "Deploy KubeSphere on Azure VM Instance" -keywords: "Kubesphere, Installation, HA, high availability, load balancer, Azure" +keywords: "KubeSphere, Installation, HA, high availability, load balancer, Azure" description: "The tutorial is for installing a high-availability cluster on Azure." + +Weight: 2225 --- -## Before you begin +## Before You Begin -Technically, you can either install, administer, and manage Kubernetes yourself or go for a managed Kubernetes solution. If you are looking for a way to take advantage of Kubernetes with a hands-off approach, a fully managed platform solution is what you’re looking for, please see [Deploy KubeSphere on AKS](../../../installing-on-kubernetes/hosted-kubernetes/install-ks-on-aks) for more details. But if you want a bit more control over your configuration and setup a highly available cluster on Azure, this instruction will help you to setup a production-ready Kubernetes and KubeSphere. +Technically, you can either install and manage Kubernetes yourself or adopt a managed Kubernetes solution. If you are looking for a hands-off approach to taking advantage of Kubernetes, a fully-managed platform solution may suit you best. Please see [Deploy KubeSphere on AKS](../../../installing-on-kubernetes/hosted-kubernetes/install-kubesphere-on-aks/) for more details. However, if you want a bit more control over your configuration and set up a highly-available cluster on Azure, this instruction will help you to create a production-ready Kubernetes and KubeSphere cluster. ## Introduction -In this tutorial, we will use two key features of Azure virtual machines (VMs): +In this tutorial, we will use two key features of Azure virtual machines (VMs): -- Virtual Machine Scale Sets: Azure VMSS let you create and manage a group of load balanced VMs. The number of VM instances can automatically increase or decrease in response to demand or a defined schedule(Kubernates Autoscaler is available, but not covered in this tutorial, see [autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/cloudprovider/azure) for more details), which perfectly fits the Worker Nodes. -- Availability sets: An availability set is a logical grouping of VMs within a datacenter that automatically distributed across fault domains. This approach limits the impact of potential physical hardware failures, network outages, or power interruptions. All the Master and ETCD VMs will be placed in an Availability sets to meet our High Availability goals. +- Virtual Machine Scale Sets (VMSS): Azure VMSS let you create and manage a group of load balanced VMs. The number of VM instances can automatically increase or decrease in response to demand or a defined schedule (Kubernetes Autoscaler is available, but not covered in this tutorial. See [autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/cloudprovider/azure) for more details), which perfectly fits Worker nodes. +- Availability Sets: An availability set is a logical grouping of VMs within a datacenter that are automatically distributed across fault domains. This approach limits the impact of potential physical hardware failures, network outages, or power interruptions. All the Master and ETCD VMs will be placed in an availability set to achieve high availability. Besides those VMs, other resources like Load Balancer, Virtual Network and Network Security Group will be involved. ## Prerequisites - You need an [Azure](https://portal.azure.com) account to create all the resources. -- Basic knowledge of [Azure Resource Manager](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/)(ARM) templates, which are files that define the Azure infrastructure and configuration. +- Basic knowledge of [Azure Resource Manager](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/) (ARM) templates, which are files that define the infrastructure and configuration for your project. - Considering data persistence, for a production environment, we recommend you to prepare persistent storage and create a StorageClass in advance. For development and testing, you can use the integrated OpenEBS to provision LocalPV as the storage service directly. ## Architecture -Six machines of "Ubuntu 18.04" will be deployed in Azure Resources Group. Three of them are grouped into an Availability sets, playing the role of both Master and ETCD of the Kubernetes control plane. Another three VMs will be defined as a VMSS, Worker nodes will be run on it. +Six machines of **Ubuntu 18.04** will be deployed in Azure Resource Group. Three of them are grouped into an availability set, serving as both Master and ETCD of the Kubernetes control plane. Another three VMs will be defined as a VMSS where Worker nodes will be running. ![Architecture](/images/docs/aks/Azure-architecture.png) -Those VMs will be attached to a load balancer, there are two predefined rules in the LB: +Those VMs will be attached to a load balancer. There are two predefined rules in the LB: -- **Inbound NAT**: ssh port will be mapped for each machine, so we can easily manage VMs. -- **Load Balancing**: http and https ports will be mapped to Node pools by default, we can add other ports on demand. +- **Inbound NAT**: ssh port will be mapped for each machine so that you can easily manage VMs. +- **Load Balancing**: http and https ports will be mapped to Node pools by default. Other ports can be added on demand. | Service | Protocol | Rule | Backend Port | Frontend Port/Ports | Pools | |---|---|---|---|---|---| @@ -44,35 +46,41 @@ Those VMs will be attached to a load balancer, there are two predefined rules in ## Deploy HA Cluster Infrastructrue -You don't have to create those resources one by one with Wizards. Following the best practice of **infrastructure as code** on Azure, all resources in the architecture are already defined as ARM templates. +You don't have to create those resources one by one with wizards. According to the best practice of **infrastructure as code** on Azure, all resources in the architecture are already defined as ARM templates. ### Start to deploy with one click -Click the *Deploy* button below, you will be redirected to Azure and asked to fill in deployment parameters. +Click the **Deploy** button below, and you will be redirected to Azure and asked to fill in deployment parameters. [![Deploy to Azure](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/deploytoazure.svg?sanitize=true)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FRolandMa1986%2Fazurek8s%2Fmaster%2Fazuredeploy.json) [![Visualize](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/visualizebutton.svg?sanitize=true)](http://armviz.io/#/?load=https%3A%2F%2Fraw.githubusercontent.com%2FRolandMa1986%2Fazurek8s%2Fmaster%2Fazuredeploy.json) ### Change template parameters -Only a few parameter need to be changed. +Only few parameters need to be changed. -- Choose the *Create new* link under the Resources group and fill in a Name such as "KubeSphereVMRG". -- Fill in the admin's Username. -- Copy your public ssh key and fill in the Admin Key. Or create new one with *ssh-keygen*. +- Click **Create new** under **Resource group** and enter a name such as "KubeSphereVMRG". +- Enter **Admin Username**. +- Copy your public ssh key for the field **Admin Key**. Alternatively, create a new one with `ssh-keygen`. -> Password authentication is restriced in the Linux configuration, only SSH accept. +![](https://ap3.qingstor.com/kubesphere-website/docs/20200902145020.png) -Click the *Purchase* button in the bottom when you ready to continue. +{{< notice note >}} + +Password authentication is restricted in the Linux configuration. Only SSH is acceptable. + +{{}} + +Click the **Purchase** button at the bottom when you are ready to continue. ### Review Azure Resources in the Portal -Once the deployment success, you can find all the resources you need in the KubeSphereVMRG Resources group. Take your time and check them one by one if you are new to Azure. Then find the public IP of LB and private IP addresses of the VMs. You will need them in the next step. +Once the deployment succeeds, you can find all the resources you need in the resource group KubeSphereVMRG. Take your time and check them one by one if you are new to Azure. Record the public IP of LB and private IP addresses of the VMs. You will need them in the next step. ![New Created Resources](/images/docs/aks/azure-vm-all-resources.png) -## Deploy Kubernetes and Kubesphere +## Deploy Kubernetes and KubeSphere -You can execute the following command on your laptop or SSH to one of the Master VMs. There are files will be downloaded to local and disturbed to each VM during the installation. The installation will be much faster when you use **kk** in the Intranet than the Internet. +You can execute the following command on your device or connect to one of the Master VMs through ssh. During the installation, files will be downloaded and distributed to each VM. The installation will be much faster if you use KubeKey in the Intranet than the Internet. ```bash # copy your private ssh to master-0 @@ -84,25 +92,25 @@ ssh -i .ssh/id_rsa2 -p50200 kubesphere@40.81.5.xx ### Download KubeKey -[Kubekey](https://github.com/kubesphere/kubekey) is the next-gen installer which is used for installing Kubernetes and KubeSphere v3.0.0 fastly, flexibly and easily. +[Kubekey](https://github.com/kubesphere/kubekey) is the next-gen installer which provides an easy, fast and flexible way to install Kubernetes and KubeSphere v3.0.0. -1. First, download it and generate a configuration file to customize the installation as follows. +1. Download it so that you can generate a configuration file in the next step. {{< tabs >}} -{{< tab "For users with poor network to GitHub" >}} +{{< tab "For users with poor network connections to GitHub" >}} -For users in China, you can download the installer using this link. +Download KubeKey using the following command: ```bash wget https://kubesphere.io/kubekey/releases/v1.0.0 ``` {{}} -{{< tab "For users with good network to GitHub" >}} +{{< tab "For users with good network connections to GitHub" >}} -For users with good network to GitHub, you can download it from [GitHub Release Page](https://github.com/kubesphere/kubekey/releases/tag/v1.0.0) or use the following link directly. +Download KubeKey from [GitHub Release Page](https://github.com/kubesphere/kubekey/releases/tag/v1.0.0) or use the following command directly: ```bash wget https://github.com/kubesphere/kubekey/releases/download/v1.0.0/kubekey-v1.0.0-linux-amd64.tar.gz @@ -123,16 +131,16 @@ Grant the execution right to `kk`: chmod +x kk ``` -2. Then create an example configuration file with default configurations. Here we use Kubernetes v1.17.9 as an example. +2. Create an example configuration file with default configurations. Here Kubernetes v1.17.9 is used as an example. -``` +```bash ./kk create config --with-kubesphere v3.0.0 --with-kubernetes v1.17.9 ``` -> The following Kubernetes versions have been fully tested with KubeSphere: -> - v1.15:   v1.15.12 -> - v1.16:   v1.16.13 -> - v1.17:   v1.17.9 (default) -> - v1.18:   v1.18.6 +{{< notice note >}} + +These Kubernetes versions have been fully tested with KubeSphere: v1.15.12, v1.16.13, v1.17.9 (default), and v1.18.6. + +{{}} ### config-sample.yaml Example @@ -176,7 +184,11 @@ In addition to the node information, you need to provide the load balancer infor port: "6443" ``` -> - Note we are using the public load balancer directly instead of an internal load balancer due to the Azure [Load Balancer limits](https://docs.microsoft.com/en-us/azure/load-balancer/load-balancer-troubleshoot#cause-4-accessing-the-internal-load-balancer-frontend-from-the-participating-load-balancer-backend-pool-vm). +{{< notice note >}} + +The public load balancer is used directly instead of an internal load balancer due to Azure [Load Balancer limits](https://docs.microsoft.com/en-us/azure/load-balancer/load-balancer-troubleshoot#cause-4-accessing-the-internal-load-balancer-frontend-from-the-participating-load-balancer-backend-pool-vm). + +{{}} ### Persistent Storage Plugin Configuration @@ -184,7 +196,7 @@ See [Storage Configuration](../storage-configuration) for details. ### Configure the Network Plugin -Azure Virtual Network doesn't support IPIP mode which used by [calico](https://docs.projectcalico.org/reference/public-cloud/azure#about-calico-on-azure). So let's change the network plugin to flannel. +Azure Virtual Network doesn't support IPIP mode used by [calico](https://docs.projectcalico.org/reference/public-cloud/azure#about-calico-on-azure). You need to change the network plugin to `flannel`. ```yaml network: @@ -230,9 +242,9 @@ https://kubesphere.io 2020-xx-xx xx:xx:xx Congratulation! Now you can access the KubeSphere console using http://10.128.0.44:30880 (Replace the IP with yours). -## Add addtional Ports +## Add Additional Ports -Since we are using self-hosted Kubernetes solutions on Azure, So the Load Balancer is not integrated with [Kubernetes Service](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer). But you still can manually map the Nodeport to the PublicLB. There are 2 steps required. +Since we are using self-hosted Kubernetes solutions on Azure, the Load Balancer is not integrated with [Kubernetes Service](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer). However, you can still manually map the Nodeport to the PublicLB. There are 2 steps required. 1. Create a new Load Balance Rule in the Load Balancer. ![Load Balancer](/images/docs/aks/azure-vm-loadbalancer-rule.png) diff --git a/content/zh/docs/installing-on-linux/public-cloud/kubesphere-on-qingcloud-instance.md b/content/zh/docs/installing-on-linux/public-cloud/kubesphere-on-qingcloud-instance.md index bfabcc660..06d37f58c 100644 --- a/content/zh/docs/installing-on-linux/public-cloud/kubesphere-on-qingcloud-instance.md +++ b/content/zh/docs/installing-on-linux/public-cloud/kubesphere-on-qingcloud-instance.md @@ -115,26 +115,30 @@ Click **Submit** when you finish. ### Download KubeKey -[Kubekey](https://github.com/kubesphere/kubekey) is the next-gen installer which is used for installing Kubernetes and KubeSphere v3.0.0 fastly, flexibly and easily. +[Kubekey](https://github.com/kubesphere/kubekey) is the next-gen installer which provides an easy, fast and flexible way to install Kubernetes and KubeSphere v3.0.0. + +Follow the step below to download KubeKey. {{< tabs >}} -{{< tab "For users with poor network to GitHub" >}} +{{< tab "For users with poor network connections to GitHub" >}} -For users in China, you can download the installer using this link. +Download KubeKey using the following command: ```bash wget https://kubesphere.io/kubekey/releases/v1.0.0 ``` + {{}} -{{< tab "For users with good network to GitHub" >}} +{{< tab "For users with good network connections to GitHub" >}} -For users with good network to GitHub, you can download it from [GitHub Release Page](https://github.com/kubesphere/kubekey/releases/tag/v1.0.0) or use the following link directly. +Download KubeKey from [GitHub Release Page](https://github.com/kubesphere/kubekey/releases/tag/v1.0.0) or use the following command directly. ```bash wget https://github.com/kubesphere/kubekey/releases/download/v1.0.0/kubekey-v1.0.0-linux-amd64.tar.gz ``` + {{}} {{}} @@ -151,13 +155,17 @@ Grant the execution right to `kk`: chmod +x kk ``` -Then create an example configuration file with default configurations. Here we use Kubernetes v1.17.9 as an example. +Create an example configuration file with default configurations. Here Kubernetes v1.17.9 is used as an example. ```bash ./kk create config --with-kubesphere v3.0.0 --with-kubernetes v1.17.9 ``` -> Tip: These Kubernetes versions have been fully tested with KubeSphere: *v1.15.12*, *v1.16.13*, *v1.17.9* (default), *v1.18.6*. +{{< notice note >}} + +These Kubernetes versions have been fully tested with KubeSphere: v1.15.12, v1.16.13, v1.17.9 (default), and v1.18.6. + +{{}} ### Cluster Node Planning @@ -222,7 +230,7 @@ In addition to the node information, you need to provide the load balancer infor {{}} -After that, you can enable any components you need by following **Enable Pluggable Components** and start your HA cluster installation. +After that, you can enable any components you need by following [Enable Pluggable Components](../../../pluggable-components/) and start your HA cluster installation. ### Kubernetes Cluster Configuration (Optional) @@ -253,7 +261,7 @@ For each storage plugin configuration, you can refer to [config-example.md](http KubeSphere has decoupled some core feature components since v2.1.0. These components are designed to be pluggable which means you can enable them either before or after installation. By default, KubeSphere will be started with a minimal installation if you do not enable them. -You can enable any of them according to your demands. It is highly recommended that you install these pluggable components to discover the full-stack features and capabilities provided by KubeSphere. Please ensure your machines have sufficient CPU and memory before enabling them. See [Enable Pluggable Components](https://github.com/kubesphere/ks-installer#enable-pluggable-components) for details. +You can enable any of them according to your demands. It is highly recommended that you install these pluggable components to discover the full-stack features and capabilities provided by KubeSphere. Please ensure your machines have sufficient CPU and memory before enabling them. See [Enable Pluggable Components](../../../pluggable-components/) for details. ### Start to Bootstrap a Cluster diff --git a/content/zh/docs/introduction/_index.md b/content/zh/docs/introduction/_index.md index 29c100754..908feae00 100644 --- a/content/zh/docs/introduction/_index.md +++ b/content/zh/docs/introduction/_index.md @@ -13,27 +13,27 @@ icon: "/images/docs/docs.svg" This chapter gives you an overview of the basic concept of KubeSphere, features, advantages, uses cases and more. -## [What is KubeSphere](https://kubesphere-v3.netlify.app/docs/introduction/what-is-kubesphere/) +## [What is KubeSphere](https://kubesphere.io/docs/introduction/what-is-kubesphere/) Develop a basic understanding of KubeSphere and highlighted features of its latest version. -## [Features](https://kubesphere-v3.netlify.app/docs/introduction/features/) +## [Features](https://kubesphere.io/docs/introduction/features/) Get started with KubeSphere by understanding what KubeSphere is capable of and how you can make full use of it. -## [Architecture](https://kubesphere-v3.netlify.app/docs/introduction/architecture/) +## [Architecture](https://kubesphere.io/docs/introduction/architecture/) Explore the structure of KubeSphere to get a clear view of the components both at front end and back end. -## [Advantages](https://kubesphere-v3.netlify.app/docs/introduction/advantages/) +## [Advantages](https://kubesphere.io/docs/introduction/advantages/) Understand the reason why KubeSphere is beneficial to your work. -## [Use Cases](https://kubesphere-v3.netlify.app/docs/introduction/scenarios/) +## [Use Cases](https://kubesphere.io/docs/introduction/scenarios/) See how KubeSphere can be used in different scenarios, such as multi-cluster deployment, DevOps and service mesh. -## [Glossary](https://kubesphere-v3.netlify.app/docs/introduction/glossary/) +## [Glossary](https://kubesphere.io/docs/introduction/glossary/) Learn terms and phrases that are used in KubeSphere. diff --git a/content/zh/docs/pluggable-components/_index.md b/content/zh/docs/pluggable-components/_index.md index ce07e09e0..46476c850 100644 --- a/content/zh/docs/pluggable-components/_index.md +++ b/content/zh/docs/pluggable-components/_index.md @@ -8,15 +8,42 @@ linkTitle: "Enable Pluggable Components" weight: 3500 icon: "/images/docs/docs.svg" - --- -## Installing KubeSphere and Kubernetes on Linux +This chapter demonstrates detailed steps of enabling different components in KubeSphere both before and after installation so that you can take full advantage of the container platform for your business. -In this chapter, we will demonstrate how to use KubeKey to provision a new Kubernetes and KubeSphere cluster based on different infrastructures. Kubekey can help you to quickly build a production-ready cluster architecture on a set of machines from zero to one. It also helps you to easily scale the cluster and install pluggable components on existing architecture. +## [Overview](../pluggable-components/overview/) -## Most Popular Pages +Develop a basic understanding of key components in KubeSphere, including features and resource consumption. -Below you will find some of the most common and helpful pages from this chapter. We highly recommend you to review them at first. +## [KubeSphere App Store](../pluggable-components/app-store/) -{{< popularPage icon="/images/docs/bitmap.jpg" title="Install KubeSphere on AWS EC2" description="Provisioning a new Kubernetes and KubeSphere cluster based on AWS" link="" >}} +Learn how to enable App Store to share data and apps internally and set industry standards of delivery process externally. + +## [KubeSphere DevOps System](../pluggable-components/devops/) + +Learn how to enable DevOps to further free your developers and let them focus on code writing. + +## [KubeSphere Auditing Logs](../pluggable-components/auditing-logs/) + +Learn how to enable Auditing to document platform events and activities. + +## [KubeSphere Events](../pluggable-components/events/) + +Learn how to enable Events to keep track of everything that is happening on the platform. + +## [KubeSphere Logging System](../pluggable-components/logging/) + +Learn how to enable Logging to leverage the tenant-based system for log collection, query and management. + +## [KubeSphere Service Mesh](../pluggable-components/service-mesh/) + +Learn how to enable Service Mesh to use different traffic management strategies for microservices governance. + +## [KubeSphere Alerting and Notification](../pluggable-components/alerting-notification/) + +Learn how to enable Alerting and Notification to identify any potential issues in advance before they take a toll on your business. + +## [Network Policy](../pluggable-components/network-policy/) + +Learn how to enable Network Policy to control traffic flow at the IP address or port level. \ No newline at end of file diff --git a/content/zh/docs/pluggable-components/alerting-notification.md b/content/zh/docs/pluggable-components/alerting-notification.md new file mode 100644 index 000000000..f6fcfeeed --- /dev/null +++ b/content/zh/docs/pluggable-components/alerting-notification.md @@ -0,0 +1,157 @@ +--- +title: "KubeSphere Alerting and Notification" +keywords: "Kubernetes, alertmanager, KubeSphere, alerting, notification" +description: "How to Enable Alerting and Notification" + +linkTitle: "KubeSphere Alerting and Notification" +weight: 3545 +--- + +## What are KubeSphere Alerting and Notification + +Alerting and Notification are two important building blocks of observability, closely related monitoring and logging. The alerting system in KubeSphere, coupled with the proactive failure notification system, allows users to know activities of interest based on alert policies. When a predefined threshold of a certain metric is reached, an alert will be sent to preconfigured recipients, the notification method of which can be set by yourself, including Email, WeChat Work and Slack. With a highly functional alerting and notification system in place, you can quickly identify and resolve potential issues in advance before they affect your business. + +For more information, see Alerting Policy and Message. + +{{< notice note >}} + +It is recommended that you enable Alerting and Notification together so that users can receive notifications of alerts in time. + +{{}} + +## Enable Alerting and Notification before Installation + +### Installing on Linux + +When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. + +1. In the tutorial of [Installing KubeSphere on Linux](../../installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: + +```bash +vi config-sample.yaml +``` + +{{< notice note >}} + +If you adopt [All-in-one Installation](../../quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable Alerting and Notification in this mode (e.g. for testing purpose), refer to the following section to see how Alerting and Notification can be installed after installation. + +{{}} + +2. In this file, navigate to `alerting` and `notification` and change `false` to `true` for `enabled`. Save the file after you finish. + +```bash +alerting: + enabled: true # Change "false" to "true" +notification: + enabled: true # Change "false" to "true" +``` + +3. Create a cluster using the configuration file: + +```bash +./kk create cluster -f config-sample.yaml +``` + +### **Installing on Kubernetes** + +When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) for cluster setting. If you want to install Alerting and Notification, do not use `kubectl apply -f` directly for this file. + +1. In the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml). After that, to enable Alerting and Notification, create a local file cluster-configuration.yaml. + +```bash +vi cluster-configuration.yaml +``` + +2. Copy all the content in the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) and paste it to the local file just created. +3. In this local cluster-configuration.yaml file, navigate to `alerting` and `notification` and enable them by changing `false` to `true` for `enabled`. Save the file after you finish. + +```bash +alerting: + enabled: true # Change "false" to "true" +notification: + enabled: true # Change "false" to "true" +``` + +4. Execute the following command to start installation: + +```bash +kubectl apply -f cluster-configuration.yaml +``` + +## Enable Alerting and Notification after Installation + +1. Log in the console as `admin`. Click **Platform** at the top left corner and select **Clusters Management**. + +![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) + +2. Click **CRDs** and enter `clusterconfiguration` in the search bar. Click the result to view its detailed page. + +{{< notice info >}} + +A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. + +{{}} + +3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**. + +![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) + +4. In this yaml file, navigate to `alerting` and `notification` and change `false` to `true` for `enabled`. After you finish, click **Update** at the bottom right corner to save the configuration. + +```bash +alerting: + enabled: true # Change "false" to "true" +notification: + enabled: true # Change "false" to "true" +``` + +5. You can use the web kubectl to check the installation process by executing the following command: + +```bash +kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f +``` + +{{< notice tip >}} + +You can find the web kubectl tool by clicking the hammer icon at the bottom right corner of the console. + +{{}} + +## Verify the Installation of Component + +{{< tabs >}} + +{{< tab "Verify the Component in Dashboard" >}} + +If you can see **Alerting Messages** and **Alerting Policies** in the image below, it means the installation succeeds as the two parts won't display until you install the component. + +![alerting](https://ap3.qingstor.com/kubesphere-website/docs/20200901143123.png) + +{{}} + +{{< tab "Verify the Component through kubectl" >}} + +Execute the following command to check the status of pods: + +```bash +kubectl get pod -n kubesphere-alerting-system +``` + +The output may look as follows if the component runs successfully: + +```bash +NAME READY STATUS RESTARTS AGE +alerting-client-744c794979-xvsbz 1/1 Running 2 36m +alerting-db-ctrl-job-jwdsh 0/1 Completed 0 36m +alerting-db-init-job-sj2nv 0/1 Completed 0 36m +alerting-executor-59ff88f484-2l57d 2/2 Running 0 36m +alerting-manager-5dc9d6cd46-jshkw 1/1 Running 0 36m +alerting-watcher-dcb87b665-sm87b 1/1 Running 0 36m +notification-db-ctrl-job-phxsx 0/1 Completed 3 36m +notification-db-init-job-8q5rf 0/1 Completed 0 36m +notification-deployment-748897cbdf-2djpr 1/1 Running 0 36m +``` + +{{}} + +{{}} \ No newline at end of file diff --git a/content/zh/docs/pluggable-components/app-store.md b/content/zh/docs/pluggable-components/app-store.md index 4045d6207..cf9d1385f 100644 --- a/content/zh/docs/pluggable-components/app-store.md +++ b/content/zh/docs/pluggable-components/app-store.md @@ -23,7 +23,7 @@ For more information, see App Store. When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. -1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere-v3.netlify.app/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: +1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere.io/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: ```bash vi config-sample.yaml @@ -31,7 +31,7 @@ vi config-sample.yaml {{< notice note >}} -If you adopt [All-in-one Installation](https://kubesphere-v3.netlify.app/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable App Store in this mode (e.g. for testing purpose), refer to the following section to see how App Store can be installed after installation. +If you adopt [All-in-one Installation](https://kubesphere.io/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable App Store in this mode (e.g. for testing purpose), refer to the following section to see how App Store can be installed after installation. {{}} @@ -52,7 +52,7 @@ openpitrix: When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml) for cluster setting. If you want to install App Store, do not use `kubectl apply -f` directly for this file. -1. In the tutorial of [Installing KubeSphere on Kubernetes](https://kubesphere-v3.netlify.app/docs/installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable App Store, create a local file cluster-configuration.yaml. +1. In the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable App Store, create a local file cluster-configuration.yaml. ```bash vi cluster-configuration.yaml @@ -141,4 +141,3 @@ openpitrix-hyperpitrix-deployment-fb76645f4-crvmm 1/1 Running 0 {{}} {{}} - diff --git a/content/zh/docs/pluggable-components/auditing-logs.md b/content/zh/docs/pluggable-components/auditing-logs.md index ce801d30e..113fb54d9 100644 --- a/content/zh/docs/pluggable-components/auditing-logs.md +++ b/content/zh/docs/pluggable-components/auditing-logs.md @@ -19,7 +19,7 @@ For more information, see Logging, Events, and Auditing. When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. -1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere-v3.netlify.app/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: +1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere.io/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: ```bash vi config-sample.yaml @@ -27,7 +27,7 @@ vi config-sample.yaml {{< notice note >}} -If you adopt [All-in-one Installation](https://kubesphere-v3.netlify.app/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable Auditing in this mode (e.g. for testing purpose), refer to the following section to see how Auditing can be installed after installation. +If you adopt [All-in-one Installation](https://kubesphere.io/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable Auditing in this mode (e.g. for testing purpose), refer to the following section to see how Auditing can be installed after installation. {{}} @@ -66,7 +66,7 @@ es: # Storage backend for logging, tracing, events and auditing. When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml) for cluster setting. If you want to install Auditing, do not use `kubectl apply -f` directly for this file. -1. In the tutorial of [Installing KubeSphere on Kubernetes](https://kubesphere-v3.netlify.app/docs/installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable Auditing, create a local file cluster-configuration.yaml. +1. In the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable Auditing, create a local file cluster-configuration.yaml. ```bash vi cluster-configuration.yaml @@ -200,4 +200,4 @@ kube-auditing-webhook-deploy-6dfb46bb6c-jp77q 1/1 Runnin {{}} -{{}} \ No newline at end of file +{{}} diff --git a/content/zh/docs/pluggable-components/devops.md b/content/zh/docs/pluggable-components/devops.md index 3622f299a..92bb4bf79 100644 --- a/content/zh/docs/pluggable-components/devops.md +++ b/content/zh/docs/pluggable-components/devops.md @@ -21,7 +21,7 @@ For more information, see DevOps Administration. When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. -1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere-v3.netlify.app/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: +1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere.io/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: ```bash vi config-sample.yaml @@ -29,7 +29,7 @@ vi config-sample.yaml {{< notice note >}} -If you adopt [All-in-one Installation](https://kubesphere-v3.netlify.app/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable DevOps in this mode (e.g. for testing purpose), refer to the following section to see how DevOps can be installed after installation. +If you adopt [All-in-one Installation](https://kubesphere.io/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable DevOps in this mode (e.g. for testing purpose), refer to the following section to see how DevOps can be installed after installation. {{}} @@ -50,7 +50,7 @@ devops: When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml) for cluster setting. If you want to install DevOps, do not use `kubectl apply -f` directly for this file. -1. In the tutorial of [Installing KubeSphere on Kubernetes](https://kubesphere-v3.netlify.app/docs/installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable DevOps, create a local file cluster-configuration.yaml. +1. In the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable DevOps, create a local file cluster-configuration.yaml. ```bash vi cluster-configuration.yaml @@ -138,4 +138,4 @@ uc-jenkins-update-center-8c898f44f-hqv78 1/1 Running 0 1h14m {{}} -{{}} \ No newline at end of file +{{}} diff --git a/content/zh/docs/pluggable-components/events.md b/content/zh/docs/pluggable-components/events.md new file mode 100644 index 000000000..38691d4f9 --- /dev/null +++ b/content/zh/docs/pluggable-components/events.md @@ -0,0 +1,202 @@ +--- +title: "KubeSphere Events" +keywords: "Kubernetes, events, KubeSphere, k8s-events" +description: "How to enable KubeSphere Events" + +linkTitle: "KubeSphere Events" +weight: 3530 +--- + +## What are KubeSphere Events + +KubeSphere events allow users to keep track of what is happening inside a cluster, such as node scheduling status and image pulling result. They will be accurately recorded with the specific reason, status and message displayed in the web console. To query events, users can quickly launch the web Toolkit and enter related information in the search bar with different filters (e.g keyword and project) available. Events can also be archived to third-party tools, such as Elasticsearch, Kafka or Fluentd. + +For more information, see Logging, Events and Auditing. + +## Enable Events before Installation + +### Installing on Linux + +When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. + +1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere.io/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: + +```bash +vi config-sample.yaml +``` + +{{< notice note >}} + +If you adopt [All-in-one Installation](https://kubesphere.io/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable Events in this mode (e.g. for testing purpose), refer to the following section to see how Events can be installed after installation. + +{{}} + +2. In this file, navigate to `events` and change `false` to `true` for `enabled`. Save the file after you finish. + +```bash +events: + enabled: true # Change "false" to "true" +``` + +{{< notice note >}} + +By default, KubeKey will install Elasticsearch internally if Events is enabled. For a production environment, it is highly recommended that you set the following value in **config-sample.yaml** if you want to enable Events, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information before installation, KubeKey will integrate your external Elasticsearch directly instead of installing an internal one. + +{{}} + +```bash +es: # Storage backend for logging, tracing, events and auditing. + elasticsearchMasterReplicas: 1 # total number of master nodes, it's not allowed to use even number + elasticsearchDataReplicas: 1 # total number of data nodes + elasticsearchMasterVolumeSize: 4Gi # Volume size of Elasticsearch master nodes + elasticsearchDataVolumeSize: 20Gi # Volume size of Elasticsearch data nodes + logMaxAge: 7 # Log retention time in built-in Elasticsearch, it is 7 days by default. + elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log + externalElasticsearchUrl: # The URL of external Elasticsearch + externalElasticsearchPort: # The port of external Elasticsearch +``` + +3. Create a cluster using the configuration file: + +```bash +./kk create cluster -f config-sample.yaml +``` + +### **Installing on Kubernetes** + +When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) for cluster setting. If you want to install Events, do not use `kubectl apply -f` directly for this file. + +1. In the tutorial of [Installing KubeSphere on Kubernetes](https://kubesphere.io/docs/installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml). After that, to enable Events, create a local file cluster-configuration.yaml. + +```bash +vi cluster-configuration.yaml +``` + +2. Copy all the content in the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) and paste it to the local file just created. +3. In this local cluster-configuration.yaml file, navigate to `events` and enable Events by changing `false` to `true` for `enabled`. Save the file after you finish. + +```bash +events: + enabled: true # Change "false" to "true" +``` + +{{< notice note >}} + +By default, ks-installer will install Elasticsearch internally if Events is enabled. For a production environment, it is highly recommended that you set the following value in **cluster-configuration.yaml** if you want to enable Events, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information before installation, ks-installer will integrate your external Elasticsearch directly instead of installing an internal one. + +{{}} + +```bash +es: # Storage backend for logging, tracing, events and auditing. + elasticsearchMasterReplicas: 1 # total number of master nodes, it's not allowed to use even number + elasticsearchDataReplicas: 1 # total number of data nodes + elasticsearchMasterVolumeSize: 4Gi # Volume size of Elasticsearch master nodes + elasticsearchDataVolumeSize: 20Gi # Volume size of Elasticsearch data nodes + logMaxAge: 7 # Log retention time in built-in Elasticsearch, it is 7 days by default. + elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log + externalElasticsearchUrl: # The URL of external Elasticsearch + externalElasticsearchPort: # The port of external Elasticsearch +``` + +4. Execute the following command to start installation: + +```bash +kubectl apply -f cluster-configuration.yaml +``` + +## Enable Events after Installation + +1. Log in the console as `admin`. Click **Platform** at the top left corner and select **Clusters Management**. + +![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) + +2. Click **CRDs** and enter `clusterconfiguration` in the search bar. Click the result to view its detailed page. + +{{< notice info >}} + +A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. + +{{}} + +3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**. + +![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) + +4. In this yaml file, navigate to `events` and change `false` to `true` for `enabled`. After you finish, click **Update** at the bottom right corner to save the configuration. + +```bash +events: + enabled: true # Change "false" to "true" +``` + +{{< notice note >}} + +By default, Elasticsearch will be installed internally if Events is enabled. For a production environment, it is highly recommended that you set the following value in this yaml file if you want to enable Events, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information, KubeSphere will integrate your external Elasticsearch directly instead of installing an internal one. + +{{}} + +```bash +es: # Storage backend for logging, tracing, events and auditing. + elasticsearchMasterReplicas: 1 # total number of master nodes, it's not allowed to use even number + elasticsearchDataReplicas: 1 # total number of data nodes + elasticsearchMasterVolumeSize: 4Gi # Volume size of Elasticsearch master nodes + elasticsearchDataVolumeSize: 20Gi # Volume size of Elasticsearch data nodes + logMaxAge: 7 # Log retention time in built-in Elasticsearch, it is 7 days by default. + elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log + externalElasticsearchUrl: # The URL of external Elasticsearch + externalElasticsearchPort: # The port of external Elasticsearch +``` + +5. You can use the web kubectl to check the installation process by executing the following command: + +```bash +kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f +``` + +{{< notice tip >}} + +You can find the web kubectl tool by clicking the hammer icon at the bottom right corner of the console. + +{{}} + +## Verify the Installation of Component + +{{< tabs >}} + +{{< tab "Verify the Component in Dashboard" >}} + +If you enable both Logging and Events, you can check the status of Events in **Logging** in **Components**. You may see an image as follows: + +![events](https://ap3.qingstor.com/kubesphere-website/docs/events.png) + +If you only enable Events without Logging installed, you cannot see the image above as the button **Logging** will not display. + +{{}} + +{{< tab "Verify the Component through kubectl" >}} + +Execute the following command to check the status of pods: + +```bash +kubectl get pod -n kubesphere-logging-system +``` + +The output may look as follows if the component runs successfully: + +```bash +NAME READY STATUS RESTARTS AGE +elasticsearch-logging-data-0 1/1 Running 0 11m +elasticsearch-logging-data-1 1/1 Running 0 6m48s +elasticsearch-logging-discovery-0 1/1 Running 0 11m +fluent-bit-ljlsl 1/1 Running 0 6m30s +fluentbit-operator-5bf7687b88-85vxv 1/1 Running 0 11m +ks-events-exporter-5cb959c74b-rc4lm 2/2 Running 0 7m1s +ks-events-operator-7d46fcccc9-8vvsh 1/1 Running 0 10m +ks-events-ruler-97f756879-lg65t 2/2 Running 0 7m1s +ks-events-ruler-97f756879-ptbkr 2/2 Running 0 7m1s +``` + +{{}} + +{{}} + diff --git a/content/zh/docs/pluggable-components/logging.md b/content/zh/docs/pluggable-components/logging.md index 18451e2d6..5eaf84e5f 100644 --- a/content/zh/docs/pluggable-components/logging.md +++ b/content/zh/docs/pluggable-components/logging.md @@ -9,7 +9,7 @@ weight: 3535 ## What is KubeSphere Logging System -KubeSphere provides a powerful, holistic and easy-to-use logging system for log collection, query and management. It covers logs from at varied levels, including tenants, infrastructure resources, and applications. Users can search logs from different dimensions, such as project, workload, Pod and keyword. Compared with Kibana, the tenant-based logging system of KubeSphere features better isolation and security among tenants as each tenant can only view his or her own logs. Apart from KubeSphere's own logging system, the container platform also allows users to add third-party log collectors, such as Elasticsearch, Kafka and Fluentd. +KubeSphere provides a powerful, holistic and easy-to-use logging system for log collection, query and management. It covers logs from at varied levels, including tenants, infrastructure resources, and applications. Users can search logs from different dimensions, such as project, workload, Pod and keyword. Compared with Kibana, the tenant-based logging system of KubeSphere features better isolation and security among tenants as each tenant can only view his or her own logs. Apart from KubeSphere's own logging system, the container platform also allows users to add third-party log collectors, such as Elasticsearch, Kafka and Fluentd. For more information, see Logging, Events and Auditing. @@ -19,7 +19,7 @@ For more information, see Logging, Events and Auditing. When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. -1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere-v3.netlify.app/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: +1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere.io/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: ```bash vi config-sample.yaml @@ -27,7 +27,7 @@ vi config-sample.yaml {{< notice note >}} -If you adopt [All-in-one Installation](https://kubesphere-v3.netlify.app/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable Logging in this mode (e.g. for testing purpose), refer to the following section to see how Logging can be installed after installation. +If you adopt [All-in-one Installation](https://kubesphere.io/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable Logging in this mode (e.g. for testing purpose), refer to the following section to see how Logging can be installed after installation. {{}} @@ -65,7 +65,7 @@ es: # Storage backend for logging, tracing, events and auditing. When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml) for cluster setting. If you want to install Logging, do not use `kubectl apply -f` directly for this file. -1. In the tutorial of [Installing KubeSphere on Kubernetes](https://kubesphere-v3.netlify.app/docs/installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable Logging, create a local file cluster-configuration.yaml. +1. In the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable Logging, create a local file cluster-configuration.yaml. ```bash vi cluster-configuration.yaml @@ -193,4 +193,4 @@ logsidecar-injector-deploy-667c6c9579-tjckn 2/2 Running 0 8m56s {{}} -{{}} \ No newline at end of file +{{}} diff --git a/content/zh/docs/pluggable-components/network-policy.md b/content/zh/docs/pluggable-components/network-policy.md new file mode 100644 index 000000000..1dfd4a3b5 --- /dev/null +++ b/content/zh/docs/pluggable-components/network-policy.md @@ -0,0 +1,119 @@ +--- +title: "Network Policy" +keywords: "Kubernetes, KubeSphere, NetworkPolicy" +description: "How to Enable Network Policy" + +linkTitle: "Network Policy" +weight: 3547 +--- + +## What is Network Policy + +Starting from v3.0.0, users can configure network policies of native Kubernetes in KubeSphere. Network Policies are an application-centric construct, enabling you to specify how a pod is allowed to communicate with various network entities over the network. With network policies, users can achieve network isolation within the same cluster, which means firewalls can be set up between certain instances (pods). + +{{< notice note >}} + +- Please make sure that the CNI network plugin used by the cluster supports Network Policies before you enable it. There are a number of CNI network plugins that support Network Policies, including Calico, Cilium, Kube-router, Romana and Weave Net. +- It is recommended that you use [Calico](https://www.projectcalico.org/) as the CNI plugin before you enable Network Policy. + +{{}} + +For more information, see [Network Policies](https://kubernetes.io/docs/concepts/services-networking/network-policies/). + +## Enable Network Policy before Installation + +### Installing on Linux + +When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. + +1. In the tutorial of [Installing KubeSphere on Linux](../../installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: + +```bash +vi config-sample.yaml +``` + +{{< notice note >}} + +If you adopt [All-in-one Installation](../../quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable Network Policy in this mode (e.g. for testing purpose), refer to the following section to see how Network Policy can be installed after installation. + +{{}} + +2. In this file, navigate to `networkpolicy` and change `false` to `true` for `enabled`. Save the file after you finish. + +```bash +networkpolicy: + enabled: true # Change "false" to "true" +``` + +3. Create a cluster using the configuration file: + +```bash +./kk create cluster -f config-sample.yaml +``` + +### **Installing on Kubernetes** + +When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) for cluster setting. If you want to install Network Policy, do not use `kubectl apply -f` directly for this file. + +1. In the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml). After that, to enable Network Policy, create a local file cluster-configuration.yaml. + +```bash +vi cluster-configuration.yaml +``` + +2. Copy all the content in the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) and paste it to the local file just created. +3. In this local cluster-configuration.yaml file, navigate to `networkpolicy` and enable Network Policy by changing `false` to `true` for `enabled`. Save the file after you finish. + +```bash +networkpolicy: + enabled: true # Change "false" to "true" +``` + +4. Execute the following command to start installation: + +```bash +kubectl apply -f cluster-configuration.yaml +``` + +## Enable Network Policy after Installation + +1. Log in the console as `admin`. Click **Platform** at the top left corner and select **Clusters Management**. + +![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) + +2. Click **CRDs** and enter `clusterconfiguration` in the search bar. Click the result to view its detailed page. + +{{< notice info >}} + +A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. + +{{}} + +3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**. + +![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) + +4. In this yaml file, navigate to `networkpolicy` and change `false` to `true` for `enabled`. After you finish, click **Update** at the bottom right corner to save the configuration. + +```bash +networkpolicy: + enabled: true # Change "false" to "true" +``` + +5. You can use the web kubectl to check the installation process by executing the following command: + +```bash +kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f +``` + +{{< notice tip >}} + +You can find the web kubectl tool by clicking the hammer icon at the bottom right corner of the console. + +{{}} + +## Verify the Installation of Component + +If you can see **Network Policies** in **Network** as the image below, it means the installation succeeds as this part won't display until you install the component. + +![networkpolicy](https://ap3.qingstor.com/kubesphere-website/docs/20200831162836.png) \ No newline at end of file diff --git a/content/zh/docs/pluggable-components/overview.md b/content/zh/docs/pluggable-components/overview.md new file mode 100644 index 000000000..cccdb3382 --- /dev/null +++ b/content/zh/docs/pluggable-components/overview.md @@ -0,0 +1,10 @@ +--- +title: "Overview" +keywords: "Kubernetes, KubeSphere, pluggable-components, overview" +description: "Overview of installing pluggable components." + +linkTitle: "Overview" +weight: 3510 +--- + +TBD diff --git a/content/zh/docs/pluggable-components/release-v200.md b/content/zh/docs/pluggable-components/release-v200.md deleted file mode 100644 index 7f0c64c6c..000000000 --- a/content/zh/docs/pluggable-components/release-v200.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "KubeSphere Alerting and Notification" -keywords: "kubernetes, alertmanager, kubesphere, alerting, notification" -description: "How to Enable Alerting and Notification System" - -linkTitle: "KubeSphere Alerting and Notification" -weight: 500 ---- - -KubeSphere 2.0.0 was released on **May 18th, 2019**. - -## What's New in 2.0.0 - -### Component Upgrades - -- Support Kubernetes [Kubernetes 1.13.5](https://github.com/kubernetes/kubernetes/releases/tag/v1.13.5) -- Integrate [QingCloud Cloud Controller](https://github.com/yunify/qingcloud-cloud-controller-manager). After installing load balancer, QingCloud load balancer can be created through KubeSphere console and the backend workload is bound automatically.  -- Integrate [QingStor CSI v0.3.0](https://github.com/yunify/qingstor-csi/tree/v0.3.0) storage plugin and support physical NeonSAN storage system. Support SAN storage service with high availability and high performance. -- Integrate [QingCloud CSI v0.2.1](https://github.com/yunify/qingcloud-csi/tree/v0.2.1) storage plugin and support many types of volume to create QingCloud block services. -- Harbor is upgraded to 1.7.5. -- GitLab is upgraded to 11.8.1. -- Prometheus is upgraded to 2.5.0. - -### Microservice Governance - -- Integrate Istio 1.1.1 and support visualization of service mesh management. -- Enable the access to the project's external websites and the application traffic governance. -- Provide built-in sample microservice [Bookinfo Application](https://istio.io/docs/examples/bookinfo/). -- Support traffic governance. -- Support traffic images. -- Provide load balancing of microservice based on Istio. -- Support canary release. -- Enable blue-green deployment. -- Enable circuit breaking. -- Enable microservice tracing. - -### DevOps (CI/CD Pipeline) - -- CI/CD pipeline provides email notification and supports the email notification during construction. -- Enhance CI/CD graphical editing pipelines, and more pipelines for common plugins and execution conditions. -- Provide source code vulnerability scanning based on SonarQube 7.4. -- Support [Source to Image](https://github.com/kubesphere/s2ioperator) feature. - -### Monitoring - -- Provide Kubernetes component independent monitoring page including etcd, kube-apiserver and kube-scheduler. -- Optimize several monitoring algorithm. -- Optimize monitoring resources. Reduce Prometheus storage and the disk usage up to 80%. - -### Logging - -- Provide unified log console in terms of tenant. -- Enable accurate and fuzzy retrieval. -- Support real-time and history logs. -- Support combined log query based on namespace, workload, Pod, container, key words and time limit.   -- Support detail page of single and direct logs. Pods and containers can be switched. -- [FluentBit Operator](https://github.com/kubesphere/fluentbit-operator) supports logging gathering settings: ElasticSearch, Kafka and Fluentd can be added, activated or turned off as log collectors. Before sending to log collectors, you can configure filtering conditions for needed logs. - -### Alerting and Notifications - -- Email notifications are available for cluster nodes and workload resources.  -- Notification rules: combined multiple monitoring resources are available. Different warning levels, detection cycle, push times and threshold can be configured. -- Time and notifiers can be set. -- Enable notification repeating rules for different levels. - -### Security Enhancement - -- Fix RunC Container Escape Vulnerability [Runc container breakout](https://log.qingcloud.com/archives/5127) -- Fix Alpine Docker's image Vulnerability [Alpine container shadow breakout](https://www.alpinelinux.org/posts/Docker-image-vulnerability-CVE-2019-5021.html) -- Support single and multi-login configuration items. -- Verification code is required after multiple invalid logins. -- Enhance passwords' policy and prevent weak passwords. -- Others security enhancements. - -### Interface Optimization - -- Optimize multiple user experience of console, such as the switch between DevOps project and other projects. -- Optimize many Chinese-English webpages. - -### Others - -- Support Etcd backup and recovery. -- Support regular cleanup of the docker's image. - -## Bugs Fixes - -- Fix delay updates of the resource and deleted pages. -- Fix the left dirty data after deleting the HPA workload. -- Fix incorrect Job status display. -- Correct resource quota, Pod usage and storage metrics algorithm. -- Adjust CPU usage percentages. -- many more bugfix diff --git a/content/zh/docs/pluggable-components/release-v2001.md b/content/zh/docs/pluggable-components/release-v2001.md deleted file mode 100644 index f47697406..000000000 --- a/content/zh/docs/pluggable-components/release-v2001.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "KubeSphere Events System" -keywords: "kubernetes, events, kubesphere, k8s-events" -description: "How to enable KubeSphere events system" - -linkTitle: "KubeSphere Events System" -weight: 700 ---- - -KubeSphere 2.0.0 was released on **May 18th, 2019**. - -## What's New in 2.0.0 - -### Component Upgrades - -- Support Kubernetes [Kubernetes 1.13.5](https://github.com/kubernetes/kubernetes/releases/tag/v1.13.5) -- Integrate [QingCloud Cloud Controller](https://github.com/yunify/qingcloud-cloud-controller-manager). After installing load balancer, QingCloud load balancer can be created through KubeSphere console and the backend workload is bound automatically.  -- Integrate [QingStor CSI v0.3.0](https://github.com/yunify/qingstor-csi/tree/v0.3.0) storage plugin and support physical NeonSAN storage system. Support SAN storage service with high availability and high performance. -- Integrate [QingCloud CSI v0.2.1](https://github.com/yunify/qingcloud-csi/tree/v0.2.1) storage plugin and support many types of volume to create QingCloud block services. -- Harbor is upgraded to 1.7.5. -- GitLab is upgraded to 11.8.1. -- Prometheus is upgraded to 2.5.0. - -### Microservice Governance - -- Integrate Istio 1.1.1 and support visualization of service mesh management. -- Enable the access to the project's external websites and the application traffic governance. -- Provide built-in sample microservice [Bookinfo Application](https://istio.io/docs/examples/bookinfo/). -- Support traffic governance. -- Support traffic images. -- Provide load balancing of microservice based on Istio. -- Support canary release. -- Enable blue-green deployment. -- Enable circuit breaking. -- Enable microservice tracing. - -### DevOps (CI/CD Pipeline) - -- CI/CD pipeline provides email notification and supports the email notification during construction. -- Enhance CI/CD graphical editing pipelines, and more pipelines for common plugins and execution conditions. -- Provide source code vulnerability scanning based on SonarQube 7.4. -- Support [Source to Image](https://github.com/kubesphere/s2ioperator) feature. - -### Monitoring - -- Provide Kubernetes component independent monitoring page including etcd, kube-apiserver and kube-scheduler. -- Optimize several monitoring algorithm. -- Optimize monitoring resources. Reduce Prometheus storage and the disk usage up to 80%. - -### Logging - -- Provide unified log console in terms of tenant. -- Enable accurate and fuzzy retrieval. -- Support real-time and history logs. -- Support combined log query based on namespace, workload, Pod, container, key words and time limit.   -- Support detail page of single and direct logs. Pods and containers can be switched. -- [FluentBit Operator](https://github.com/kubesphere/fluentbit-operator) supports logging gathering settings: ElasticSearch, Kafka and Fluentd can be added, activated or turned off as log collectors. Before sending to log collectors, you can configure filtering conditions for needed logs. - -### Alerting and Notifications - -- Email notifications are available for cluster nodes and workload resources.  -- Notification rules: combined multiple monitoring resources are available. Different warning levels, detection cycle, push times and threshold can be configured. -- Time and notifiers can be set. -- Enable notification repeating rules for different levels. - -### Security Enhancement - -- Fix RunC Container Escape Vulnerability [Runc container breakout](https://log.qingcloud.com/archives/5127) -- Fix Alpine Docker's image Vulnerability [Alpine container shadow breakout](https://www.alpinelinux.org/posts/Docker-image-vulnerability-CVE-2019-5021.html) -- Support single and multi-login configuration items. -- Verification code is required after multiple invalid logins. -- Enhance passwords' policy and prevent weak passwords. -- Others security enhancements. - -### Interface Optimization - -- Optimize multiple user experience of console, such as the switch between DevOps project and other projects. -- Optimize many Chinese-English webpages. - -### Others - -- Support Etcd backup and recovery. -- Support regular cleanup of the docker's image. - -## Bugs Fixes - -- Fix delay updates of the resource and deleted pages. -- Fix the left dirty data after deleting the HPA workload. -- Fix incorrect Job status display. -- Correct resource quota, Pod usage and storage metrics algorithm. -- Adjust CPU usage percentages. -- many more bugfix diff --git a/content/zh/docs/pluggable-components/release-v300.md b/content/zh/docs/pluggable-components/release-v300.md deleted file mode 100644 index 15eacc468..000000000 --- a/content/zh/docs/pluggable-components/release-v300.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Overview" -keywords: "kubernetes, docker, kubesphere, jenkins, istio, prometheus" -description: "KubeSphere Release Notes For 3.0.0" - -linkTitle: "Overview" -weight: 50 ---- - -TBD diff --git a/content/zh/docs/pluggable-components/service-mesh.md b/content/zh/docs/pluggable-components/service-mesh.md index 2035f722a..86aaae4a5 100644 --- a/content/zh/docs/pluggable-components/service-mesh.md +++ b/content/zh/docs/pluggable-components/service-mesh.md @@ -19,7 +19,7 @@ For more information, see related sections in Project Administration and Usage. When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. -1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere-v3.netlify.app/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: +1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere.io/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: ```bash vi config-sample.yaml @@ -27,7 +27,7 @@ vi config-sample.yaml {{< notice note >}} -If you adopt [All-in-one Installation](https://kubesphere-v3.netlify.app/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable Service Mesh in this mode (e.g. for testing purpose), refer to the following section to see how Service Mesh can be installed after installation. +If you adopt [All-in-one Installation](https://kubesphere.io/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable Service Mesh in this mode (e.g. for testing purpose), refer to the following section to see how Service Mesh can be installed after installation. {{}} @@ -48,7 +48,7 @@ servicemesh: When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml) for cluster setting. If you want to install Service Mesh, do not use `kubectl apply -f` directly for this file. -1. In the tutorial of [Installing KubeSphere on Kubernetes](https://kubesphere-v3.netlify.app/docs/installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable Service Mesh, create a local file cluster-configuration.yaml. +1. In the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable Service Mesh, create a local file cluster-configuration.yaml. ```bash vi cluster-configuration.yaml @@ -147,4 +147,4 @@ jaeger-query-b478c5655-s57k8 2/2 Running 0 1h17m {{}} -{{}} \ No newline at end of file +{{}} diff --git a/content/zh/docs/quick-start/_index.md b/content/zh/docs/quick-start/_index.md index e1b810318..ab45e47e2 100644 --- a/content/zh/docs/quick-start/_index.md +++ b/content/zh/docs/quick-start/_index.md @@ -13,27 +13,27 @@ icon: "/images/docs/docs.svg" Quickstarts include six hands-on lab exercises that help you quickly get started with KubeSphere. It is highly recommended that you go though all of these parts to explore the basic feature of KubeSphere. -## [All-in-one Installation on Linux](https://kubesphere-v3.netlify.app/docs/quick-start/all-in-one-on-linux/) +## [All-in-one Installation on Linux](https://kubesphere.io/docs/quick-start/all-in-one-on-linux/) Learn how to install KubeSphere on Linux with a minimal installation package. The tutorial serves as a basic kick-starter for you to understand the container platform, paving the way for learning the following guides. -## [Minimal KubeSphere on Kubernetes](https://kubesphere-v3.netlify.app/docs/quick-start/minimal-kubesphere-on-k8s/) +## [Minimal KubeSphere on Kubernetes](https://kubesphere.io/docs/quick-start/minimal-kubesphere-on-k8s/) -Learn how to install KubeSphere on existing Kubernetes clusters with a minimal installation package. Your Kubernetes clusters can be hosed on cloud or on-premises. +Learn how to install KubeSphere on existing Kubernetes clusters with a minimal installation package. Your Kubernetes clusters can be hosted on cloud or on-premises. -## [Create Workspace, Project, Account and Role](https://kubesphere-v3.netlify.app/docs/quick-start/create-workspace-and-project/) +## [Create Workspace, Project, Account and Role](https://kubesphere.io/docs/quick-start/create-workspace-and-project/) Understand how you can take advantage of multi-tenant system in KubeSphere for fine-grained access control at different levels. -## [Deploy Bookinfo](https://kubesphere-v3.netlify.app/docs/quick-start/deploy-bookinfo-to-k8s/) +## [Deploy Bookinfo](https://kubesphere.io/docs/quick-start/deploy-bookinfo-to-k8s/) Explore KubeSphere service mesh by deploying Bookinfo and using different traffic management strategies, such as canary release. -## [Compose and Deploy Wordpress](https://kubesphere-v3.netlify.app/docs/quick-start/composing-an-app/) +## [Compose and Deploy Wordpress](https://kubesphere.io/docs/quick-start/composing-an-app/) Learn the entire process of deploying an example app in KubeSphere, including credential creation, volume creation, and component setting. -## [Enable Pluggable Components](https://kubesphere-v3.netlify.app/docs/quick-start/enable-pluggable-components/) +## [Enable Pluggable Components](https://kubesphere.io/docs/quick-start/enable-pluggable-components/) Install pluggable components on the platform so that you can explore KubeSphere in an all-around way. Pluggable components can be enabled both before and after the installation. diff --git a/content/zh/docs/quick-start/all-in-one-on-linux.md b/content/zh/docs/quick-start/all-in-one-on-linux.md index 44b48bfa7..4104d02ef 100644 --- a/content/zh/docs/quick-start/all-in-one-on-linux.md +++ b/content/zh/docs/quick-start/all-in-one-on-linux.md @@ -29,7 +29,7 @@ See the requirements for hardware and operating system shown below. To get start {{< notice note >}} -The system requirements above and the instructions below are for the default minimal installation without any optional components enabled. If your machine has at least 8 cores and 16G memory, it is recommended that you enable all components. For more information, see Enable Pluggable Components. +The system requirements above and the instructions below are for the default minimal installation without any optional components enabled. If your machine has at least 8 cores and 16G memory, it is recommended that you enable all components. For more information, see [Enable Pluggable Components](../../pluggable-components/). {{}} @@ -54,24 +54,28 @@ The system requirements above and the instructions below are for the default min ## Step 2: Download KubeKey +Follow the step below to download KubeKey. + {{< tabs >}} -{{< tab "For users with poor network to GitHub" >}} +{{< tab "For users with poor network connections to GitHub" >}} -For users in China, you can download the installer using this link. +Download KubeKey using the following command: ```bash wget https://kubesphere.io/kubekey/releases/v1.0.0 ``` + {{}} -{{< tab "For users with good network to GitHub" >}} +{{< tab "For users with good network connections to GitHub" >}} -For users with good network to GitHub, you can download it from [GitHub Release Page](https://github.com/kubesphere/kubekey/releases/tag/v1.0.0) or use the following link directly. +Download KubeKey from [GitHub Release Page](https://github.com/kubesphere/kubekey/releases/tag/v1.0.0) or use the following command directly. ```bash wget https://github.com/kubesphere/kubekey/releases/download/v1.0.0/kubekey-v1.0.0-linux-amd64.tar.gz ``` + {{}} {{}} @@ -177,4 +181,4 @@ After logging in the console, you can check the status of different components i ## Enable Pluggable Components (Optional) -The guide above is used only for minimal installation by default. To enable other components in KubeSphere, see Enable Pluggable Components for more details. +The guide above is used only for minimal installation by default. To enable other components in KubeSphere, see [Enable Pluggable Components](../../pluggable-components/) for more details. diff --git a/content/zh/docs/quick-start/enable-pluggable-components.md b/content/zh/docs/quick-start/enable-pluggable-components.md index e0caa45a9..d58b51bdb 100644 --- a/content/zh/docs/quick-start/enable-pluggable-components.md +++ b/content/zh/docs/quick-start/enable-pluggable-components.md @@ -26,8 +26,8 @@ For more information about each component, see Overview of Enable Pluggable Comp {{< notice note >}} -- By default, the above components are not enabled except `metrics_server`. In some cases, you need to manually disable it by changing `true` to `false` in the configuration. This is because the component may already be installed in your environment, especially for cloud-hosted Kubernetes clusters. -- `multicluster` is not covered in this tutorial. If you want to enable this feature, you need to set a corresponding value for `clusterRole`. For more information, see [Multi-cluster Management](https://kubesphere-v3.netlify.app/docs/multicluster-management/). +- If you use KubeKey to install KubeSphere on Linux, by default, the above components are not enabled except `metrics_server`. However, `metrics_server` remains disabled in the installer if you install KubeSphere on existing Kubernetes clusters. This is because the component may already be installed in your environment, especially for cloud-hosted Kubernetes clusters. +- `multicluster` is not covered in this tutorial. If you want to enable this feature, you need to set a corresponding value for `clusterRole`. For more information, see [Multi-cluster Management](https://kubesphere.io/docs/multicluster-management/). - Make sure your machine meets the hardware requirements before the installation. Here is the recommendation if you want to enable all pluggable components: CPU ≥ 8 Cores, Memory ≥ 16 G, Disk Space ≥ 100 G. {{}} @@ -38,7 +38,7 @@ For more information about each component, see Overview of Enable Pluggable Comp When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. -1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere-v3.netlify.app/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: +1. In the tutorial of [Installing KubeSphere on Linux](https://kubesphere.io/docs/installing-on-linux/introduction/multioverview/), you create a default file **config-sample.yaml**. Modify the file by executing the following command: ```bash vi config-sample.yaml @@ -46,9 +46,9 @@ vi config-sample.yaml {{< notice note >}} -If you adopt [All-in-one Installation](https://kubesphere-v3.netlify.app/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable pluggable components in this mode (e.g. for testing purpose), refer to the following section to see how pluggable components can be installed after installation. +If you adopt [All-in-one Installation](https://kubesphere.io/docs/quick-start/all-in-one-on-linux/), you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable pluggable components in this mode (e.g. for testing purpose), refer to the following section to see how pluggable components can be installed after installation. -{{}} +{{}} 2. In this file, enable the pluggable components you want to install by changing `false` to `true` for `enabled`. Here is [an example file](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md) for your reference. Save the file after you finish. 3. Create a cluster using the configuration file: @@ -61,7 +61,7 @@ If you adopt [All-in-one Installation](https://kubesphere-v3.netlify.app/docs/qu When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml) for cluster setting. If you want to install pluggable components, do not use `kubectl apply -f` directly for this file. -1. In the tutorial of [Installing KubeSphere on Kubernetes](https://kubesphere-v3.netlify.app/docs/installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable pluggable components, create a local file cluster-configuration.yaml. +1. In the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the file [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml). After that, to enable pluggable components, create a local file cluster-configuration.yaml. ```bash vi cluster-configuration.yaml @@ -113,7 +113,7 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app= {{< notice tip >}} -You can find the web kubectl tool by clicking the hammer icon at the bottom right corner of the console. +You can find the web kubectl tool by clicking the hammer icon at the bottom right corner of the console. {{}} @@ -149,4 +149,4 @@ https://kubesphere.io 20xx-xx-xx xx:xx:xx If you do not see relevant components in the above image, some pods may not be ready yet. You can execute `kubectl get pod --all-namespaces` through kubectl to see the status of pods. -{{}} \ No newline at end of file +{{}} diff --git a/content/zh/docs/quick-start/minimal-kubesphere-on-k8s.md b/content/zh/docs/quick-start/minimal-kubesphere-on-k8s.md index 666e90c89..edd771647 100644 --- a/content/zh/docs/quick-start/minimal-kubesphere-on-k8s.md +++ b/content/zh/docs/quick-start/minimal-kubesphere-on-k8s.md @@ -7,7 +7,7 @@ linkTitle: "Minimal KubeSphere on Kubernetes" weight: 3020 --- -In addition to installing KubeSphere on a Linux machine, you can also deploy it on existing Kubernetes clusters directly. This QuickStart guide walks you through the general steps of completing a minimal KubeSphere installation on Kubernetes. For more information, see [Installing on Kubernetes](https://kubesphere-v3.netlify.app/docs/installing-on-kubernetes/). +In addition to installing KubeSphere on a Linux machine, you can also deploy it on existing Kubernetes clusters directly. This QuickStart guide walks you through the general steps of completing a minimal KubeSphere installation on Kubernetes. For more information, see [Installing on Kubernetes](https://kubesphere.io/docs/installing-on-kubernetes/). {{< notice note >}} @@ -15,7 +15,7 @@ In addition to installing KubeSphere on a Linux machine, you can also deploy it - Make sure your machine meets the minimal hardware requirement: CPU > 1 Core, Memory > 2 G; - A default Storage Class in your Kubernetes cluster needs to be configured before the installation; - The CSR signing feature is activated in kube-apiserver when it is started with the `--cluster-signing-cert-file` and `--cluster-signing-key-file` parameters. See [RKE installation issue](https://github.com/kubesphere/kubesphere/issues/1925#issuecomment-591698309). -- For more information about the prerequisites of installing KubeSphere on Kubernetes, see [Prerequisites](https://kubesphere-v3.netlify.app/docs/installing-on-kubernetes/introduction/prerequisites/). +- For more information about the prerequisites of installing KubeSphere on Kubernetes, see [Prerequisites](https://kubesphere.io/docs/installing-on-kubernetes/introduction/prerequisites/). {{}} @@ -23,14 +23,7 @@ In addition to installing KubeSphere on a Linux machine, you can also deploy it After you make sure your machine meets the prerequisites, you can follow the steps below to install KubeSphere. -- Please read the note below before you execute the commands to start installation: - -{{< notice note >}} - -- If your server has trouble accessing GitHub, you can copy the content in [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml) and [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml) respectively and past it to local files. You then can use `kubectl apply -f` for the local files to install KubeSphere. -- In cluster-configuration.yaml, you need to disable `metrics_server` manually by changing `true` to `false` if the component has already been installed in your environment, especially for cloud-hosted Kubernetes clusters. - -{{}} +- Execute the following commands: ```bash kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml @@ -40,7 +33,13 @@ kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0. kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml ``` -- Inspect the logs of installation: +{{< notice note >}} + +If your server has trouble accessing GitHub, you can copy the content in [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml) and [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml) respectively and past it to local files. You then can use `kubectl apply -f` for the local files to install KubeSphere. + +{{}} + +Inspect the logs of installation: ```bash kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f @@ -59,4 +58,4 @@ kubectl get svc/ks-console -n kubesphere-system ## Enable Pluggable Components (Optional) -The guide above is used only for minimal installation by default. To enable other components in KubeSphere, see Enable Pluggable Components for more details. +The guide above is used only for minimal installation by default. To enable other components in KubeSphere, see [Enable Pluggable Components](../../pluggable-components/) for more details. diff --git a/content/zh/docs/release/_index.md b/content/zh/docs/release/_index.md index ee376ec42..9f28c2119 100644 --- a/content/zh/docs/release/_index.md +++ b/content/zh/docs/release/_index.md @@ -1,6 +1,6 @@ --- title: "Release Notes" -description: "Help you to better understand KubeSphere with detailed graphics and contents" +description: "Release Notes of Different KubeSphere Versions" layout: "single" linkTitle: "Release Notes" @@ -11,12 +11,29 @@ icon: "/images/docs/docs.svg" --- -## Installing KubeSphere and Kubernetes on Linux +This chapter lists the release notes of all versions of KubeSphere, helping you gain a comprehensive understanding of upgrades and feature enhancements in every version release. -In this chapter, we will demonstrate how to use KubeKey to provision a new Kubernetes and KubeSphere cluster based on different infrastructures. Kubekey can help you to quickly build a production-ready cluster architecture on a set of machines from zero to one. It also helps you to easily scale the cluster and install pluggable components on existing architecture. +## [Release Notes - 3.0.0](../release/release-v300/) -## Most Popular Pages +Release Notes for 3.0.0. -Below you will find some of the most common and helpful pages from this chapter. We highly recommend you to review them at first. +## [Release Notes - 2.1.1](../release/release-v211/) + +Release Notes for 2.1.1. + +## [Release Notes - 2.1.0](../release/release-v210/) + +Release Notes for 2.1.0. + +## [Release Notes - 2.0.2](../release/release-v202/) + +Release Notes for 2.0.2. + +## [Release Notes - 2.0.1](../release/release-v201/) + +Release Notes for 2.0.1. + +## [Release Notes - 2.0.0](../release/release-v200/) + +Release Notes for 2.0.0. -{{< popularPage icon="/images/docs/bitmap.jpg" title="Install KubeSphere on AWS EC2" description="Provisioning a new Kubernetes and KubeSphere cluster based on AWS" link="" >}} diff --git a/content/zh/docs/release/release-v300.md b/content/zh/docs/release/release-v300.md index e459798ca..4ceb85a7c 100644 --- a/content/zh/docs/release/release-v300.md +++ b/content/zh/docs/release/release-v300.md @@ -9,8 +9,8 @@ weight: 50 ## How to get v3.0.0 -- [Install KubeSphere v3.0.0 on Linux](https://github.com/kubesphere/kubekey) -- [Install KubeSphere v3.0.0 on existing Kubernetes](https://github.com/kubesphere/ks-installer) +- [Install KubeSphere v3.0.0 on Linux](../../installing-on-linux/) +- [Install KubeSphere v3.0.0 on existing Kubernetes](../../installing-on-kubernetes/) ## Release Notes @@ -26,14 +26,14 @@ weight: 50 - [KubeKey](https://github.com/kubesphere/kubekey) officially supports Kubernetes 1.15.12, 1.16.13, 1.17.9 and 1.18.6 (Please avoid using KubeKey to install Kubernetes 1.15 to 1.15.5 and 1.16 to 1.16.2, because Kubernetes has an [API validation issue](https://github.com/kubernetes/kubernetes/issues/83778)) - Add support for EulerOS, UOS and KylinOS - Add support for Kunpeng and Phytium CPU -- Use ClusterConfiguration to store ks-installer's configuration instead of ConfigMap +- Use ClusterConfiguration CRD to store ks-installer's configuration instead of ConfigMap ## **Cluster Management** ### FEATURES - Support management of multiple Kubernetes clusters -- Support Federated Deployment across multiple clusters +- Support Federated Deployment and Federated StatefulSet across multiple clusters ## **Observability** @@ -54,7 +54,7 @@ weight: 50 - Upgrade Node Exporter to v0.18.1 - Upgrade kube-state-metrics to v1.9.6 - Upgrade metrics server to v0.3.7 -- metrics-server is enabled by default +- metrics-server is enabled by default (Disabled if KubeSphere is installed on existing Kubernetes) - Upgrade Fluent Bit Operator to v0.2.0 - Upgrade Fluent Bit to v1.4.6 - Significantly improve log searching performance @@ -97,28 +97,35 @@ weight: 50 ### UPGRADES & ENHANCEMENTS - Users can use the same application repository name + - Support the application template which contains CRDs + - Merge all OpenPitrix services into one service + - Support HTTP basic authentication when adding an application repository + - Add and upgrade below apps in App Store: - AWS EBS CSI Driver 0.5.0 - Helm 0.3.0 - AWS EFS CSI Driver 0.3.0 - Helm 0.1.0 - AWS FSX CSI Driver 0.1.0 - Helm 0.1.0 - Elasticsearch Exporter 1.1.0 - Helm 3.3.0 - etcd 3.3.12 - Helm 0.1.1 - Harbor 2.0.0 - Helm 1.4.0 - Memcached 1.5.20 - Helm 3.2.3 - Minio master - Helm 5.0.26 - MongoDB 4.2.1 - Helm 0.3.0 - MySQL 5.7.30 - Helm 1.6.6 - MySQL Exporter 0.11.0 - Helm 0.5.3 - Nginx 1.18.0 - Helm 1.3.2 - Porter 0.3-alpha - Helm 0.1.3 - PostgreSQL 12.0 - Helm 0.3.2 - RabbitMQ 3.8.1 - Helm 0.3.0 - Redis 5.0.5 - Helm 0.3.2 - Redis Exporter 1.3.4 - Helm 3.4.1 - Tomcat 8.5.41 - Helm 0.4.1+1 + + | App Name | App Version | Chart Version | + | ---------------------- | ----------- | :------------ | + | AWS EBS CSI Driver | 0.5.0 | 0.3.0 | + | AWS EFS CSI Driver | 0.3.0 | 0.1.0 | + | AWS FSX CSI Driver | 0.1.0 | 0.1.0 | + | Elasticsearch Exporter | 1.1.0 | 3.3.0 | + | etcd | 3.3.12 | 0.1.1 | + | Harbor | 2.0.0 | 1.4.0 | + | Memcached | 1.5.20 | 3.2.3 | + | Minio master | | 5.0.26 | + | MongoDB | 4.2.1 | 0.3.0 | + | MySQL | 5.7.30 | 1.6.6 | + | MySQL Exporter | 0.11.0 | 0.5.3 | + | Nginx | 1.18.0 | 1.3.2 | + | Porter | 0.3-alpha | 0.1.3 | + | PostgreSQL | 12.0 | 0.3.2 | + | RabbitMQ | 3.8.1 | 0.3.0 | + | Redis | 5.0.5 | 0.3.2 | + | Redis Exporter | 1.3.4 | 3.4.1 | + | Tomcat | 8.5.41 | 0.4.1+1 | ### BUG FIXES diff --git a/content/zh/docs/upgrade/upgrade-overview.md b/content/zh/docs/upgrade/upgrade-overview.md index ed4f5f64d..523a5961c 100644 --- a/content/zh/docs/upgrade/upgrade-overview.md +++ b/content/zh/docs/upgrade/upgrade-overview.md @@ -33,6 +33,6 @@ KubeSphere v3.0.0 is compatible with Kubernetes 1.15.x, 1.16.x, 1.17.x and 1.18. A brand new installer [KubeKey](https://github.com/kubesphere/kubekey) is introduced in KubeSphere v3.0.0, with which you can install or upgrade Kubernetes and KubeSphere. More details about upgrading with [KubeKey](https://github.com/kubesphere/kubekey) will be covered in the following sections. -### KubeKey or ks-installer? +## KubeKey or ks-installer? [ks-installer](https://github.com/kubesphere/ks-installer/tree/master) was the main installation tool as of KubeSphere v2. For users whose Kubernetes clusters were NOT deployed via [KubeSphere Installer](https://v2-1.docs.kubesphere.io/docs/installation/all-in-one/#step-2-download-installer-package), they should choose ks-installer to upgrade KubeSphere. For example, if your Kubernetes is hosted by cloud vendors or self provisioned, you should go for [Upgrade with ks-installer](../upgrade-with-ks-installer).