search

suse-edge / suse-edge.github.io

SUSE Edge collaborative space
https://suse-edge.github.io/
Apache License 2.0
4 stars 22 forks source link

[doc] Issue in "Installing cluster API dependencies" #217

Closed peteingithub closed 2 weeks ago

peteingithub commented 3 weeks ago

Installing cluster API dependencies:

https://suse-edge.github.io/quickstart-metal3.html#id-installing-cluster-api-dependencies

Why do we use a hidden directory `~/.cluster-api for CAPI manifest?

Does clusterctl need the directory for something runtime?

hardys commented 3 weeks ago

@peteingithub yes the ~/.cluster-api/clusterctl.yaml is the configuration file consumed by clusterctl - we configure it to use the downstream SUSE images, without this it'll pull the upstream images which we do not test/support.

hardys commented 3 weeks ago

Let me know if you think any additional clarification is needed to the docs or if this can be closed, thanks!

peteingithub commented 3 weeks ago

I did not spot this configuration file in the CAPI docs, so that's the reason I asked.

If the configuration file would only be used once, then it is OK to close. If it would be needed multiple times (and could be run from multiple machines), then it might require a note or something.

hardys commented 3 weeks ago

The configuration file is documented in the clusterctl docs https://cluster-api.sigs.k8s.io/clusterctl/configuration - perhaps I can link to those and explain why it's needed

peteingithub commented 2 weeks ago

OK, I was confused for the directory being hidden under user's home directory ~/.cluster-api while the clusterctl docs state it residing in $XDG_CONFIG_HOME, which is missing in our management cluster, and path then defaulting to $HOME/.config. But it seems the EIB docs state the path as command line parameter pointing to /home/metal3/clusterctl.yml.