You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by "wusamzong (via GitHub)" <gi...@apache.org> on 2023/05/12 11:19:24 UTC
[GitHub] [yunikorn-site] wusamzong opened a new pull request, #295: [YUNIKORN-1660] Documentation: add more realistic examples and use cases
wusamzong opened a new pull request, #295:
URL: https://github.com/apache/yunikorn-site/pull/295
### What is this PR for?
I have brought in some application scenarios for some features of Yunikorn.
This page it will explaining each feature with real cases.
I have added YAML or shell scripts for these cases in k8shim to help users implement them faster. I will link readers to these Yaml files after PR on k8shim's is accepted.
The Limit number of running applications feature is still being enhanced, so I have not added this Use case.
### What type of PR is it?
* [x] - Task
### What is the Jira issue?
* Open an issue on Jira https://issues.apache.org/jira/browse/YUNIKORN-1660/
### How should this be tested?
`./local-build.sh run`
### Screenshots (if appropriate)
### Questions:
1. What other cases can I add?
2. I've added a new page for Use cases and I'm not sure if it would be better to have these cases under each feature page?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [yunikorn-site] wilfred-s commented on a diff in pull request #295: [YUNIKORN-1660] Documentation: add more realistic examples and use cases
Posted by "wilfred-s (via GitHub)" <gi...@apache.org>.
wilfred-s commented on code in PR #295:
URL: https://github.com/apache/yunikorn-site/pull/295#discussion_r1201282823
##########
docs/user_guide/use_case.md:
##########
@@ -0,0 +1,483 @@
+---
+id: use_cases
+title: Use Cases
+---
+
+<!--
+ * 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.
+ -->
+
+## Introduction
+
+Yunikorn offers a range of features, including advanced capabilities like hierarchical resource queues, access control lists, resource limits, preemption, priority, and placement rules for managing your cluster. This page presents a real-world scenario to demonstrate the practical application of these features.
+
+We will now introduce the various functions and configurations of Yunikorn in sequence.
+
+The following will be included in this article：
+
+- Access control with ACL
+- Placement of different users
+- Limit usable resources on a queue level
+- Preemption and priority scheduling with fencing
+
+---
+
+## Prerequisite
+
+Before configuring yunikorn-config, we need to create users using [Authenticating](https://kubernetes.io/docs/reference/access-authn-authz/authentication/) and [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) from Kubernetes.
+
+To create the necessary users for the example, you can download the `create_user.sh` script directly from yunikorn-k8shim under deployment/examples/use-case/access-control.
+
+Here are the users we need to create:
+
+| user | group |
+| --- | --- |
+| admin | admin |
+| sue | group-a |
+| bob | group-a |
+| kim | group-b |
+| yono | group-b |
+| anonymous | anonymous |
Review Comment:
table layout: the column separators | should line up:
```
| user | group |
| --------- | --------- |
| admin | admin |
| sue | group-a |
| bob | group-a |
| kim | group-b |
| yono | group-b |
| anonymous | anonymous |
```
Most IDE can help you line up the columns nicely
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [yunikorn-site] wusamzong commented on pull request #295: [YUNIKORN-1660] Documentation: add more realistic examples and use cases
Posted by "wusamzong (via GitHub)" <gi...@apache.org>.
wusamzong commented on PR #295:
URL: https://github.com/apache/yunikorn-site/pull/295#issuecomment-1558362007
Thank you for your review, @wilfred-s. I have line up all table by using tool. And fixing the broken links.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [yunikorn-site] wilfred-s closed pull request #295: [YUNIKORN-1660] Documentation: add more realistic examples and use cases
Posted by "wilfred-s (via GitHub)" <gi...@apache.org>.
wilfred-s closed pull request #295: [YUNIKORN-1660] Documentation: add more realistic examples and use cases
URL: https://github.com/apache/yunikorn-site/pull/295
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org