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

CLI: "operator root" and "operator gossip" commands are missing command file #23671

Closed
jrasell opened this issue Jul 23, 2024 · 2 comments · Fixed by #23855
Closed

CLI: "operator root" and "operator gossip" commands are missing command file #23671

jrasell opened this issue Jul 23, 2024 · 2 comments · Fixed by #23855
Labels
good first issue stage/accepted Confirmed, and intend to work on. No timeline committment though. theme/cli type/bug

Comments

@jrasell
Copy link
Member

jrasell commented Jul 23, 2024

When running the nomad operator -h command, the gossip and root sections are missing their synopsis comment. This is because each of these subcommands does not have a command file, which includes this information. We should add both files with the relevant detail, so the command help output is complete.

$ nomad operator -h
Usage: nomad operator <subcommand> [options]

  Provides cluster-level tools for Nomad operators, such as interacting with
  the Raft subsystem. NOTE: Use this command with extreme caution, as improper
  use could lead to a Nomad outage and even loss of data.

  Please see the individual subcommand help for detailed usage information.

Subcommands:
    api             Query Nomad's HTTP API
    autopilot       Provides tools for modifying Autopilot configuration
    client-state    Dump the nomad client state
    debug           Build a debug archive
    gossip
    metrics         Retrieve Nomad metrics
    raft            Provides access to the Raft subsystem
    root
    scheduler       Provides access to the scheduler configuration
    snapshot        Saves and inspects snapshots of Nomad server state
@jrasell jrasell added type/bug theme/cli good first issue stage/accepted Confirmed, and intend to work on. No timeline committment though. labels Jul 23, 2024
@jrasell jrasell moved this from Needs Triage to Needs Roadmapping in Nomad - Community Issues Triage Jul 23, 2024
@harisudarsan1
Copy link

@jrasell can I work on this?

@tgross
Copy link
Member

tgross commented Aug 6, 2024

@harisudarsan1 you're welcome to open a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue stage/accepted Confirmed, and intend to work on. No timeline committment though. theme/cli type/bug
Projects
Development

Successfully merging a pull request may close this issue.

3 participants