[yunikorn-site] branch master updated: [YUNIKORN-702] Add doc explaining YuniKorn can support any K8s workload (#172)

[wi...@apache.org]

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 6ed5a3ce7 [YUNIKORN-702] Add doc explaining YuniKorn can support any K8s workload (#172)
6ed5a3ce7 is described below

commit 6ed5a3ce7e6ef79c0bdfa255f32083009d7118d0
Author: Craig Condit <cc...@apache.org>
AuthorDate: Fri Aug 19 12:23:01 2022 +1000

    [YUNIKORN-702] Add doc explaining YuniKorn can support any K8s workload (#172)
    
    Moved to official release 2.0.1 of docusaurus.
    
    Closes: #172
    
    Signed-off-by: Wilfred Spiegelenburg <wi...@apache.org>
---
 docs/user_guide/workloads/workload_overview.md | 58 ++++++++++++++++++++++++++
 package.json                                   |  6 +--
 sidebars.js                                    |  1 +
 3 files changed, 62 insertions(+), 3 deletions(-)

diff --git a/docs/user_guide/workloads/workload_overview.md b/docs/user_guide/workloads/workload_overview.md
new file mode 100644
index 000000000..cae7392bf
--- /dev/null
+++ b/docs/user_guide/workloads/workload_overview.md
@@ -0,0 +1,58 @@
+---
+id: workload_overview
+title: Overview
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+The YuniKorn scheduler is able to run any Kubernetes workload. All that is required is to ensure
+that the `schedulerName` field of a Pod specification is set to `yunikorn` and an `applicationId`
+label is set to a unique value per application:
+
+```yaml
+apiVersion: v1
+kind: Pod
+metadata:
+  labels:
+    app: sleep
+    applicationId: "application-sleep-0001"
+  name: sleep-app-1
+spec:
+  schedulerName: yunikorn
+  containers:
+    - name: sleep-30s
+      image: "alpine:latest"
+      command: ["sleep", "30"]
+      resources:
+        requests:
+          cpu: "100m"
+          memory: "100M"
+```
+
+Additionally, if the YuniKorn admission controller is present, the `schedulerName` field may be
+omitted as it will be set automatically on newly created pods.
+
+## Advanced Examples
+
+Examples of more advanced use cases can be found here:
+
+* [Run Spark Jobs](run_spark)
+* [Run Flink Jobs](run_flink)
+* [Run TensorFlow Jobs](run_tf)
diff --git a/package.json b/package.json
index 820559dce..a5ac5ba74 100644
--- a/package.json
+++ b/package.json
@@ -10,9 +10,9 @@
     "release": "docusaurus docs:version"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.22",
-    "@docusaurus/preset-classic": "2.0.0-beta.22",
-    "@docusaurus/theme-search-algolia": "^2.0.0-beta.22",
+    "@docusaurus/core": "2.0.1",
+    "@docusaurus/preset-classic": "2.0.1",
+    "@docusaurus/theme-search-algolia": "^2.0.1",
     "@mdx-js/react": "^1.5.8",
     "clsx": "^1.1.1",
     "react": "17.0.2",
diff --git a/sidebars.js b/sidebars.js
index 00f9bffc2..01d6ad4cc 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -34,6 +34,7 @@ module.exports = {
                 type: 'category',
                 label: 'Workloads',
                 items: [
+                    'user_guide/workloads/workload_overview',
                     'user_guide/workloads/run_spark',
                     'user_guide/workloads/run_flink',
                     'user_guide/workloads/run_tf'