From ce848b6873af11bd1cab06627c2ff5a1b9845a94 Mon Sep 17 00:00:00 2001 From: Ray Zhou Date: Thu, 5 Nov 2020 15:32:47 +0800 Subject: [PATCH] Update optional components enabling guide - app store, devops Signed-off-by: Ray Zhou --- .../en/docs/pluggable-components/app-store.md | 8 +- .../en/docs/pluggable-components/devops.md | 75 +++++++++---------- 2 files changed, 41 insertions(+), 42 deletions(-) diff --git a/content/en/docs/pluggable-components/app-store.md b/content/en/docs/pluggable-components/app-store.md index c94dd2253..fc22446a5 100644 --- a/content/en/docs/pluggable-components/app-store.md +++ b/content/en/docs/pluggable-components/app-store.md @@ -21,7 +21,7 @@ For more information, see [App Store](../../application-store/). ### Installing on Linux -When you install KubeSphere on 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: @@ -37,7 +37,7 @@ If you adopt [All-in-one Installation](../../quick-start/all-in-one-on-linux/), 2. In this file, navigate to `openpitrix` and change `false` to `true` for `enabled`. Save the file after you finish. - ```bash + ```yaml openpitrix: enabled: true # Change "false" to "true" ``` @@ -60,7 +60,7 @@ The process of installing KubeSphere on Kubernetes is same as stated in the tuto 2. In this local cluster-configuration.yaml file, navigate to `openpitrix` and enable App Store by changing `false` to `true` for `enabled`. Save the file after you finish. - ```bash + ```yaml openpitrix: enabled: true # Change "false" to "true" ``` @@ -91,7 +91,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource 4. In this yaml file, navigate to `openpitrix` and change `false` to `true` for `enabled`. After you finish, click **Update** in the bottom-right corner to save the configuration. - ```bash + ```yaml openpitrix: enabled: true # Change "false" to "true" ``` diff --git a/content/en/docs/pluggable-components/devops.md b/content/en/docs/pluggable-components/devops.md index 753e4c14c..d6a939bb3 100644 --- a/content/en/docs/pluggable-components/devops.md +++ b/content/en/docs/pluggable-components/devops.md @@ -13,19 +13,19 @@ KubeSphere DevOps System is designed for CI/CD workflows in Kubernetes. Based on The DevOps system offers an enabling environment for users as apps can be automatically released to the same platform. It is also compatible with third-party private image registries (e.g. Harbor) and code repositories (e.g. GitLab/GitHub/SVN/BitBucket). As such, it creates excellent user experiences by providing users with comprehensive, visualized CI/CD pipelines which are extremely useful in air-gapped environments. -For more information, see DevOps Administration. +For more information, see [DevOps User Guide](../../devops-user-guide/). ## Enable DevOps before Installation ### Installing on Linux -When you install KubeSphere on 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: -```bash -vi config-sample.yaml -``` + ```bash + vi config-sample.yaml + ``` {{< notice note >}} @@ -35,46 +35,46 @@ If you adopt [All-in-one Installation](../../quick-start/all-in-one-on-linux/), 2. In this file, navigate to `devops` and change `false` to `true` for `enabled`. Save the file after you finish. -```bash -devops: - enabled: true # Change "false" to "true" -``` + ```yaml + devops: + enabled: true # Change "false" to "true" + ``` 3. Create a cluster using the configuration file: -```bash -./kk create cluster -f config-sample.yaml -``` + ```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://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) for cluster setting. If you want to install DevOps, do not use `kubectl apply -f` directly for this file. +The process of installing KubeSphere on Kubernetes is same as stated in the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/) except the optional component DevOps needs to be enabled first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/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://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml). After that, to enable DevOps, create a local file cluster-configuration.yaml. +1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) and open it for editing. -```bash -vi cluster-configuration.yaml -``` + ```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, navigate to `devops` and enable DevOps by changing `false` to `true` for `enabled`. Save the file after you finish. +2. In this local cluster-configuration.yaml file, navigate to `devops` and enable DevOps by changing `false` to `true` for `enabled`. Save the file after you finish. -```bash -devops: - enabled: true # Change "false" to "true" -``` + ```yaml + devops: + enabled: true # Change "false" to "true" + ``` -4. Execute the following command to start installation: +3. Execute the following commands to start installation: -```bash -kubectl apply -f cluster-configuration.yaml -``` + ```bash + kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml + + kubectl apply -f cluster-configuration.yaml + ``` ## Enable DevOps after Installation 1. Log in the console as `admin`. Click **Platform** in the top-left corner and select **Clusters Management**. - -![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) + ![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. @@ -85,21 +85,20 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource {{}} 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) + ![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) 4. In this yaml file, navigate to `devops` and change `false` to `true` for `enabled`. After you finish, click **Update** in the bottom-right corner to save the configuration. -```bash -devops: - enabled: true # Change "false" to "true" -``` + ```yaml + devops: + 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 -``` + ```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 >}}