mirror of
https://github.com/kemko/nomad.git
synced 2026-01-01 16:05:42 +03:00
b09c1146a9
Several commands that inspect objects where the names are user-controlled share a bug where the user cannot inspect the object if it has a name that is an exact prefix of the name of another object (in the same namespace, where applicable). For example, the object "test" can't be inspected if there's an object with the name "testing". Copy existing logic we have for jobs, node pools, etc. to the impacted commands: * `plugin status` * `quota inspect` * `quota status` * `scaling policy info` * `service info` * `volume deregister` * `volume detach` * `volume status` If we get multiple objects for the prefix query, we check if any of them are an exact match and use that object instead of returning an error. Where possible because the prefix query signatures are the same, use a generic function that can be shared across multiple commands. Fixes: https://github.com/hashicorp/nomad/issues/13920 Fixes: https://github.com/hashicorp/nomad/issues/17132 Fixes: https://github.com/hashicorp/nomad/issues/23236 Ref: https://hashicorp.atlassian.net/browse/NET-10054 Ref: https://hashicorp.atlassian.net/browse/NET-10055
143 lines
3.0 KiB
Go
143 lines
3.0 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package command
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/hashicorp/nomad/api"
|
|
"github.com/posener/complete"
|
|
)
|
|
|
|
type QuotaInspectCommand struct {
|
|
Meta
|
|
}
|
|
|
|
type inspectedQuota struct {
|
|
Spec *api.QuotaSpec
|
|
Usages map[string]*api.QuotaUsage
|
|
Failures map[string]string `json:"UsageLookupErrors"`
|
|
}
|
|
|
|
func (c *QuotaInspectCommand) Help() string {
|
|
helpText := `
|
|
Usage: nomad quota inspect [options] <quota>
|
|
|
|
Inspect is used to view raw information about a particular quota.
|
|
|
|
If ACLs are enabled, this command requires a token with the 'quota:read'
|
|
capability and access to any namespaces that the quota is applied to.
|
|
|
|
General Options:
|
|
|
|
` + generalOptionsUsage(usageOptsDefault) + `
|
|
|
|
Inspect Options:
|
|
|
|
-json
|
|
Output the latest quota information in a JSON format.
|
|
|
|
-t
|
|
Format and display quota information using a Go template.
|
|
`
|
|
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *QuotaInspectCommand) AutocompleteFlags() complete.Flags {
|
|
return mergeAutocompleteFlags(c.Meta.AutocompleteFlags(FlagSetClient),
|
|
complete.Flags{
|
|
"-t": complete.PredictAnything,
|
|
"-json": complete.PredictNothing,
|
|
})
|
|
}
|
|
|
|
func (c *QuotaInspectCommand) AutocompleteArgs() complete.Predictor {
|
|
return QuotaPredictor(c.Meta.Client)
|
|
}
|
|
|
|
func (c *QuotaInspectCommand) Synopsis() string {
|
|
return "Inspect a quota specification"
|
|
}
|
|
|
|
func (c *QuotaInspectCommand) Name() string { return "quota inspect" }
|
|
|
|
func (c *QuotaInspectCommand) Run(args []string) int {
|
|
var json bool
|
|
var tmpl string
|
|
flags := c.Meta.FlagSet(c.Name(), FlagSetClient)
|
|
flags.Usage = func() { c.Ui.Output(c.Help()) }
|
|
flags.BoolVar(&json, "json", false, "")
|
|
flags.StringVar(&tmpl, "t", "", "")
|
|
|
|
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: <quota>")
|
|
c.Ui.Error(commandErrorText(c))
|
|
return 1
|
|
}
|
|
|
|
name := 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
|
|
}
|
|
|
|
quotas := client.Quotas()
|
|
spec, possible, err := getQuotaByPrefix(quotas, name)
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error retrieving quota: %s", err))
|
|
return 1
|
|
}
|
|
|
|
if len(possible) != 0 {
|
|
c.Ui.Error(fmt.Sprintf("Prefix matched multiple quotas\n\n%s", formatQuotaSpecs(possible)))
|
|
return 1
|
|
}
|
|
|
|
if json || len(tmpl) > 0 {
|
|
out, err := Format(json, tmpl, spec)
|
|
if err != nil {
|
|
c.Ui.Error(err.Error())
|
|
return 1
|
|
}
|
|
|
|
c.Ui.Output(out)
|
|
return 0
|
|
}
|
|
|
|
// Get the quota usages
|
|
usages, failures := quotaUsages(spec, quotas)
|
|
|
|
failuresConverted := make(map[string]string, len(failures))
|
|
for r, e := range failures {
|
|
failuresConverted[r] = e.Error()
|
|
}
|
|
|
|
data := &inspectedQuota{
|
|
Spec: spec,
|
|
Usages: usages,
|
|
Failures: failuresConverted,
|
|
}
|
|
|
|
ftr := JSONFormat{}
|
|
out, err := ftr.TransformData(data)
|
|
if err != nil {
|
|
c.Ui.Error(err.Error())
|
|
return 1
|
|
}
|
|
|
|
c.Ui.Output(out)
|
|
return 0
|
|
}
|