e0beda704a
This PR adds the command documentations and has small CLI fixes.
137 lines
3.5 KiB
Go
137 lines
3.5 KiB
Go
package command
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/hashicorp/nomad/api"
|
|
flaghelper "github.com/hashicorp/nomad/helper/flag-helpers"
|
|
)
|
|
|
|
type JobPromoteCommand struct {
|
|
Meta
|
|
}
|
|
|
|
func (c *JobPromoteCommand) Help() string {
|
|
helpText := `
|
|
Usage: nomad job promote [options] <job id>
|
|
|
|
Promote is used to promote task groups in the most recent deployment for the
|
|
given job. Promotion should occur when the deployment has placed canaries for a
|
|
task group and those canaries have been deemed healthy. When a task group is
|
|
promoted, the rolling upgrade of the remaining allocations is unblocked. If the
|
|
canaries are found to be unhealthy, the deployment may either be failed using
|
|
the "nomad deployment fail" command, the job can be failed forward by submitting
|
|
a new version or failed backwards by reverting to an older version using the
|
|
"nomad job revert" command.
|
|
|
|
General Options:
|
|
|
|
` + generalOptionsUsage() + `
|
|
|
|
Promote Options:
|
|
|
|
-group
|
|
Group may be specified many times and is used to promote that particular
|
|
group. If no specific groups are specified, all groups are promoted.
|
|
|
|
-detach
|
|
Return immediately instead of entering monitor mode. After deployment
|
|
resume, the evaluation ID will be printed to the screen, which can be used
|
|
to examine the evaluation using the eval-status command.
|
|
|
|
-verbose
|
|
Display full information.
|
|
`
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *JobPromoteCommand) Synopsis() string {
|
|
return "Promote a job's canaries"
|
|
}
|
|
|
|
func (c *JobPromoteCommand) Run(args []string) int {
|
|
var detach, verbose bool
|
|
var groups []string
|
|
|
|
flags := c.Meta.FlagSet("job promote", FlagSetClient)
|
|
flags.Usage = func() { c.Ui.Output(c.Help()) }
|
|
flags.BoolVar(&detach, "detach", false, "")
|
|
flags.BoolVar(&verbose, "verbose", false, "")
|
|
flags.Var((*flaghelper.StringFlag)(&groups), "group", "")
|
|
|
|
if err := flags.Parse(args); err != nil {
|
|
return 1
|
|
}
|
|
|
|
// Check that we got no arguments
|
|
args = flags.Args()
|
|
if l := len(args); l != 1 {
|
|
c.Ui.Error(c.Help())
|
|
return 1
|
|
}
|
|
|
|
// Truncate the id unless full length is requested
|
|
length := shortId
|
|
if verbose {
|
|
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
|
|
}
|
|
|
|
// Check if the job exists
|
|
jobID := args[0]
|
|
jobs, _, err := client.Jobs().PrefixList(jobID)
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error promoting job: %s", err))
|
|
return 1
|
|
}
|
|
if len(jobs) == 0 {
|
|
c.Ui.Error(fmt.Sprintf("No job(s) with prefix or id %q found", jobID))
|
|
return 1
|
|
}
|
|
if len(jobs) > 1 && strings.TrimSpace(jobID) != jobs[0].ID {
|
|
c.Ui.Error(fmt.Sprintf("Prefix matched multiple jobs\n\n%s", createStatusListOutput(jobs)))
|
|
return 1
|
|
}
|
|
jobID = jobs[0].ID
|
|
|
|
// Do a prefix lookup
|
|
deploy, _, err := client.Jobs().LatestDeployment(jobID, nil)
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error retrieving deployment: %s", err))
|
|
return 1
|
|
}
|
|
|
|
if deploy == nil {
|
|
c.Ui.Error(fmt.Sprintf("Job %q has no deployment to promote", jobID))
|
|
return 1
|
|
}
|
|
|
|
var u *api.DeploymentUpdateResponse
|
|
if len(groups) == 0 {
|
|
u, _, err = client.Deployments().PromoteAll(deploy.ID, nil)
|
|
} else {
|
|
u, _, err = client.Deployments().PromoteGroups(deploy.ID, groups, nil)
|
|
}
|
|
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error promoting deployment %q for job %q: %s", deploy.ID, jobID, err))
|
|
return 1
|
|
}
|
|
|
|
// Nothing to do
|
|
evalCreated := u.EvalID != ""
|
|
if detach || !evalCreated {
|
|
return 0
|
|
}
|
|
|
|
mon := newMonitor(c.Ui, client, length)
|
|
return mon.monitor(u.EvalID, false)
|
|
}
|