You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by wi...@apache.org on 2022/12/19 07:12:14 UTC
[yunikorn-site] branch master updated: [YUNIKORN-1417] Create "archived" section in design docs (#229)
This is an automated email from the ASF dual-hosted git repository.
wilfreds pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new 12b0636cb [YUNIKORN-1417] Create "archived" section in design docs (#229)
12b0636cb is described below
commit 12b0636cbca32cf7f6d52671fb1f91c17024203a
Author: KatLantyss <re...@gmail.com>
AuthorDate: Mon Dec 19 18:11:27 2022 +1100
[YUNIKORN-1417] Create "archived" section in design docs (#229)
Move older no longer relevant design docs into an archived section of
the developer guide.
Closes: #229
Signed-off-by: Wilfred Spiegelenburg <wi...@apache.org>
---
.../cross_queue_preemption.md | 0
docs/{design => archived_design}/k8shim.md | 2 +-
.../namespace_resource_quota.md | 0
docs/{design => archived_design}/predicates.md | 0
.../scheduler_core_design.md | 2 +-
docs/design/architecture.md | 4 ++--
sidebars.js | 20 +++++++++++++-------
7 files changed, 17 insertions(+), 11 deletions(-)
diff --git a/docs/design/cross_queue_preemption.md b/docs/archived_design/cross_queue_preemption.md
similarity index 100%
rename from docs/design/cross_queue_preemption.md
rename to docs/archived_design/cross_queue_preemption.md
diff --git a/docs/design/k8shim.md b/docs/archived_design/k8shim.md
similarity index 97%
rename from docs/design/k8shim.md
rename to docs/archived_design/k8shim.md
index 6d19a2a34..0f9a848ee 100644
--- a/docs/design/k8shim.md
+++ b/docs/archived_design/k8shim.md
@@ -24,7 +24,7 @@ under the License.
Github repo: https://github.com/apache/yunikorn-k8shim
-Please read the [architecture](architecture.md) doc before reading this one, you will need to understand
+Please read the [architecture](../design/architecture.md) doc before reading this one, you will need to understand
the 3 layer design of YuniKorn before getting to understand what is the Kubernetes shim.
## The Kubernetes shim
diff --git a/docs/design/namespace_resource_quota.md b/docs/archived_design/namespace_resource_quota.md
similarity index 100%
rename from docs/design/namespace_resource_quota.md
rename to docs/archived_design/namespace_resource_quota.md
diff --git a/docs/design/predicates.md b/docs/archived_design/predicates.md
similarity index 100%
rename from docs/design/predicates.md
rename to docs/archived_design/predicates.md
diff --git a/docs/design/scheduler_core_design.md b/docs/archived_design/scheduler_core_design.md
similarity index 99%
rename from docs/design/scheduler_core_design.md
rename to docs/archived_design/scheduler_core_design.md
index 917c172b2..c3da548c0 100644
--- a/docs/design/scheduler_core_design.md
+++ b/docs/archived_design/scheduler_core_design.md
@@ -24,7 +24,7 @@ title: Scheduler Core Design
:::caution
The scheduler core design has changed. [YUNIKORN-317](https://issues.apache.org/jira/browse/YUNIKORN-317) was committed and has removed the scheduler cache.
This document will not be maintained and is just for historical reference.
-See [scheduler cache removal design](cache_removal.md)
+See [scheduler cache removal design](../design/cache_removal.md)
:::
Github repo: https://github.com/apache/yunikorn-core
diff --git a/docs/design/architecture.md b/docs/design/architecture.md
index 40db1bc00..5163d4c9f 100644
--- a/docs/design/architecture.md
+++ b/docs/design/architecture.md
@@ -50,7 +50,7 @@ Scheduler core encapsulates all scheduling algorithms, it collects resources fro
platforms (like YARN/K8s), and is responsible for container allocation requests. It makes the decision where is the
best spot for each request and then sends response allocations to the resource management platform.
Scheduler core is agnostic about underneath platforms, all the communications are through the [scheduler interface](https://github.com/apache/yunikorn-scheduler-interface).
-Please read more about the design of schedule core [here](scheduler_core_design.md).
+Please read more about the design of schedule core [here](../archived_design/scheduler_core_design.md).
### Kubernetes shim
@@ -58,5 +58,5 @@ The YuniKorn Kubernetes shim is responsible for talking to Kubernetes, it is res
cluster resources, and resource requests via scheduler interface and send them to the scheduler core.
And when a scheduler decision is made, it is responsible for binding the pod to the specific node. All the communication
between the shim and the scheduler core is through the [scheduler interface](https://github.com/apache/yunikorn-scheduler-interface).
-Please read more about the design of the Kubernetes shim [here](k8shim.md).
+Please read more about the design of the Kubernetes shim [here](../archived_design/k8shim.md).
diff --git a/sidebars.js b/sidebars.js
index c34ae6738..4d4f95fc8 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -61,12 +61,12 @@ module.exports = {
'developer_guide/dependencies',
'developer_guide/deployment',
'developer_guide/openshift_development',
+ 'developer_guide/translation',
{
type: 'category',
label: 'Designs',
items: [
'design/architecture',
- 'design/k8shim',
'design/scheduler_plugin',
'design/gang_scheduling',
'design/user_group',
@@ -75,20 +75,26 @@ module.exports = {
'design/cache_removal',
'design/simple_preemptor',
'design/generic_resource',
- 'design/namespace_resource_quota',
'design/pluggable_app_management',
'design/priority_scheduling',
'design/resilience',
- 'design/predicates',
- 'design/scheduler_configuration',
'design/state_aware_scheduling',
'design/scheduler_object_states',
- 'design/scheduler_core_design',
- 'design/cross_queue_preemption',
'design/config_v2',
+ 'design/scheduler_configuration',
]
},
- 'developer_guide/translation',
+ {
+ type: 'category',
+ label: 'Archived Designs',
+ items: [
+ 'archived_design/k8shim',
+ 'archived_design/namespace_resource_quota',
+ 'archived_design/predicates',
+ 'archived_design/scheduler_core_design',
+ 'archived_design/cross_queue_preemption',
+ ]
+ },
],
'Performance': [
'performance/evaluate_perf_function_with_kubemark',