nomad icon indicating copy to clipboard operation
nomad copied to clipboard

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

Open jrasell opened this issue 1 year ago • 2 comments
trafficstars

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 avatar Jul 23 '24 13:07 jrasell

@jrasell can I work on this?

harisudarsan1 avatar Aug 06 '24 14:08 harisudarsan1

@harisudarsan1 you're welcome to open a PR.

tgross avatar Aug 06 '24 15:08 tgross

I'm going to lock this issue because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

github-actions[bot] avatar Feb 16 '25 02:02 github-actions[bot]