From 04c14c7134c84dd9bbdcb5cf614361b193b31f59 Mon Sep 17 00:00:00 2001 From: Ray Zhou Date: Mon, 2 Nov 2020 14:49:24 +0800 Subject: [PATCH 1/4] Chonge Wordpress to WordPress Signed-off-by: Ray Zhou --- content/en/docs/quick-start/wordpress-deployment.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/quick-start/wordpress-deployment.md b/content/en/docs/quick-start/wordpress-deployment.md index b1586be59..cae4b835d 100644 --- a/content/en/docs/quick-start/wordpress-deployment.md +++ b/content/en/docs/quick-start/wordpress-deployment.md @@ -1,15 +1,15 @@ --- -title: "Compose and Deploy Wordpress" -keywords: 'KubeSphere, Kubernetes, app, Wordpress' +title: "Compose and Deploy WordPress" +keywords: 'KubeSphere, Kubernetes, app, WordPress' description: 'Compose and deploy Wordpress.' -linkTitle: "Compose and Deploy Wordpress" +linkTitle: "Compose and Deploy WordPress" weight: 3050 --- ## WordPress Introduction -WordPress is a free and open-source content management system written in PHP, allowing users to build their own websites. A complete Wordpress application includes the following Kubernetes objects with MySQL serving as the backend database. +WordPress is a free and open-source content management system written in PHP, allowing users to build their own websites. A complete WordPress application includes the following Kubernetes objects with MySQL serving as the backend database. ![WordPress](https://pek3b.qingstor.com/kubesphere-docs/png/20200105181908.png) From a5be8e418de5f2300b7a26b9f2fd3f806c2aaa72 Mon Sep 17 00:00:00 2001 From: Ray Zhou Date: Mon, 2 Nov 2020 22:28:00 +0800 Subject: [PATCH 2/4] refactor quickstarts - enable pluggable components Signed-off-by: Ray Zhou --- .../quick-start/enable-pluggable-components.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/content/en/docs/quick-start/enable-pluggable-components.md b/content/en/docs/quick-start/enable-pluggable-components.md index e8bf3e982..9c31dc366 100644 --- a/content/en/docs/quick-start/enable-pluggable-components.md +++ b/content/en/docs/quick-start/enable-pluggable-components.md @@ -22,7 +22,7 @@ This tutorial demonstrates how to enable pluggable components of KubeSphere both | openpitrix | KubeSphere App Store | Provide an app store for Helm-based applications and allow users to manage apps throughout the entire lifecycle. | | servicemesh | KubeSphere Service Mesh (Istio-based) | Provide fine-grained traffic management, observability and tracing, and visualized traffic topology. | -For more information about each component, see Overview of Enable Pluggable Components. +For more information about each component, see [Overview of Enable Pluggable Components](../../pluggable-components/). {{< notice note >}} @@ -36,7 +36,7 @@ For more information about each component, see Overview of Enable Pluggable Comp ### **Installing on Linux** -When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. +When you install KubeSphere on multi-node 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: @@ -46,11 +46,11 @@ 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 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](../../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](#enable-pluggable-components-after-installation) 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. +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/release-1.0/docs/config-example.md) for your reference. Save the file after you finish. 3. Create a cluster using the configuration file: ```bash @@ -59,17 +59,17 @@ If you adopt [All-in-one Installation](../../quick-start/all-in-one-on-linux/), ### Installing on Kubernetes -When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) for cluster setting. If you want to install pluggable components, do not use `kubectl apply -f` directly for this file. +When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) for cluster setting. -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://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml). After that, to enable pluggable components, create a local file cluster-configuration.yaml. +1. To enable pluggable components you want to install, change `false` to `true` for `enabled` in the file cluster-configuration.yaml. Here is [an example file](https://github.com/kubesphere/ks-installer/blob/release-3.0/deploy/cluster-configuration.yaml) for your reference. Save the file after you finish.. ```bash vi cluster-configuration.yaml ``` -2. Copy all the content in the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) and paste it to the local file just created. -3. In this local cluster-configuration.yaml 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/ks-installer/blob/master/deploy/cluster-configuration.yaml) for your reference. Save the file after you finish. -4. Execute the following command to start installation: +2. In the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the installer file [kubesphere-installer.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml) which waits the file cluster-configuration.yaml to apply for continuing the installation. + +3. Execute the following command to start installation: ```bash kubectl apply -f cluster-configuration.yaml From 6248ec9bc1cc3da94d2a575edc70e019ef365fca Mon Sep 17 00:00:00 2001 From: rayzhou2017 Date: Tue, 3 Nov 2020 11:56:28 +0800 Subject: [PATCH 3/4] Update enable-pluggable-components.md --- content/en/docs/quick-start/enable-pluggable-components.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/quick-start/enable-pluggable-components.md b/content/en/docs/quick-start/enable-pluggable-components.md index 9c31dc366..b4f36e0b4 100644 --- a/content/en/docs/quick-start/enable-pluggable-components.md +++ b/content/en/docs/quick-start/enable-pluggable-components.md @@ -36,7 +36,7 @@ For more information about each component, see [Overview of Enable Pluggable Com ### **Installing on Linux** -When you install KubeSphere on multi-node Linux, you need to create a configuration file, which lists all KubeSphere components. +When you implement multi-node installation of 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: From c18dd4124fed1a3b417b4b1e03223fb2409c200a Mon Sep 17 00:00:00 2001 From: rayzhou2017 Date: Tue, 3 Nov 2020 14:29:54 +0800 Subject: [PATCH 4/4] Update enable-pluggable-components.md --- .../quick-start/enable-pluggable-components.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/content/en/docs/quick-start/enable-pluggable-components.md b/content/en/docs/quick-start/enable-pluggable-components.md index b4f36e0b4..ad686e7a7 100644 --- a/content/en/docs/quick-start/enable-pluggable-components.md +++ b/content/en/docs/quick-start/enable-pluggable-components.md @@ -59,22 +59,27 @@ If you adopt [All-in-one Installation](../../quick-start/all-in-one-on-linux/), ### Installing on Kubernetes -When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) for cluster setting. +When you install KubeSphere on Kubernetes, you need to execute `kubectl apply -f` first for the installer file [kubesphere-installer.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml) as stated in the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/). After that, follow the steps below to enable pluggable components: -1. To enable pluggable components you want to install, change `false` to `true` for `enabled` in the file cluster-configuration.yaml. Here is [an example file](https://github.com/kubesphere/ks-installer/blob/release-3.0/deploy/cluster-configuration.yaml) for your reference. Save the file after you finish.. +1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) and copy and paste the content of it to a local `cluster-configuration.yaml` file. ```bash vi cluster-configuration.yaml ``` -2. In the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you execute `kubectl apply -f` first for the installer file [kubesphere-installer.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml) which waits the file cluster-configuration.yaml to apply for continuing the installation. - -3. Execute the following command to start installation: +2. To enable the pluggable component you want to install, change `false` to `true` for `enabled` under the component in this file. +3. Save this local file and execute the following command to apply it. ```bash kubectl apply -f cluster-configuration.yaml ``` +{{< notice warning >}} + +You must apply the `kubesphere-installer.yaml` file first before you apply the file `cluster-configuration.yaml`. Wrong execution order or the failure to apply either file can result in installation failure. + +{{}} + Whether you install KubeSphere on Linux or on Kubernetes, you can check the status of the components you have enabled in the web console of KubeSphere after installation. Go to **Components**, and you can see an image below: ![KubeSphere-components](https://ap3.qingstor.com/kubesphere-website/docs/20200828145506.png)