diff --git a/docs/user_docs/handle-an-exception/_category_.yml b/docs/user_docs/handle-an-exception/_category_.yml index b7b8fb29532..93f382986c8 100644 --- a/docs/user_docs/handle-an-exception/_category_.yml +++ b/docs/user_docs/handle-an-exception/_category_.yml @@ -1,4 +1,4 @@ -position: 9 +position: 10 label: Handle an Exception collapsible: true collapsed: true \ No newline at end of file diff --git a/docs/user_docs/kubeblocks-for-elasticsearch/_category_.yml b/docs/user_docs/kubeblocks-for-elasticsearch/_category_.yml index 0235a4159c8..0d135e18ae7 100644 --- a/docs/user_docs/kubeblocks-for-elasticsearch/_category_.yml +++ b/docs/user_docs/kubeblocks-for-elasticsearch/_category_.yml @@ -1,4 +1,4 @@ -position: 18 +position: 20 label: KubeBlocks for Elasticsearch collapsible: true collapsed: true diff --git a/docs/user_docs/kubeblocks-for-kafka/_category_.yml b/docs/user_docs/kubeblocks-for-kafka/_category_.yml index ccd012f54d7..94a7654f9c1 100644 --- a/docs/user_docs/kubeblocks-for-kafka/_category_.yml +++ b/docs/user_docs/kubeblocks-for-kafka/_category_.yml @@ -1,4 +1,4 @@ -position: 16 +position: 17 label: KubeBlocks for Kafka collapsible: true collapsed: true \ No newline at end of file diff --git a/docs/user_docs/kubeblocks-for-milvus/_category_.yml b/docs/user_docs/kubeblocks-for-milvus/_category_.yml index 6e19433e25d..87a3ba9ad9a 100644 --- a/docs/user_docs/kubeblocks-for-milvus/_category_.yml +++ b/docs/user_docs/kubeblocks-for-milvus/_category_.yml @@ -1,4 +1,4 @@ -position: 15 +position: 16 label: KubeBlocks for Milvus collapsible: true collapsed: true diff --git a/docs/user_docs/kubeblocks-for-mongodb/_category_.yml b/docs/user_docs/kubeblocks-for-mongodb/_category_.yml index 619b06449d0..ec7987f10c6 100644 --- a/docs/user_docs/kubeblocks-for-mongodb/_category_.yml +++ b/docs/user_docs/kubeblocks-for-mongodb/_category_.yml @@ -1,4 +1,4 @@ -position: 13 +position: 14 label: KubeBlocks for MongoDB collapsible: true collapsed: true diff --git a/docs/user_docs/kubeblocks-for-mysql-community-edition/_category_.yml b/docs/user_docs/kubeblocks-for-mysql-community-edition/_category_.yml index 61d55211722..7184c4a038f 100644 --- a/docs/user_docs/kubeblocks-for-mysql-community-edition/_category_.yml +++ b/docs/user_docs/kubeblocks-for-mysql-community-edition/_category_.yml @@ -1,4 +1,4 @@ -position: 11 +position: 12 label: KubeBlocks for MySQL Community Edition collapsible: true collapsed: true \ No newline at end of file diff --git a/docs/user_docs/kubeblocks-for-postgresql/_category_.yml b/docs/user_docs/kubeblocks-for-postgresql/_category_.yml index ba26848cd39..8388c37559f 100644 --- a/docs/user_docs/kubeblocks-for-postgresql/_category_.yml +++ b/docs/user_docs/kubeblocks-for-postgresql/_category_.yml @@ -1,4 +1,4 @@ -position: 12 +position: 13 label: KubeBlocks for PostgreSQL collapsible: true collapsed: true diff --git a/docs/user_docs/kubeblocks-for-pulsar/_category_.yml b/docs/user_docs/kubeblocks-for-pulsar/_category_.yml index f5f5afdeff9..7dc386e2fd9 100644 --- a/docs/user_docs/kubeblocks-for-pulsar/_category_.yml +++ b/docs/user_docs/kubeblocks-for-pulsar/_category_.yml @@ -1,4 +1,4 @@ -position: 16 +position: 18 label: KubeBlocks for Pulsar collapsible: true collapsed: true \ No newline at end of file diff --git a/docs/user_docs/kubeblocks-for-qdrant/_category_.yml b/docs/user_docs/kubeblocks-for-qdrant/_category_.yml index 294c5e3676a..54c51e27581 100644 --- a/docs/user_docs/kubeblocks-for-qdrant/_category_.yml +++ b/docs/user_docs/kubeblocks-for-qdrant/_category_.yml @@ -1,4 +1,4 @@ -position: 16 +position: 19 label: KubeBlocks for Qdrant collapsible: true collapsed: true diff --git a/docs/user_docs/kubeblocks-for-rabbitmq/_category_.yml b/docs/user_docs/kubeblocks-for-rabbitmq/_category_.yml index 4cb5c8130e4..8189b4a6005 100644 --- a/docs/user_docs/kubeblocks-for-rabbitmq/_category_.yml +++ b/docs/user_docs/kubeblocks-for-rabbitmq/_category_.yml @@ -1,4 +1,4 @@ -position: 21 +position: 22 label: KubeBlocks for RabbitMQ collapsible: true collapsed: true \ No newline at end of file diff --git a/docs/user_docs/kubeblocks-for-redis/_category_.yml b/docs/user_docs/kubeblocks-for-redis/_category_.yml index dd283f8e27a..7fb27f09fb1 100644 --- a/docs/user_docs/kubeblocks-for-redis/_category_.yml +++ b/docs/user_docs/kubeblocks-for-redis/_category_.yml @@ -1,4 +1,4 @@ -position: 14 +position: 15 label: KubeBlocks for Redis collapsible: true collapsed: true \ No newline at end of file diff --git a/docs/user_docs/kubeblocks-for-starrocks/_category_.yml b/docs/user_docs/kubeblocks-for-starrocks/_category_.yml index d42d61c5e57..557e6f62bd8 100644 --- a/docs/user_docs/kubeblocks-for-starrocks/_category_.yml +++ b/docs/user_docs/kubeblocks-for-starrocks/_category_.yml @@ -1,4 +1,4 @@ -position: 20 +position: 21 label: KubeBlocks for StarRocks collapsible: true collapsed: true \ No newline at end of file diff --git a/docs/user_docs/maintenance/_category_.yaml b/docs/user_docs/maintenance/_category_.yaml index ea167bed4ae..c230a0fa4b7 100644 --- a/docs/user_docs/maintenance/_category_.yaml +++ b/docs/user_docs/maintenance/_category_.yaml @@ -1,4 +1,4 @@ -position: 5 +position: 7 label: Maintenance collapsible: true collapsed: true diff --git a/docs/user_docs/instance-template/_category_.yml b/docs/user_docs/maintenance/instance-template/_category_.yml similarity index 100% rename from docs/user_docs/instance-template/_category_.yml rename to docs/user_docs/maintenance/instance-template/_category_.yml diff --git a/docs/user_docs/instance-template/how-to-use-instance-template.md b/docs/user_docs/maintenance/instance-template/how-to-use-instance-template.md similarity index 100% rename from docs/user_docs/instance-template/how-to-use-instance-template.md rename to docs/user_docs/maintenance/instance-template/how-to-use-instance-template.md diff --git a/docs/user_docs/instance-template/introduction.md b/docs/user_docs/maintenance/instance-template/introduction.md similarity index 100% rename from docs/user_docs/instance-template/introduction.md rename to docs/user_docs/maintenance/instance-template/introduction.md diff --git a/docs/user_docs/observability/_category_.yml b/docs/user_docs/observability/_category_.yml index 9ee0b89b361..8ca18aa4faf 100644 --- a/docs/user_docs/observability/_category_.yml +++ b/docs/user_docs/observability/_category_.yml @@ -1,4 +1,4 @@ -position: 6 +position: 8 label: Observability collapsible: true collapsed: true \ No newline at end of file diff --git a/docs/user_docs/observability/monitor-database.md b/docs/user_docs/observability/monitor-database.md index 718d9b1db4e..b587ef05809 100644 --- a/docs/user_docs/observability/monitor-database.md +++ b/docs/user_docs/observability/monitor-database.md @@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem'; This tutorial demonstrates how to configure the monitoring function for a PostgreSQL cluster, using Prometheus and Grafana. -## Step 1. Install the Prometheus Operator and Grafana +## Step 1. Install Prometheus Operator and Grafana Install the Promethus Operator and Grafana to monitor the performance of a database. Skip this step if a Prometheus Operator is already installed in your environment. @@ -44,31 +44,31 @@ Install the Promethus Operator and Grafana to monitor the performance of a datab 1. Check the service endpoints of Prometheus and Grafana. - ```bash - kubectl get svc -n monitoring - ``` + ```bash + kubectl get svc -n monitoring + ``` 2. Use port forwarding to access the Prometheus dashboard locally. - ```bash - kubectl port-forward svc/prometheus-operator-kube-p-prometheus -n monitoring 9090:9090 - ``` + ```bash + kubectl port-forward svc/prometheus-operator-kube-p-prometheus -n monitoring 9090:9090 + ``` - You can also access the Prometheus dashboard by opening "http://localhost:9090" in your browser. + You can also access the Prometheus dashboard by opening "http://localhost:9090" in your browser. 3. Retrieve the Grafana's login credential from the secret. - ```bash - kubectl get secrets prometheus-operator-grafana -n monitoring -o yaml - ``` + ```bash + kubectl get secrets prometheus-operator-grafana -n monitoring -o yaml + ``` 4. Use port forwarding to access the Grafana dashboard locally. - ```bash - kubectl port-forward svc/prometheus-operator-grafana -n monitoring 3000:80 - ``` + ```bash + kubectl port-forward svc/prometheus-operator-grafana -n monitoring 3000:80 + ``` - You can also access the Grafana dashboard by opening "http://localhost:3000" in your browser. + You can also access the Grafana dashboard by opening "http://localhost:3000" in your browser. 6. Configure the selectors for PodMonitor and ServiceMonitor to match your monitoring requirements. @@ -287,7 +287,7 @@ When the cluster is running, each Pod should have a sidecar container, named `ex There is a pre-configured dashboard for PostgreSQL under the `APPS / PostgreSQL` folder in the Grafana dashboard. And more dashboards can be found in the [Grafana dashboard store](https://grafana.com/grafana/dashboards/). -::::note +:::note Make sure the labels (such as the values of path and port in endpoint) are set correctly in the `PodMonitor` file to match your dashboard. diff --git a/docs/user_docs/user-management/_category_.yml b/docs/user_docs/user-management/_category_.yml index dee64c79165..7a15357336a 100644 --- a/docs/user_docs/user-management/_category_.yml +++ b/docs/user_docs/user-management/_category_.yml @@ -1,4 +1,4 @@ -position: 7 +position: 9 label: User Management collapsible: true collapsed: true \ No newline at end of file diff --git a/i18n/zh-cn/user-docs/connect-databases/_category_.yml b/i18n/zh-cn/user-docs/connect-databases/_category_.yml index 6d46a1fc9f5..5eab895a53a 100644 --- a/i18n/zh-cn/user-docs/connect-databases/_category_.yml +++ b/i18n/zh-cn/user-docs/connect-databases/_category_.yml @@ -1,4 +1,4 @@ -position: 4 +position: 6 label: 连接数据库 collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/handle-an-exception/_category_.yml b/i18n/zh-cn/user-docs/handle-an-exception/_category_.yml index 084f3749ee5..066d53f5556 100644 --- a/i18n/zh-cn/user-docs/handle-an-exception/_category_.yml +++ b/i18n/zh-cn/user-docs/handle-an-exception/_category_.yml @@ -1,4 +1,4 @@ -position: 9 +position: 10 label: 故障处理 collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/_category_.yml index e82a5529363..578f44d5031 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-apecloud-mysql/_category_.yml @@ -1,4 +1,4 @@ -position: 10 +position: 11 label: 用 KubeBlocks 管理 ApeCloud MySQL collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-elasticsearch/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-elasticsearch/_category_.yml index cf84488a188..0040676e19f 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-elasticsearch/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-elasticsearch/_category_.yml @@ -1,4 +1,4 @@ -position: 18 +position: 20 label: 用 KubeBlocks 管理 Elasticsearch collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-kafka/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-kafka/_category_.yml index 6e9a3fed0aa..2ec90d95dbc 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-kafka/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-kafka/_category_.yml @@ -1,4 +1,4 @@ -position: 15 +position: 17 label: 用 KubeBlocks 管理 Kafka collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-milvus/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-milvus/_category_.yml index 0fcdf4d0196..41920587f0d 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-milvus/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-milvus/_category_.yml @@ -1,4 +1,4 @@ -position: 17 +position: 16 label: 用 KubeBlocks 管理 Milvus collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-mongodb/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-mongodb/_category_.yml index afd96813a90..711ebd5d912 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-mongodb/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-mongodb/_category_.yml @@ -1,4 +1,4 @@ -position: 13 +position: 14 label: 用 KubeBlocks 管理 MongoDB collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/_category_.yml index a0c8e129e62..338008c6013 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-mysql-community-edition/_category_.yml @@ -1,4 +1,4 @@ -position: 11 +position: 12 label: 用 KubeBlocks 管理 MySQL 社区版 collapsible: true collapsed: true \ No newline at end of file diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/_category_.yml index 8c30679c877..59c1bf0311e 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-postgresql/_category_.yml @@ -1,4 +1,4 @@ -position: 11 +position: 13 label: 用 KubeBlocks 管理 PostgreSQL collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-pulsar/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-pulsar/_category_.yml index a0a18fa3184..66a7a8b2522 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-pulsar/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-pulsar/_category_.yml @@ -1,4 +1,4 @@ -position: 16 +position: 18 label: 用 KubeBlocks 管理 Pulsar collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-qdrant/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-qdrant/_category_.yml index 31018b762de..ab9fdc3d6ea 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-qdrant/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-qdrant/_category_.yml @@ -1,4 +1,4 @@ -position: 14 +position: 19 label: 用 KubeBlocks 管理 Qdrant collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-rabbitmq/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-rabbitmq/_category_.yml index 4cb5c8130e4..1a274c7afcd 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-rabbitmq/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-rabbitmq/_category_.yml @@ -1,4 +1,4 @@ -position: 21 -label: KubeBlocks for RabbitMQ +position: 22 +label: 用 KubeBlocks 管理 RabbitMQ collapsible: true collapsed: true \ No newline at end of file diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-redis/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-redis/_category_.yml index f0e0cab66b7..ac3f5e184a1 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-redis/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-redis/_category_.yml @@ -1,4 +1,4 @@ -position: 14 +position: 15 label: 用 KubeBlocks 管理 Redis collapsible: true collapsed: true \ No newline at end of file diff --git a/i18n/zh-cn/user-docs/kubeblocks-for-starrocks/_category_.yml b/i18n/zh-cn/user-docs/kubeblocks-for-starrocks/_category_.yml index d4b90fe5ffc..7a7819cab46 100644 --- a/i18n/zh-cn/user-docs/kubeblocks-for-starrocks/_category_.yml +++ b/i18n/zh-cn/user-docs/kubeblocks-for-starrocks/_category_.yml @@ -1,4 +1,4 @@ -position: 20 +position: 21 label: 用 KubeBlocks 管理 StarRocks collapsible: true collapsed: true \ No newline at end of file diff --git a/i18n/zh-cn/user-docs/maintenance/_category_.yml b/i18n/zh-cn/user-docs/maintenance/_category_.yml index 1e2f103c4bc..c4a1a27178b 100644 --- a/i18n/zh-cn/user-docs/maintenance/_category_.yml +++ b/i18n/zh-cn/user-docs/maintenance/_category_.yml @@ -1,4 +1,4 @@ -position: 5 +position: 7 label: 集群维护 collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/observability/_category_.yml b/i18n/zh-cn/user-docs/observability/_category_.yml index eb5ceed40ba..7435e2e3f34 100644 --- a/i18n/zh-cn/user-docs/observability/_category_.yml +++ b/i18n/zh-cn/user-docs/observability/_category_.yml @@ -1,4 +1,4 @@ -position: 6 +position: 8 label: 可观测性 collapsible: true collapsed: true diff --git a/i18n/zh-cn/user-docs/observability/monitor-database.md b/i18n/zh-cn/user-docs/observability/monitor-database.md index 00c3b3f984f..b1db27cc57b 100644 --- a/i18n/zh-cn/user-docs/observability/monitor-database.md +++ b/i18n/zh-cn/user-docs/observability/monitor-database.md @@ -44,31 +44,31 @@ import TabItem from '@theme/TabItem'; 1. 查看 Prometheus 和 Grafana 的服务端口。 - ```bash - kubectl get svc -n monitoring - ``` + ```bash + kubectl get svc -n monitoring + ``` 2. 使用 port forward 从本地连接 Prometheus 大盘。 - ```bash - kubectl port-forward svc/prometheus-operator-kube-p-prometheus -n monitoring 9090:9090 - ``` + ```bash + kubectl port-forward svc/prometheus-operator-kube-p-prometheus -n monitoring 9090:9090 + ``` - 您也可通过在浏览器中打开 "http://localhost:9090" 地址,连接 Prometheus 大盘。 + 您也可通过在浏览器中打开 "http://localhost:9090" 地址,连接 Prometheus 大盘。 3. 从 secret 中获取 Grafana 的连接凭证。 - ```bash - kubectl get secrets prometheus-operator-grafana -n monitoring -oyaml - ``` + ```bash + kubectl get secrets prometheus-operator-grafana -n monitoring -oyaml + ``` 4. 使用 port forward 从本地连接 Grafana 大盘。 - ```bash - kubectl port-forward svc/prometheus-operator-grafana -n monitoring 3000:80 - ``` + ```bash + kubectl port-forward svc/prometheus-operator-grafana -n monitoring 3000:80 + ``` - 您也可通过在浏览器中打开 "http://localhost:3000" 地址,连接 Grafana 大盘。 + 您也可通过在浏览器中打开 "http://localhost:3000" 地址,连接 Grafana 大盘。 6. (可选)配置 `PodMonitor` 及 `ServiceMonitor` 选择器。 @@ -290,7 +290,7 @@ componentSpecs: Grafana 大盘的 `APPS / PostgreSQL` 文件夹下有预设的大盘模板。您也可以在 [Grafana 大盘商店](https://grafana.com/grafana/dashboards/)获取更多大盘模板。 -::::note +:::note 请确保 `PodMonitor` 文件中的标签(如 endpoint 中的 path 和 port 值)设置正确,与您使用的大盘匹配。 diff --git a/i18n/zh-cn/user-docs/user-management/_category_.yml b/i18n/zh-cn/user-docs/user-management/_category_.yml index d8fad0af815..ec27cfe7b40 100644 --- a/i18n/zh-cn/user-docs/user-management/_category_.yml +++ b/i18n/zh-cn/user-docs/user-management/_category_.yml @@ -1,4 +1,4 @@ -position: 7 +position: 9 label: 用户管理 collapsible: true collapsed: true