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.

Sign up for GitHub

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

Jump to bottom

#23671 Added synopsis for operator root and operator gossip command. #23855

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

#23671 Added synopsis for operator root and operator gossip command. #23855

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e1cbb96
Added synopsis for operator root and operator gossip command
raj-hegde Aug 22, 2024
8681eb2
Merge branch 'hashicorp:main' into main
raj-hegde Sep 13, 2024
eb31ad1
Merge branch 'hashicorp:main' into main
raj-hegde Sep 28, 2024
b07f8b6
Merge branch 'hashicorp:main' into main
raj-hegde Oct 4, 2024
158531f
Removed Whitespaces for root and gossip command keeping consistency w…
raj-hegde Oct 5, 2024
26d94b5
Changelog entry for PR 23671
raj-hegde Oct 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions command/commands.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -716,6 +716,11 @@ func Commands(metaPtr *Meta, agentUi cli.Ui) map[string]cli.CommandFactory {
Meta: meta,
}, nil
},
"operator gossip": func() (cli.Command, error) {
return &OperatorGossipCommand{
Meta: meta,
}, nil
},
"operator gossip keyring": func() (cli.Command, error) {
return &OperatorGossipKeyringCommand{
Meta: meta,
Expand Down Expand Up @@ -804,6 +809,11 @@ func Commands(metaPtr *Meta, agentUi cli.Ui) map[string]cli.CommandFactory {
Meta: meta,
}, nil
},
"operator root": func() (cli.Command, error) {
return &OperatorRootCommand{
Meta: meta,
}, nil
},
"operator root keyring": func() (cli.Command, error) {
return &OperatorRootKeyringCommand{
Meta: meta,
Expand Down
30 changes: 30 additions & 0 deletions command/operator_gossip.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package command

import (
"strings"

"github.com/mitchellh/cli"
)

type OperatorGossipCommand struct {
Meta
}

func (*OperatorGossipCommand) Help() string {
helpText := `
Usage: nomad operator gossip [options]

This command is accessed by using one of the subcommands below.
`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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.
`

return strings.TrimSpace(helpText)
}

func (*OperatorGossipCommand) Synopsis() string {
return "Provides access to the Gossip protocol"
}

func (f *OperatorGossipCommand) Name() string { return "operator gossip" }

func (f *OperatorGossipCommand) Run(args []string) int {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The args function parameter is unused, so we can use an underscore to show this is ignored.

Suggested change
func (f *OperatorGossipCommand) Run(args []string) int {
func (f *OperatorGossipCommand) Run(_ []string) int {

return cli.RunResultHelp
}
31 changes: 31 additions & 0 deletions command/operator_root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package command

import (
"strings"

"github.com/mitchellh/cli"
)

type OperatorRootCommand struct {
Meta
}

func (*OperatorRootCommand) Help() string {
helpText := `
Usage: nomad operator root [options]

This command is accessed by using one of the subcommands below.
`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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.
`


return strings.TrimSpace(helpText)
}

func (*OperatorRootCommand) Synopsis() string {
return "Provides access to root encryption keys"
}

func (f *OperatorRootCommand) Name() string { return "operator gossip" }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this may have been a copy/paste error :D

Suggested change
func (f *OperatorRootCommand) Name() string { return "operator gossip" }
func (f *OperatorRootCommand) Name() string { return "operator root" }


func (f *OperatorRootCommand) Run(args []string) int {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The args function parameter is unused, so we can use an underscore to show this is ignored.

Suggested change
func (f *OperatorRootCommand) Run(args []string) int {
func (f *OperatorRootCommand) Run(_ []string) int {

return cli.RunResultHelp
}