Merge pull request #367 from autumn0207/improve_scheudler_docs

improve docs
gocrane · Jun 20, 2022 · e890581 · e890581
2 parents 8802d07 + 2489bf6
commit e890581
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 44 deletions.
diff --git a/docs/tutorials/scheduling-pods-based-on-actual-node-load.md b/docs/tutorials/scheduling-pods-based-on-actual-node-load.md
@@ -12,7 +12,7 @@ Make sure your kubernetes cluster has Prometheus installed. If not, please refer
 
 ### Configure Prometheus Rules
 
-1. Configure the rules of Prometheus to get expected aggregated data:
+Configure the rules of Prometheus to get expected aggregated data:
 
 ```yaml
 apiVersion: monitoring.coreos.com/v1
@@ -57,26 +57,6 @@ spec:
 
         The sampling interval of Prometheus must be less than 30 seconds, otherwise the above rules(such as cpu_usage_active) may not take effect.
 
-2\. Update the configuration of Prometheus service discovery to ensure that `node_exporters/telegraf` are using node name as instance name:
-
-```yaml hl_lines="9-11"
-    - job_name: kubernetes-node-exporter
-      tls_config:
-        ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-        insecure_skip_verify: true
-      bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
-      scheme: https
-      kubernetes_sd_configs:
-      ...
-      # Host name
-      - source_labels: [__meta_kubernetes_node_name]
-        target_label: instance
-      ...
-```
-
-!!! note "Note"
-      This step can be skipped if the node name itself is the host IP.
-
 ### Install Crane-scheduler
 There are two options:
 

diff --git a/docs/tutorials/scheduling-pods-based-on-actual-node-load.zh.md b/docs/tutorials/scheduling-pods-based-on-actual-node-load.zh.md
@@ -12,7 +12,7 @@ Crane-scheduler 是一组基于[scheduler framework](https://kubernetes.io/docs/
 
 ### 配置 Prometheus 规则
 
-1. 配置 Prometheus 的规则以获取预期的聚合数据：
+配置 Prometheus 的规则以获取预期的聚合数据：
 
 ```yaml
 apiVersion: monitoring.coreos.com/v1
@@ -57,27 +57,6 @@ spec:
 
         Prometheus 的采样间隔必须小于30秒，不然可能会导致规则无法正常生效。如：`cpu_usage_active`。
 
-2\. 更新 Prometheus 服务发现的配置，确保`node_exporters/telegraf`正在使用节点名称作为实例名称：
-
-```yaml hl_lines="9-11"
-    - job_name: kubernetes-node-exporter
-      tls_config:
-        ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-        insecure_skip_verify: true
-      bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
-      scheme: https
-      kubernetes_sd_configs:
-      ...
-      # Host name
-      - source_labels: [__meta_kubernetes_node_name]
-        target_label: instance
-      ...
-```
-
-!!! note "Note"
-
-      如果节点名称是本机IP，则可以跳过此步骤。
-
 ### 安装 Crane-scheduler
 有两种选择：
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -51,6 +51,8 @@ plugins:
           Mirror Repo: 镜像仓库
           Code Standard: 代码标准
           Roadmap: 路线图
+          Overview: 概述
+          Load-aware Scheduling: 负载感知调度
 markdown_extensions:
   - codehilite
   - admonition
@@ -86,7 +88,9 @@ nav:
         - Replicas Recommendation: tutorials/replicas-recommendation.md
       - Qos Ensurance: tutorials/using-qos-ensurance.md
       - Time Series Prediction: tutorials/using-time-series-prediction.md
-      - Load-aware Scheduling: tutorials/scheduling-pods-based-on-actual-node-load.md
+      - Crane-scheduler:
+        - Overview: tutorials/scheduling-pods-based-on-actual-node-load.md
+        - Load-aware Scheduling: tutorials/dynamic-scheduler-plugin.md
   - Proposals:
       - Advanced CpuSet Manager: proposals/20220228-advanced-cpuset-manger.md
   - Contributing: CONTRIBUTING.md