Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[YUNIKORN-2109] Deprecate service.operatorPlugins configuration #363

Closed
wants to merge 1 commit into from
Closed

[YUNIKORN-2109] Deprecate service.operatorPlugins configuration #363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 docs/design/pluggable_app_management.md → ...chived_design/pluggable_app_management.md
View file
Open in desktop
File renamed without changes.
39 changes: 22 additions & 17 deletions docs/user_guide/service_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ or via the Helm `yunikornDefaults` section:

| Deprecated setting | ConfigMap replacement |
|----------------------------------------|-------------------------------------------------|
| operatorPlugins | service.operatorPlugins |
| operatorPlugins | - |
| placeHolderImage | service.placeholderImage |
| admissionController: processNamespaces | admissionController.filtering.processNamespaces |
| admissionController: bypassNamespaces | admissionController.filtering.bypassNamespaces |
Expand Down Expand Up @@ -432,7 +432,6 @@ Replacement example:
```yaml
yunikornDefaults:
service.policyGroup: queues
service.operatorPlugins: general
service.placeholderImage: registry.k8s.io/pause:3.7
admissionController.filtering.processNamespaces: "^spark-,^mpi-"
admissionController.filtering.bypassNamespaces: "^kube-system$"
Expand Down Expand Up @@ -485,7 +484,6 @@ data:
service.volumeBindTimeout: "10s"
service.eventChannelCapacity: "1048576"
service.dispatchTimeout: "5m"
service.operatorPlugins: "general"
service.disableGangScheduling: "false"
service.enableConfigHotRefresh: "true"
service.placeholderImage: "registry.k8s.io/pause:3.7"
Expand Down Expand Up @@ -604,19 +602,6 @@ Example:
```yaml
service.dispatchTimeout: "10m"
```
#### service.operatorPlugins
Controls the set of operator plugins which are enabled within YuniKorn.
Currently, only the `general`, `spark-k8s-operator`, and `yunikorn-app`
plugins are implemented. The `general` plugin should not be disabled.

A change to this setting requires a restart of YuniKorn to take effect.

Default: `general`

Example:
```yaml
service.operatorPlugins: "general,spark-k8s-operator"
```
#### service.disableGangScheduling
Allows global disabling of the gang scheduling feature (not recommended).

Expand Down Expand Up @@ -734,7 +719,6 @@ The `log.level` is the default log level for all loggers.
log.level: "INFO"
log.admission.level: "DEBUG"
log.core.config.level: "INFO"
log.shim.appmgmt.sparkoperator.level: "ERROR"
```

### Kubernetes settings
Expand Down Expand Up @@ -993,6 +977,27 @@ Example:
admissionController.accessControl.externalGroups: "^sales$,^marketing$,^admin-"
```

### Deprecated settings

#### service.operatorPlugins

**_DEPRECATED in 1.4.0:_** No replacement

Controls the set of operator plugins which are enabled within YuniKorn.
Currently, only the `general` plugin is implemented, and the plugin
functionality will be removed entirely in a future release. The `general`
plugin should not be disabled as it is critical to the proper operation of
YuniKorn.

A change to this setting requires a restart of YuniKorn to take effect.

Default: `general`

Example:
```yaml
service.operatorPlugins: "general"
```

[^1]: Available log subsystem values:
- admission
- admission.client
Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ module.exports = {
'design/preemption',
'design/simple_preemptor',
'design/generic_resource',
'design/pluggable_app_management',
'design/priority_scheduling',
'design/resilience',
'design/state_aware_scheduling',
Expand All @@ -98,6 +97,7 @@ module.exports = {
'archived_design/predicates',
'archived_design/scheduler_core_design',
'archived_design/cross_queue_preemption',
'archived_design/pluggable_app_management',
]
},
],
Expand Down