Skip to content

Commit

Permalink
Update enable pluggable components docs.
Browse files Browse the repository at this point in the history
Signed-off-by: serenashe <[email protected]>
  • Loading branch information
serenashe authored and Felixnoo committed Nov 1, 2021
1 parent 03bf3f7 commit 53fa90d
Show file tree
Hide file tree
Showing 83 changed files with 170 additions and 218 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You need an account granted a role including the permission of **Cluster Managem

2. If you have enabled the [multi-cluster feature](../../../multicluster-management/) with Member clusters imported, you can select a specific cluster to view its nodes. If you have not enabled the feature, refer to the next step directly.

3. Navigate to **Cluster Nodes** under **Node Management**, where you can see existing nodes in the current cluster.
3. Navigate to **Cluster Nodes** under **Nodes**, where you can see existing nodes in the current cluster.

![Node Management](/images/docs/devops-user-guide/using-devops/set-ci-node-for-dependency-cache/set-node-1.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,6 @@ Before you use Istio-based features of KubeSphere, you have to delete `applicati

{{</ notice >}}

After your component is installed, go to the **Cluster Management** page, and you will see the interface below. You can check the status of your component in **Components**.
After your component is installed, go to the **Cluster Management** page, and you will see the interface below. You can check the status of your component in **System Components**.

![Full View of KubeSphere Console](/images/docs/huawei-cce/en/view-ks-console-full.png)
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ To make sure edge nodes can successfully talk to your cluster, you must forward

1. Log in to the console as `admin` and click **Platform** in the top-left corner.

2. Select **Cluster Management** and navigate to **Edge Nodes** under **Node Management**.
2. Select **Cluster Management** and navigate to **Edge Nodes** under **Nodes**.

{{< notice note >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ weight: 3620

Marking a node as unschedulable prevents the scheduler from placing new Pods onto that node while not affecting existing Pods on the node. This is useful as a preparatory step before a node reboot or other maintenance.

Log in to the console as `admin` and go to the **Cluster Management** page. To mark a node unschedulable, choose **Cluster Nodes** under **Node Management** from the left menu, find a node you want to remove from the cluster, and click **Cordon**. Alternatively, you can run the command `kubectl cordon $NODENAME` directly. See [Kubernetes Nodes](https://kubernetes.io/docs/concepts/architecture/nodes/) for more details.
Log in to the console as `admin` and go to the **Cluster Management** page. To mark a node unschedulable, choose **Cluster Nodes** under **Nodes** from the left menu, find a node you want to remove from the cluster, and click **Cordon**. Alternatively, you can run the command `kubectl cordon $NODENAME` directly. See [Kubernetes Nodes](https://kubernetes.io/docs/concepts/architecture/nodes/) for more details.

![cordon](/images/docs/installing-on-linux/add-and-delete-nodes/delete-nodes/cordon.png)

Expand Down
12 changes: 5 additions & 7 deletions content/en/docs/pluggable-components/alerting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ weight: 6600

Alerting is an important building block of observability, closely related to monitoring and logging. The alerting system in KubeSphere, coupled with the proactive failure notification system, allows users to know activities of interest based on alerting policies. When a predefined threshold of a certain metric is reached, an alert will be sent to preconfigured recipients. Therefore, you need to configure the notification method beforehand, including Email, Slack, DingTalk, WeCom and Webhook. 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.

## Enable Alerting before Installation
## Enable Alerting Before Installation

### Installing on Linux

Expand Down Expand Up @@ -62,9 +62,9 @@ As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introdu
kubectl apply -f cluster-configuration.yaml
```

## Enable Alerting after Installation
## Enable Alerting After Installation

1. Log in to the console as `admin`. Click **Platform** in the top-left corner and select **Cluster Management**.
1. Log in to the console as `admin`. Click **Platform** in the upper-left corner and select **Cluster Management**.

2. Click **CRDs** and enter `clusterconfiguration` in the search bar. Click the result to view its detail page.

Expand All @@ -74,7 +74,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource

3. In **Resource List**, click <img src="/images/docs/enable-pluggable-components/kubesphere-alerting/three-dots.png" height="20px"> on the right of `ks-installer` and select **Edit YAML**.

4. In this YAML file, navigate to `alerting` and change `false` to `true` for `enabled`. After you finish, click **Update** in the bottom-right corner to save the configuration.
4. In this YAML file, navigate to `alerting` and change `false` to `true` for `enabled`. After you finish, click **OK** in the lower-right corner to save the configuration.

```yaml
alerting:
Expand All @@ -89,14 +89,12 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource

{{< notice note >}}

You can find the web kubectl tool by clicking <img src="/images/docs/enable-pluggable-components/kubesphere-alerting/hammer.png" height="20px"> in the bottom-right corner of the console.
You can find the web kubectl tool by clicking <img src="/images/docs/enable-pluggable-components/kubesphere-alerting/hammer.png" height="20px"> in the lower-right corner of the console.
{{</ notice >}}

## Verify the Installation of the Component

If you can see **Alerting Messages** and **Alerting Policies** on the **Cluster Management** page, it means the installation is successful as the two parts won't display until the component is installed.
![alerting-section](/images/docs/enable-pluggable-components/kubesphere-alerting/alerting-section.png)
20 changes: 8 additions & 12 deletions content/en/docs/pluggable-components/app-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,9 @@ As an open-source and app-centric container platform, KubeSphere provides users

Internally, the 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 17 built-in apps in the App Store. After you enable this feature, you can add more apps with app templates.

![app-store](/images/docs/enable-pluggable-components/kubesphere-app-store/app-store.png)

For more information, see [App Store](../../application-store/).

## Enable the App Store before Installation
## Enable the App Store Before Installation

### Installing on Linux

Expand Down Expand Up @@ -70,9 +68,9 @@ As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introdu
kubectl apply -f cluster-configuration.yaml
```

## Enable the App Store after Installation
## Enable the App Store After Installation

1. Log in to the console as `admin`. Click **Platform** in the top-left corner and select **Cluster Management**.
1. Log in to the console as `admin`. Click **Platform** in the upper-left corner and select **Cluster Management**.

2. Click **CRDs** and enter `clusterconfiguration` in the search bar. Click the result to view its detail page.

Expand All @@ -84,7 +82,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource

3. In **Resource List**, click <img src="/images/docs/enable-pluggable-components/kubesphere-app-store/three-dots.png" height="20px"> on the right of `ks-installer` and select **Edit YAML**.

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. In this YAML file, navigate to `openpitrix` and change `false` to `true` for `enabled`. After you finish, click **OK** in the lower-right corner to save the configuration.

```yaml
openpitrix:
Expand All @@ -100,25 +98,23 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource

{{< notice note >}}

You can find the web kubectl tool by clicking <img src="/images/docs/enable-pluggable-components/kubesphere-app-store/hammer.png" height="20px"> in the bottom-right corner of the console.
You can find the web kubectl tool by clicking <img src="/images/docs/enable-pluggable-components/kubesphere-app-store/hammer.png" height="20px"> in the lower-right corner of the console.

{{</ notice >}}

## Verify the Installation of the Component

After you log in to the console, if you can see **App Store** in the top-left corner and 17 built-in apps in it, it means the installation is successful.

![app-store](/images/docs/enable-pluggable-components/kubesphere-app-store/app-store.png)
After you log in to the console, if you can see **App Store** in the upper-left corner and 17 built-in apps in it, it means the installation is successful.

{{< notice note >}}

- You can even access the App Store without logging in to the console by visiting `<NodeIP>:30880/apps`.
- Different from previous versions, the **OpenPitrix** tab in KubeSphere 3.1 does not appear on the **Components** page after the App Store is enabled.
- The **OpenPitrix** tab in KubeSphere 3.2 does not appear on the **System Components** page after the App Store is enabled.

{{</ notice >}}

## Use the App Store in a Multi-cluster Architecture

[In a multi-cluster architecture](../../multicluster-management/introduction/kubefed-in-kubesphere/), you have one Host Cluster (H Cluster) managing all Member Clusters (M Clusters). Different from other components in KubeSphere, the App Store serves as a global application pool for all clusters, including H Cluster and M Clusters. You only need to enable the App Store on the H Cluster and you can use functions related to the App Store on M Clusters directly (no matter whether the App Store is enabled on M Clusters or not), such as [app templates](../../project-user-guide/application/app-template/) and [app repositories](../../workspace-administration/app-repository/import-helm-repository/).
[In a multi-cluster architecture](../../multicluster-management/introduction/kubefed-in-kubesphere/), you have one Host Cluster (H Cluster) managing all Member Clusters (M Clusters). Different from other components in KubeSphere, the App Store serves as a global application pool for all clusters, including H Cluster and M Clusters. You only need to enable the App Store on the H Cluster and you can use functions related to the App Store on M Clusters directly (no matter whether the App Store is enabled on M Clusters or not), such as [App Templates](../../project-user-guide/application/app-template/) and [App Repositories](../../workspace-administration/app-repository/import-helm-repository/).

However, if you only enable the App Store on M Clusters without enabling it on the H Cluster, you will not be able to use the App Store on any cluster in the multi-cluster architecture.
14 changes: 6 additions & 8 deletions content/en/docs/pluggable-components/auditing-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The KubeSphere Auditing Log System provides a security-relevant chronological se

For more information, see [Auditing Log Query](../../toolbox/auditing/auditing-query/).

## Enable Auditing Logs before Installation
## Enable Auditing Logs Before Installation

### Installing on Linux

Expand Down Expand Up @@ -96,9 +96,9 @@ By default, ks-installer will install Elasticsearch internally if Auditing is en
kubectl apply -f cluster-configuration.yaml
```

## Enable Auditing Logs after Installation
## Enable Auditing Logs After Installation

1. Log in to the console as `admin`. Click **Platform** in the top-left corner and select **Cluster Management**.
1. Log in to the console as `admin`. Click **Platform** in the upper-left corner and select **Cluster Management**.

2. Click **CRDs** and enter `clusterconfiguration` in the search bar. Click the result to view its detail page.

Expand All @@ -108,7 +108,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource

3. In **Resource List**, click <img src="/images/docs/enable-pluggable-components/kubesphere-auditing-logs/three-dots.png" height="20px"> on the right of `ks-installer` and select **Edit YAML**.

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. In this YAML file, navigate to `auditing` and change `false` to `true` for `enabled`. After you finish, click **OK** in the lower-right corner to save the configuration.

```yaml
auditing:
Expand Down Expand Up @@ -139,7 +139,7 @@ By default, Elasticsearch will be installed internally if Auditing is enabled. F

{{< notice note >}}

You can find the web kubectl tool by clicking <img src="/images/docs/enable-pluggable-components/kubesphere-auditing-logs/hammer.png" height="20px"> in the bottom-right corner of the console.
You can find the web kubectl tool by clicking <img src="/images/docs/enable-pluggable-components/kubesphere-auditing-logs/hammer.png" height="20px"> in the lower-right corner of the console.
{{</ notice >}}

## Verify the Installation of the Component
Expand All @@ -148,9 +148,7 @@ You can find the web kubectl tool by clicking <img src="/images/docs/enable-plug

{{< tab "Verify the component on the dashboard" >}}

Verify that you can use the **Auditing Operating** function from the **Toolbox** in the bottom-right corner.

![auditing-operating](/images/docs/enable-pluggable-components/kubesphere-auditing-logs/auditing-operating.png)
Verify that you can use the **Auditing Operating** function from the **Toolbox** in the lower-right corner.

{{</ tab >}}

Expand Down
14 changes: 6 additions & 8 deletions content/en/docs/pluggable-components/devops.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The DevOps System offers an enabling environment for users as apps can be automa

For more information, see [DevOps User Guide](../../devops-user-guide/).

## Enable DevOps before Installation
## Enable DevOps Before Installation

### Installing on Linux

Expand Down Expand Up @@ -66,9 +66,9 @@ As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introdu
kubectl apply -f cluster-configuration.yaml
```

## Enable DevOps after Installation
## Enable DevOps After Installation

1. Log in to the console as `admin`. Click **Platform** in the top-left corner and select **Cluster Management**.
1. Log in to the console as `admin`. Click **Platform** in the upper-left corner and select **Cluster Management**.

2. Click **CRDs** and enter `clusterconfiguration` in the search bar. Click the result to view its detail page.

Expand All @@ -80,7 +80,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource

3. In **Resource List**, click <img src="/images/docs/enable-pluggable-components/kubesphere-devops-system/three-dots.png" height="20px"> on the right of `ks-installer` and select **Edit YAML**.

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. In this YAML file, navigate to `devops` and change `false` to `true` for `enabled`. After you finish, click **OK** in the lower-right corner to save the configuration.

```yaml
devops:
Expand All @@ -95,7 +95,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource

{{< notice note >}}

You can find the web kubectl tool by clicking <img src="/images/docs/enable-pluggable-components/kubesphere-devops-system/hammer.png" height="20px"> in the bottom-right corner of the console.
You can find the web kubectl tool by clicking <img src="/images/docs/enable-pluggable-components/kubesphere-devops-system/hammer.png" height="20px"> in the lower-right corner of the console.

{{</ notice >}}

Expand All @@ -105,9 +105,7 @@ You can find the web kubectl tool by clicking <img src="/images/docs/enable-plug

{{< tab "Verify the component on the dashboard" >}}

Go to **Components** and check the status of **DevOps**. You may see an image as follows:

![devops](/images/docs/enable-pluggable-components/kubesphere-devops-system/devops.png)
Go to **System Components** and check that all components on the **DevOps** tab page is in **Healthy** state.

{{</ tab >}}

Expand Down
16 changes: 7 additions & 9 deletions content/en/docs/pluggable-components/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ linkTitle: "KubeSphere Events"
weight: 6500
---

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 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.

For more information, see [Event Query](../../toolbox/events-query/).

## Enable Events before Installation
## Enable Events Before Installation

### Installing on Linux

Expand Down Expand Up @@ -98,9 +98,9 @@ By default, ks-installer will install Elasticsearch internally if Events is enab
kubectl apply -f cluster-configuration.yaml
```

## Enable Events after Installation
## Enable Events After Installation

1. Log in to the console as `admin`. Click **Platform** in the top-left corner and select **Cluster Management**.
1. Log in to the console as `admin`. Click **Platform** in the upper-left corner and select **Cluster Management**.

2. Click **CRDs** and enter `clusterconfiguration` in the search bar. Click the result to view its detail page.

Expand All @@ -112,7 +112,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource

3. In **Resource List**, click <img src="/images/docs/enable-pluggable-components/kubesphere-events/three-dots.png" height="20px"> on the right of `ks-installer` and select **Edit YAML**.

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. In this YAML file, navigate to `events` and change `false` to `true` for `enabled`. After you finish, click **OK** in the lower-right corner to save the configuration.

```yaml
events:
Expand Down Expand Up @@ -144,7 +144,7 @@ By default, Elasticsearch will be installed internally if Events is enabled. For

{{< notice note >}}

You can find the web kubectl tool by clicking <img src="/images/docs/enable-pluggable-components/kubesphere-events/hammer.png" height="20px"> in the bottom-right corner of the console.
You can find the web kubectl tool by clicking <img src="/images/docs/enable-pluggable-components/kubesphere-events/hammer.png" height="20px"> in the lower-right corner of the console.

{{</ notice >}}

Expand All @@ -154,9 +154,7 @@ You can find the web kubectl tool by clicking <img src="/images/docs/enable-plug

{{< tab "Verify the component on the dashboard" >}}

Verify that you can use the **Event Search** function from the **Toolbox** in the bottom-right corner.

![event-search](/images/docs/enable-pluggable-components/kubesphere-events/event-search.png)
Verify that you can use the **Event Search** function from the **Toolbox** in the lower-right corner.

{{</ tab >}}

Expand Down
Loading

0 comments on commit 53fa90d

Please sign in to comment.