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

Improving documentation - best approach? #311

Open
tbtommyb opened this issue Jan 5, 2020 · 2 comments
Open

Improving documentation - best approach? #311

tbtommyb opened this issue Jan 5, 2020 · 2 comments

Comments

@tbtommyb
Copy link

tbtommyb commented Jan 5, 2020

Thanks very much for this tool. I've used it to successfully deploy a cluster. I did find that it required a lot of digging through issues to fix problems. Some things I spent a while figuring out:

  • default node size is too small for master.
  • integrating floating IPs (I ended up using fip-controller).
  • hetzner-csi addon works but nodes need to be in same data centre. Rook just fell over after a while for me.

Not to mention the important issues of firewalls and backups.

I'm happy to add documentation but I'm not sure of the best format. Some ideas:

  • Addon-specific READMEs. I'm concerned that they'll be hidden deep in the repo and missed by most people.
  • A detailed walkthrough explaining how to get a "batteries-included" cluster up-and-running.
  • More detailed information within the CLI tool explaining requirements/limitations of each addon.
@tbtommyb
Copy link
Author

I've written a blog post covering what I did to get a working cluster going. It may be useful for people trying to get a fairly standard setup (two workers, storage, ingress, TLS).

@wethinkagile
Copy link

wethinkagile commented Oct 19, 2020

Docs could need some improvement I agree with @tbtommyb
I am missing the cloud-config documentation, no idea how to resize workers, am I missing where a description of cloud-config is located?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants