Refactor doc faq section

Signed-off-by: Sherlock113 <sherlockxu@yunify.com>
This commit is contained in:
Sherlock113 2020-12-23 12:09:36 +08:00
parent 29d7160743
commit d78c9d8a55
22 changed files with 73 additions and 94 deletions

View File

@ -0,0 +1,6 @@
---
title: "Access Control and Account Management"
keywords: 'Kubernetes, KubeSphere, account, access control'
description: 'Faq about access control and account management'
weight: 16400
---

View File

@ -0,0 +1,27 @@
---
title: "Reset the Account Password"
keywords: "Forgot, Password, KubeSphere, Kubernetes"
description: "How to reset the password if you forgot it."
linkTitle: "Reset the Account Password"
Weight: 16410
---
## Reset the Password of a Regular User
The administrator who has the permission to manage users can change an account password. On the **Accounts** page, click the account of which you need to change the password. On the detail page, select **Change Password** from the **More** drop-down list.
![modify-password](/images/docs/faq/forgot-password/modify-password.png)
### Reset the Administrator Password
Execute the following command on the host cluster to change the password of any account.
```bash
kubectl patch users <USERNAME> -p '{"spec":{"password":"<YOURPASSWORD>"}}' --type='merge' && kubectl annotate users <USERNAME> iam.kubesphere.io/password-encrypted-
```
{{< notice note >}}
Make sure you replace `<USERNAME>` and `<YOURPASSWORD>` with the account and the new password in the command before you run it.
{{</ notice >}}

View File

@ -0,0 +1,6 @@
---
title: "KubeSphere Web Console"
keywords: 'Kubernetes, KubeSphere, web console'
description: 'Faq about the KubeSphere web console'
weight: 16500
---

View File

@ -1,9 +1,9 @@
---
title: "Questions about KubeSphere Console"
title: "Supported Browsers"
keywords: "FAQ, console, KubeSphere, Kubernetes"
description: "FAQ is designed to answer and summarize the questions our users most frequently ask about KubeSphere Console."
Weight: 16200
linkTitle: "Supported Browsers"
Weight: 16510
---
**What kind of browsers does KubeSphere support?**

View File

@ -3,7 +3,7 @@ title: "Edit System Resources on the Console"
keywords: "system, resources, KubeSphere, Kubernetes"
description: "How to edit system resources on the console."
linkTitle: 'Edit System Resources on the Console'
Weight: 16300
Weight: 16520
---
When you install KubeSphere, the workspace `system-workspace` is created where all KubeSphere system projects and Kubernetes system projects run. To avoid any misoperation on both systems, you are not allowed to edit resources in the workspace directly on the console. However, you can still make adjustments to resources using `kubectl`.

View File

@ -1,25 +0,0 @@
---
title: "Forgot Password"
keywords: "Forgot, Password, KubeSphere, Kubernetes"
description: "How to reset the password if you forgot it."
Weight: 16500
---
## I forgot my password. How do I reset it?
### Forgot the password of a regular user
The administrator(who has the rights to manage users) can change a user password if required by simply using the "Change Password" action for a user.
![modify-password](/images/docs/faq/forgot-password/modify-password.png)
### Forgot the unique administrator password
Execute the following command on the host cluster.
```bash
kubectl patch users <USERNAME> -p '{"spec":{"password":"<YOURPASSWORD>"}}' --type='merge' && kubectl annotate users <USERNAME> iam.kubesphere.io/password-encrypted-
```
Please don't forget to replace the `<USERNAME>` and `<YOURPASSWORD>`.

View File

@ -0,0 +1,6 @@
---
title: "Installation"
keywords: 'Kubernetes, KubeSphere, installation, FAQ'
description: 'Faq about installation'
weight: 16100
---

View File

