From 66041efd06632d921cbd38c27ec5ce8ce0ec5f7e Mon Sep 17 00:00:00 2001 From: Felixnoo Date: Tue, 9 Nov 2021 18:08:40 +0800 Subject: [PATCH 1/2] Update Enable Logging Docs Signed-off-by: Felixnoo --- .../en/docs/pluggable-components/logging.md | 24 +++++++++++++------ .../zh/docs/pluggable-components/logging.md | 18 ++++++++++---- 2 files changed, 31 insertions(+), 11 deletions(-) diff --git a/content/en/docs/pluggable-components/logging.md b/content/en/docs/pluggable-components/logging.md index e8b0dabe8..448661d54 100644 --- a/content/en/docs/pluggable-components/logging.md +++ b/content/en/docs/pluggable-components/logging.md @@ -37,8 +37,11 @@ When you install KubeSphere on Linux, you need to create a configuration file, w enabled: true # Change "false" to "true". ``` - {{< notice note >}} -By default, KubeKey will install Elasticsearch internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in `config-sample.yaml` if you want to enable Logging, 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. + {{< notice info >}}To use containerd as the container runtime, change the value of the field `.logging.containerruntime` to `containerd`. + + {{}} + + {{< notice note >}}By default, KubeKey will install Elasticsearch internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in `config-sample.yaml` if you want to enable Logging, 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. {{}} ```yaml @@ -76,8 +79,11 @@ As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introdu enabled: true # Change "false" to "true". ``` - {{< notice note >}} -By default, ks-installer will install Elasticsearch internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in `cluster-configuration.yaml` if you want to enable Logging, 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. + {{< notice info >}}To use containerd as the container runtime, change the value of the field `.logging.containerruntime` to `containerd`. + + {{}} + + {{< notice note >}}By default, ks-installer will install Elasticsearch internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in `cluster-configuration.yaml` if you want to enable Logging, 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. {{}} ```yaml @@ -121,10 +127,14 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource 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. - + {{< notice info >}}To use containerd as the container runtime, change the value of the field `.logging.containerruntime` to `containerd`. + {{}} - + + {{< 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. + + {{}} + ```yaml es: # Storage backend for logging, tracing, events and auditing. elasticsearchMasterReplicas: 1 # The total number of master nodes. Even numbers are not allowed. diff --git a/content/zh/docs/pluggable-components/logging.md b/content/zh/docs/pluggable-components/logging.md index 50b2242b5..f30978bd2 100644 --- a/content/zh/docs/pluggable-components/logging.md +++ b/content/zh/docs/pluggable-components/logging.md @@ -37,8 +37,11 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 enabled: true # 将“false”更改为“true”。 ``` - {{< notice note >}} -默认情况下，如果启用了日志系统，KubeKey 将安装内置 Elasticsearch。对于生产环境，如果您想启用日志系统，强烈建议在 `config-sample.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，KubeKey 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 + {{< notice info >}}若使用 containerd 作为容器运行时，请将 `.logging.containerruntime` 字段的值更改为 `containerd`。 + + {{}} + + {{< notice note >}}默认情况下，如果启用了日志系统，KubeKey 将安装内置 Elasticsearch。对于生产环境，如果您想启用日志系统，强烈建议在 `config-sample.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，KubeKey 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -76,8 +79,11 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 enabled: true # 将“false”更改为“true”。 ``` - {{< notice note >}} -默认情况下，如果启用了日志系统，ks-installer 将安装内置 Elasticsearch。对于生产环境，如果您想启用日志系统，强烈建议在 `cluster-configuration.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，ks-installer 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 + {{< notice info >}}若使用 containerd 作为容器运行时，请将 `.logging.containerruntime` 字段的值更改为 `containerd`。 + + {{}} + + {{< notice note >}}默认情况下，如果启用了日志系统，ks-installer 将安装内置 Elasticsearch。对于生产环境，如果您想启用日志系统，强烈建议在 `cluster-configuration.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，ks-installer 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -121,6 +127,10 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 enabled: true # 将“false”更改为“true”。 ``` + {{< notice info >}}若使用 containerd 作为容器运行时，请将 `.logging.containerruntime` 字段的值更改为 `containerd`。 + + {{}} + {{< notice note >}}默认情况下，如果启用了日志系统，将会安装内置 Elasticsearch。对于生产环境，如果您想启用日志系统，强烈建议在该 YAML 文件中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在文件中提供以下信息后，KubeSphere 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} From be0728535eb1091bb273de8bc16f1ebabf251051 Mon Sep 17 00:00:00 2001 From: Felixnoo Date: Wed, 10 Nov 2021 13:57:54 +0800 Subject: [PATCH 2/2] minor updates Signed-off-by: Felixnoo --- content/en/docs/pluggable-components/logging.md | 9 ++++++--- content/zh/docs/pluggable-components/logging.md | 9 ++++++--- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/content/en/docs/pluggable-components/logging.md b/content/en/docs/pluggable-components/logging.md index 448661d54..ed0a47c5b 100644 --- a/content/en/docs/pluggable-components/logging.md +++ b/content/en/docs/pluggable-components/logging.md @@ -35,9 +35,10 @@ When you install KubeSphere on Linux, you need to create a configuration file, w ```yaml logging: enabled: true # Change "false" to "true". + containerruntime: docker ``` - {{< notice info >}}To use containerd as the container runtime, change the value of the field `.logging.containerruntime` to `containerd`. + {{< notice info >}}To use containerd as the container runtime, change the value of the field `containerruntime` to `containerd`. If you upgraded to KubeSphere 3.2.0 from earlier versions, you have to manually add the field `containerruntime` under `logging` when enabling KubeSphere Logging system. {{}} @@ -77,9 +78,10 @@ As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introdu ```yaml logging: enabled: true # Change "false" to "true". + containerruntime: docker ``` - {{< notice info >}}To use containerd as the container runtime, change the value of the field `.logging.containerruntime` to `containerd`. + {{< notice info >}}To use containerd as the container runtime, change the value of the field `.logging.containerruntime` to `containerd`. If you upgraded to KubeSphere 3.2.0 from earlier versions, you have to manually add the field `containerruntime` under `logging` when enabling KubeSphere Logging system. {{}} @@ -125,9 +127,10 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource ```yaml logging: enabled: true # Change "false" to "true". + containerruntime: docker ``` - {{< notice info >}}To use containerd as the container runtime, change the value of the field `.logging.containerruntime` to `containerd`. + {{< notice info >}}To use containerd as the container runtime, change the value of the field `.logging.containerruntime` to `containerd`. If you upgraded to KubeSphere 3.2.0 from earlier versions, you have to manually add the field `containerruntime` under `logging` when enabling KubeSphere Logging system. {{}} diff --git a/content/zh/docs/pluggable-components/logging.md b/content/zh/docs/pluggable-components/logging.md index f30978bd2..887176539 100644 --- a/content/zh/docs/pluggable-components/logging.md +++ b/content/zh/docs/pluggable-components/logging.md @@ -35,9 +35,10 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 ```yaml logging: enabled: true # 将“false”更改为“true”。 + containerruntime: docker ``` - {{< notice info >}}若使用 containerd 作为容器运行时，请将 `.logging.containerruntime` 字段的值更改为 `containerd`。 + {{< notice info >}}若使用 containerd 作为容器运行时，请将 `containerruntime` 字段的值更改为 `containerd`。如果您从低版本升级至 KubeSphere 3.2.0，则启用 KubeSphere 日志系统时必须在 `logging` 字段下手动添加 `containerruntime` 字段。 {{}} @@ -77,9 +78,10 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 ```yaml logging: enabled: true # 将“false”更改为“true”。 + containerruntime: docker ``` - {{< notice info >}}若使用 containerd 作为容器运行时，请将 `.logging.containerruntime` 字段的值更改为 `containerd`。 + {{< notice info >}}若使用 containerd 作为容器运行时，请将 `.logging.containerruntime` 字段的值更改为 `containerd`。如果您从低版本升级至 KubeSphere 3.2.0，则启用 KubeSphere 日志系统时必须在 `logging` 字段下手动添加 `containerruntime` 字段。 {{}} @@ -125,9 +127,10 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 ```yaml logging: enabled: true # 将“false”更改为“true”。 + containerruntime: docker ``` - {{< notice info >}}若使用 containerd 作为容器运行时，请将 `.logging.containerruntime` 字段的值更改为 `containerd`。 + {{< notice info >}}若使用 containerd 作为容器运行时，请将 `.logging.containerruntime` 字段的值更改为 `containerd`。如果您从低版本升级至 KubeSphere 3.2.0，则启用 KubeSphere 日志系统时必须在 `logging` 字段下手动添加 `containerruntime` 字段。 {{}}