Skip to content

Commit e031f3b

Browse files
committed
[YUNIKORN-3265] Doc cleanup in yunikorn-site repo
1 parent fb75739 commit e031f3b

5 files changed

Lines changed: 8 additions & 64 deletions

File tree

docs/design/scheduler_plugin.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ title: K8s Scheduler Plugin
2121
* limitations under the License.
2222
-->
2323

24+
25+
NOTE: The plugin deployment mode is deprecated and no longer supported. Please refer [deployment modes](user_guide/deployment_modes.md) section for more details
26+
2427
## Background
2528

2629
YuniKorn (on Kubernetes) is traditionally implemented as a ground-up implementation of a Kubernetes scheduler.

docs/developer_guide/build.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ Building the Docker images can be triggered by following command:
6060
make image
6161
```
6262

63-
This will generate images for the scheduler, scheduler plugin, and admission
64-
controller.
63+
This will generate images for the scheduler and admission controller.
6564

6665
The images created can be deployed directly on Kubernetes.
6766
Some sample deployments that can be used are found under the
@@ -93,7 +92,6 @@ info in the image metadata. You can retrieve this information with docker
9392

9493
```shell script
9594
docker inspect apache/yunikorn:scheduler-amd64-latest
96-
docker inspect apache/yunikorn:scheduler-plugin-amd64-latest
9795
docker inspect apache/yunikorn:admission-controller-amd64-latest
9896
```
9997

@@ -229,12 +227,6 @@ make run
229227
This will launch a local scheduler and connect to the Kubernetes cluster
230228
referenced in your `KUBECONFIG` or `$HOME/.kube/config`.
231229

232-
To run YuniKorn in Kubernetes scheduler plugin mode instead, execute:
233-
234-
```
235-
make run_plugin
236-
```
237-
238230
You can also use the same approach to run the scheduler locally but connecting
239231
to a remote kubernetes cluster, as long as the `$HOME/.kube/config` file
240232
is pointing to that remote cluster.

docs/developer_guide/deployment.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,6 @@ The deployment will run 2 containers from your pre-built docker images in 1 pod,
8585
* yunikorn-scheduler-core (yunikorn scheduler core and shim for K8s)
8686
* yunikorn-scheduler-web (web UI)
8787

88-
Alternatively, the scheduler can be deployed as a K8S scheduler plugin:
89-
```
90-
kubectl create -f deployments/scheduler/plugin.yaml
91-
```
92-
9388
The pod is deployed as a customized scheduler, it will take the responsibility to schedule pods which explicitly specifies `schedulerName: yunikorn` in pod's spec. In addition to the `schedulerName`, you will also have to add a label `applicationId` to the pod.
9489
```yaml
9590
metadata:

docs/developer_guide/env_setup.md

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -225,36 +225,6 @@ Set the following values in the dialog (as shown):
225225
Once the changes are done, click "Apply", then "Debug". You will need to
226226
set proper breakpoints in order to debug the program.
227227

228-
## Debug the scheduler plugin
229-
230-
The scheduler may also be run in plugin mode. In this mode, the YuniKorn
231-
scheduler is built on top of the default scheduler and runs as a
232-
plugin (rather than completely standalone). Functionally, it performs the
233-
same tasks, but relies on the upstream Kubernetes scheduler codebase for
234-
common functionality.
235-
236-
The run configuration for the scheduler in plugin mode is as follows:
237-
238-
- Run Kind: Package
239-
- Package path: `github.com/apache/yunikorn-k8shim/pkg/cmd/schedulerplugin`
240-
- Working directory: Project base directory (`yunikorn-k8shim`)
241-
- Program arguments:
242-
```
243-
--bind-address=0.0.0.0
244-
--leader-elect=false
245-
--config=conf/scheduler-config-local.yaml
246-
-v=2
247-
```
248-
- Environment: If `KUBECONFIG` is not set globally, ensure it is set here.
249-
Additionally, you may want to set `NAMESPACE=yunikorn`, as otherwise
250-
YuniKorn will look for the `yunikorn-configs` ConfigMap under the
251-
`default` Kubernetes namespace.
252-
253-
Additionally, before running for the first time, run `make init` from a
254-
terminal in the root of the `yunikorn-k8shim` repository. This will
255-
generate the contents of `conf/scheduler-config-local.yaml`, which is
256-
required.
257-
258228
## Access remote Kubernetes cluster
259229

260230
This setup assumes you have already installed a remote Kubernetes cluster.

docs/user_guide/service_config.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,6 @@ image:
4646
tag: scheduler-{version} # default depends on YuniKorn version
4747
pullPolicy: Always
4848

49-
# Image information for the plugin scheduler
50-
pluginImage:
51-
repository: apache/yunikorn
52-
tag: scheduler-plugin-{version} # default depends on YuniKorn version
53-
pullPolicy: Always
54-
5549
# Image information for the web UI
5650
web:
5751
image:
@@ -402,15 +396,7 @@ Example:
402396
```yaml
403397
embedAdmissionController: false
404398
```
405-
#### enableSchedulerPlugin
406-
Controls whether to run YuniKorn in scheduler plugin mode.
407-
408-
Default: `false`
409399

410-
Example:
411-
```yaml
412-
enableSchedulerPlugin: true
413-
```
414400
#### enableWebService
415401
Controls whether to enable the YuniKorn Web UI service.
416402

@@ -995,9 +981,8 @@ all pods which are scheduled by YuniKorn will have an `applicationId` label appl
995981
When running YuniKorn using the standard deployment model, all pods should be labeled,
996982
as YuniKorn is unable to schedule pods without an `applicationId` defined.
997983

998-
When running YuniKorn using the scheduler plugin deployment model, this setting can
999-
be used to filter which namespaces should be scheduled via YuniKorn's queueing model,
1000-
and which should bypass queueing and be scheduled by the embedded default scheduler.
984+
This setting can be used to filter which namespaces should be scheduled via YuniKorn's queueing model,
985+
and which should bypass queueing and be scheduled by the default scheduler.
1001986

1002987
This setting is a comma-separated list of regular expressions. If this setting
1003988
is an empty string, all pods forwarded to YuniKorn will have an `applicationId` label
@@ -1019,9 +1004,8 @@ acts as an exception list to `admissionController.filtering.labelNamespaces`.
10191004
When running YuniKorn using the standard deployment model, all pods should be labeled,
10201005
as YuniKorn is unable to schedule pods without an `applicationId` defined.
10211006

1022-
When running YuniKorn using the scheduler plugin deployment model, this setting can
1023-
be used to filter which namespaces should be scheduled via YuniKorn's queueing model,
1024-
and which should bypass queueing and be scheduled by the embedded default scheduler.
1007+
This setting can be used to filter which namespaces should be scheduled via YuniKorn's queueing model,
1008+
and which should bypass queueing and be scheduled by the default scheduler.
10251009

10261010
This setting is a comma-separated list of regular expressions. If this setting
10271011
is an empty string, no exclusions to `admissionController.filtering.labelNamespaces` will

0 commit comments

Comments
 (0)