mirror of
https://github.com/kubesphere/website.git
synced 2025-12-26 00:12:48 +00:00
Update example file link
Signed-off-by: Sherlock113 <sherlockxu@yunify.com>
This commit is contained in:
Sherlock113
parent
62c2bf5a42
commit
2be3c3746d
|
|
@ -41,9 +41,9 @@ To add a log receiver:
|
|||
|
||||
### Add Elasticsearch as a log receiver
|
||||
|
||||
A default Elasticsearch receiver will be added with its service address set to an Elasticsearch cluster if `logging`, `events`, or `auditing` is enabled in [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md).
|
||||
A default Elasticsearch receiver will be added with its service address set to an Elasticsearch cluster if `logging`, `events`, or `auditing` is enabled in [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md).
|
||||
|
||||
An internal Elasticsearch cluster will be deployed to the Kubernetes cluster if neither `externalElasticsearchUrl` nor `externalElasticsearchPort` is specified in [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md) when `logging`, `events` or `auditing` is enabled. The internal Elasticsearch cluster is for testing and development only. It is recommended that you configure an external Elasticsearch cluster for production.
|
||||
An internal Elasticsearch cluster will be deployed to the Kubernetes cluster if neither `externalElasticsearchUrl` nor `externalElasticsearchPort` is specified in [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md) when `logging`, `events` or `auditing` is enabled. The internal Elasticsearch cluster is for testing and development only. It is recommended that you configure an external Elasticsearch cluster for production.
|
||||
|
||||
Log searching relies on the internal or external Elasticsearch cluster configured.
|
||||
|
||||
|
|
@ -59,7 +59,7 @@ If you need to output logs to more places other than Elasticsearch or Kafka, you
|
|||
|
||||
## Add a Log Receiver (i.e. Collector) for Events or Auditing Logs
|
||||
|
||||
Starting from KubeSphere v3.0.0, the logs of Kubernetes events and the auditing logs of Kubernetes and KubeSphere can be archived in the same way as container logs. The tab **Events** or **Auditing** on the **Log Collections** page will appear if `events` or `auditing` is enabled accordingly in [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md). You can go to the corresponding tab to configure log receivers for Kubernetes events or Kubernetes and KubeSphere auditing logs.
|
||||
Starting from KubeSphere v3.0.0, the logs of Kubernetes events and the auditing logs of Kubernetes and KubeSphere can be archived in the same way as container logs. The tab **Events** or **Auditing** on the **Log Collections** page will appear if `events` or `auditing` is enabled accordingly in [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md). You can go to the corresponding tab to configure log receivers for Kubernetes events or Kubernetes and KubeSphere auditing logs.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ There are several scenarios to use KubeKey:
|
|||
|
||||
## How Does KubeKey Work
|
||||
|
||||
After you download KubeKey, you use an executable called `kk` to perform different operations. No matter you use it to create, scale or upgrade a cluster, you must prepare a configuration file using `kk` beforehand. This configuration file contains basic parameters of your cluster, such as host information, network configurations (CNI plugin and Pod and Service CIDR), registry mirrors, add-ons (YAML or Chart) and pluggable component options (if you install KubeSphere). For more information, see [an example configuration file](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md).
|
||||
After you download KubeKey, you use an executable called `kk` to perform different operations. No matter you use it to create, scale or upgrade a cluster, you must prepare a configuration file using `kk` beforehand. This configuration file contains basic parameters of your cluster, such as host information, network configurations (CNI plugin and Pod and Service CIDR), registry mirrors, add-ons (YAML or Chart) and pluggable component options (if you install KubeSphere). For more information, see [an example configuration file](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md).
|
||||
|
||||
With the configuration file in place, you execute the `./kk` command with varied flags for different operations. After that, KubeKey automatically installs Docker and pulls all the necessary images for installation. When the installation is complete, you can also inspect installation logs.
|
||||
|
||||
|
|
|
|||
|
|
@ -278,7 +278,7 @@ KubeKey will install [OpenEBS](https://openebs.io/) to provision [LocalPV](https
|
|||
{{< notice tip >}}
|
||||
|
||||
- You can enable the multi-cluster feature by editing the configuration file. For more information, see [Multi-cluster Management](../../../multicluster-management/).
|
||||
- You can also select the components you want to install. For more information, see [Enable Pluggable Components](../../../pluggable-components/). For an example of a complete `config-sample.yaml` file, see [this file](https://github.com/kubesphere/kubekey/blob/release-1.0/docs/config-example.md).
|
||||
- You can also select the components you want to install. For more information, see [Enable Pluggable Components](../../../pluggable-components/). For an example of a complete `config-sample.yaml` file, see [this file](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md).
|
||||
|
||||
{{</ notice >}}
|
||||
|
||||
|
|
|
|||
|
|
@ -183,7 +183,7 @@ spec:
|
|||
- node000001
|
||||
- node000002
|
||||
```
|
||||
For a complete configuration sample explanation, please see [this file](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md).
|
||||
For a complete configuration sample explanation, please see [this file](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md).
|
||||
|
||||
### Configure the Load Balancer
|
||||
|
||||
|
|
|
|||
|
|
@ -221,7 +221,7 @@ spec:
|
|||
- node3
|
||||
```
|
||||
|
||||
For a complete configuration sample explanation, see [this file](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md).
|
||||
For a complete configuration sample explanation, see [this file](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md).
|
||||
|
||||
### Step 4: Configure the load balancer
|
||||
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ When you implement multi-node installation of KubeSphere on Linux, you need to c
|
|||
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.
|
||||
{{</ notice >}}
|
||||
|
||||
2. In this file, enable the pluggable components you want to install by changing `false` to `true` for `enabled`. Here is [the complete 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 [the complete file](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md) for your reference. Save the file after you finish.
|
||||
|
||||
3. Create a cluster using the configuration file:
|
||||
|
||||
|
|
|
|||
|
|
@ -187,7 +187,7 @@ Make sure the Kubernetes version is the one you downloaded.
|
|||
|
||||
#### Edit the configuration file
|
||||
|
||||
Edit the configuration file `config-sample.yaml`. Here is [an example for your reference](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md).
|
||||
Edit the configuration file `config-sample.yaml`. Here is [an example for your reference](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md).
|
||||
|
||||
{{< notice warning >}}
|
||||
|
||||
|
|
@ -275,7 +275,7 @@ Make sure the Kubernetes version is the one you downloaded.
|
|||
|
||||
#### Edit the configuration file
|
||||
|
||||
Edit the configuration file `config-sample.yaml`. Here is [an example for your reference](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md).
|
||||
Edit the configuration file `config-sample.yaml`. Here is [an example for your reference](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md).
|
||||
|
||||
{{< notice warning >}}
|
||||
|
||||
|
|
|
|||
|
|
@ -120,7 +120,7 @@ Edit `sample.yaml` based on your cluster configuration. Make sure you replace th
|
|||
|
||||
{{< notice note >}}
|
||||
|
||||
For more information, see [Edit the configuration file](../../installing-on-linux/introduction/multioverview/#2-edit-the-configuration-file) or refer to the `Cluster` section of [the complete configuration file](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md) for more information.
|
||||
For more information, see [Edit the configuration file](../../installing-on-linux/introduction/multioverview/#2-edit-the-configuration-file) or refer to the `Cluster` section of [the complete configuration file](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md) for more information.
|
||||
|
||||
{{</ notice >}}
|
||||
|
||||
|
|
|
|||
|
|
@ -41,9 +41,9 @@ KubeSphere 提供灵活的日志收集配置方式。基于 [FluentBit Operator]
|
|||
|
||||
### 添加 Elasticsearch 作为日志接收器
|
||||
|
||||
如果 [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md) 中启用了 `logging`、`events` 或 `auditing`，则会添加默认的 Elasticsearch 接收器，服务地址会设为 Elasticsearch 集群。
|
||||
如果 [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md) 中启用了 `logging`、`events` 或 `auditing`，则会添加默认的 Elasticsearch 接收器，服务地址会设为 Elasticsearch 集群。
|
||||
|
||||
当 `logging`、`events` 或 `auditing` 启用时，如果 [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md) 中未指定 `externalElasticsearchUrl` 和 `externalElasticsearchPort`，则内置 Elasticsearch 集群会部署至 Kubernetes 集群。内置 Elasticsearch 集群仅用于测试和开发。生产环境下，建议您集成外置 Elasticsearch 集群。
|
||||
当 `logging`、`events` 或 `auditing` 启用时，如果 [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md) 中未指定 `externalElasticsearchUrl` 和 `externalElasticsearchPort`，则内置 Elasticsearch 集群会部署至 Kubernetes 集群。内置 Elasticsearch 集群仅用于测试和开发。生产环境下，建议您集成外置 Elasticsearch 集群。
|
||||
|
||||
日志查询需要依靠所配置的内置或外置 Elasticsearch 集群。
|
||||
|
||||
|
|
@ -59,7 +59,7 @@ Kafka 往往用于接收日志，并作为 Spark 等处理系统的代理 (Broke
|
|||
|
||||
## 为事件或审计日志添加日志接收器
|
||||
|
||||
自 KubeSphere v3.0.0 起，Kubernetes 事件和 Kubernetes 以及 KubeSphere 审计日志可以通过和容器日志相同的方式进行存档。如果在 [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md) 中启用了 `events` 或 `auditing`，**日志收集**页面会对应显示**事件**或**审计**选项卡。您可以前往对应选项卡为 Kubernetes 事件或 Kubernetes 以及 KubeSphere 审计日志配置日志接收器。
|
||||
自 KubeSphere v3.0.0 起，Kubernetes 事件和 Kubernetes 以及 KubeSphere 审计日志可以通过和容器日志相同的方式进行存档。如果在 [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md) 中启用了 `events` 或 `auditing`，**日志收集**页面会对应显示**事件**或**审计**选项卡。您可以前往对应选项卡为 Kubernetes 事件或 Kubernetes 以及 KubeSphere 审计日志配置日志接收器。
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ KubeKey 的几种使用场景：
|
|||
|
||||
## KubeKey 如何运作
|
||||
|
||||
下载 KubeKey 之后，您可以使用可执行文件 `kk` 来进行不同的操作。无论您是使用它来创建，扩缩还是升级集群，都必须事先使用 `kk` 准备配置文件。此配置文件包含集群的基本参数，例如主机信息、网络配置（CNI 插件以及 Pod 和 Service CIDR）、仓库镜像、插件（YAML 或 Chart）和可插拔组件选项（如果您安装 KubeSphere）。有关更多信息，请参见[示例配置文件](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md)。
|
||||
下载 KubeKey 之后，您可以使用可执行文件 `kk` 来进行不同的操作。无论您是使用它来创建，扩缩还是升级集群，都必须事先使用 `kk` 准备配置文件。此配置文件包含集群的基本参数，例如主机信息、网络配置（CNI 插件以及 Pod 和 Service CIDR）、仓库镜像、插件（YAML 或 Chart）和可插拔组件选项（如果您安装 KubeSphere）。有关更多信息，请参见[示例配置文件](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md)。
|
||||
|
||||
准备好配置文件后，您需要使用 `./kk` 命令以及不同的标志来进行不同的操作。这之后，KubeKey 会自动安装 Docker，并拉取所有必要的镜像以进行安装。安装完成后，您还可以检查安装日志。
|
||||
|
||||
|
|
|
|||
|
|
@ -273,7 +273,7 @@ KubeSphere 会默认安装 [OpenEBS](https://openebs.io/)，为开发和测试
|
|||
{{< notice tip >}}
|
||||
|
||||
- 您可以编辑配置文件，启用多集群功能。有关更多信息，请参见[多集群管理](../../../multicluster-management/)。
|
||||
- 您也可以选择要安装的组件。有关更多信息，请参见[启用可插拔组件](../../../pluggable-components/)。有关完整的 `config-sample.yaml` 文件的示例，请参见[此文件](https://github.com/kubesphere/kubekey/blob/release-1.0/docs/config-example.md)。
|
||||
- 您也可以选择要安装的组件。有关更多信息，请参见[启用可插拔组件](../../../pluggable-components/)。有关完整的 `config-sample.yaml` 文件的示例，请参见[此文件](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md)。
|
||||
|
||||
{{</ notice >}}
|
||||
|
||||
|
|
|
|||
|
|
@ -184,7 +184,7 @@ spec:
|
|||
- node000001
|
||||
- node000002
|
||||
```
|
||||
For a complete configuration sample explanation, please see [this file](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md).
|
||||
For a complete configuration sample explanation, please see [this file](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md).
|
||||
|
||||
### Configure the Load Balancer
|
||||
|
||||
|
|
|
|||
|
|
@ -222,7 +222,7 @@ spec:
|
|||
- node3
|
||||
```
|
||||
|
||||
有关完整的配置示例说明，请参见[此文件](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md)。
|
||||
有关完整的配置示例说明，请参见[此文件](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md)。
|
||||
|
||||
### 步骤 4：配置负载均衡器
|
||||
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ weight: 2600
|
|||
如果采用 [All-in-one 模式安装](../../quick-start/all-in-one-on-linux/)，您无需创建 `config-sample.yaml` 文件，因为 all-in-one 模式可以通过一条命令直接创建集群。通常，all-in-one 模式适用于刚接触 KubeSphere 并希望快速上手该系统的用户。如果要在此模式下启用可插拔组件（例如，出于测试目的），请参考[在安装后启用可插拔组件](#在安装后启用可插拔组件)。
|
||||
{{</ notice >}}
|
||||
|
||||
2. 在此文件中，将 `enabled` 的值从 `false` 改为 `true`。这是[完整文件](https://github.com/kubesphere/kubekey/blob/release-1.0/docs/config-example.md)供您参考，修改完成后保存文件。
|
||||
2. 在此文件中，将 `enabled` 的值从 `false` 改为 `true`。这是[完整文件](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md)供您参考，修改完成后保存文件。
|
||||
|
||||
3. 使用该配置文件创建集群：
|
||||
|
||||
|
|
|
|||
|
|
@ -187,7 +187,7 @@ chmod +x kk
|
|||
|
||||
#### 编辑配置文件
|
||||
|
||||
编辑该配置文件 `config-sample.yaml`。请查看[供您参考的示例](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md)。
|
||||
编辑该配置文件 `config-sample.yaml`。请查看[供您参考的示例](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md)。
|
||||
|
||||
{{< notice warning >}}
|
||||
|
||||
|
|
@ -275,7 +275,7 @@ chmod +x kk
|
|||
|
||||
#### 编辑配置文件
|
||||
|
||||
编辑该配置文件 `config-sample.yaml`。请查看[供您参考的示例](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md)。
|
||||
编辑该配置文件 `config-sample.yaml`。请查看[供您参考的示例](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md)。
|
||||
|
||||
{{< notice warning >}}
|
||||
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@ chmod +x kk
|
|||
|
||||
{{< notice note >}}
|
||||
|
||||
有关更多信息，请参见[编辑配置文件](../../installing-on-linux/introduction/multioverview/#2-编辑配置文件)，或参考[完整配置文件](https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md)中的 `Cluster` 部分获取更多信息。
|
||||
有关更多信息，请参见[编辑配置文件](../../installing-on-linux/introduction/multioverview/#2-编辑配置文件)，或参考[完整配置文件](https://github.com/kubesphere/kubekey/blob/release-1.1/docs/config-example.md)中的 `Cluster` 部分获取更多信息。
|
||||
|
||||
{{</ notice >}}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue