Skip to content

Add WLM workload group settings UI - #526

Merged
KishoreKicha14 merged 2 commits into
opensearch-project:mainfrom
dzane17:wlm-group-settings
Jun 1, 2026
Merged

Add WLM workload group settings UI#526
KishoreKicha14 merged 2 commits into
opensearch-project:mainfrom
dzane17:wlm-group-settings

Conversation

@dzane17

@dzane17 dzane17 commented May 27, 2026

Copy link
Copy Markdown
Member

Description

Adds dashboard support for the per-workload-group settings block introduced in OpenSearch 3.7 (#20536, #21143, #21523, #21721). Administrators can now set, update, and remove the six supported keys directly from the WLM Workload Management UI on both the create and edit flows.

Documentation: opensearch-project/documentation-website#12444

What's new

A new Group settings section on the Settings tab of the WLM details page, mirrored as a panel on the create page. Each row carries the raw API key (search.max_buckets, override_request_values, etc.), a short description, a Set toggle, and a typed input.

Screenshot 2026-05-27 at 1 59 07 PM

Things to note

  • Version gate. New isWlmGroupSettingsSupported(version) helper hides the section on data sources < 3.7, mirroring the existing isSecurityAttributesSupported ≥ 3.3 pattern.
  • Live validation. Each input is validated as the user types — search.max_buckets ≥ 0, time values match 250ms / 30s / 1m, integers respect their per-key minimum. Invalid rows show an inline error and disable Apply Changes. Constraints live in a single table (WLM_SETTING_DEFS) — adding a new key is a one-row append.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@dzane17
dzane17 force-pushed the wlm-group-settings branch from de7692a to cc4f9ee Compare May 27, 2026 00:30
@dzane17

dzane17 commented May 27, 2026

Copy link
Copy Markdown
Member Author

Security check failure will be resolved by #527

@dzane17
dzane17 marked this pull request as ready for review May 27, 2026 15:39
@dzane17
dzane17 force-pushed the wlm-group-settings branch 2 times, most recently from eada788 to 6dc4362 Compare May 27, 2026 17:07
@KishoreKicha14

Copy link
Copy Markdown
Collaborator

@dzane17

  1. instead of having search.default_search_timeout as label. can we have it as text
  2. can we say enabled instead of set?
  3. if we have dont set what value does it settings point to?

@KishoreKicha14

Copy link
Copy Markdown
Collaborator

can you also fix the failing cypress tests?

@dzane17
dzane17 force-pushed the wlm-group-settings branch from 6dc4362 to 09adbb9 Compare May 27, 2026 21:01
Signed-off-by: David Zane <davizane@amazon.com>
@dzane17
dzane17 force-pushed the wlm-group-settings branch from 09adbb9 to d986bd5 Compare May 27, 2026 21:51
@dzane17

dzane17 commented May 27, 2026

Copy link
Copy Markdown
Member Author

@KishoreKicha14 Good points

  1. I am not sure that is necessary. The technical name is needed to associate the WLM setting with it's corresponding cluster setting and request param. And for understanding, each setting has a one-liner below.
  2. Done
  3. If the WLM group setting is not defined it will fall back to whatever cluster or request value was present before this feature. I have added a small explanation under this section header.

@KishoreKicha14 KishoreKicha14 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks @dzane17 for the PR..

@KishoreKicha14
KishoreKicha14 merged commit 0a23143 into opensearch-project:main Jun 1, 2026
12 checks passed
@dzane17
dzane17 deleted the wlm-group-settings branch June 1, 2026 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants