Updating the `node-images.md` doc

Sayanta66 commented 6 months ago

The goal is to update the node-image doc with relevant technical information from a user's POV.

Tasks to be covered:

Tasks I can cover myself:

Introduction to Node-image and what it does.
Point out its relevance to CAPH.

Tasks I need help from the core technical team:

If a user comes up and asks that I want another image apart from Ubuntu 22.04, what are the steps required so that he gets his flavour of the image with CAPH?
- A user wants the image that’s already present on hetzner
  - For example fedora-39, how will the workflow look like in this case? How will kubeadm commands change in this case? Tell the user how to use dnf-based commands.
- A user wants an image that’s not present on hetzner
  - How can a user build an image with Packer and upload it to hetzner and use the same machine image?
  - An example script is given but the user needs to build his/her own scripts as per the operating system.

Scope of the above tasks

Need live demos of the process that can be recorded instantly or recorded videos of the demos.
Available resources like docs or videos related to the docs that can help with the writing.

Note: Anyone from @kranurag7 @batistein @guettli @janiskemper can help with the above tasks.

janiskemper commented 6 months ago

@guettli can you give your input on this matter? Whatever format you can is appreciated!

guettli commented 6 months ago

@Sayanta66

Need live demos of the process that can be recorded instantly or recorded videos of the demos.

I would avoid that now. First it is a lot of work, and second a video can't be easily updated in the long run. Changing text is much easier.

A video makes sense to present a general overview of what caph is, but these details are better handled with written docs (my point of view).

guettli commented 4 weeks ago

If we improve the docs here, I would add a note: Maintaining machine images is a lot of effort. If you just want to modify the base image a bit, you can use KubeadmConfig.PreKubeadmCommands to run some code before kubeadm initializes the node.

syself / cluster-api-provider-hetzner