#23671 Added synopsis for operator root and operator gossip command. #23855
Conversation
|
|
|
Please give feedback if I did anything wrong. |
There was a problem hiding this comment.
Hi @raj-hegde and thank you very much for raising this PR. I have added some minor suggestions for you to look at. Once these are resolved, I will get this PR merged.
Also, if you could add a changelog entry via the make cl command, that would be awesome.
command/operator_gossip.go
Outdated
| Usage: nomad operator gossip [options] | ||
|
|
||
| This command is accessed by using one of the subcommands below. | ||
| ` |
There was a problem hiding this comment.
When running the command locally, the output format seemed slightly off. The whitespace suggestion fixes that and the change to the usage keeps more consistency with other commands and correctly shows subcommand expectation.
| Usage: nomad operator gossip [options] | |
| This command is accessed by using one of the subcommands below. | |
| ` | |
| Usage: nomad operator gossip <subcommand> [options] [args] | |
| This command is accessed by using one of the subcommands below. | |
| ` |
command/operator_gossip.go
Outdated
|
|
||
| func (f *OperatorGossipCommand) Name() string { return "operator gossip" } | ||
|
|
||
| func (f *OperatorGossipCommand) Run(args []string) int { |
There was a problem hiding this comment.
The args function parameter is unused, so we can use an underscore to show this is ignored.
| func (f *OperatorGossipCommand) Run(args []string) int { | |
| func (f *OperatorGossipCommand) Run(_ []string) int { |
command/operator_root.go
Outdated
| Usage: nomad operator root [options] | ||
|
|
||
| This command is accessed by using one of the subcommands below. | ||
| ` |
There was a problem hiding this comment.
When running the command locally, the output format seemed slightly off. The whitespace suggestion fixes that and the change to the usage keeps more consistency with other commands and correctly shows subcommand expectation.
| Usage: nomad operator root [options] | |
| This command is accessed by using one of the subcommands below. | |
| ` | |
| Usage: nomad operator root <subcommand> [options] [args] | |
| This command is accessed by using one of the subcommands below. | |
| ` |
command/operator_root.go
Outdated
|
|
||
| func (f *OperatorRootCommand) Name() string { return "operator gossip" } | ||
|
|
||
| func (f *OperatorRootCommand) Run(args []string) int { |
There was a problem hiding this comment.
The args function parameter is unused, so we can use an underscore to show this is ignored.
| func (f *OperatorRootCommand) Run(args []string) int { | |
| func (f *OperatorRootCommand) Run(_ []string) int { |
| return "Provides access to root encryption keys" | ||
| } | ||
|
|
||
| func (f *OperatorRootCommand) Name() string { return "operator gossip" } |
There was a problem hiding this comment.
I think this may have been a copy/paste error :D
| func (f *OperatorRootCommand) Name() string { return "operator gossip" } | |
| func (f *OperatorRootCommand) Name() string { return "operator root" } |
jrasell
added
backport/ent/1.6.x+ent
|
Hi @jrasell, Thanks for the feedback I'll work on it right away. |
|
Hi @jrasell removed white spaces keeping consistency with other commands and changed the args function operator to underscore. Also made a changlelog entry. Any feedback is greatly appreciated. |
Synopsis comment for both gossip and root section has been added. Added the respective command files for each of the subcommands.
closes #14881
closes #23671