cli: add system command and subcmds to interact with system API. (#6924)

cli: add system command and subcmds to interact with system API.

command/commands.go

@@ -610,6 +610,26 @@ func Commands(metaPtr *Meta, agentUi cli.Ui) map[string]cli.CommandFactory {
 				Meta: meta,
 			}, nil
 		},
+		"system": func() (cli.Command, error) {
+			return &SystemCommand{
+				Meta: meta,
+			}, nil
+		},
+		"system gc": func() (cli.Command, error) {
+			return &SystemGCCommand{
+				Meta: meta,
+			}, nil
+		},
+		"system reconcile": func() (cli.Command, error) {
+			return &SystemReconcileCommand{
+				Meta: meta,
+			}, nil
+		},
+		"system reconcile summaries": func() (cli.Command, error) {
+			return &SystemReconcileSummariesCommand{
+				Meta: meta,
+			}, nil
+		},
 		"ui": func() (cli.Command, error) {
 			return &UiCommand{
 				Meta: meta,

command/system.go

@@ -0,0 +1,35 @@
+package command
+
+import (
+	"strings"
+
+	"github.com/mitchellh/cli"
+)
+
+type SystemCommand struct {
+	Meta
+}
+
+func (sc *SystemCommand) Help() string {
+	helpText := `
+Usage: nomad system <subcommand> [options]
+
+  This command groups subcommands for interacting with the system API. Users
+  can perform system maintenance tasks such as trigger the garbage collector or
+  perform job summary reconciliation.
+
+  Please see the individual subcommand help for detailed usage information.
+`
+
+	return strings.TrimSpace(helpText)
+}
+
+func (sc *SystemCommand) Synopsis() string {
+	return "Interact with the system API"
+}
+
+func (sc *SystemCommand) Name() string { return "system" }
+
+func (sc *SystemCommand) Run(args []string) int {
+	return cli.RunResultHelp
+}

command/system_gc.go

@@ -0,0 +1,54 @@
+package command
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/posener/complete"
+)
+
+type SystemGCCommand struct {
+	Meta
+}
+
+func (c *SystemGCCommand) Help() string {
+	helpText := `
+Usage: nomad system gc [options]
+
+  Initializes a garbage collection of jobs, evaluations, allocations, and nodes.
+
+General Options:
+
+  ` + generalOptionsUsage()
+	return strings.TrimSpace(helpText)
+}
+
+func (c *SystemGCCommand) Synopsis() string {
+	return "Run the system garbage collection process"
+}
+
+func (c *SystemGCCommand) AutocompleteFlags() complete.Flags {
+	return c.Meta.AutocompleteFlags(FlagSetClient)
+}
+
+func (c *SystemGCCommand) AutocompleteArgs() complete.Predictor {
+	return complete.PredictNothing
+}
+
+func (c *SystemGCCommand) Name() string { return "system gc" }
+
+func (c *SystemGCCommand) Run(args []string) int {
+
+	// Get the HTTP client
+	client, err := c.Meta.Client()
+	if err != nil {
+		c.Ui.Error(fmt.Sprintf("Error initializing client: %s", err))
+		return 1
+	}
+
+	if err := client.System().GarbageCollect(); err != nil {
+		c.Ui.Error(fmt.Sprintf("Error running system garbage-collection: %s", err))
+		return 1
+	}
+	return 0
+}

command/system_gc_test.go

@@ -0,0 +1,27 @@
+package command
+
+import (
+	"testing"
+
+	"github.com/mitchellh/cli"
+)
+
+func TestSystemGCCommand_Implements(t *testing.T) {
+	t.Parallel()
+	var _ cli.Command = &SystemGCCommand{}
+}
+
+func TestSystemGCCommand_Good(t *testing.T) {
+	t.Parallel()
+
+	// Create a server
+	srv, _, url := testServer(t, true, nil)
+	defer srv.Shutdown()
+
+	ui := new(cli.MockUi)
+	cmd := &SystemGCCommand{Meta: Meta{Ui: ui, flagAddress: url}}
+
+	if code := cmd.Run([]string{"-address=" + url}); code != 0 {
+		t.Fatalf("expected exit 0, got: %d; %v", code, ui.ErrorWriter.String())
+	}
+}

command/system_reconcile.go

@@ -0,0 +1,37 @@
+package command
+
+import (
+	"strings"
+
+	"github.com/mitchellh/cli"
+)
+
+type SystemReconcileCommand struct {
+	Meta
+}
+
+func (s *SystemReconcileCommand) Help() string {
+	helpText := `
+Usage: nomad system reconcile <subcommand> [options]
+
+  This command groups subcommands for interacting with the system reconcile API.
+
+  Reconcile the summaries of all registered jobs:
+
+      $ nomad system reconcile summaries
+
+  Please see the individual subcommand help for detailed usage information.
+`
+
+	return strings.TrimSpace(helpText)
+}
+
+func (s *SystemReconcileCommand) Synopsis() string {
+	return "Perform system reconciliation tasks"
+}
+
+func (s *SystemReconcileCommand) Name() string { return "system reconcile" }
+
+func (s *SystemReconcileCommand) Run(args []string) int {
+	return cli.RunResultHelp
+}

command/system_reconcile_summaries.go

@@ -0,0 +1,54 @@
+package command
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/posener/complete"
+)
+
+type SystemReconcileSummariesCommand struct {
+	Meta
+}
+
+func (c *SystemReconcileSummariesCommand) Help() string {
+	helpText := `
+Usage: nomad system reconcile summaries [options]
+
+  Reconciles the summaries of all registered jobs.
+
+General Options:
+
+  ` + generalOptionsUsage()
+	return strings.TrimSpace(helpText)
+}
+
+func (c *SystemReconcileSummariesCommand) Synopsis() string {
+	return "Reconciles the summaries of all registered jobs"
+}
+
+func (c *SystemReconcileSummariesCommand) AutocompleteFlags() complete.Flags {
+	return c.Meta.AutocompleteFlags(FlagSetClient)
+}
+
+func (c *SystemReconcileSummariesCommand) AutocompleteArgs() complete.Predictor {
+	return complete.PredictNothing
+}
+
+func (c *SystemReconcileSummariesCommand) Name() string { return "system reconcile summaries" }
+
+func (c *SystemReconcileSummariesCommand) Run(args []string) int {
+
+	// Get the HTTP client
+	client, err := c.Meta.Client()
+	if err != nil {
+		c.Ui.Error(fmt.Sprintf("Error initializing client: %s", err))
+		return 1
+	}
+
+	if err := client.System().ReconcileSummaries(); err != nil {
+		c.Ui.Error(fmt.Sprintf("Error running system summary reconciliation: %s", err))
+		return 1
+	}
+	return 0
+}

