diff --git a/content/zh/docs/pluggable-components/_index.md b/content/zh/docs/pluggable-components/_index.md index 46476c850..d6aea85df 100644 --- a/content/zh/docs/pluggable-components/_index.md +++ b/content/zh/docs/pluggable-components/_index.md @@ -1,49 +1,49 @@ --- -title: "Enable Pluggable Components" -description: "Enable KubeSphere Pluggable Components" +title: "启用可插拔组件" +description: "启用 KubeSphere 的可插拔组件" layout: "single" -linkTitle: "Enable Pluggable Components" +linkTitle: "启用可插拔组件" weight: 3500 icon: "/images/docs/docs.svg" --- -This chapter demonstrates detailed steps of enabling different components in KubeSphere both before and after installation so that you can take full advantage of the container platform for your business. +本章详细演示了 KubeSphere 中不同组件在安装前和安装后的启用步骤，以便您可以充分利用容器平台为您的业务服务。 -## [Overview](../pluggable-components/overview/) +## [概览](../pluggable-components/overview/) -Develop a basic understanding of key components in KubeSphere, including features and resource consumption. +培养对 KubeSphere 中关键组件的基本理解，包括功能和资源消耗。 -## [KubeSphere App Store](../pluggable-components/app-store/) +## [KubeSphere 应用商店](../pluggable-components/app-store/) -Learn how to enable App Store to share data and apps internally and set industry standards of delivery process externally. +学习如何在内部实现 KubeSphere 应用商店的数据和应用共享，并在外部制定交付流程的行业标准。 -## [KubeSphere DevOps System](../pluggable-components/devops/) +## [KubeSphere DevOps 系统](../pluggable-components/devops/) -Learn how to enable DevOps to further free your developers and let them focus on code writing. +了解如何启用 DevOps 系统来进一步解放你的开发人员，让他们专注于代码编写。 -## [KubeSphere Auditing Logs](../pluggable-components/auditing-logs/) +## [KubeSphere 审计日志](../pluggable-components/auditing-logs/) -Learn how to enable Auditing to document platform events and activities. +了解如何启用审计来记录平台事件和活动。 -## [KubeSphere Events](../pluggable-components/events/) +## [KubeSphere 事件](../pluggable-components/events/) -Learn how to enable Events to keep track of everything that is happening on the platform. +了解如何启用 KubeSphere 事件模块来跟踪平台上发生的一切。 -## [KubeSphere Logging System](../pluggable-components/logging/) +## [KubeSphere 日志系统](../pluggable-components/logging/) -Learn how to enable Logging to leverage the tenant-based system for log collection, query and management. +了解如何启用日志，利用基于租户的系统进行日志收集、查询和管理。 -## [KubeSphere Service Mesh](../pluggable-components/service-mesh/) +## [KubeSphere 服务网关](../pluggable-components/service-mesh/) -Learn how to enable Service Mesh to use different traffic management strategies for microservices governance. +了解如何使服务网格使用不同的流量管理策略进行微服务治理。 -## [KubeSphere Alerting and Notification](../pluggable-components/alerting-notification/) +## [KubeSphere 告警和通知](../pluggable-components/alerting-notification/) -Learn how to enable Alerting and Notification to identify any potential issues in advance before they take a toll on your business. +了解如何启用告报和通知功能，以便在潜在问题对您的业务造成影响之前提前识别这些问题。 -## [Network Policy](../pluggable-components/network-policy/) +## [网络策略](../pluggable-components/network-policy/) -Learn how to enable Network Policy to control traffic flow at the IP address or port level. \ No newline at end of file +了解如何启用网络策略来控制 IP 地址或端口级别的流量。 diff --git a/content/zh/docs/pluggable-components/alerting-notification.md b/content/zh/docs/pluggable-components/alerting-notification.md index 8db1091fe..5b322612a 100644 --- a/content/zh/docs/pluggable-components/alerting-notification.md +++ b/content/zh/docs/pluggable-components/alerting-notification.md @@ -1,31 +1,31 @@ --- -title: "KubeSphere Alerting and Notification" +title: "KubeSphere 告警和通知系统" keywords: "Kubernetes, alertmanager, KubeSphere, alerting, notification" -description: "How to Enable Alerting and Notification" +description: "如何启用告警和通知系统" -linkTitle: "KubeSphere Alerting and Notification" +linkTitle: "KubeSphere 告警和通知" weight: 3545 --- -## What are KubeSphere Alerting and Notification +## 什么是 KubeSphere 告警和通知系统 -Alerting and Notification are two important building blocks of observability, closely related monitoring and logging. The alerting system in KubeSphere, coupled with the proactive failure notification system, allows users to know activities of interest based on alert policies. When a predefined threshold of a certain metric is reached, an alert will be sent to preconfigured recipients, the notification method of which can be set by yourself, including Email, WeChat Work and Slack. With a highly functional alerting and notification system in place, you can quickly identify and resolve potential issues in advance before they affect your business. +告警和通知是可观察性的两个重要构件，与监控和日志密切相关。KubeSphere 中的告警系统与主动故障通知系统相结合，用户可以根据告警策略了解感兴趣的活动。当达到某个指标的预定义阈值时，会向预先配置的收件人发出警报，通知方式可以自行设置，包括 Email、企业微信和 Slack。有了高功能的预警和通知系统，您就可以在潜在的问题影响到您的业务之前，迅速发现并提前解决。 -For more information, see Alerting Policy and Message. +更多信息，请参见告警策略和消息。 {{< notice note >}} -It is recommended that you enable Alerting and Notification together so that users can receive notifications of alerts in time. +建议同时启用告警和通知功能，这样用户可以及时收到告警通知。 {{}} -## Enable Alerting and Notification before Installation +## 在安装前启用告警和通知系统 -### Installing on Linux +### 在 Linux 上安装 -When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. +当您在 Linux 上安装 KubeSphere 时，你需要创建一个配置文件，该文件列出了所有 KubeSphere 组件。 -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: +1. 基于[在 Linux 上安装 KubeSphere](.../.../installing-on-linux/introduction/multioverview/) 的教程，您创建了一个默认文件 **config-sample.yaml**。通过执行以下命令修改该文件： ```bash vi config-sample.yaml @@ -33,11 +33,11 @@ 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 Alerting and Notification in this mode (e.g. for testing purpose), refer to the following section to see how Alerting and Notification can be installed after installation. +如果采用 [All-in-one 安装](.../.../quick-start/all-in-one-on-linux/)，则不需要创建 `config-sample.yaml` 文件，因为可以直接创建集群。一般来说，All-in-one 模式是为那些刚刚接触 KubeSphere 并希望熟悉系统的用户准备的。如果您想在这个模式下启用告警和通知（比如出于测试的目的），可以参考下面的部分，看看安装后如何启用告警和通知系统。 {{}} -2. In this file, navigate to `alerting` and `notification` and change `false` to `true` for `enabled`. Save the file after you finish. +2. 在该文件中，搜寻到 `alerting` 和 `notification`，并将 `enabled` 的 `false` 改为 `true`。完成后保存文件。 ```bash alerting: @@ -46,24 +46,25 @@ notification: enabled: true # Change "false" to "true" ``` -3. Create a cluster using the configuration file: +3. 使用配置文件创建一个集群： ```bash ./kk create cluster -f config-sample.yaml ``` -### **Installing on Kubernetes** +### 在 Kubernetes 上安装 -When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) for cluster setting. If you want to install Alerting and Notification, do not use `kubectl apply -f` directly for this file. +在 Kubernetes 上安装 KubeSphere 时，需要下载文件 [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) 进行集群设置。如果要安装告警和通知系统，不要直接使用 `kubectl apply -f` 对这个文件进行设置。 -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://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml). After that, to enable Alerting and Notification, create a local file cluster-configuration.yaml. +1. 参照[在 Kubernetes 上安装 KubeSphere](.../.../installing-on-kubernetes/introduction/overview/) 的教程，先对文件 [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml) 执行 `kubectl apply -f`。之后，为了启用告警和通知系统，创建一个本地文件 `cluster-configuration.yaml`。 ```bash vi cluster-configuration.yaml ``` -2. Copy all the content in the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) and paste it to the local file just created. -3. In this local cluster-configuration.yaml file, navigate to `alerting` and `notification` and enable them by changing `false` to `true` for `enabled`. Save the file after you finish. +2. 将 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件中的所有内容复制到刚才创建的本地文件中。 + +3. 在这个本地 `cluster-configuration.yaml` 文件中，搜寻到 `alerting` 和 `notification`，并将 `enabled` 的 `false` 改为 `true`，启用它们。完成后保存文件。 ```bash alerting: @@ -72,31 +73,31 @@ notification: enabled: true # Change "false" to "true" ``` -4. Execute the following command to start installation: +4. 执行以下命令开始安装： ```bash kubectl apply -f cluster-configuration.yaml ``` -## Enable Alerting and Notification after Installation +## 在安装后启用告警和通知系统 -1. Log in the console as `admin`. Click **Platform** in the top-left corner and select **Clusters Management**. +1. 以 `admin` 身份登录控制台。点击左上角的**平台管理**，选择**集群管理**。 -![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) +![集群管理](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. +2. 点击 **自定义资源 CRD**，在搜索栏中输入 `clusterconfiguration`。点击结果查看其详细页面。 {{< notice info >}} -A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. +自定义资源定义（CRD）允许用户在不增加另一个 API 服务器的情况下创建一种新的资源类型。他们可以像其他任何本地 Kubernetes 对象一样使用这些资源。 {{}} -3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**. +3. 在**资源列表**中，点击 `ks-installer` 右边的三个点，选择**编辑 YAML**。 -![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) +![编辑 YAML](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) -4. In this yaml file, navigate to `alerting` and `notification` and change `false` to `true` for `enabled`. After you finish, click **Update** in the bottom-right corner to save the configuration. +4. 在这个 YAML 文件中，搜寻到 `alerting` 和 `notification`，将 `enabled` 的 `false` 改为 `true`。完成后，点击右下角的**更新**，保存配置。 ```bash alerting: @@ -105,7 +106,7 @@ notification: enabled: true # Change "false" to "true" ``` -5. You can use the web kubectl to check the installation process by executing the following command: +5. 您可以通过执行以下命令，使用 Web Kubectl 工具来检查安装过程： ```bash kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f @@ -113,31 +114,31 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app= {{< notice tip >}} -You can find the web kubectl tool by clicking the hammer icon in the bottom-right corner of the console. +您可以通过点击控制台右下角的锤子图标找到 Kubectl 工具。 {{}} -## Verify the Installation of Component +## 验证组件的安装 {{< tabs >}} -{{< tab "Verify the Component in Dashboard" >}} +{{< tab "在仪表板中验证组件的安装" >}} -If you can see **Alerting Messages** and **Alerting Policies** in the image below, it means the installation succeeds as the two parts won't display until you install the component. +如果在下图中可以看到**告警消息**和**告警策略**，说明安装成功，因为在安装组件之前，这两部分不会显示。 -![alerting](https://ap3.qingstor.com/kubesphere-website/docs/20200901143123.png) +![告警系统](https://ap3.qingstor.com/kubesphere-website/docs/20200901143123.png) {{}} -{{< tab "Verify the Component through kubectl" >}} +{{< tab "通过 kubectl 验证组件的安装" >}} -Execute the following command to check the status of pods: +执行以下命令来检查 Pod 的状态： ```bash kubectl get pod -n kubesphere-alerting-system ``` -The output may look as follows if the component runs successfully: +如果组件运行成功，输出结果可能如下： ```bash NAME READY STATUS RESTARTS AGE @@ -154,4 +155,4 @@ notification-deployment-748897cbdf-2djpr 1/1 Running 0 36m {{}} -{{}} \ No newline at end of file +{{}} diff --git a/content/zh/docs/pluggable-components/app-store.md b/content/zh/docs/pluggable-components/app-store.md index 0c5102ed5..ae03130fa 100644 --- a/content/zh/docs/pluggable-components/app-store.md +++ b/content/zh/docs/pluggable-components/app-store.md @@ -1,29 +1,29 @@ --- -title: "KubeSphere App Store" +title: "KubeSphere 应用商店" keywords: "Kubernetes, KubeSphere, app-store, OpenPitrix" -description: "How to Enable KubeSphere App Store" +description: "如何启用 KubeSphere 应用商店" -linkTitle: "KubeSphere App Store" +linkTitle: "KubeSphere 应用商店" weight: 3515 --- -## What is KubeSphere App Store +## 什么是 KubeSphere 应用商店 -As an open-source and app-centric container platform, KubeSphere provides users with a Helm-based app store for application lifecycle management on the back of [OpenPitrix](https://github.com/openpitrix/openpitrix), an open-source web-based system to package, deploy and manage different types of apps. KubeSphere App Store allows ISVs, developers and users to upload, test, deploy and release apps with just several clicks in a one-stop shop. +作为一个开源的、以应用为中心的容器平台，KubeSphere 在 [OpenPitrix](https://github.com/openpitrix/openpitrix) 的基础上，为用户提供了一个基于 Helm 的应用商店，用于应用生命周期管理，这是一个开源的基于网络的系统，用于打包、部署和管理不同类型的应用。KubeSphere 应用商店允许 ISV、开发者和用户在一站式服务中只需点击几下就可以上传、测试、部署和发布应用。 -Internally, KubeSphere App Store can serve as a place for different teams to share data, middleware, and office applications. Externally, it is conducive to setting industry standards of building and delivery. By default, there are 15 apps in the App Store. After you enable this feature, you can add more apps with app templates. +对内，KubeSphere 应用商店可以作为不同团队共享数据、中间件和办公应用的场所。对外，有利于制定行业标准的建设和交付。默认情况下，应用商店中有 15 个应用。启用该功能后，可以通过应用模板添加更多应用。 -![app-store](https://ap3.qingstor.com/kubesphere-website/docs/20200828170503.png) +![应用商店](https://ap3.qingstor.com/kubesphere-website/docs/20200828170503.png) -For more information, see App Store. +有关更多信息，请参阅应用商店。 -## Enable App Store before Installation +## 在安装前启用应用商店 -### Installing on Linux +### 在 Linux 上安装 -When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. +当您在 Linux 上安装 KubeSphere 时，你需要创建一个配置文件，该文件列出了所有 KubeSphere 组件。 -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: +1. 基于[在 Linux 上安装 KubeSphere](.../.../installing-on-linux/introduction/multioverview/) 的教程，您创建了一个默认文件 **config-sample.yaml**。通过执行以下命令修改该文件： ```bash vi config-sample.yaml @@ -31,73 +31,74 @@ 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 App Store in this mode (e.g. for testing purpose), refer to the following section to see how App Store can be installed after installation. +如果采用 [All-in-one 安装](.../.../quick-start/all-in-one-on-linux/)，则不需要创建 `config-sample.yaml` 文件，因为可以直接创建集群。一般来说，All-in-one 模式是为那些刚刚接触 KubeSphere 并希望熟悉系统的用户准备的。如果您想在这个模式下启用应用商店（比如出于测试的目的），可以参考下面的部分，看看安装后如何启用应用商店。 {{}} -2. In this file, navigate to `openpitrix` and change `false` to `true` for `enabled`. Save the file after you finish. +2. 在该文件中，搜寻到 `openpitrix`，并将 `enabled` 的 `false` 改为 `true`。完成后保存文件。 ```bash openpitrix: enabled: true # Change "false" to "true" ``` -3. Create a cluster using the configuration file: +3. 使用配置文件创建一个集群： ```bash ./kk create cluster -f config-sample.yaml ``` -### **Installing on Kubernetes** +### 在 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 App Store, do not use `kubectl apply -f` directly for this file. +在 Kubernetes 上安装 KubeSphere 时，需要下载文件 [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) 进行集群设置。如果要安装应用商店，不要直接使用 `kubectl apply -f` 对这个文件进行设置。 -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 App Store, create a local file cluster-configuration.yaml. +1. 参照[在 Kubernetes 上安装 KubeSphere](.../.../installing-on-kubernetes/introduction/overview/) 的教程，先对文件 [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml) 执行 `kubectl apply -f`。之后，为了启用应用商店，创建一个本地文件 `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 `openpitrix` and enable App Store by changing `false` to `true` for `enabled`. Save the file after you finish. +2. 将 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件中的所有内容复制到刚才创建的本地文件中。 + +3. 在这个本地 `cluster-configuration.yaml` 文件中，搜寻到 `openpitrix`，并将 `enabled` 的 `false` 改为 `true`，启用它们。完成后保存文件。 ```bash openpitrix: enabled: true # Change "false" to "true" ``` -4. Execute the following command to start installation: +4. 执行以下命令开始安装： ```bash kubectl apply -f cluster-configuration.yaml ``` -## Enable App Store after Installation +## 在安装后启用应用商店 -1. Log in the console as `admin`. Click **Platform** in the top-left corner and select **Clusters Management**. +1. 以 `admin` 身份登录控制台。点击左上角的**平台管理**，选择**集群管理**。 -![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) +![集群管理](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. +2. 点击 **自定义资源 CRD**，在搜索栏中输入 `clusterconfiguration`。点击结果查看其详细页面。 {{< notice info >}} -A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. +自定义资源定义（CRD）允许用户在不增加另一个 API 服务器的情况下创建一种新的资源类型。他们可以像其他任何本地 Kubernetes 对象一样使用这些资源。 {{}} -3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**. +3. 在**资源列表**中，点击 `ks-installer` 右边的三个点，选择**编辑 YAML**。 -![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) +![编辑 YAML](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) -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. +4. 在这个 YAML 文件中，搜寻到 `openpitrix`，将 `enabled` 的 `false` 改为 `true`。完成后，点击右下角的**更新**，保存配置。 ```bash openpitrix: enabled: true # Change "false" to "true" ``` -5. You can use the web kubectl to check the installation process by executing the following command: +5. 您可以通过执行以下命令，使用 Web Kubectl 工具来检查安装过程： ```bash kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f @@ -105,31 +106,31 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app= {{< notice tip >}} -You can find the web kubectl tool by clicking the hammer icon in the bottom-right corner of the console. +您可以通过点击控制台右下角的锤子图标找到 Kubectl 工具。 {{}} -## Verify the Installation of Component +## 验证组件的安装 {{< tabs >}} -{{< tab "Verify the Component in Dashboard" >}} +{{< tab "在仪表板中验证组件的安装" >}} -Go to **Components** and check the status of OpenPitrix. You may see an image as follows: +进入**服务组件**，检查 **OpenPitrix** 的状态。您可能会看到如下图片： ![openpitrix](https://ap3.qingstor.com/kubesphere-website/docs/20200829124018.png) {{}} -{{< tab "Verify the Component through kubectl" >}} +{{< tab "通过 kubectl 验证组件的安装" >}} -Execute the following command to check the status of pods: +执行以下命令来检查 Pod 的状态： ```bash kubectl get pod -n openpitrix-system ``` -The output may look as follows if the component runs successfully: +如果组件运行成功，输出结果可能如下： ```bash NAME READY STATUS RESTARTS AGE diff --git a/content/zh/docs/pluggable-components/auditing-logs.md b/content/zh/docs/pluggable-components/auditing-logs.md index 9d3fef9cb..10925a0c4 100644 --- a/content/zh/docs/pluggable-components/auditing-logs.md +++ b/content/zh/docs/pluggable-components/auditing-logs.md @@ -1,25 +1,25 @@ --- -title: "KubeSphere Auditing Logs" +title: "KubeSphere 审计日志" keywords: "Kubernetes, auditing, KubeSphere, logs" -description: "How to enable KubeSphere Auditing Logs" +description: "如何启用 KubeSphere 审计日志" -linkTitle: "KubeSphere Auditing Logs" +linkTitle: "KubeSphere 审计日志" weight: 3525 --- -## What are KubeSphere Auditing Logs? +## 什么是 KubeSphere 审计日志 -KubeSphere Auditing Log System provides a security-relevant chronological set of records documenting the sequence of activities related to individual users, managers, or other components of the system. Each request to KubeSphere generates an event that is then written to a webhook and processed according to a certain rule. +KubeSphere 审计日志系统提供了一套与安全相关的按时间顺序排列的记录，记录了与单个用户、管理人员或系统其他组件相关的活动顺序。对 KubeSphere 的每个请求都会产生一个事件，然后写入 Webhook，并根据一定的规则进行处理。 -For more information, see Logging, Events, and Auditing. +有关更多信息，请参阅日志、事件和审计。 -## Enable Auditing Logs before Installation +## 在安装前启用审计日志 -### Installing on Linux +### 在 Linux 上安装 -When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. +当您在 Linux 上安装 KubeSphere 时，你需要创建一个配置文件，该文件列出了所有 KubeSphere 组件。 -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: +1. 基于[在 Linux 上安装 KubeSphere](.../.../installing-on-linux/introduction/multioverview/) 的教程，您创建了一个默认文件 **config-sample.yaml**。通过执行以下命令修改该文件： ```bash vi config-sample.yaml @@ -27,11 +27,11 @@ 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 Auditing in this mode (e.g. for testing purpose), refer to the following section to see how Auditing can be installed after installation. +如果采用 [All-in-one 安装](.../.../quick-start/all-in-one-on-linux/)，则不需要创建 `config-sample.yaml` 文件，因为可以直接创建集群。一般来说，All-in-one 模式是为那些刚刚接触 KubeSphere 并希望熟悉系统的用户准备的。如果您想在这个模式下启用审计日志（比如出于测试的目的），可以参考下面的部分，看看安装后如何启用审计模式。 {{}} -2. In this file, navigate to `auditing` and change `false` to `true` for `enabled`. Save the file after you finish. +2. 在该文件中，搜寻到 `auditing`，并将 `enabled` 的 `false` 改为 `true`。完成后保存文件。 ```bash auditing: @@ -40,7 +40,7 @@ auditing: {{< notice note >}} -By default, KubeKey will install Elasticsearch internally if Auditing is enabled. For a production environment, it is highly recommended that you set the following value in **config-sample.yaml** if you want to enable Auditing, 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. +默认情况下，如果启用了审计功能，KubeKey 将在内部安装 Elasticsearch。对于生产环境，如果你想启用审计，强烈建议你在 **config-sample.yaml** 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。一旦你在安装前提供以下信息，KubeKey 将直接整合你的外部 Elasticsearch，而不是安装一个内部 Elasticsearch。 {{}} @@ -56,24 +56,25 @@ es: # Storage backend for logging, tracing, events and auditing. externalElasticsearchPort: # The port of external Elasticsearch ``` -3. Create a cluster using the configuration file: +3. 使用配置文件创建一个集群： ```bash ./kk create cluster -f config-sample.yaml ``` -### **Installing on Kubernetes** +### 在 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 Auditing, do not use `kubectl apply -f` directly for this file. +在 Kubernetes 上安装 KubeSphere 时，需要下载文件 [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) 进行集群设置。如果要安装审计日志，不要直接使用 `kubectl apply -f` 对这个文件进行设置。 -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 Auditing, create a local file cluster-configuration.yaml. +1. 参照[在 Kubernetes 上安装 KubeSphere](.../.../installing-on-kubernetes/introduction/overview/) 的教程，先对文件 [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml) 执行 `kubectl apply -f`。之后，为了启用审计日志，创建一个本地文件 `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 `auditing` and enable Auditing by changing `false` to `true` for `enabled`. Save the file after you finish. +2. 将 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件中的所有内容复制到刚才创建的本地文件中。 + +3. 在这个本地 `cluster-configuration.yaml` 文件中，搜寻到 `auditing`，并将 `enabled` 的 `false` 改为 `true`，启用它们。完成后保存文件。 ```bash auditing: @@ -82,7 +83,7 @@ auditing: {{< notice note >}} -By default, ks-installer will install Elasticsearch internally if Auditing is enabled. For a production environment, it is highly recommended that you set the following value in **cluster-configuration.yaml** if you want to enable Auditing, 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. +默认情况下，如果启用了审计功能，ks-installer 会在内部安装 Elasticsearch。对于生产环境，如果你想启用审计，强烈建议你在 **cluster-configuration.yaml** 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。当你在安装前提供以下信息时，ks-installer 将直接整合你的外部 Elasticsearch，而不是安装内部 Elasticsearch。 {{}} @@ -98,31 +99,31 @@ es: # Storage backend for logging, tracing, events and auditing. externalElasticsearchPort: # The port of external Elasticsearch ``` -4. Execute the following command to start installation: +4. 执行以下命令开始安装： ```bash kubectl apply -f cluster-configuration.yaml ``` -## Enable Auditing Logs after Installation +## 在安装后启用审计日志 -1. Log in the console as `admin`. Click **Platform** in the top-left corner and select **Clusters Management**. +1. 以 `admin` 身份登录控制台。点击左上角的**平台管理**，选择**集群管理**。 -![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) +![集群管理](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. +2. 点击 **自定义资源 CRD**，在搜索栏中输入 `clusterconfiguration`。点击结果查看其详细页面。 {{< notice info >}} -A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. +自定义资源定义（CRD）允许用户在不增加另一个 API 服务器的情况下创建一种新的资源类型。他们可以像其他任何本地 Kubernetes 对象一样使用这些资源。 {{}} -3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**. +3. 在**资源列表**中，点击 `ks-installer` 右边的三个点，选择**编辑 YAML**。 -![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) +![编辑 YAML](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) -4. In this yaml file, navigate to `auditing` and change `false` to `true` for `enabled`. After you finish, click **Update** in the bottom-right corner to save the configuration. +4. 在这个 YAML 文件中，搜寻到 `auditing`，将 `enabled` 的 `false` 改为 `true`。完成后，点击右下角的**更新**，保存配置。 ```bash auditing: @@ -131,7 +132,7 @@ auditing: {{< notice note >}} -By default, Elasticsearch will be installed internally if Auditing is enabled. For a production environment, it is highly recommended that you set the following value in this yaml file if you want to enable Auditing, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information, KubeSphere will integrate your external Elasticsearch directly instead of installing an internal one. +默认情况下，如果启用了审计功能，Elasticsearch 将在内部安装。对于生产环境，如果你想启用审计，强烈建议你在这个 YAML 文件中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。一旦你提供了以下信息，KubeSphere 将直接整合你的外部 Elasticsearch，而不是安装一个内部 Elasticsearch。 {{}} @@ -147,7 +148,7 @@ es: # Storage backend for logging, tracing, events and auditing. externalElasticsearchPort: # The port of external Elasticsearch ``` -5. You can use the web kubectl to check the installation process by executing the following command: +5. 您可以通过执行以下命令，使用 Web Kubectl 工具来检查安装过程： ```bash kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f @@ -155,33 +156,33 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app= {{< notice tip >}} -You can find the web kubectl tool by clicking the hammer icon in the bottom-right corner of the console. +您可以通过点击控制台右下角的锤子图标找到 Kubectl 工具。 {{}} -## Verify the Installation of Component +## 验证组件的安装 {{< tabs >}} -{{< tab "Verify the Component in Dashboard" >}} +{{< tab "在仪表板中验证组件的安装" >}} -If you enable both Logging and Auditing, you can check the status of Auditing in **Logging** in **Components**. You may see an image as follows: +如果您同时启用了日志记录和审计日志，您可以在**服务组件**的 **Logging** 中查看审计状态。您可能会看到如下图片： ![auditing](https://ap3.qingstor.com/kubesphere-website/docs/20200829121140.png) -If you only enable Auditing without Logging installed, you cannot see the image above as the button **Logging** will not display. +如果只启用审计而不安装日志，则无法看到上面的图片，因为 **Loggiing** 按钮不会显示。 {{}} -{{< tab "Verify the Component through kubectl" >}} +{{< tab "通过 kubectl 验证组件的安装" >}} -Execute the following command to check the status of pods: +执行以下命令来检查 Pod 的状态： ```bash kubectl get pod -n kubesphere-logging-system ``` -The output may look as follows if the component runs successfully: +如果组件运行成功，输出结果可能如下： ```bash NAME READY STATUS RESTARTS AGE diff --git a/content/zh/docs/pluggable-components/devops.md b/content/zh/docs/pluggable-components/devops.md index 753e4c14c..6ee22e74e 100644 --- a/content/zh/docs/pluggable-components/devops.md +++ b/content/zh/docs/pluggable-components/devops.md @@ -1,27 +1,27 @@ --- -title: "KubeSphere DevOps System" +title: "KubeSphere DevOps 系统" keywords: "Kubernetes, Jenkins, KubeSphere, DevOps, cicd" -description: "How to Enable KubeSphere DevOps System" +description: "如何启用 KubeSphere DevOps 系统" -linkTitle: "KubeSphere DevOps System" +linkTitle: "KubeSphere DevOps" weight: 3520 --- -## What is KubeSphere DevOps System +## 什么是 KubeSphere DevOps 系统 -KubeSphere DevOps System is designed for CI/CD workflows in Kubernetes. Based on [Jenkins](https://jenkins.io/), it provides one-stop solutions to help both development and Ops teams build, test and publish apps to Kubernetes in a straight-forward way. It also features plugin management, Binary-to-Image (B2I), Source-to-Image (S2I), code dependency caching, code quality analysis, pipeline logging, etc. +KubeSphere DevOps 系统是专为 Kubernetes 中的 CI/CD 工作流设计的。基于 [Jenkins](https://jenkins.io/)，它提供了一站式的解决方案，帮助开发和运维团队以直接的方式构建、测试和发布应用到 Kubernetes。它还具有插件管理、二进制到图像（B2I）、源到图像（S2I）、代码依赖缓存、代码质量分析、流水线日志等功能。 -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. +DevOps 系统为用户提供了一个有利的环境，因为应用可以自动发布到同一个平台。它还兼容第三方私有镜像注册库（如 Harbor）和代码库（如 GitLab/GitHub/SVN/BitBucket）。因此，它通过为用户提供全面的、可视化的 CI/CD 管道来创造优秀的用户体验，这些管道在气垫环境中非常有用。 -For more information, see DevOps Administration. +有关更多信息，请参阅 DevOps 管理。 -## Enable DevOps before Installation +## 在安装前启用 DevOps -### Installing on Linux +### 在 Linux 上安装 -When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. +当您在 Linux 上安装 KubeSphere 时，你需要创建一个配置文件，该文件列出了所有 KubeSphere 组件。 -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: +1. 基于[在 Linux 上安装 KubeSphere](.../.../installing-on-linux/introduction/multioverview/) 的教程，您创建了一个默认文件 **config-sample.yaml**。通过执行以下命令修改该文件： ```bash vi config-sample.yaml @@ -29,73 +29,74 @@ 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 DevOps in this mode (e.g. for testing purpose), refer to the following section to see how DevOps can be installed after installation. +如果采用 [All-in-one 安装](.../.../quick-start/all-in-one-on-linux/)，则不需要创建 `config-sample.yaml` 文件，因为可以直接创建集群。一般来说，All-in-one 模式是为那些刚刚接触 KubeSphere 并希望熟悉系统的用户准备的。如果您想在这个模式下启用 DevOps（比如出于测试的目的），可以参考下面的部分，看看安装后如何启用 DevOps 系统。 {{}} -2. In this file, navigate to `devops` and change `false` to `true` for `enabled`. Save the file after you finish. +2. 在该文件中，搜寻到 `devops`，并将 `enabled` 的 `false` 改为 `true`。完成后保存文件。 ```bash devops: enabled: true # Change "false" to "true" ``` -3. Create a cluster using the configuration file: +3. 使用配置文件创建一个集群： ```bash ./kk create cluster -f config-sample.yaml ``` -### **Installing on Kubernetes** +### 在 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. +在 Kubernetes 上安装 KubeSphere 时，需要下载文件 [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) 进行集群设置。如果要安装 DevOps 系统，不要直接使用 `kubectl apply -f` 对这个文件进行设置。 -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. 参照[在 Kubernetes 上安装 KubeSphere](.../.../installing-on-kubernetes/introduction/overview/) 的教程，先对文件 [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml) 执行 `kubectl apply -f`。之后，为了启用 DevOps，创建一个本地文件 `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. 将 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件中的所有内容复制到刚才创建的本地文件中。 + +3. 在这个本地 `cluster-configuration.yaml` 文件中，搜寻到 `devops`，并将 `enabled` 的 `false` 改为 `true`，启用它们。完成后保存文件。 ```bash devops: enabled: true # Change "false" to "true" ``` -4. Execute the following command to start installation: +4. 执行以下命令开始安装： ```bash kubectl apply -f cluster-configuration.yaml ``` -## Enable DevOps after Installation +## 在安装后启用 DevOps 系统 -1. Log in the console as `admin`. Click **Platform** in the top-left corner and select **Clusters Management**. +1. 以 `admin` 身份登录控制台。点击左上角的**平台管理**，选择**集群管理**。 -![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) +![集群管理](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. +2. 点击 **自定义资源 CRD**，在搜索栏中输入 `clusterconfiguration`。点击结果查看其详细页面。 {{< notice info >}} -A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. +自定义资源定义（CRD）允许用户在不增加另一个 API 服务器的情况下创建一种新的资源类型。他们可以像其他任何本地 Kubernetes 对象一样使用这些资源。 {{}} -3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**. +3. 在**资源列表**中，点击 `ks-installer` 右边的三个点，选择**编辑 YAML**。 -![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) +![编辑 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. +4. 在这个 YAML 文件中，搜寻到 `devops`，将 `enabled` 的 `false` 改为 `true`。完成后，点击右下角的**更新**，保存配置。 ```bash devops: enabled: true # Change "false" to "true" ``` -5. You can use the web kubectl to check the installation process by executing the following command: +5. 您可以通过执行以下命令，使用 Web Kubectl 工具来检查安装过程： ```bash kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f @@ -103,31 +104,31 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app= {{< notice tip >}} -You can find the web kubectl tool by clicking the hammer icon in the bottom-right corner of the console. +您可以通过点击控制台右下角的锤子图标找到 Kubectl 工具。 {{}} -## Verify the Installation of Component +## 验证组件的安装 {{< tabs >}} -{{< tab "Verify the Component in Dashboard" >}} +{{< tab "在仪表板中验证组件的安装" >}} -Go to **Components** and check the status of DevOps. You may see an image as follows: +进入**服务组件**，检查 DevOps 的状态。你可能会看到如下图片： ![devops](https://ap3.qingstor.com/kubesphere-website/docs/20200829125245.png) {{}} -{{< tab "Verify the Component through kubectl" >}} +{{< tab "通过 kubectl 验证组件的安装" >}} -Execute the following command to check the status of pods: +执行以下命令来检查 Pod 的状态： ```bash kubectl get pod -n kubesphere-devops-system ``` -The output may look as follows if the component runs successfully: +如果组件运行成功，输出结果可能如下： ```bash NAME READY STATUS RESTARTS AGE diff --git a/content/zh/docs/pluggable-components/events.md b/content/zh/docs/pluggable-components/events.md index d3b5626d7..ac87e51fc 100644 --- a/content/zh/docs/pluggable-components/events.md +++ b/content/zh/docs/pluggable-components/events.md @@ -1,25 +1,25 @@ --- -title: "KubeSphere Events" +title: "KubeSphere 事件系统" keywords: "Kubernetes, events, KubeSphere, k8s-events" -description: "How to enable KubeSphere Events" +description: "如何启用 KubeSphere 事件" -linkTitle: "KubeSphere Events" +linkTitle: "KubeSphere 事件系统" weight: 3530 --- -## What are KubeSphere Events +## 什么是 KubeSphere 事件系统 -KubeSphere events allow users to keep track of what is happening inside a cluster, such as node scheduling status and image pulling result. They will be accurately recorded with the specific reason, status and message displayed in the web console. To query events, users can quickly launch the web Toolkit and enter related information in the search bar with different filters (e.g keyword and project) available. Events can also be archived to third-party tools, such as Elasticsearch, Kafka or Fluentd. +KubeSphere 事件系统允许用户跟踪集群内部发生的事情，如节点调度状态和镜像拉取结果。它们将被准确地记录下来，并在Web 控制台中显示具体的原因、状态和信息。要查询事件，用户可以快速启动 Web 工具箱，在搜索栏中输入相关信息，并有不同的过滤器（如关键字和项目）可供选择。事件也可以归档到第三方工具，如 Elasticsearch、Kafka 或 Fluentd。 -For more information, see Logging, Events and Auditing. +有关更多信息，请参见日志记录、事件和审计系统。 -## Enable Events before Installation +## 在安装前启用事件系统 -### Installing on Linux +### 在 Linux 上安装 -When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. +当您在 Linux 上安装 KubeSphere 时，你需要创建一个配置文件，该文件列出了所有 KubeSphere 组件。 -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: +1. 基于[在 Linux 上安装 KubeSphere](.../.../installing-on-linux/introduction/multioverview/) 的教程，您创建了一个默认文件 **config-sample.yaml**。通过执行以下命令修改该文件： ```bash vi config-sample.yaml @@ -27,11 +27,11 @@ 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 Events in this mode (e.g. for testing purpose), refer to the following section to see how Events can be installed after installation. +如果采用 [All-in-one 安装](.../.../quick-start/all-in-one-on-linux/)，则不需要创建 `config-sample.yaml` 文件，因为可以直接创建集群。一般来说，All-in-one 模式是为那些刚刚接触 KubeSphere 并希望熟悉系统的用户准备的。如果您想在这个模式下启用事件（比如出于测试的目的），可以参考下面的部分，看看安装后如何启用事件系统。 {{}} -2. In this file, navigate to `events` and change `false` to `true` for `enabled`. Save the file after you finish. +2. 在该文件中，搜寻到 `events`，并将 `enabled` 的 `false` 改为 `true`。完成后保存文件。 ```bash events: @@ -40,7 +40,7 @@ events: {{< notice note >}} -By default, KubeKey will install Elasticsearch internally if Events is enabled. For a production environment, it is highly recommended that you set the following value in **config-sample.yaml** if you want to enable Events, 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. +默认情况下，如果启用了审计功能，KubeKey 将在内部安装 Elasticsearch。对于生产环境，如果你想启用事件，强烈建议你在 **config-sample.yaml** 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。一旦你在安装前提供以下信息，KubeKey 将直接整合你的外部 Elasticsearch，而不是安装一个内部 Elasticsearch。 {{}} @@ -56,24 +56,25 @@ es: # Storage backend for logging, tracing, events and auditing. externalElasticsearchPort: # The port of external Elasticsearch ``` -3. Create a cluster using the configuration file: +3. 使用配置文件创建一个集群： ```bash ./kk create cluster -f config-sample.yaml ``` -### **Installing on Kubernetes** +### 在 Kubernetes 上安装 -When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) for cluster setting. If you want to install Events, do not use `kubectl apply -f` directly for this file. +在 Kubernetes 上安装 KubeSphere 时，需要下载文件 [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) 进行集群设置。如果要安装事件系统，不要直接使用 `kubectl apply -f` 对这个文件进行设置。 -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://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml). After that, to enable Events, create a local file cluster-configuration.yaml. +1. 参照[在 Kubernetes 上安装 KubeSphere](.../.../installing-on-kubernetes/introduction/overview/) 的教程，先对文件 [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml) 执行 `kubectl apply -f`。之后，为了启用事件，创建一个本地文件 `cluster-configuration.yaml`。 ```bash vi cluster-configuration.yaml ``` -2. Copy all the content in the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) and paste it to the local file just created. -3. In this local cluster-configuration.yaml file, navigate to `events` and enable Events by changing `false` to `true` for `enabled`. Save the file after you finish. +2. 将 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件中的所有内容复制到刚才创建的本地文件中。 + +3. 在这个本地 `cluster-configuration.yaml` 文件中，搜寻到 `events`，并将 `enabled` 的 `false` 改为 `true`，启用它们。完成后保存文件。 ```bash events: @@ -82,7 +83,7 @@ events: {{< notice note >}} -By default, ks-installer will install Elasticsearch internally if Events is enabled. For a production environment, it is highly recommended that you set the following value in **cluster-configuration.yaml** if you want to enable Events, 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. +默认情况下，如果启用了事件功能，ks-installer 会在内部安装 Elasticsearch。对于生产环境，如果你想启用事件，强烈建议你在 **cluster-configuration.yaml** 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。当你在安装前提供以下信息时，ks-installer 将直接整合你的外部 Elasticsearch，而不是安装内部 Elasticsearch。 {{}} @@ -98,31 +99,31 @@ es: # Storage backend for logging, tracing, events and auditing. externalElasticsearchPort: # The port of external Elasticsearch ``` -4. Execute the following command to start installation: +4. 执行以下命令开始安装： ```bash kubectl apply -f cluster-configuration.yaml ``` -## Enable Events after Installation +## 在安装后启用事件 -1. Log in the console as `admin`. Click **Platform** in the top-left corner and select **Clusters Management**. +1. 以 `admin` 身份登录控制台。点击左上角的**平台管理**，选择**集群管理**。 -![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) +![集群管理](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. +2. 点击 **自定义资源 CRD**，在搜索栏中输入 `clusterconfiguration`。点击结果查看其详细页面。 {{< notice info >}} -A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. +自定义资源定义（CRD）允许用户在不增加另一个 API 服务器的情况下创建一种新的资源类型。他们可以像其他任何本地 Kubernetes 对象一样使用这些资源。 {{}} -3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**. +3. 在**资源列表**中，点击 `ks-installer` 右边的三个点，选择**编辑 YAML**。 -![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) +![编辑 YAML](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) -4. In this yaml file, navigate to `events` and change `false` to `true` for `enabled`. After you finish, click **Update** in the bottom-right corner to save the configuration. +4. 在这个 YAML 文件中，搜寻到 `events`，将 `enabled` 的 `false` 改为 `true`。完成后，点击右下角的**更新**，保存配置。 ```bash events: @@ -131,7 +132,7 @@ events: {{< notice note >}} -By default, Elasticsearch will be installed internally if Events is enabled. For a production environment, it is highly recommended that you set the following value in this yaml file if you want to enable Events, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information, KubeSphere will integrate your external Elasticsearch directly instead of installing an internal one. +默认情况下，如果启用了事件，Elasticsearch 将在内部安装。对于生产环境，如果你想启用审计，强烈建议你在这个 YAML 文件中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。一旦你提供了以下信息，KubeSphere 将直接整合你的外部 Elasticsearch，而不是安装一个内部 Elasticsearch。 {{}} @@ -147,7 +148,7 @@ es: # Storage backend for logging, tracing, events and auditing. externalElasticsearchPort: # The port of external Elasticsearch ``` -5. You can use the web kubectl to check the installation process by executing the following command: +5. 您可以通过执行以下命令，使用 Web Kubectl 工具来检查安装过程： ```bash kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f @@ -155,33 +156,33 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app= {{< notice tip >}} -You can find the web kubectl tool by clicking the hammer icon in the bottom-right corner of the console. +您可以通过点击控制台右下角的锤子图标找到 Kubectl 工具。 {{}} -## Verify the Installation of Component +## 验证组件的安装 {{< tabs >}} -{{< tab "Verify the Component in Dashboard" >}} +{{< tab "在仪表板中验证组件的安装" >}} -If you enable both Logging and Events, you can check the status of Events in **Logging** in **Components**. You may see an image as follows: +如果您同时启用了日志和事件，您可以在**服务组件**的 **Logging** 中查看事件服务状态。您可能会看到如下图片： ![events](https://ap3.qingstor.com/kubesphere-website/docs/events.png) -If you only enable Events without Logging installed, you cannot see the image above as the button **Logging** will not display. +如果只启用事件而不安装日志，则无法看到上面的图片，因为 **Loggiing** 按钮不会显示。 {{}} -{{< tab "Verify the Component through kubectl" >}} +{{< tab "通过 kubectl 验证组件的安装" >}} -Execute the following command to check the status of pods: +执行以下命令来检查 Pod 的状态： ```bash kubectl get pod -n kubesphere-logging-system ``` -The output may look as follows if the component runs successfully: +如果组件运行成功，输出结果可能如下： ```bash NAME READY STATUS RESTARTS AGE diff --git a/content/zh/docs/pluggable-components/faq/_index.md b/content/zh/docs/pluggable-components/faq/_index.md new file mode 100644 index 000000000..c3f3d5bdd --- /dev/null +++ b/content/zh/docs/pluggable-components/faq/_index.md @@ -0,0 +1,7 @@ +--- +linkTitle: "FAQ" +weight: 3550 + +_build: + render: false +--- diff --git a/content/zh/docs/pluggable-components/faq/logging.md b/content/zh/docs/pluggable-components/faq/logging.md new file mode 100644 index 000000000..51e6ae60b --- /dev/null +++ b/content/zh/docs/pluggable-components/faq/logging.md @@ -0,0 +1,144 @@ +--- +title: "日志系统" +keywords: "Kubernetes, Elasticsearch, KubeSphere, Logging, logs" +description: "FAQ" + +linkTitle: "日志系统" +weight: 3535 +--- + +## 如何将日志存储改为外部弹性搜索并关闭内部弹性搜索 + +如果您使用的是 KubeSphere 内部的 Elasticsearch，并且想把它改成您的外部备用，请按照下面的指南操作。否则，如果你还没有启用日志系统，请到[启用日志系统](.../.../logging/)直接设置外部 Elasticsearch。 + +首先，更新 KubeKey 配置。 + +```shell +kubectl edit cc -n kubesphere-system ks-installer +``` + +- 将如下 `es.elasticsearchDataXXX`、`es.elasticsearchMasterXXX` 和 `status.logging` 的注释取消。 + +- 将 `es.externalElasticsearchUrl` 设置为弹性搜索的地址，`es.externalElasticsearchPort` 设置为它的端口号。 + +```shell +apiVersion: installer.kubesphere.io/v1alpha1 +kind: ClusterConfiguration +metadata: + name: ks-installer + namespace: kubesphere-system + ... +spec: + ... + common: + es: + # elasticsearchDataReplicas: 1 + # elasticsearchDataVolumeSize: 20Gi + # elasticsearchMasterReplicas: 1 + # elasticsearchMasterVolumeSize: 4Gi + elkPrefix: logstash + logMaxAge: 7 + externalElasticsearchUrl: <192.168.0.2> + externalElasticsearchPort: <9200> + ... +status: + ... + # logging: + # enabledTime: 2020-08-10T02:05:13UTC + # status: enabled + ... +``` + +然后，重新运行 ks-installer。 + +```shell +kubectl rollout restart deploy -n kubesphere-system ks-installer +``` + +最后，要删除内部的 Elasticsearch，请运行以下命令。请确认你已经备份了内部 Elasticsearch 中的数据。 + +```shell +helm uninstall -n kubesphere-logging-system elasticsearch-logging +``` + +## 如何在启用 X-Pack Security 的情况下将日志存储改为 Elasticsearch + +目前，KubeSphere 不支持与启用 X-Pack Security 的 Elasticsearch 集成。此功能即将推出。 + +## 如何修改日志数据保留天数 + +你需要更新 KubeKey 配置并重新运行 ks-installer。 + +```shell +kubectl edit cc -n kubesphere-system ks-installer +``` + +- 将如下 `status.logging` 的注释取消。 + +- 将 `es.logMaxAge` 设置为所需天数（默认为 7 天）。 + +```shell +apiVersion: installer.kubesphere.io/v1alpha1 +kind: ClusterConfiguration +metadata: + name: ks-installer + namespace: kubesphere-system + ... +spec: + ... + common: + es: + ... + logMaxAge: <7> + ... +status: + ... + # logging: + # enabledTime: 2020-08-10T02:05:13UTC + # status: enabled + ... +``` + +- 重新运行 ks-installer。 + +```shell +kubectl rollout restart deploy -n kubesphere-system ks-installer +``` + +## 无法从工具箱中的某些节点上的工作负载中找出日志 + +如果你采用[多节点安装](.../.../installing-on-linux/introduction/multioverview/)，并且使用符号链接作为 Docker 根目录，请确保所有节点遵循完全相同的符号链接。日志代理在 DaemonSet 中部署到节点上。容器日志路径的任何差异都可能导致该节点上的收集失败。 + +要找出节点上的 Docker 根目录路径，可以运行以下命令。确保所有节点都适用相同的值。 + +``` +docker info -f '{{.DockerRootDir}}' +``` + +## 工具箱中的日志查看页面在加载中卡住 + +如果您发现日志搜索在加载中卡住，请检查您使用的存储系统。例如，配置不当的 NFS 存储系统可能会导致此问题。 + +## 工具箱显示今天没有日志记录 + +请检查您的日志容量是否超过了 Elasticsearch 的存储容量限制。如果是，请增加 Elasticsearch 的磁盘容量。 + +## 在工具箱中查看日志时，报告服务器内部错误 + +如果您在工具箱中观察到内部服务器错误，可能有几个原因导致此问题。 + +- 网络分区 +- 无效的 Elasticsearch 主机和端口 +- Elasticsearch 健康状态为红色 + +## 如何让 KubeSphere 只收集指定工作负载的日志 + +KubeSphere 的日志代理是由 Fluent Bit 提供的，您需要更新 Fluent Bit 配置来排除某些工作负载的日志。要修改 Fluent Bit 输入配置，请运行以下命令： + +```shell +kubectl edit input -n kubesphere-logging-system tail +``` + +更新 `Input.Spec.Tail.ExcludePath` 字段。例如，将路径设置为 `/var/log/containers/*_kube*-system_*.log`，以排除系统组件的任何日志。 + +更多信息请阅读项目 [Fluent Bit Operator](https://github.com/kubesphere/fluentbit-operator)。 diff --git a/content/zh/docs/pluggable-components/faq/monitoring.md b/content/zh/docs/pluggable-components/faq/monitoring.md new file mode 100644 index 000000000..72405e686 --- /dev/null +++ b/content/zh/docs/pluggable-components/faq/monitoring.md @@ -0,0 +1,107 @@ +--- +title: "监控系统" +keywords: "Kubernetes, Prometheus, KubeSphere, Monitoring" +description: "FAQ" + +linkTitle: "监控系统" +weight: 3540 +--- + +## 如何访问 KubeSphere Prometheus 控制台 + +KubeSphere 监控引擎由 Prometheus 提供支持。出于调试目的，您可能希望通过 NodePort 访问内置的 Prometheus 服务。要做到这一点，运行以下命令来编辑服务类型。 + +```shell +kubectl edit svc -n kubesphere-monitoring-system prometheus-k8s +``` + +## Node Exporter 引起的主机端口 9100 冲突 + +如果有进程占用主机端口 9100，`kubespher-monitoring-system` 下的 Node Exporter 会崩溃。为了解决冲突，你需要终止进程或将 Node Exporter 换到另一个可用端口。 + +要采用另一个主机端口，例如 `29100`，运行以下命令，将所有 `9100` 替换为 `29100`（需要更改 5 处）。 + + ```shell + kubectl edit ds -n kubesphere-monitoring-system node-exporter + ``` + + ```shell + apiVersion: apps/v1 + kind: DaemonSet + metadata: + name: node-exporter + namespace: kubesphere-monitoring-system + ... + spec: + ... + template: + ... + spec: + containers: + - name: node-exporter + image: kubesphere/node-exporter:ks-v0.18.1 + args: + - --web.listen-address=127.0.0.1:9100 + ... + - name: kube-rbac-proxy + image: kubesphere/kube-rbac-proxy:v0.4.1 + args: + - --logtostderr + - --secure-listen-address=[$(IP)]:9100 + - --upstream=http://127.0.0.1:9100/ + ... + ports: + - containerPort: 9100 + hostPort: 9100 + ... +``` + +## 与现有的 Prometheus Operator 相冲突 + +如果你已经自行部署了 Prometheus Operator，请确保在安装 KubeSphere 之前将 Prometheus Operator 删除。否则，可能会出现 KubeSphere 内置的 Prometheus Operator 选择重复的 ServiceMonitor 对象的冲突。 + +## 如何修改监控数据保留天数 + +运行下面的命令来编辑最大保留天数。找出 `retention` 字段，并将其更新为所需天数（默认为 7）。 + +```shell +kubectl edit prometheuses -n kubesphere-monitoring-system k8s +``` + +## kube-scheduler / kube-controller-manager 没有监测数据 + +首先，请确保标志 `--bind-address` 被设置为 `0.0.0.0`（默认），而不是 `127.0.0.1`。Prometheus 可能需要从其它主机到达这些组件。 + +随后，请检查 kube-scheduler 和 kube-controller-manager 的端点对象是否存在。如果它们缺失，请通过创建服务选择目标 Pod 手动创建它们。 + +```shell +kubectl get ep -n kube-system | grep -E 'kube-scheduler|kube-controller-manager' +``` + +## 过去几分钟没有监测数据 + +请检查您的计算机浏览器本地时钟是否与互联网时间和您的群集同步。时差可能会导致这个问题。特别是您处于在局域网中，可能会出现这种情况。 + +## 两个节点和控制平面都没有监控数据 + +请检查您的网络插件，并确保您的主机和 Pod 网络 CIDR 之间没有 IPPool 重叠。KubeSphere 强烈建议您使用 [KubeKey](https://github.com/kubesphere/kubekey) 安装 Kubernetes。 + +中国读者可以参考 KubeSphere 中文论坛的[讨论](https://kubesphere.com.cn/forum/d/2027/16)了解更多信息。 + +## Prometheus 产生错误日志：打开存储失败，没有这样的文件或目录 + +如果 `kubesphere-monitoring-system` 下的 Prometheus Pod 崩溃并产生以下错误日志，您的 Prometheus 数据可能已经损坏，需要手动删除才能恢复。 + +``` +level=error ts=2020-10-14T17:43:30.485Z caller=main.go:764 err="opening storage failed: block dir: \"/prometheus/01EM0016F8FB33J63RNHFMHK3\": open /prometheus/01EM0016F8FB33J63RNHFMHK3/meta.json: no such file or directory" +``` + +执行进入 Prometheus Pod（如果可能的话），并删除目录 `/prometheus/01EM0016F8FB33J63RNHFMHK3`。 + +```shell +kubectl exec -it -n kubesphere-monitoring-system prometheus-k8s-0 -c prometheus sh + +rm -rf 01EM0016F8FB33J63RNHFMHK3/ +``` + +或者您可以简单地从链接到 Prometheus PVC 的持久存储卷中删除目录。 diff --git a/content/zh/docs/pluggable-components/logging.md b/content/zh/docs/pluggable-components/logging.md index da80c2ca8..0e28c7dbf 100644 --- a/content/zh/docs/pluggable-components/logging.md +++ b/content/zh/docs/pluggable-components/logging.md @@ -1,25 +1,25 @@ --- -title: "KubeSphere Logging System" +title: "KubeSphere 日志系统" keywords: "Kubernetes, Elasticsearch, KubeSphere, Logging, logs" -description: "How to Enable KubeSphere Logging System" +description: "如何启用 KubeSphere 日志系统" -linkTitle: "KubeSphere Logging System" +linkTitle: "KubeSphere 日志系统" weight: 3535 --- -## What is KubeSphere Logging System +## 什么是 KubeSphere 日志系统 -KubeSphere provides a powerful, holistic and easy-to-use logging system for log collection, query and management. It covers logs at varied levels, including tenants, infrastructure resources, and applications. Users can search logs from different dimensions, such as project, workload, Pod and keyword. Compared with Kibana, the tenant-based logging system of KubeSphere features better isolation and security among tenants as each tenant can only view his or her own logs. Apart from KubeSphere's own logging system, the container platform also allows users to add third-party log collectors, such as Elasticsearch, Kafka and Fluentd. +KubeSphere 为日志收集、查询和管理提供了一个强大的、整体的、易于使用的日志系统。它涵盖了不同层次的日志，包括租户、基础设施资源和应用。用户可以从项目、工作量、Pod 和关键字等不同维度对日志进行搜索。与 Kibana 相比，KubeSphere 基于租户的日志系统具有更好的隔离性和租户之间的安全性，因为每个租户只能查看自己的日志。除了 KubeSphere 自身的日志系统，容器平台还允许用户添加第三方日志收集器，如 Elasticsearch、Kafka 和 Fluentd。 -For more information, see Logging, Events and Auditing. +有关更多信息，请参阅日志、事件和审计系统。 -## Enable Logging before Installation +## 在安装前启用日志系统 -### Installing on Linux +### 在 Linux 上安装 -When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. +当您在 Linux 上安装 KubeSphere 时，你需要创建一个配置文件，该文件列出了所有 KubeSphere 组件。 -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: +1. 基于[在 Linux 上安装 KubeSphere](.../.../installing-on-linux/introduction/multioverview/) 的教程，您创建了一个默认文件 **config-sample.yaml**。通过执行以下命令修改该文件： ```bash vi config-sample.yaml @@ -27,11 +27,17 @@ 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 Logging in this mode (e.g. for testing purpose), refer to the following section to see how Logging can be installed after installation. +如果采用 [All-in-one 安装](.../.../quick-start/all-in-one-on-linux/)，则不需要创建 `config-sample.yaml` 文件，因为可以直接创建集群。一般来说，All-in-one 模式是为那些刚刚接触 KubeSphere 并希望熟悉系统的用户准备的。如果您想在这个模式下启用日志系统（比如出于测试的目的），可以参考下面的部分，看看安装后如何启用日志系统。 {{}} -2. In this file, navigate to `logging` and change `false` to `true` for `enabled`. Save the file after you finish. +{{< notice warning >}} + +如果你采用[多节点安装](.../.../install-on-linux/introduction/multioverview/)，并且使用符号链接作为 Docker 根目录，请确保所有节点遵循完全相同的符号链接。日志代理在 DaemonSet 中部署到节点上。容器日志路径的任何差异都可能导致该节点的收集失败。 + +{{}} + +2. 在该文件中，搜寻到 `logging`，并将 `enabled` 的 `false` 改为 `true`。完成后保存文件。 ```bash logging: @@ -40,7 +46,7 @@ logging: {{< 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 value 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. +默认情况下，如果启用了审计功能，KubeKey 将在内部安装 Elasticsearch。对于生产环境，如果你想启用日志系统，强烈建议你在 **config-sample.yaml** 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。一旦你在安装前提供以下信息，KubeKey 将直接整合你的外部 Elasticsearch，而不是安装一个内部 Elasticsearch。 {{}} @@ -55,24 +61,26 @@ es: # Storage backend for logging, tracing, events and auditing. externalElasticsearchUrl: # The URL of external Elasticsearch externalElasticsearchPort: # The port of external Elasticsearch ``` -3. Create a cluster using the configuration file: + +3. 使用配置文件创建一个集群： ```bash ./kk create cluster -f config-sample.yaml ``` -### **Installing on Kubernetes** +### 在 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 Logging, do not use `kubectl apply -f` directly for this file. +在 Kubernetes 上安装 KubeSphere 时，需要下载文件 [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) 进行集群设置。如果要安装日志系统，不要直接使用 `kubectl apply -f` 对这个文件进行设置。 -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 Logging, create a local file cluster-configuration.yaml. +1. 参照[在 Kubernetes 上安装 KubeSphere](.../.../installing-on-kubernetes/introduction/overview/) 的教程，先对文件 [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml) 执行 `kubectl apply -f`。之后，为了启用日志，创建一个本地文件 `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 `logging` and enable Logging by changing `false` to `true` for `enabled`. Save the file after you finish. +2. 将 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件中的所有内容复制到刚才创建的本地文件中。 + +3. 在这个本地 `cluster-configuration.yaml` 文件中，搜寻到 `logging`，并将 `enabled` 的 `false` 改为 `true`，启用它们。完成后保存文件。 ```bash logging: @@ -81,7 +89,7 @@ logging: {{< 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 value 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. +默认情况下，如果启用了日志功能，ks-installer 会在内部安装 Elasticsearch。对于生产环境，如果你想启用日志系统，强烈建议你在 **cluster-configuration.yaml** 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。当你在安装前提供以下信息时，ks-installer 将直接整合你的外部 Elasticsearch，而不是安装内部 Elasticsearch。 {{}} @@ -97,31 +105,31 @@ es: # Storage backend for logging, tracing, events and auditing. externalElasticsearchPort: # The port of external Elasticsearch ``` -4. Execute the following command to start installation: +4. 执行以下命令开始安装： ```bash kubectl apply -f cluster-configuration.yaml ``` -## Enable Logging after Installation +## 在安装后启用事件 -1. Log in the console as `admin`. Click **Platform** in the top-left corner and select **Clusters Management**. +1. 以 `admin` 身份登录控制台。点击左上角的**平台管理**，选择**集群管理**。 -![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) +![集群管理](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. +2. 点击 **自定义资源 CRD**，在搜索栏中输入 `clusterconfiguration`。点击结果查看其详细页面。 {{< notice info >}} -A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. +自定义资源定义（CRD）允许用户在不增加另一个 API 服务器的情况下创建一种新的资源类型。他们可以像其他任何本地 Kubernetes 对象一样使用这些资源。 {{}} -3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**. +3. 在**资源列表**中，点击 `ks-installer` 右边的三个点，选择**编辑 YAML**。 -![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) +![编辑 YAML](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) -4. In this yaml file, navigate to `logging` and change `false` to `true` for `enabled`. After you finish, click **Update** in the bottom-right corner to save the configuration. +4. 在这个 YAML 文件中，搜寻到 `logging`，将 `enabled` 的 `false` 改为 `true`。完成后，点击右下角的**更新**，保存配置。 ```bash logging: @@ -130,7 +138,7 @@ logging: {{< 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 value 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. +默认情况下，如果启用了日志系统，Elasticsearch 将在内部安装。对于生产环境，如果你想启用日志，强烈建议你在这个 YAML 文件中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。一旦你提供了以下信息，KubeSphere 将直接整合你的外部 Elasticsearch，而不是安装一个内部 Elasticsearch。 {{}} @@ -146,7 +154,7 @@ es: # Storage backend for logging, tracing, events and auditing. externalElasticsearchPort: # The port of external Elasticsearch ``` -5. You can use the web kubectl to check the installation process by executing the following command: +5. 您可以通过执行以下命令，使用 Web Kubectl 工具来检查安装过程： ```bash kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f @@ -154,31 +162,31 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app= {{< notice tip >}} -You can find the web kubectl tool by clicking the hammer icon in the bottom-right corner of the console. +您可以通过点击控制台右下角的锤子图标找到 Kubectl 工具。 {{}} -## Verify the Installation of Component +## 验证组件的安装 {{< tabs >}} -{{< tab "Verify the Component in Dashboard" >}} +{{< tab "在仪表板中验证组件的安装" >}} -Go to **Components** and check the status of Logging. You may see an image as follows: +进入**服务组件**，检查 Logging 的状态。你可能会看到如下图片： ![logging](https://ap3.qingstor.com/kubesphere-website/docs/20200829104152.png) {{}} -{{< tab "Verify the Component through kubectl" >}} +{{< tab "通过 kubectl 验证组件的安装" >}} -Execute the following command to check the status of pods: +执行以下命令来检查 Pod 的状态： ```bash kubectl get pod -n kubesphere-logging-system ``` -The output may look as follows if the component runs successfully: +如果组件运行成功，输出结果可能如下： ```bash NAME READY STATUS RESTARTS AGE diff --git a/content/zh/docs/pluggable-components/network-policy.md b/content/zh/docs/pluggable-components/network-policy.md index d5023d3c6..868e84380 100644 --- a/content/zh/docs/pluggable-components/network-policy.md +++ b/content/zh/docs/pluggable-components/network-policy.md @@ -1,32 +1,32 @@ --- -title: "Network Policy" +title: "网络策略" keywords: "Kubernetes, KubeSphere, NetworkPolicy" -description: "How to Enable Network Policy" +description: "如何启用网络策略" -linkTitle: "Network Policy" +linkTitle: "网络策略" weight: 3547 --- -## What is Network Policy +## 什么是网络策略 -Starting from v3.0.0, users can configure network policies of native Kubernetes in KubeSphere. Network Policies are an application-centric construct, enabling you to specify how a pod is allowed to communicate with various network entities over the network. With network policies, users can achieve network isolation within the same cluster, which means firewalls can be set up between certain instances (pods). +从 v3.0.0 开始，用户可以在 KubeSphere 中配置原生 Kubernetes 的网络策略。网络策略是一种以应用为中心的构造，可以让你指定一个 Pod 如何被允许通过网络与各种网络实体进行通信。通过网络策略，用户可以在同一集群内实现网络隔离，这意味着可以在某些实例（Pod）之间设置防火墙。 {{< notice note >}} -- Please make sure that the CNI network plugin used by the cluster supports Network Policies before you enable it. There are a number of CNI network plugins that support Network Policies, including Calico, Cilium, Kube-router, Romana and Weave Net. -- It is recommended that you use [Calico](https://www.projectcalico.org/) as the CNI plugin before you enable Network Policy. +- 在启用之前，请确保集群使用的 CNI 网络插件支持网络策略。支持网络策略的 CNI 网络插件有很多，包括 Calico、Cilium、Kube-router、Romana 和 Weave Net。 +- 建议您在启用网络策略之前，使用 [Calico](https://www.projectcalico.org/) 作为 CNI 插件。 {{}} -For more information, see [Network Policies](https://kubernetes.io/docs/concepts/services-networking/network-policies/). +更多信息请参见[网络政策](https://kubernetes.io/docs/concepts/services-networking/network-policies/)。 -## Enable Network Policy before Installation +## 在安装前启用网络策略 -### Installing on Linux +### 在 Linux 上安装 -When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. +当您在 Linux 上安装 KubeSphere 时，你需要创建一个配置文件，该文件列出了所有 KubeSphere 组件。 -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: +1. 基于[在 Linux 上安装 KubeSphere](.../.../installing-on-linux/introduction/multioverview/) 的教程，您创建了一个默认文件 **config-sample.yaml**。通过执行以下命令修改该文件： ```bash vi config-sample.yaml @@ -34,73 +34,74 @@ 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 Network Policy in this mode (e.g. for testing purpose), refer to the following section to see how Network Policy can be installed after installation. +如果采用 [All-in-one 安装](.../.../quick-start/all-in-one-on-linux/)，则不需要创建 `config-sample.yaml` 文件，因为可以直接创建集群。一般来说，All-in-one 模式是为那些刚刚接触 KubeSphere 并希望熟悉系统的用户准备的。如果您想在这个模式下启用网络策略（比如出于测试的目的），可以参考下面的部分，看看安装后如何启用网络策略。 {{}} -2. In this file, navigate to `networkpolicy` and change `false` to `true` for `enabled`. Save the file after you finish. +2. 在该文件中，搜寻到 `networkpolicy`，并将 `enabled` 的 `false` 改为 `true`。完成后保存文件。 ```bash networkpolicy: enabled: true # Change "false" to "true" ``` -3. Create a cluster using the configuration file: +3. 使用配置文件创建一个集群： ```bash ./kk create cluster -f config-sample.yaml ``` -### **Installing on Kubernetes** +### 在 Kubernetes 上安装 -When you install KubeSphere on Kubernetes, you need to download the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) for cluster setting. If you want to install Network Policy, do not use `kubectl apply -f` directly for this file. +在 Kubernetes 上安装 KubeSphere 时，需要下载文件 [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) 进行集群设置。如果要安装网络策略，不要直接使用 `kubectl apply -f` 对这个文件进行设置。 -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://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml). After that, to enable Network Policy, create a local file cluster-configuration.yaml. +1. 参照[在 Kubernetes 上安装 KubeSphere](.../.../installing-on-kubernetes/introduction/overview/) 的教程，先对文件 [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml) 执行 `kubectl apply -f`。之后，为了启用网络策略，创建一个本地文件 `cluster-configuration.yaml`。 ```bash vi cluster-configuration.yaml ``` -2. Copy all the content in the file [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) and paste it to the local file just created. -3. In this local cluster-configuration.yaml file, navigate to `networkpolicy` and enable Network Policy by changing `false` to `true` for `enabled`. Save the file after you finish. +2. 将 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件中的所有内容复制到刚才创建的本地文件中。 + +3. 在这个本地 `cluster-configuration.yaml` 文件中，搜寻到 `networkpolicy`，并将 `enabled` 的 `false` 改为 `true`，启用它们。完成后保存文件。 ```bash networkpolicy: enabled: true # Change "false" to "true" ``` -4. Execute the following command to start installation: +4. 执行以下命令开始安装： ```bash kubectl apply -f cluster-configuration.yaml ``` -## Enable Network Policy after Installation +## 在安装后启用网络策略 -1. Log in the console as `admin`. Click **Platform** in the top-left corner and select **Clusters Management**. +1. 以 `admin` 身份登录控制台。点击左上角的**平台管理**，选择**集群管理**。 -![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) +![集群管理](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. +2. 点击 **自定义资源 CRD**，在搜索栏中输入 `clusterconfiguration`。点击结果查看其详细页面。 {{< notice info >}} -A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. +自定义资源定义（CRD）允许用户在不增加另一个 API 服务器的情况下创建一种新的资源类型。他们可以像其他任何本地 Kubernetes 对象一样使用这些资源。 {{}} -3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**. +3. 在**资源列表**中，点击 `ks-installer` 右边的三个点，选择**编辑 YAML**。 -![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) +![编辑 YAML](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) -4. In this yaml file, navigate to `networkpolicy` and change `false` to `true` for `enabled`. After you finish, click **Update** in the bottom-right corner to save the configuration. +4. 在这个 YAML 文件中，搜寻到 `networkpolicy`，将 `enabled` 的 `false` 改为 `true`。完成后，点击右下角的**更新**，保存配置。 ```bash networkpolicy: enabled: true # Change "false" to "true" ``` -5. You can use the web kubectl to check the installation process by executing the following command: +5. 您可以通过执行以下命令，使用 Web Kubectl 工具来检查安装过程： ```bash kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f @@ -108,12 +109,12 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app= {{< notice tip >}} -You can find the web kubectl tool by clicking the hammer icon in the bottom-right corner of the console. +您可以通过点击控制台右下角的锤子图标找到 Kubectl 工具。 {{}} -## Verify the Installation of Component +## 验证组件的安装 -If you can see **Network Policies** in **Network** as the image below, it means the installation succeeds as this part won't display until you install the component. +如果您能在**网络管理**中看到**网络策略**，如下图所示，说明安装成功，因为在安装组件之前，这部分不会显示。 -![networkpolicy](https://ap3.qingstor.com/kubesphere-website/docs/20200831162836.png) \ No newline at end of file +![networkpolicy](https://ap3.qingstor.com/kubesphere-website/docs/20200831162836.png) diff --git a/content/zh/docs/pluggable-components/overview.md b/content/zh/docs/pluggable-components/overview.md index cccdb3382..b0e659426 100644 --- a/content/zh/docs/pluggable-components/overview.md +++ b/content/zh/docs/pluggable-components/overview.md @@ -1,9 +1,9 @@ --- -title: "Overview" +title: "概览" keywords: "Kubernetes, KubeSphere, pluggable-components, overview" -description: "Overview of installing pluggable components." +description: "可插拔组件的安装概览" -linkTitle: "Overview" +linkTitle: "概览" weight: 3510 --- diff --git a/content/zh/docs/pluggable-components/service-mesh.md b/content/zh/docs/pluggable-components/service-mesh.md index 1abff4711..3ade1ed6f 100644 --- a/content/zh/docs/pluggable-components/service-mesh.md +++ b/content/zh/docs/pluggable-components/service-mesh.md @@ -1,25 +1,25 @@ --- -title: "KubeSphere Service Mesh" +title: "KubeSphere 服务网格" keywords: "Kubernetes, istio, KubeSphere, service-mesh, microservices" -description: "How to Enable KubeSphere Service Mesh" +description: "如何启用 KubeSphere 服务网格" -linkTitle: "KubeSphere Service Mesh" +linkTitle: "KubeSphere 服务网格" weight: 3540 --- -## What is KubeSphere Service Mesh +## 什么是 KubeSphere 服务网格 -On the basis of [Istio](https://istio.io/), KubeSphere Service Mesh visualizes microservices governance and traffic management. It features a powerful toolkit including **circuit breaking, blue-green deployment, canary release, traffic mirroring, distributed tracing, observability and traffic control**. Developers can easily get started with Service Mesh without any code hacking, with the learning curve of Istio greatly reduced. All features of KubeSphere Service Mesh are designed to meet users' demand for their business. +在 [Istio](https://istio.io/) 的基础上，KubeSphere 服务网格将微服务治理和流量管理可视化。它拥有强大的工具包，包括**断路、蓝绿部署、金丝雀发布、流量镜像、分布式跟踪、可观察性和流量控制**。开发者无需任何代码黑客，即可轻松上手服务网格，Istio 的学习曲线大大降低。KubeSphere 服务网格的所有功能都是为了满足用户的业务需求。 -For more information, see related sections in Project Administration and Usage. +更多信息请参见项目管理与使用中的相关章节。 -## Enable Service Mesh before Installation +## 在安装前启用服务网格 -### Installing on Linux +### 在 Linux 上安装 -When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. +当您在 Linux 上安装 KubeSphere 时，你需要创建一个配置文件，该文件列出了所有 KubeSphere 组件。 -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: +1. 基于[在 Linux 上安装 KubeSphere](.../.../installing-on-linux/introduction/multioverview/) 的教程，您创建了一个默认文件 **config-sample.yaml**。通过执行以下命令修改该文件： ```bash vi config-sample.yaml @@ -27,73 +27,74 @@ 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 Service Mesh in this mode (e.g. for testing purpose), refer to the following section to see how Service Mesh can be installed after installation. +如果采用 [All-in-one 安装](.../.../quick-start/all-in-one-on-linux/)，则不需要创建 `config-sample.yaml` 文件，因为可以直接创建集群。一般来说，All-in-one 模式是为那些刚刚接触 KubeSphere 并希望熟悉系统的用户准备的。如果您想在这个模式下启用服务网格（比如出于测试的目的），可以参考下面的部分，看看安装后如何启用服务网格。 {{}} -2. In this file, navigate to `servicemesh` and change `false` to `true` for `enabled`. Save the file after you finish. +2. 在该文件中，搜寻到 `servicemesh`，并将 `enabled` 的 `false` 改为 `true`。完成后保存文件。 ```bash servicemesh: enabled: true # Change "false" to "true" ``` -3. Create a cluster using the configuration file: +3. 使用配置文件创建一个集群： ```bash ./kk create cluster -f config-sample.yaml ``` -### **Installing on Kubernetes** +### 在 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 Service Mesh, do not use `kubectl apply -f` directly for this file. +在 Kubernetes 上安装 KubeSphere 时，需要下载文件 [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) 进行集群设置。如果要安装网络策略，不要直接使用 `kubectl apply -f` 对这个文件进行设置。 -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 Service Mesh, create a local file cluster-configuration.yaml. +1. 参照[在 Kubernetes 上安装 KubeSphere](.../.../installing-on-kubernetes/introduction/overview/) 的教程，先对文件 [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml) 执行 `kubectl apply -f`。之后，为了启用服务网格，创建一个本地文件 `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 `servicemesh` and enable Service Mesh by changing `false` to `true` for `enabled`. Save the file after you finish. +2. 将 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件中的所有内容复制到刚才创建的本地文件中。 + +3. 在这个本地 `cluster-configuration.yaml` 文件中，搜寻到 `servicemesh`，并将 `enabled` 的 `false` 改为 `true`，启用它们。完成后保存文件。 ```bash servicemesh: enabled: true # Change "false" to "true" ``` -4. Execute the following command to start installation: +4. 执行以下命令开始安装： ```bash kubectl apply -f cluster-configuration.yaml ``` -## Enable Service Mesh after Installation +## 在安装后启用服务网格 -1. Log in the console as `admin`. Click **Platform** in the top-left corner and select **Clusters Management**. +1. 以 `admin` 身份登录控制台。点击左上角的**平台管理**，选择**集群管理**。 -![clusters-management](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png) +![集群管理](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. +2. 点击 **自定义资源 CRD**，在搜索栏中输入 `clusterconfiguration`。点击结果查看其详细页面。 {{< notice info >}} -A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. +自定义资源定义（CRD）允许用户在不增加另一个 API 服务器的情况下创建一种新的资源类型。他们可以像其他任何本地 Kubernetes 对象一样使用这些资源。 {{}} -3. In **Resource List**, click the three dots on the right of `ks-installer` and select **Edit YAML**. +3. 在**资源列表**中，点击 `ks-installer` 右边的三个点，选择**编辑 YAML**。 -![edit-yaml](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) +![编辑 YAML](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png) -4. In this yaml file, navigate to `servicemesh` and change `false` to `true` for `enabled`. After you finish, click **Update** in the bottom-right corner to save the configuration. +4. 在这个 YAML 文件中，搜寻到 `servicemesh`，将 `enabled` 的 `false` 改为 `true`。完成后，点击右下角的**更新**，保存配置。 ```bash servicemesh: enabled: true # Change "false" to "true" ``` -5. You can use the web kubectl to check the installation process by executing the following command: +5. 您可以通过执行以下命令，使用 Web Kubectl 工具来检查安装过程： ```bash kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f @@ -101,31 +102,31 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app= {{< notice tip >}} -You can find the web kubectl tool by clicking the hammer icon in the bottom-right corner of the console. +您可以通过点击控制台右下角的锤子图标找到 Kubectl 工具。 {{}} -## Verify the Installation of Component +## 验证组件的安装 {{< tabs >}} -{{< tab "Verify the Component in Dashboard" >}} +{{< tab "在仪表板中验证组件的安装" >}} -Go to **Components** and check the status of Istio. You may see an image as follows: +进入**服务组件**，检查 Logging 的状态。你可能会看到如下图片： ![Istio](https://ap3.qingstor.com/kubesphere-website/docs/20200829130918.png) {{}} -{{< tab "Verify the Component through kubectl" >}} +{{< tab "通过 kubectl 验证组件的安装" >}} -Execute the following command to check the status of pods: +执行以下命令来检查 Pod 的状态： ```bash kubectl get pod -n istio-system ``` -The output may look as follows if the component runs successfully: +如果组件运行成功，输出结果可能如下： ```bash NAME READY STATUS RESTARTS AGE