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

Doc & Example for External Match Syntax #155

Open
mej opened this issue Dec 20, 2024 · 0 comments
Open

Doc & Example for External Match Syntax #155

mej opened this issue Dec 20, 2024 · 0 comments
Assignees
Labels
documentation Fixes/enhancements to the docs enhancement usability Confusing, strange, misleading, or otherwise problematic UX
Milestone

Comments

@mej
Copy link
Owner

mej commented Dec 20, 2024

NHC's support for Match Strings is a powerful, extensible mechanism for determining exactly which checks will run on which hosts and under what conditions. The most obvious and prevalent way they are used is in the config file, specifying criteria for NHC to use in deciding which checks it should run. While the 3 built-in mstr types (glob, regex, range) are usually sufficient for making that decision based solely on hostname/nodename, there are use cases for using other criteria, like nodegroups, Slurm partitions or states, etc., a few of which exist at Los Alamos.

To that end, NHC supports a fourth mstr type called "external." External matching is extremely useful but non-obvious, as it allows (or requires, depending on how you look at it!) the end-user/admin to define basically everything about how it works. Unfortunately, the current documentation hardly mentions them at all, except in passing, and has no examples or relevant details at all!

I need to add a lot more information to the README.md file. I'd also like to provide one or two simple examples -- perhaps one nodegroup-based and one Slurm-/state-based -- that are copy-and-paste-ready for users and admins to use, specifically the production team here at LANL!

See also #135 and my reply

@mej mej added enhancement documentation Fixes/enhancements to the docs usability Confusing, strange, misleading, or otherwise problematic UX labels Dec 20, 2024
@mej mej added this to the 1.5 Release milestone Dec 20, 2024
@mej mej self-assigned this Dec 20, 2024
@github-project-automation github-project-automation bot moved this to Triage / TODO in NHC 1.5 Release Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Fixes/enhancements to the docs enhancement usability Confusing, strange, misleading, or otherwise problematic UX
Projects
Status: Triage / TODO
Development

No branches or pull requests

1 participant