diff --git a/content/en/docs/pluggable-components/app-store.md b/content/en/docs/pluggable-components/app-store.md index f2399b292..49356ee23 100644 --- a/content/en/docs/pluggable-components/app-store.md +++ b/content/en/docs/pluggable-components/app-store.md @@ -36,6 +36,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ```yaml openpitrix: + store: enabled: true # Change "false" to "true" ``` @@ -47,7 +48,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ### **Installing on Kubernetes** -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 App Store needs to be enabled first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. +As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you can enable the KubeSphere App Store first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. 1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) and edit it. @@ -59,6 +60,7 @@ The process of installing KubeSphere on Kubernetes is same as stated in the tuto ```yaml openpitrix: + store: enabled: true # Change "false" to "true" ``` @@ -92,6 +94,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource ```yaml openpitrix: + store: enabled: true # Change "false" to "true" ``` diff --git a/content/en/docs/pluggable-components/auditing-logs.md b/content/en/docs/pluggable-components/auditing-logs.md index 3d366001c..0e5f64354 100644 --- a/content/en/docs/pluggable-components/auditing-logs.md +++ b/content/en/docs/pluggable-components/auditing-logs.md @@ -32,7 +32,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ```yaml auditing: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` {{< notice note >}} @@ -59,7 +59,7 @@ By default, KubeKey will install Elasticsearch internally if Auditing is enabled ### **Installing on Kubernetes** -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 Auditing needs to be enabled first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. +As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you can enable KubeSphere Auditing first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. 1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) and edit it. @@ -71,7 +71,7 @@ The process of installing KubeSphere on Kubernetes is same as stated in the tuto ```yaml auditing: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` {{< notice note >}} @@ -118,7 +118,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource ```yaml auditing: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` {{< notice note >}} diff --git a/content/en/docs/pluggable-components/devops.md b/content/en/docs/pluggable-components/devops.md index 1fae4baef..1135abd06 100644 --- a/content/en/docs/pluggable-components/devops.md +++ b/content/en/docs/pluggable-components/devops.md @@ -34,7 +34,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ```yaml devops: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` 3. Create a cluster using the configuration file: @@ -45,7 +45,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ### **Installing on Kubernetes** -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) file. +As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you can enable KubeSphere DevOps first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. 1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) and edit it. @@ -57,7 +57,7 @@ The process of installing KubeSphere on Kubernetes is same as stated in the tuto ```yaml devops: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` 3. Execute the following commands to start installation: @@ -89,7 +89,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource ```yaml devops: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` 5. You can use the web kubectl to check the installation process by executing the following command: diff --git a/content/en/docs/pluggable-components/events.md b/content/en/docs/pluggable-components/events.md index 644f87cb4..01ca87e7a 100644 --- a/content/en/docs/pluggable-components/events.md +++ b/content/en/docs/pluggable-components/events.md @@ -34,7 +34,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ```yaml events: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` {{< notice note >}} @@ -61,7 +61,7 @@ By default, KubeKey will install Elasticsearch internally if Events is enabled. ### Installing on Kubernetes -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 Events needs to be enabled first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. +As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you can enable KubeSphere Events first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. 1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) and edit it. @@ -73,7 +73,7 @@ The process of installing KubeSphere on Kubernetes is same as stated in the tuto ```yaml events: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` {{< notice note >}} @@ -122,7 +122,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource ```yaml events: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` {{< notice note >}} diff --git a/content/en/docs/pluggable-components/logging.md b/content/en/docs/pluggable-components/logging.md index d54af881f..1380d55c3 100644 --- a/content/en/docs/pluggable-components/logging.md +++ b/content/en/docs/pluggable-components/logging.md @@ -36,7 +36,7 @@ When you install KubeSphere on Linux, you need to create a configuration file, w ```yaml logging: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` {{< notice note >}} @@ -63,7 +63,7 @@ By default, KubeKey will install Elasticsearch internally if Logging is enabled. ### **Installing on Kubernetes** -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 Logging needs to be enabled first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. +As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you can enable KubeSphere Logging first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. 1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) and edit it. @@ -75,7 +75,7 @@ The process of installing KubeSphere on Kubernetes is same as stated in the tuto ```yaml logging: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` {{< notice note >}} @@ -124,7 +124,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource ```yaml logging: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` {{< notice note >}}By default, Elasticsearch will be installed internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in this yaml file if you want to enable Logging, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information, KubeSphere will integrate your external Elasticsearch directly instead of installing an internal one. diff --git a/content/en/docs/pluggable-components/metrics-server.md b/content/en/docs/pluggable-components/metrics-server.md index 4dd9eec6a..c2610bcc5 100644 --- a/content/en/docs/pluggable-components/metrics-server.md +++ b/content/en/docs/pluggable-components/metrics-server.md @@ -14,11 +14,34 @@ KubeSphere supports Horizontal Pod Autoscalers (HPA) for [Deployments](../../pro ### Installing on Linux -When you use KubeKey to create a configuration file for your cluster, the Metrics Server is enabled by default in the file. Namely, you do not need to manually enable it before you install KubeSphere on Linux. +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 + ``` + + {{< 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 the Metrics Server in this mode (e.g. for testing purposes), refer to [the following section](#enable-devops-after-installation) to see how the Metrics Server can be installed after installation. + {{}} + +2. In this file, navigate to `metrics_server` and change `false` to `true` for `enabled`. Save the file after you finish. + + ```yaml + metrics_server: + 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** -The process of installing KubeSphere on Kubernetes is stated in the tutorial of [Installing KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/). To install the optional component Metrics Server, you can enable it first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. +As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you can enable the Metrics Server first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. 1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) and edit it. @@ -67,7 +90,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource ```yaml metrics_server: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` 5. You can use the web kubectl to check the installation process by executing the following command: diff --git a/content/en/docs/pluggable-components/network-policy.md b/content/en/docs/pluggable-components/network-policy.md index 3597c903b..863867d57 100644 --- a/content/en/docs/pluggable-components/network-policy.md +++ b/content/en/docs/pluggable-components/network-policy.md @@ -39,7 +39,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ```yaml networkpolicy: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` 3. Create a cluster using the configuration file: @@ -50,7 +50,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ### **Installing on Kubernetes** -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 Network Policy needs to be enabled first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. +As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you can enable the Network Policy first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. 1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) and edit it. @@ -62,7 +62,7 @@ The process of installing KubeSphere on Kubernetes is same as stated in the tuto ```yaml networkpolicy: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` 3. Execute the following commands to start installation: @@ -93,7 +93,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource ```yaml networkpolicy: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` 5. You can use the web kubectl to check the installation process by executing the following command: diff --git a/content/en/docs/pluggable-components/service-mesh.md b/content/en/docs/pluggable-components/service-mesh.md index e90589af0..aad073205 100644 --- a/content/en/docs/pluggable-components/service-mesh.md +++ b/content/en/docs/pluggable-components/service-mesh.md @@ -2,7 +2,6 @@ title: "KubeSphere Service Mesh" keywords: "Kubernetes, Istio, KubeSphere, service-mesh, microservices" description: "Learn how to enable KubeSphere Service Mesh to use different traffic management strategies for microservices governance." - linkTitle: "KubeSphere Service Mesh" weight: 6800 --- @@ -33,7 +32,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ```yaml servicemesh: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` 3. Create a cluster using the configuration file: @@ -44,7 +43,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ### **Installing on Kubernetes** -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 Service Mesh needs to be enabled first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. +As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you can enable KubeSphere Service Mesh first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) file. 1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) and edit it. @@ -56,7 +55,7 @@ The process of installing KubeSphere on Kubernetes is same as stated in the tuto ```yaml servicemesh: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` 3. Execute the following commands to start installation: @@ -86,7 +85,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource ```yaml servicemesh: - enabled: true # Change "false" to "true" + enabled: true # Change "false" to "true" ``` 5. You can use the web kubectl to check the installation process by executing the following command: