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

Long help string for plan command contains an error #432

Closed
1 of 2 tasks
Comradin opened this issue Apr 14, 2024 · 0 comments · Fixed by #433
Closed
1 of 2 tasks

Long help string for plan command contains an error #432

Comradin opened this issue Apr 14, 2024 · 0 comments · Fixed by #433

Comments

@Comradin
Copy link
Contributor

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?

  • Yes
  • No
Comradin added a commit to Comradin/k3sup that referenced this issue Apr 14, 2024
Fix the given JSON in the long command help text and show a valid
JSON document.

resolves alexellis#432
Comradin added a commit to Comradin/k3sup that referenced this issue Apr 14, 2024
Fix the given JSON in the long command help text and show a valid
JSON document.

resolves alexellis#432

Signed-off-by: Marcus Franke <[email protected]>
alexellis pushed a commit that referenced this issue May 15, 2024
Fix the given JSON in the long command help text and show a valid
JSON document.

resolves #432

Signed-off-by: Marcus Franke <[email protected]>
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

Successfully merging a pull request may close this issue.

1 participant