@ -3,7 +3,7 @@ title: "Configure a Booster for Installation"
keywords: 'KubeSphere, booster, installation, faq'
description: 'How to configure a booster for installation'
linkTitle: "Configure a Booster for Installation"
weight: 3610
weight: 16200
---
If you have trouble downloading images from `dockerhub.io`, it is highly recommended that you configure a registry mirror (i.e. booster) beforehand to speed up downloads. You can refer to the [official documentation of Docker](https://docs.docker.com/registry/recipes/mirror/#configure-the-docker-daemon) or follow the steps below.

View File

@ -2,8 +2,8 @@
title: "Telemetry in KubeSphere"
keywords: "Installer, Telemetry, KubeSphere, Kubernetes"
description: "Telemetry collects aggregate information of KubeSphere installation."
Weight: 16400
linkTitle: "Telemetry in KubeSphere"
Weight: 16300
---
Telemetry collects aggregate information about the size of KubeSphere clusters installed, KubeSphere and Kubernetes versions, components enabled, cluster running time, error logs, etc. KubeSphere promises that the information is only used by the KubeSphere community to improve products and will not be shared with any third parties.

View File

@ -0,0 +1,6 @@
---
title: "Observability"
keywords: 'Kubernetes, KubeSphere, observability, FAQ'
description: 'Faq about observability'
weight: 16300
---

View File

@ -1,9 +1,9 @@
---
title: "Bring your own Prometheus"
title: "Bring Your Own Prometheus"
keywords: "Monitoring, Prometheus, node-exporter, kube-state-metrics, KubeSphere, Kubernetes"
description: "Use your own Prometheus stack for KubeSphere monitoring"
Weight: 16100
linkTitle: "Bring Your Own Prometheus"
Weight: 16330
---
KubeSphere comes with several pre-installed customized monitoring components including Prometheus Operator, Prometheus, Alertmanager, Grafana (Optional), various service monitors, node-exporter, kube-state-metrics. These components might already exist before you install KubeSphere, it's possible to use your own Prometheus stack setup in KubeSphere v3.0.0 .

View File

@ -3,7 +3,7 @@ title: "Logging"
keywords: "Kubernetes, Elasticsearch, KubeSphere, Logging, logs"
description: "FAQ about logging"
linkTitle: "Logging"
weight: 6920
weight: 16310
---
This page contains some of the frequently asked questions about logging.

View File

@ -3,7 +3,7 @@ title: "Monitoring"
keywords: "Kubernetes, Prometheus, KubeSphere, Monitoring"
description: "FAQ about monitoring"
linkTitle: "Monitoring"
weight: 6930
weight: 16320
---
This page contains some of the frequently asked questions about monitoring.

View File

@ -0,0 +1,6 @@
---
title: "Upgrade"
keywords: 'Kubernetes, KubeSphere, upgrade, FAQ'
description: 'Faq about upgrade'
weight: 16200
---

View File

@ -1,10 +1,9 @@
---
title: "FAQ"
title: "Upgrade Qingcloud CSI"
keywords: "Kubernetes, upgrade, KubeSphere, v3.0.0"
description: "KubeSphere Upgrade FAQ"
linkTitle: "FAQ"
weight: 7700
description: "Upgrade Qingcloud CSI"
linkTitle: "Upgrade Qingcloud CSI"
weight: 16210
---
## How to upgrade Qingcloud CSI after upgrading?

View File

@ -1,7 +0,0 @@
---
linkTitle: "FAQ"
weight: 4500
_build:
render: false
---

View File

@ -1,10 +0,0 @@
---
title: "FAQ"
keywords: 'kubernetes, kubesphere, faq'
description: 'FAQ'
weight: 4510
---
TBD

View File

@ -71,12 +71,6 @@ Cordon a node and even delete a node to scale in your cluster.
Remove KubeSphere and Kubernetes from your machines.
## FAQ
### [Configure Booster for Installation](../installing-on-linux/faq/configure-booster/)
Set a registry mirror to speed up image downloads during installation.
## Most Popular Pages
Below you will find some of the most viewed and helpful pages in this chapter. It is highly recommended that you refer to them first.

View File

@ -1,8 +0,0 @@
---
title: "FAQ"
keywords: 'kubernetes, kubesphere, uninstalling, remove-cluster'
description: 'How to uninstall KubeSphere'
weight: 3600
---

View File

@ -47,13 +47,3 @@ Learn how to enable the Service Mesh to use different traffic management strateg
## [Network Policies](../pluggable-components/network-policy/)
Learn how to enable Network Policies to control traffic flow at the IP address or port level.
## FAQ
### [Logging](../pluggable-components/faq/logging/)
Questions asked frequently about the logging functionality.
### [Monitoring](../pluggable-components/faq/monitoring/)
Questions asked frequently about the monitoring functionality.

View File

@ -1,7 +0,0 @@
---
linkTitle: "FAQ"
weight: 6910
_build:
render: false
---

View File

@ -36,7 +36,3 @@ Follow steps to use ks-installer and Offline-package to upgrade KubeSphere.
## [Changes after Upgrade](../upgrade/what-changed/)
Understand what will be changed after the upgrade.
## [FAQ](../upgrade/upgrade-faq/)
Find the answers to some of the most asked questions of upgrading.