open-nomad/command/var_purge.go
Tim Gross 357e7f4521
docs: include path in ACL requirements for variables (#14561)
Also add links to the ACL policy reference and variables concepts docs near the
top of the page.
2022-09-13 10:21:29 -04:00

122 lines
2.8 KiB
Go

package command
import (
"errors"
"fmt"
"strconv"
"strings"
"github.com/mitchellh/cli"
"github.com/posener/complete"
)
type VarPurgeCommand struct {
Meta
}
func (c *VarPurgeCommand) Help() string {
helpText := `
Usage: nomad var purge [options] <path>
Purge is used to permanently delete an existing variable.
If ACLs are enabled, this command requires a token with the 'variables:destroy'
capability for the target variable's namespace and path.
General Options:
` + generalOptionsUsage(usageOptsDefault) + `
Purge Options:
-check-index
If set, the variable is only acted upon if the server side version's modify
index matches the provided value.
`
return strings.TrimSpace(helpText)
}
func (c *VarPurgeCommand) AutocompleteFlags() complete.Flags {
return c.Meta.AutocompleteFlags(FlagSetClient)
}
func (c *VarPurgeCommand) AutocompleteArgs() complete.Predictor {
return VariablePathPredictor(c.Meta.Client)
}
func (c *VarPurgeCommand) Synopsis() string {
return "Purge a variable"
}
func (c *VarPurgeCommand) Name() string { return "var purge" }
func (c *VarPurgeCommand) Run(args []string) int {
var checkIndexStr string
flags := c.Meta.FlagSet(c.Name(), FlagSetClient)
flags.Usage = func() { c.Ui.Output(c.Help()) }
flags.StringVar(&checkIndexStr, "check-index", "", "")
if err := flags.Parse(args); err != nil {
return 1
}
// Check that we got one argument
args = flags.Args()
if l := len(args); l != 1 {
c.Ui.Error("This command takes one argument: <path>")
c.Ui.Error(commandErrorText(c))
return 1
}
// Parse the check-index
checkIndex, enforce, err := parseCheckIndex(checkIndexStr)
if err != nil {
switch {
case errors.Is(err, strconv.ErrRange):
c.Ui.Error(fmt.Sprintf("Invalid -check-index value %q: out of range for uint64", checkIndexStr))
case errors.Is(err, strconv.ErrSyntax):
c.Ui.Error(fmt.Sprintf("Invalid -check-index value %q: not parsable as uint64", checkIndexStr))
default:
c.Ui.Error(fmt.Sprintf("Error parsing -check-index value %q: %v", checkIndexStr, err))
}
return 1
}
if c.Meta.namespace == "*" {
c.Ui.Error(errWildcardNamespaceNotAllowed)
return 1
}
path := args[0]
// 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 enforce {
_, err = client.Variables().CheckedDelete(path, checkIndex, nil)
} else {
_, err = client.Variables().Delete(path, nil)
}
if err != nil {
if handled := handleCASError(err, c); handled {
return 1
}
c.Ui.Error(fmt.Sprintf("Error purging variable: %s", err))
return 1
}
c.Ui.Output(fmt.Sprintf("Successfully purged variable %q!", path))
return 0
}
func (c *VarPurgeCommand) GetConcurrentUI() cli.ConcurrentUi {
return cli.ConcurrentUi{Ui: c.Ui}
}