search

gubernator-io / gubernator

High Performance Rate Limiting MicroService and Library - Developed at Mailgun
Apache License 2.0
67 stars 6 forks source link

Can haz help? #23

Open dimaqq opened 2 weeks ago

dimaqq commented 2 weeks ago 
> go run cmd/gubernator/main.go --help
INFO[0000] Gubernator dev-build (amd64/darwin)
ERRO[0000] while parsing flags: flag: help requested     category=gubernator
exit status 1

In fact, I've only discovered --debug by looking at the source code.

Perhaps not having help is the whole point, that it works out of the box and the defaults are what everyone should use...

In that case, options and config file content (?) really needs to be prominently documented.

For context, I need to disable workers, or limit workers to 1, because I'm planning to scale the cluster using k8s primitives, i.e. spin up more pods. Today I can't figure out how to do that, except by reading the source code.

thrawn01 commented 1 week ago

I'll add --help as an option in v3. Since the workers are going away in v3, It probably won't be useful to document them... unless people plan on staying on v2 for a while. Thoughts?

dimaqq commented 1 week ago

Maybe it’s worth noting somewhere that workers are going away… somehow I missed that.