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

#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
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .changelog/23671.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:improvement
cli: Added synopsis for operator root and operator gossip command
```
10 changes: 10 additions & 0 deletions command/commands.go
Original file line number Diff line number Diff line change
Expand Up @@ -731,6 +731,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 @@ -819,6 +824,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
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 <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(_ []string) int {
return cli.RunResultHelp
}
31 changes: 31 additions & 0 deletions command/operator_root.go
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 <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(_ []string) int {
return cli.RunResultHelp
}