command/system_reconcile_summaries_test.go

@@ -0,0 +1,27 @@
+package command
+
+import (
+	"testing"
+
+	"github.com/mitchellh/cli"
+)
+
+func TestSystemReconcileSummariesCommand_Implements(t *testing.T) {
+	t.Parallel()
+	var _ cli.Command = &SystemReconcileSummariesCommand{}
+}
+
+func TestSystemReconcileSummariesCommand_Good(t *testing.T) {
+	t.Parallel()
+
+	// Create a server
+	srv, _, url := testServer(t, true, nil)
+	defer srv.Shutdown()
+
+	ui := new(cli.MockUi)
+	cmd := &SystemReconcileSummariesCommand{Meta: Meta{Ui: ui, flagAddress: url}}
+
+	if code := cmd.Run([]string{"-address=" + url}); code != 0 {
+		t.Fatalf("expected exit 0, got: %d; %v", code, ui.ErrorWriter.String())
+	}
+}

command/system_reconcile_test.go

@@ -0,0 +1,12 @@
+package command
+
+import (
+	"testing"
+
+	"github.com/mitchellh/cli"
+)
+
+func TestSystemReconcileCommand_Implements(t *testing.T) {
+	t.Parallel()
+	var _ cli.Command = &SystemCommand{}
+}

