alexellis / k3sup

bootstrap K3s over SSH in < 60s 🚀
https://github.com/sponsors/alexellis
Other
6.33k stars 376 forks source link

Long help string for plan command contains an error #432

Closed Comradin closed 6 months ago

Comradin commented 7 months ago

The Long command help for plan contains an error in the example of the json. It should be a slice with two nodes, but is a slice with one block that contains two nodes.

Why do you need this?

Just ran into this and saw it is kind of misleading.

Expected Behaviour

I think it should look like this:

[{
        "hostname": "node-1",
        "ip": "192.168.128.100",
},
{
        "hostname": "node-2",
        "ip": "192.168.128.101",
}]

This way it is clear we can have something like --servers 2 and get the installation command for two server nodes. Or have one server node and one worker with --servers 1.

Current Behaviour

The current example even isn't a valid json document, as it has two fiels with the same fieldnames.

Possible Solution

Like written in the expected behaviour block, it must be a slice with two elements.

Do you want to work on this?

Subject to design approval, are you willing to work on a Pull Request for this issue or feature request?