Skip to content

Commit

Permalink
#23671 Added synopsis for operator root and operator gossip command. (#…
Browse files Browse the repository at this point in the history
…23855)

Co-authored-by: James Rasell <[email protected]>
  • Loading branch information
raj-hegde and jrasell authored Oct 18, 2024
1 parent 1f9b92f commit 42eacc8
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 0 deletions.
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
33 changes: 33 additions & 0 deletions command/operator_gossip.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1

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
}
34 changes: 34 additions & 0 deletions command/operator_root.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1

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 root" }

func (f *OperatorRootCommand) Run(_ []string) int {
return cli.RunResultHelp
}

0 comments on commit 42eacc8

Please sign in to comment.