Merge pull request #2086 from Felixnoo/update-logging

Update Enable Logging Docs
This commit is contained in:
KubeSphere CI Bot 2021-11-10 17:58:32 +08:00 committed by GitHub
commit fed9d38d1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 37 additions and 11 deletions

View File

@ -35,10 +35,14 @@ 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 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 `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.
{{</ notice >}}
{{< 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 >}}
```yaml
@ -74,10 +78,14 @@ As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introdu
```yaml
logging:
enabled: true # Change "false" to "true".
containerruntime: docker
```
{{< 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`. 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.
{{</ notice >}}
{{< 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 >}}
```yaml
@ -119,12 +127,17 @@ 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 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`. 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.
{{</ notice >}}
{{< 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 >}}
```yaml
es: # Storage backend for logging, tracing, events and auditing.
elasticsearchMasterReplicas: 1 # The total number of master nodes. Even numbers are not allowed.

View File

@ -35,10 +35,14 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的
```yaml
logging:
enabled: true # 将“false”更改为“true”。
containerruntime: docker
```
{{< notice note >}}
默认情况下如果启用了日志系统KubeKey 将安装内置 Elasticsearch。对于生产环境如果您想启用日志系统强烈建议在 `config-sample.yaml` 中设置以下值,尤其是 `externalElasticsearchUrl``externalElasticsearchPort`。在安装前提供以下信息后KubeKey 将直接对接您的外部 Elasticsearch不再安装内置 Elasticsearch。
{{< notice info >}}若使用 containerd 作为容器运行时,请将 `containerruntime` 字段的值更改为 `containerd`。如果您从低版本升级至 KubeSphere 3.2.0,则启用 KubeSphere 日志系统时必须在 `logging` 字段下手动添加 `containerruntime` 字段。
{{</ notice >}}
{{< notice note >}}默认情况下如果启用了日志系统KubeKey 将安装内置 Elasticsearch。对于生产环境如果您想启用日志系统强烈建议在 `config-sample.yaml` 中设置以下值,尤其是 `externalElasticsearchUrl``externalElasticsearchPort`。在安装前提供以下信息后KubeKey 将直接对接您的外部 Elasticsearch不再安装内置 Elasticsearch。
{{</ notice >}}
```yaml
@ -74,10 +78,14 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的
```yaml
logging:
enabled: true # 将“false”更改为“true”。
containerruntime: docker
```
{{< notice note >}}
默认情况下如果启用了日志系统ks-installer 将安装内置 Elasticsearch。对于生产环境如果您想启用日志系统强烈建议在 `cluster-configuration.yaml` 中设置以下值,尤其是 `externalElasticsearchUrl``externalElasticsearchPort`。在安装前提供以下信息后ks-installer 将直接对接您的外部 Elasticsearch不再安装内置 Elasticsearch。
{{< notice info >}}若使用 containerd 作为容器运行时,请将 `.logging.containerruntime` 字段的值更改为 `containerd`。如果您从低版本升级至 KubeSphere 3.2.0,则启用 KubeSphere 日志系统时必须在 `logging` 字段下手动添加 `containerruntime` 字段。
{{</ notice >}}
{{< notice note >}}默认情况下如果启用了日志系统ks-installer 将安装内置 Elasticsearch。对于生产环境如果您想启用日志系统强烈建议在 `cluster-configuration.yaml` 中设置以下值,尤其是 `externalElasticsearchUrl``externalElasticsearchPort`。在安装前提供以下信息后ks-installer 将直接对接您的外部 Elasticsearch不再安装内置 Elasticsearch。
{{</ notice >}}
```yaml
@ -119,8 +127,13 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的
```yaml
logging:
enabled: true # 将“false”更改为“true”。
containerruntime: docker
```
{{< notice info >}}若使用 containerd 作为容器运行时,请将 `.logging.containerruntime` 字段的值更改为 `containerd`。如果您从低版本升级至 KubeSphere 3.2.0,则启用 KubeSphere 日志系统时必须在 `logging` 字段下手动添加 `containerruntime` 字段。
{{</ notice >}}
{{< notice note >}}默认情况下,如果启用了日志系统,将会安装内置 Elasticsearch。对于生产环境如果您想启用日志系统强烈建议在该 YAML 文件中设置以下值,尤其是 `externalElasticsearchUrl``externalElasticsearchPort`。在文件中提供以下信息后KubeSphere 将直接对接您的外部 Elasticsearch不再安装内置 Elasticsearch。
{{</ notice >}}