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.

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-2773] Update Document - Removal of default queue configuration #513

Closed
wants to merge 5 commits into from
Closed
Changes from 1 commit
Commits
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
60 changes: 31 additions & 29 deletions docs/user_guide/service_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,6 @@ data:
admissionController.filtering.labelNamespaces: ""
admissionController.filtering.noLabelNamespaces: ""
admissionController.filtering.generateUniqueAppId: "false"
admissionController.filtering.defaultQueue: "root.default"
admissionController.accessControl.bypassAuth: "false"
admissionController.accessControl.trustControllers: "true"
admissionController.accessControl.systemUsers: "^system:serviceaccount:kube-system:"
Expand Down Expand Up @@ -1005,34 +1004,6 @@ Example:
admissionController.filtering.generateUniqueAppId: "true"
```

#### admissionController.filtering.defaultQueue
Controlls what will be the default queue name for the application.

If the application does not define a queue name during app submission, admission controller will add a default queue name to the pod labels. `root.default` queue name will be added to the pod labels if this property is not set.

In case, the default queue name needs to be updated to something other than `root.default`, `admissionController.filtering.defaultQueue` can be set with the desired queue name.

Example:
```yaml
# Change default queue to root.mydefault
admissionController.filtering.defaultQueue: "root.mydefault"
```

**_NOTE :_**
The queue name needs to be a fully qualified queue name.

For certain use-cases, there may be a need to skip adding a default queue name to the pod labels. In such cases, `admissionController.filtering.defaultQueue` can be set to empty string.

Adding default queue name should be avoided when `provided` rule is used in conjunction with other placement rules and `provided` rule is higher in the hierarchy. If default queue label is added whenever there is no queue name specified, all the apps will be placed via `provided` rule and the other rules after that will never be executed.

Default: `root.default`

Example:
```yaml
# Skip adding default queue name
admissionController.filtering.defaultQueue: ""
```

### Admission controller ACL settings

#### admissionController.accessControl.bypassAuth
Expand Down Expand Up @@ -1204,3 +1175,34 @@ service.operatorPlugins: "general"
- shim.scheduler
- shim.scheduler.plugin
- shim.utils

#### admissionController.filtering.defaultQueue

**_DEPRECATED in 1.6.0:_** No replacement

Controlls what will be the default queue name for the application.

If the application does not define a queue name during app submission, admission controller will add a default queue name to the pod labels. `root.default` queue name will be added to the pod labels if this property is not set.

In case, the default queue name needs to be updated to something other than `root.default`, `admissionController.filtering.defaultQueue` can be set with the desired queue name.

Example:
```yaml
# Change default queue to root.mydefault
admissionController.filtering.defaultQueue: "root.mydefault"
```

**_NOTE :_**
The queue name needs to be a fully qualified queue name.

For certain use-cases, there may be a need to skip adding a default queue name to the pod labels. In such cases, `admissionController.filtering.defaultQueue` can be set to empty string.

Adding default queue name should be avoided when `provided` rule is used in conjunction with other placement rules and `provided` rule is higher in the hierarchy. If default queue label is added whenever there is no queue name specified, all the apps will be placed via `provided` rule and the other rules after that will never be executed.

Default: `root.default`

Example:
```yaml
# Skip adding default queue name
admissionController.filtering.defaultQueue: ""
```