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

Address Documentation Issue #57: Include clarification on selecting multiple node selection parameters in USAGE.md #59

Merged
merged 1 commit into from
Nov 18, 2024

Conversation

Anish701
Copy link
Contributor

@Anish701 Anish701 commented Nov 8, 2024

Summary

USAGE.md mentions how tests can be configured using a combination of parameters. The host, job, and nodelabel parameters all involve node selection. To clarify behavior when multiple node selection parameters are used together, I mentioned that Autopilot runs the tests on nodes that match any of the specified parameters (set union rather than set intersection).

I specifically added the following sentences under the parameters list in USAGE.md: Note that if multiple node selection parameters (host, job, nodelabel) are provided together, Autopilot will run tests on nodes that match any of the specified parameters (set union). For example, the following command will run the pciebw test on all nodes that either have the label label1 OR are running the job jobKey=job2 because both nodelabel and job parameters are provided in the input:

curl "http://<route-name>/status?check=pciebw&nodelabel=label1&job=default:jobKey=job2"

GitHub Issue

closes #57 - [Documentation] Clarification on node selection parameters in USAGE.md

@Anish701 Anish701 changed the title Update USAGE.md to include clarification on node selection parameters Address Documentation Issue #57: Include clarification on selecting multiple node selection parameters in USAGE.md Nov 8, 2024
Copy link
Collaborator

@cmisale cmisale left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks for the suggestion

@Vezio Vezio merged commit 9618968 into IBM:main Nov 18, 2024
1 check passed
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.

[Documentation] Clarification on node selection parameters in USAGE.md
3 participants