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-1643] Doc need to change for new limit wildcard interpretat… #327

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
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
13 changes: 7 additions & 6 deletions docs/user_guide/queue_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,8 @@ statedumpfilepath: <path/to/statedump/file>
```

### Limits
Limits define a set of limit objects for a partition or queue.
It can be set on either the partition or on a queue at any level.
Limits define a set of limit objects for a queue.
It can be set on a queue at any level.
```yaml
limits:
- limit: <description>
Expand All @@ -219,7 +219,7 @@ limits:

A limit object is a complex configuration object.
It defines one limit for a set of users and or groups.
Multiple independent limits can be set as part of one `limits` entry on a queue or partition.
Multiple independent limits can be set as part of one `limits` entry on a queue.
Users and or groups that are not part of the limit setting will not be limited.

A sample limits entry:
Expand Down Expand Up @@ -260,10 +260,11 @@ If the entry for users or groups contains more than one (1) entry it is always c
The star "*" is the wildcard character and matches all users or groups.
Duplicate entries in the lists are ignored and do not cause a parsing error.
Specifying a star beside other list elements is not allowed.
When a wildcard group is configured, a limit must be configured with at least one named group.
Parsing will reject the configuration with limits that do not follow this rule.

_maxapplications_ is an unsigned integer value, larger than 1, which allows you to limit the number of running applications for the configured user or group.
Specifying a zero maximum applications limit is not allowed as it would implicitly deny access.
Denying access must be handled via the ACL entries.
_maxapplications_ is an unsigned integer value, which allows you to limit the number of running applications for the configured user or group.
Specifying a zero maximum applications limit is not allowed.

The _maxresources_ parameter can be used to specify a limit for one or more resources.
The _maxresources_ uses the same syntax as the [resources](#resources) parameter for the queue.
Expand Down