command/system_test.go

@@ -0,0 +1,12 @@
+package command
+
+import (
+	"testing"
+
+	"github.com/mitchellh/cli"
+)
+
+func TestSystemCommand_Implements(t *testing.T) {
+	t.Parallel()
+	var _ cli.Command = &SystemCommand{}
+}

website/source/docs/commands/system.html.md

@@ -0,0 +1,25 @@
+---
+layout: "docs"
+page_title: "Commands: system"
+sidebar_current: "docs-commands-system"
+description: >
+  The system command is used to interact with the system API.
+---
+
+# Command: system
+
+The `system` command is used to interact with the system API. These calls are
+used for system maintenance and should not be necessary for most users.
+
+## Usage
+
+Usage: `nomad system <subcommand> [options]`
+
+Run `nomad system <subcommand> -h` for help on that subcommand. The following
+subcommands are available:
+
+- [`system gc`][gc] - Run the system garbage collection process
+- [`system reconcile summaries`][reconcile-summaries] - Reconciles the summaries of all registered jobs
+
+[gc]: /docs/commands/system/gc.html "Run the system garbage collection process"
+[reconcile-summaries]: /docs/commands/system/reconcile-summaries.html "Reconciles the summaries of all registered jobs"

website/source/docs/commands/system/gc.html.md.erb

@@ -0,0 +1,30 @@
+---
+layout: "docs"
+page_title: "Commands: system gc"
+sidebar_current: "docs-commands-system-gc"
+description: >
+  Run the system garbage collection process.
+---
+
+# Command: system gc
+
+Initializes a garbage collection of jobs, evaluations, allocations, and nodes.
+This is an asynchronous operation.
+
+## Usage
+
+```plaintext
+nomad system gc [options]
+```
+
+## General Options
+
+<%= partial "docs/commands/_general_options" %>
+
+## Examples
+
+Running the system gc command does not output unless an error occurs:
+
+```shell
+$ nomad system gc
+```

website/source/docs/commands/system/reconcile-summaries.html.md.erb

@@ -0,0 +1,30 @@
+---
+layout: "docs"
+page_title: "Commands: system reconcile summaries"
+sidebar_current: "docs-commands-system-reconcile-summaries"
+description: >
+  Reconciles the summaries of all registered jobs.
+---
+
+# Command: system reconcile summaries
+
+Reconciles the summaries of all registered jobs.
+
+## Usage
+
+```plaintext
+nomad system reconcile summaries [options]
+```
+
+## General Options
+
+<%= partial "docs/commands/_general_options" %>
+
+## Examples
+
+Running the system reconcile summaries command does not output unless an error
+occurs:
+
+```shell
+$ nomad system reconcile summaries
+```

website/source/layouts/docs.erb

@@ -351,6 +351,17 @@
           <li<%= sidebar_current("docs-commands-status") %>>
             <a href="/docs/commands/status.html">status</a>
           </li>
+          <li<%= sidebar_current("docs-commands-system") %>>
+            <a href="/docs/commands/system.html">system</a>
+            <ul class="nav">
+              <li<%= sidebar_current("docs-commands-system-gc") %>>
+                <a href="/docs/commands/system/gc.html">gc</a>
+              </li>
+              <li<%= sidebar_current("docs-commands-system-reconcile-summaries") %>>
+                <a href="/docs/commands/system/reconcile-summaries.html">reconcile summaries</a>
+              </li>
+            </ul>
+          </li>
           <li<%= sidebar_current("docs-commands-ui") %>>
             <a href="/docs/commands/ui.html">ui</a>
           </li>