// Copyright (c) HashiCorp, Inc. // SPDX-License-Identifier: MPL-2.0 package command import ( "fmt" "strings" "github.com/hashicorp/nomad/api/contexts" "github.com/posener/complete" ) type VolumeStatusCommand struct { Meta length int short bool verbose bool json bool template string } func (c *VolumeStatusCommand) Help() string { helpText := ` Usage: nomad volume status [options] Display status information about a CSI volume. If no volume id is given, a list of all volumes will be displayed. When ACLs are enabled, this command requires a token with the 'csi-read-volume' and 'csi-list-volumes' capability for the volume's namespace. General Options: ` + generalOptionsUsage(usageOptsDefault) + ` Status Options: -type List only volumes of type . -short Display short output. Used only when a single volume is being queried, and drops verbose information about allocations. -verbose Display full allocation information. -json Output the allocation in its JSON format. -t Format and display allocation using a Go template. ` return strings.TrimSpace(helpText) } func (c *VolumeStatusCommand) Synopsis() string { return "Display status information about a volume" } func (c *VolumeStatusCommand) AutocompleteFlags() complete.Flags { return mergeAutocompleteFlags(c.Meta.AutocompleteFlags(FlagSetClient), complete.Flags{ "-type": predictVolumeType, "-short": complete.PredictNothing, "-verbose": complete.PredictNothing, "-json": complete.PredictNothing, "-t": complete.PredictAnything, }) } func (c *VolumeStatusCommand) AutocompleteArgs() complete.Predictor { return complete.PredictFunc(func(a complete.Args) []string { client, err := c.Meta.Client() if err != nil { return nil } resp, _, err := client.Search().PrefixSearch(a.Last, contexts.Volumes, nil) if err != nil { return []string{} } return resp.Matches[contexts.Volumes] }) } func (c *VolumeStatusCommand) Name() string { return "volume status" } func (c *VolumeStatusCommand) Run(args []string) int { var typeArg string flags := c.Meta.FlagSet(c.Name(), FlagSetClient) flags.Usage = func() { c.Ui.Output(c.Help()) } flags.StringVar(&typeArg, "type", "", "") flags.BoolVar(&c.short, "short", false, "") flags.BoolVar(&c.verbose, "verbose", false, "") flags.BoolVar(&c.json, "json", false, "") flags.StringVar(&c.template, "t", "", "") if err := flags.Parse(args); err != nil { c.Ui.Error(fmt.Sprintf("Error parsing arguments %s", err)) return 1 } // Check that we either got no arguments or exactly one args = flags.Args() if len(args) > 1 { c.Ui.Error("This command takes either no arguments or one: ") c.Ui.Error(commandErrorText(c)) return 1 } // Truncate alloc and node IDs unless full length is requested c.length = shortId if c.verbose { c.length = fullId } // Get the HTTP client client, err := c.Meta.Client() if err != nil { c.Ui.Error(fmt.Sprintf("Error initializing client: %s", err)) return 1 } id := "" if len(args) == 1 { id = args[0] } code := c.csiStatus(client, id) if code != 0 { return code } // Extend this section with other volume implementations return 0 }