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

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

Closed
Anish701 opened this issue Nov 8, 2024 · 0 comments · Fixed by #59
Closed

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

Anish701 opened this issue Nov 8, 2024 · 0 comments · Fixed by #59
Labels
documentation Improvements or additions to documentation

Comments

@Anish701
Copy link
Contributor

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, it would be helpful to mention that Autopilot runs the tests on nodes that match any of the specified parameters. In other words, Autopilot takes the set union rather than the set intersection.

Impact

Only the USAGE.md page will be updated. The following sentences will be added under the list of parameters:
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"

  • _What pages will need to be updated? USAGE.md
  • _Will there be broken links with these changes? No.
  • _Are there any images you're adding or external content that exists outside the repository? No.
@Anish701 Anish701 added the documentation Improvements or additions to documentation label Nov 8, 2024
Vezio pushed a commit that referenced this issue Nov 18, 2024
…ultiple node selection parameters in USAGE.md (#59)

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"


Signed-off-by: Anish Sinha <[email protected]>
@Vezio Vezio closed this as completed in #59 Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
1 participant