improve the description of Koordinator (#149)

* Classify user documents Signed-off-by: fansong.cfs <[email protected]> * improve the description of Koordinator Signed-off-by: fansong.cfs <[email protected]> --------- Signed-off-by: fansong.cfs <[email protected]>
koordinator-sh · Sep 25, 2023 · fb09f0a · fb09f0a
1 parent 850c0e7
commit fb09f0a
Show file tree

Hide file tree

Showing 20 changed files with 31 additions and 25 deletions.
diff --git a/blog/2022-03-31-release/index.md b/blog/2022-03-31-release/index.md
@@ -9,7 +9,7 @@ tags: [koordinator, colocation, kubernetes, scheduling, orchestration, release]
 We’re pleased to announce the release of Koordinator v0.1.0.
 
 ## Overview
-Koordinator is a QoS based scheduling system for hybrid workloads orchestration on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
+Koordinator is a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
 
 ## Key Features
 Koordinator enhances the kubernetes user experiences in the workload management by providing the following:

diff --git a/docs/designs/nri-mode-resource-management.md b/docs/designs/nri-mode-resource-management.md
@@ -10,7 +10,7 @@ We hope to enable NRI mode resource management for koordinator for easy deployme
 
 ## Motivation
 
-Koordinator as a QoS based scheduling system for hybrid workloads orchestration on Kubernetes and its runtime hooks support two working [modes](https://github.com/koordinator-sh/koordinator/blob/main/docs/design-archive/koordlet-runtime-hooks.md) for different scenarios: `Standalone` and `Proxy`. However, both of them have some [constraints](https://shimo.im/docs/m4kMLdgO1LIma9qD). NRI (Node Resource Interface), which is a public interface for controlling node resources is a general framework for CRI-compatible container runtime plug-in extensions. It provides a mechanism for extensions to track the state of pod/containers and make limited modifications to their configuration. We'd like to integrate NRI framework to address `Standalone` and `Proxy` constraints based on this community recommend mechanism.
+Koordinator as a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes and its runtime hooks support two working [modes](https://github.com/koordinator-sh/koordinator/blob/main/docs/design-archive/koordlet-runtime-hooks.md) for different scenarios: `Standalone` and `Proxy`. However, both of them have some [constraints](https://shimo.im/docs/m4kMLdgO1LIma9qD). NRI (Node Resource Interface), which is a public interface for controlling node resources is a general framework for CRI-compatible container runtime plug-in extensions. It provides a mechanism for extensions to track the state of pod/containers and make limited modifications to their configuration. We'd like to integrate NRI framework to address `Standalone` and `Proxy` constraints based on this community recommend mechanism.
 
 ### Goals
 

diff --git a/docs/introduction.md b/docs/introduction.md
@@ -9,7 +9,7 @@ Welcome to Koordinator!
 
 ## Overview
 
-Koordinator is a QoS based scheduling system for hybrid workloads orchestration on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
+Koordinator is a QQoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
 
 
 ## Key Features

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -22,7 +22,7 @@ function getNextVersionName() {
 /** @type {import('@docusaurus/types').Config} */
 const config = {
   title: 'Koordinator',
-  tagline: 'QoS based scheduling system for hybrid workloads orchestration on Kubernetes',
+  tagline: 'QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes',
   url: 'https://koordinator.sh',
   baseUrl: '/',
   onBrokenLinks: 'throw',

diff --git a/i18n/zh-Hans/code.json b/i18n/zh-Hans/code.json
@@ -8,11 +8,11 @@
   "What is Koordinator?": {
     "message": "Koordinator 是什么?"
   },
-  "QoS based scheduling system for hybrid workloads orchestration on Kubernetes": {
-    "message": "基于 QoS 的 Kubernetes 混合工作负载调度系统"
+  "QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes": {
+    "message": "基于 QoS 调度系统，为在Kubernetes中高效运行微服务、AI、大数据负载设计"
   },
-  "Koordinator is a modern scheduling system that colocate different types of workloads on kubernetes. It achieves high utilization by combining elastic resource quota, efficient pod-packing, over-commitment, and node sharing with container resource isolation.": {
-    "message": "Koordinator 是一个先进的调度系统，可以将不同类型的工作负载托管在Kubernetes上。将弹性的资源配额、高效的 Pod 打包、超卖、节点共享与容器资源隔离相结合，实现了高利用率。"
+  "Koordinator is a modern scheduling system that colocate microservices, AI, and big data workloads on kubernetes. It achieves high utilization by combining elastic resource quota, efficient pod-packing, over-commitment, and resource sharing with container resource isolation.": {
+     "message": "Koordinator 是一个现代的调度系统，可以将微服务、AI、大数据的工作负载托管在Kubernetes上。通过弹性资源配额、高效的 Pod 装箱、资源超售、资源共享与容器资源隔离相结合，实现了高利用率。"
   },
   "Koordinator is high performance, scalable, yet most importantly,": {
     "message": "Koordinator 是具有高性能、可扩展的，"
@@ -27,7 +27,7 @@
     "message": "混合工作负载编排"
   },
   "Koordinator contains a set of colocation profiles, such as Spark profile, Presto profile, TensorFlow profile, etc. These profiles allow you to run workloads directly in a co-located manner without customizing the original workload controllers, and all you need to do is install these profiles CRs.": {
-    "message": "Koordinator 包含一组托管配置文件，如 Spark 配置、Presto 配置、TensorFlow 配置等。这些配置文件允许您在不修改原始控制器的基础上，以混部的方式运行工作负载，只需要安装应用这些配置文件 CR 即可。"
+    "message": "Koordinator 包含一组托管配置文件，如 Spark 配置、Presto 配置、TensorFlow、Pytorch 配置等。这些配置文件允许您在不修改原始控制器的基础上，以混部的方式运行工作负载，只需要安装应用这些配置文件 CR 即可。"
   },
   "These profiles provide best practices for running typical workloads on kubernetes, and you can easily extend them if they don't directly meet your needs. The koordinator community will continue to add more best practices for workload colocation.": {
     "message": "这些配置文件提供了在 Kubernetes 上运行典型工作负载的最佳实践，如果它们不能直接满足您的需求，您可以轻松扩展它们。Koordinator 社区将持续为工作负载托管添加更多最佳实践。"
@@ -51,6 +51,12 @@
   "The QoSManager continuously adjusts the resource isolation parameters of each Pod to eliminate the long-tail jitter of latency-sensitive workloads. Therefore, even if you don't care about resource utilization improvement, it will provide a series of methods to improve runtime stability and performance.": {
     "message": "QoSManager 不断调整每个 Pod 的资源隔离参数，以消除对延迟敏感的工作负载的长尾抖动。因此，即使您不关心资源利用率的提高，它也会提供一系列方法来提高运行时稳定性和性能。"
   },
+  "Koordinator consists of control plane components and node components, and does not require invasive modifications to the native components of Kubernetes. It runs in a similar fashion to a sidecar within a Kubernetes cluster, and based on the chosen policies, it schedules and manages user Pods, observes their runtime status, and optimizes their performance.": {
+    "message": "Koordinator 由控制平面组件和节点组件组成，不需要对 Kubernetes 原生组件进行侵入。它与 Kubernetes 集群中的同级边车相似，并且基于用户选择的策略，它调度和管理用户 Pod，观察其运行时状态，并优化其性能。"
+  },
+  "Koordinator follows the principle of loose coupling, allowing users to use the entire set of components or a combination of some components to meet their specific business requirements." :{
+    "message": "Koordinator 遵循松耦合原则，允许用户使用整个组件或某些组件来满足其特定业务需求。"
+  },
   "theme.ErrorPageContent.title": {
     "message": "页面已崩溃。",
     "description": "The title of the fallback page when the page crashed"

diff --git a/.../docusaurus-plugin-content-docs/current/designs/nri-mode-resource-management.md b/.../docusaurus-plugin-content-docs/current/designs/nri-mode-resource-management.md
@@ -10,7 +10,7 @@ We hope to enable NRI mode resource management for koordinator for easy deployme
 
 ## Motivation
 
-Koordinator as a QoS based scheduling system for hybrid workloads orchestration on Kubernetes and its runtime hooks support two working [modes](https://github.com/koordinator-sh/koordinator/blob/main/docs/design-archive/koordlet-runtime-hooks.md) for different scenarios: `Standalone` and `Proxy`. However, both of them have some [constraints](https://shimo.im/docs/m4kMLdgO1LIma9qD). NRI (Node Resource Interface), which is a public interface for controlling node resources is a general framework for CRI-compatible container runtime plug-in extensions. It provides a mechanism for extensions to track the state of pod/containers and make limited modifications to their configuration. We'd like to integrate NRI framework to address `Standalone` and `Proxy` constraints based on this community recommend mechanism.
+Koordinator as a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes and its runtime hooks support two working [modes](https://github.com/koordinator-sh/koordinator/blob/main/docs/design-archive/koordlet-runtime-hooks.md) for different scenarios: `Standalone` and `Proxy`. However, both of them have some [constraints](https://shimo.im/docs/m4kMLdgO1LIma9qD). NRI (Node Resource Interface), which is a public interface for controlling node resources is a general framework for CRI-compatible container runtime plug-in extensions. It provides a mechanism for extensions to track the state of pod/containers and make limited modifications to their configuration. We'd like to integrate NRI framework to address `Standalone` and `Proxy` constraints based on this community recommend mechanism.
 
 ### Goals
 

diff --git a/...saurus-plugin-content-docs/version-v1.3/designs/nri-mode-resource-management.md b/...saurus-plugin-content-docs/version-v1.3/designs/nri-mode-resource-management.md
@@ -10,7 +10,7 @@ We hope to enable NRI mode resource management for koordinator for easy deployme
 
 ## Motivation
 
-Koordinator as a QoS based scheduling system for hybrid workloads orchestration on Kubernetes and its runtime hooks support two working [modes](https://github.com/koordinator-sh/koordinator/blob/main/docs/design-archive/koordlet-runtime-hooks.md) for different scenarios: `Standalone` and `Proxy`. However, both of them have some [constraints](https://shimo.im/docs/m4kMLdgO1LIma9qD). NRI (Node Resource Interface), which is a public interface for controlling node resources is a general framework for CRI-compatible container runtime plug-in extensions. It provides a mechanism for extensions to track the state of pod/containers and make limited modifications to their configuration. We'd like to integrate NRI framework to address `Standalone` and `Proxy` constraints based on this community recommend mechanism.
+Koordinator as a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes and its runtime hooks support two working [modes](https://github.com/koordinator-sh/koordinator/blob/main/docs/design-archive/koordlet-runtime-hooks.md) for different scenarios: `Standalone` and `Proxy`. However, both of them have some [constraints](https://shimo.im/docs/m4kMLdgO1LIma9qD). NRI (Node Resource Interface), which is a public interface for controlling node resources is a general framework for CRI-compatible container runtime plug-in extensions. It provides a mechanism for extensions to track the state of pod/containers and make limited modifications to their configuration. We'd like to integrate NRI framework to address `Standalone` and `Proxy` constraints based on this community recommend mechanism.
 
 ### Goals
 

diff --git a/src/components/features.js b/src/components/features.js
@@ -9,7 +9,7 @@ const features = [
       <>
 
         <Translate>Koordinator provides a range of options for customizing scheduling policies, allowing users to fine-tune the behavior
-          of the system to suit their specific needs, such as Web Service, Spark, Presto, TensorFlow, etc.
+          of the system to suit their specific needs, such as Web Service, Spark, Presto, TensorFlow, Pytorch, etc.
           We provide a profile tool to help you manage workload scheduling policies, which allows to control scheduling policies without modifying the existing workload controller</Translate>
 
         <br></br>

diff --git a/src/pages/index.js b/src/pages/index.js
@@ -107,8 +107,8 @@ const WhatIs = () => (
           <p className="hero__subtitle">
             <small>
               <Translate>
-                Koordinator is a modern scheduling system that colocate different types of workloads on kubernetes. 
-                It achieves high utilization by combining elastic resource quota, efficient pod-packing, over-commitment, and node sharing with container resource isolation.
+                Koordinator is a modern scheduling system that colocate microservices, AI, and big data workloads on kubernetes. 
+                It achieves high utilization by combining elastic resource quota, efficient pod-packing, over-commitment, and resource sharing with container resource isolation.
               </Translate>
               <br />
               <br />

diff --git a/versioned_docs/version-v0.2/introduction.md b/versioned_docs/version-v0.2/introduction.md
@@ -9,7 +9,7 @@ Welcome to Koordinator!
 
 ## Overview
 
-Koordinator is a QoS based scheduling system for hybrid workloads orchestration on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
+Koordinator is a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
 
 
 ## Key Features

diff --git a/versioned_docs/version-v0.3/introduction.md b/versioned_docs/version-v0.3/introduction.md
@@ -9,7 +9,7 @@ Welcome to Koordinator!
 
 ## Overview
 
-Koordinator is a QoS based scheduling system for hybrid workloads orchestration on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
+Koordinator is a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
 
 
 ## Key Features

diff --git a/versioned_docs/version-v0.4/introduction.md b/versioned_docs/version-v0.4/introduction.md
@@ -9,7 +9,7 @@ Welcome to Koordinator!
 
 ## Overview
 
-Koordinator is a QoS based scheduling system for hybrid workloads orchestration on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
+Koordinator is a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
 
 
 ## Key Features

diff --git a/versioned_docs/version-v0.5/introduction.md b/versioned_docs/version-v0.5/introduction.md
@@ -9,7 +9,7 @@ Welcome to Koordinator!
 
 ## Overview
 
-Koordinator is a QoS based scheduling system for hybrid workloads orchestration on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
+Koordinator is a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
 
 
 ## Key Features

diff --git a/versioned_docs/version-v0.6/introduction.md b/versioned_docs/version-v0.6/introduction.md
@@ -9,7 +9,7 @@ Welcome to Koordinator!
 
 ## Overview
 
-Koordinator is a QoS based scheduling system for hybrid workloads orchestration on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
+Koordinator is a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
 
 
 ## Key Features

diff --git a/versioned_docs/version-v0.7/introduction.md b/versioned_docs/version-v0.7/introduction.md
@@ -9,7 +9,7 @@ Welcome to Koordinator!
 
 ## Overview
 
-Koordinator is a QoS based scheduling system for hybrid workloads orchestration on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
+Koordinator is a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
 
 
 ## Key Features

diff --git a/versioned_docs/version-v1.0/introduction.md b/versioned_docs/version-v1.0/introduction.md
@@ -9,7 +9,7 @@ Welcome to Koordinator!
 
 ## Overview
 
-Koordinator is a QoS based scheduling system for hybrid workloads orchestration on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
+Koordinator is a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
 
 
 ## Key Features

diff --git a/versioned_docs/version-v1.1/introduction.md b/versioned_docs/version-v1.1/introduction.md
@@ -9,7 +9,7 @@ Welcome to Koordinator!
 
 ## Overview
 
-Koordinator is a QoS based scheduling system for hybrid workloads orchestration on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
+Koordinator is a QoS-based scheduling for efficient orchestration of microservices, AI, and big data workloads on Kubernetes. It aims to improve the runtime efficiency and reliability of both latency sensitive workloads and batch jobs, simplify the complexity of resource-related configuration tuning, and increase pod deployment density to improve resource utilizations.
 
 
 ## Key Features