Document templating language
cool-RR opened this issue · 5 comments
Cloudprober has some kind of templating language in its configuration. I couldn't figure out what language is that. Didn't find it on the readme or in the docs. It needs to be document because people need to know exactly what they can do with this language, and how.
Reading the code now, I see it's Go templates. This is probably obvious for Go programmers, but it should be noted in the readme or docs. (I never worked with the Go template language before.)
@cool-RR Thanks for filing this. Most folks are not even aware of the templating capabilities of cloudprober configs.
Here is some documentation on available config macros in cloudprober (with examples):
https://pkg.go.dev/github.com/google/cloudprober/config
(Can you please use 'enhancement' label for documentation issues in future. We reserve 'bug' label for functionality bugs -- bugs that folks using cloudprober should be aware of.)
Thank you! Will do.
Another thing that needs to be documented here: Which variables are automatically available to us. I know that I can use .region, but do I automatically get .zone? I have to try to find out. Would be nice if I just had a list of all the variables that are available to me.
@cool-RR, Please see the announcement here: #679. Active development of this repository will move to github.com/cloudprober/cloudprober. Unfortunately, we'll have to close all the issues here, and file them again.