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

Can haz help? #23

Open
dimaqq opened this issue Jun 24, 2024 · 2 comments
Open

Can haz help? #23

dimaqq opened this issue Jun 24, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@dimaqq
Copy link
Contributor

dimaqq commented Jun 24, 2024

> 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
Copy link
Collaborator

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
Copy link
Contributor Author

dimaqq commented Jun 30, 2024

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

@thrawn01 thrawn01 self-assigned this Jul 26, 2024
@thrawn01 thrawn01 added this to the V3 milestone Jul 26, 2024
@thrawn01 thrawn01 added the documentation Improvements or additions to documentation label Oct 7, 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
Development

No branches or pull requests

2 participants