hetzner-kube
hetzner-kube copied to clipboard
Improving documentation - best approach?
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.
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).
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?