Merge pull request #391 from zsnmwy/fix/proposals_docs_display

fix: proposals docs display
gocrane · Jul 9, 2022 · 5394779 · 5394779
2 parents 5b82011 + 49526b6
commit 5394779
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/docs/proposals/Pod-Sorting-And-Precise-Execution-For-Crane-Agent.md b/docs/proposals/Pod-Sorting-And-Precise-Execution-For-Crane-Agent.md
@@ -94,6 +94,7 @@ The existing problems are:
 In order to better sort and precisely control metrics configured based on NodeQosEnsurancePolicy, the concept of attributes is introduced into metrics.
 
 The attributes of metrics include the following:
+
 1. Name indicates the name of the metric, which should be consistent with the indicator name collected in the collector module
 2. ActionPriority indicates the priority of the indicator. 0 is the lowest and 10 is the highest
 3. SortAble indicates whether the indicator can be sorted
@@ -272,4 +273,4 @@ if len(MetricsNotEvcitQuantified) != 0 {
 ### User Stories
 
 - Users can use crane agent for better QoS guarantees. Support faster node load reduction to ensure that high priority services are not affected. At the same time, the throttle/eviction of low priority services is precisely controlled to avoid excessive operation.
-- With the help of the framework of precise operation (throttle/eviction), users can easily realize the QoS function with precise operation and sorting capability based on the user-defined metric without paying attention to details by implementing the attributes and methods related to the user-defined metric.
+- With the help of the framework of precise operation (throttle/eviction), users can easily realize the QoS function with precise operation and sorting capability based on the user-defined metric without paying attention to details by implementing the attributes and methods related to the user-defined metric.
diff --git a/...d-Precise-Execution-For-Crane-Agent-CN.md → ...d-Precise-Execution-For-Crane-Agent.zh.md b/...d-Precise-Execution-For-Crane-Agent-CN.md → ...d-Precise-Execution-For-Crane-Agent.zh.md
@@ -2,6 +2,7 @@
 该proposal丰富了crane-agent的排序策略，完善了通用排序。并且实现了一套精准操作(压制/驱逐)的框架，在执行压制/驱逐等操作时，操作到用户指定的水位线即停止的精确操作逻辑，避免了对于低优pod的过度操作；
 
 具体来说：
+
 - 丰富了crane-agent的排序策略，完善了通用排序和cpu usage为主要参考的cpu维度排序；
 
 - 针对cpu usage，实现了执行压制/驱逐等操作时，操作到用户指定的水位线即停止的精确操作逻辑，避免了对于低优pod的过度操作；
@@ -91,6 +92,7 @@
 为了更好的基于NodeQOSEnsurancePolicy配置的metric进行排序和精准控制，对metric引入属性的概念。
 
 metric的属性包含如下几个：
+
 1. Name 表明了metric的名称，需要同collector模块中收集到的指标名称一致
 2. ActionPriority 表示指标的优先级，0为最低，10为最高
 3. SortAble 表明该指标是否可以排序
@@ -269,4 +271,4 @@ if len(MetricsNotEvcitQuantified) != 0 {
 ### User Stories
 
 - 用户可以使用crane-agent进行更好的QoS保障。支持更快速的降低节点负载，以保障高优先级业务不受影响。同时对低优先级业务的压制/驱逐动作，进行精确控制，避免过度操作。
-- 用户可以借助实现的精准操作(压制/驱逐)的框架，在无需关心细节的情况下，通过实现自定义metric相关的属性和方法，即可方便地实现以自定义metric为核心的具有精确操作和排序能力的QoS功能。
+- 用户可以借助实现的精准操作(压制/驱逐)的框架，在无需关心细节的情况下，通过实现自定义metric相关的属性和方法，即可方便地实现以自定义metric为核心的具有精确操作和排序能力的QoS功能。
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -113,6 +113,7 @@ nav:
         - Load-aware Scheduling: tutorials/dynamic-scheduler-plugin.md
   - Proposals:
       - Advanced CpuSet Manager: proposals/20220228-advanced-cpuset-manger.md
+      - Pod Sorting And Precise Execution For Crane Agent: proposals/Pod-Sorting-And-Precise-Execution-For-Crane-Agent.md
   - Contributing: CONTRIBUTING.md
   - Code Standard: code-standards.md
   - Roadmap: