luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity
open-nomad/website/content/docs/commands/job/stop.mdx

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

130 lines
4.4 KiB
Plaintext
Raw Normal View History

website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
---
new website :sparkles:
2020-02-06 23:45:31 +00:00
layout: docs
page_title: 'Commands: job stop'
description: |
nested command docs
2018-03-22 17:56:06 +00:00
The job stop command is used to stop a running job.
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
---
nested command docs
2018-03-22 17:56:06 +00:00
# Command: job stop
Fixup for command section of website * changed list indicator from * -> - * moved in-text links to reference links * made commands `plaintext` * made command examples `console` * rewrapped text
2019-10-22 13:44:00 +00:00
aliases
2018-03-22 18:09:26 +00:00
**Alias: `nomad stop`**
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
nested command docs
2018-03-22 17:56:06 +00:00
The `job stop` command is used to stop a running job and signals the scheduler
Sweep of docs for repeated words; minor edits (#14032)
2022-08-05 20:45:30 +00:00
to cancel all the running allocations.
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
## Usage
Fixup for command section of website * changed list indicator from * -> - * moved in-text links to reference links * made commands `plaintext` * made command examples `console` * rewrapped text
2019-10-22 13:44:00 +00:00
```plaintext
command/job_stop: accept multiple jobs, stop concurrently (#12582) * command/job_stop: accept multiple jobs, stop concurrently Signed-off-by: danishprakash <grafitykoncept@gmail.com> * command/job_stop_test: add test for multiple job stops Signed-off-by: danishprakash <grafitykoncept@gmail.com> * improve output, add changelog and docs Signed-off-by: danishprakash <grafitykoncept@gmail.com> Co-authored-by: Michael Schurter <mschurter@hashicorp.com>
2022-12-16 23:46:58 +00:00
nomad job stop [options] <job 1> <job 2> ... <job N>
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
```
command/job_stop: accept multiple jobs, stop concurrently (#12582) * command/job_stop: accept multiple jobs, stop concurrently Signed-off-by: danishprakash <grafitykoncept@gmail.com> * command/job_stop_test: add test for multiple job stops Signed-off-by: danishprakash <grafitykoncept@gmail.com> * improve output, add changelog and docs Signed-off-by: danishprakash <grafitykoncept@gmail.com> Co-authored-by: Michael Schurter <mschurter@hashicorp.com>
2022-12-16 23:46:58 +00:00
The `job stop` command requires at least one job ID or prefix to stop. If there
is an exact match based on the provided job ID or prefix, then the job will be
cancelled. Otherwise, a list of matching jobs and information will be
displayed.
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
command/job_stop: accept multiple jobs, stop concurrently (#12582) * command/job_stop: accept multiple jobs, stop concurrently Signed-off-by: danishprakash <grafitykoncept@gmail.com> * command/job_stop_test: add test for multiple job stops Signed-off-by: danishprakash <grafitykoncept@gmail.com> * improve output, add changelog and docs Signed-off-by: danishprakash <grafitykoncept@gmail.com> Co-authored-by: Michael Schurter <mschurter@hashicorp.com>
2022-12-16 23:46:58 +00:00
Stop will issue a request to deregister the matched jobs and then invoke an
Fixes to stop command
2016-11-04 22:25:12 +00:00
interactive monitor that exits automatically once the scheduler has processed
command/job_stop: accept multiple jobs, stop concurrently (#12582) * command/job_stop: accept multiple jobs, stop concurrently Signed-off-by: danishprakash <grafitykoncept@gmail.com> * command/job_stop_test: add test for multiple job stops Signed-off-by: danishprakash <grafitykoncept@gmail.com> * improve output, add changelog and docs Signed-off-by: danishprakash <grafitykoncept@gmail.com> Co-authored-by: Michael Schurter <mschurter@hashicorp.com>
2022-12-16 23:46:58 +00:00
the requests. It is safe to exit the monitor early using ctrl+c.
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
cli: remove hard requirement on `list-jobs` (#16380) Most job subcommands allow for job ID prefix match as a convenience functionality so users don't have to type the full job ID. But this introduces a hard ACL requirement that the token used to run these commands have the `list-jobs` permission, even if the token has enough permission to execute the basic command action and the user passed an exact job ID. This change softens this requirement by not failing the prefix match in case the request results in a permission denied error and instead using the information passed by the user directly.
2023-03-09 20:00:04 +00:00
When ACLs are enabled, this command requires a token with the `submit-job`
and `read-job` capabilities for the job's namespace. The `list-jobs`
capability is required to run the command with job prefixes instead of exact
job IDs.
docs: describe required ACLs for all commands
2020-11-19 21:38:08 +00:00
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
## General Options
new website :sparkles:
2020-02-06 23:45:31 +00:00
@include 'general_options.mdx'
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
## Stop Options
Fixup for command section of website * changed list indicator from * -> - * moved in-text links to reference links * made commands `plaintext` * made command examples `console` * rewrapped text
2019-10-22 13:44:00 +00:00
- `-detach`: Return immediately instead of entering monitor mode. After the
eval-status website docs
2016-05-26 01:52:14 +00:00
deregister command is submitted, a new evaluation ID is printed to the screen,
Fixup for command section of website * changed list indicator from * -> - * moved in-text links to reference links * made commands `plaintext` * made command examples `console` * rewrapped text
2019-10-22 13:44:00 +00:00
which can be used to examine the evaluation using the [eval status] command.
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
core: allow setting and propagation of eval priority on job de/registration (#11532) This change modifies the Nomad job register and deregister RPCs to accept an updated option set which includes eval priority. This param is optional and override the use of the job priority to set the eval priority. In order to ensure all evaluations as a result of the request use the same eval priority, the priority is shared to the allocReconciler and deploymentWatcher. This creates a new distinction between eval priority and job priority. The Nomad agent HTTP API has been modified to allow setting the eval priority on job update and delete. To keep consistency with the current v1 API, job update accepts this as a payload param; job delete accepts this as a query param. Any user supplied value is validated within the agent HTTP handler removing the need to pass invalid requests to the server. The register and deregister opts functions now all for setting the eval priority on requests. The change includes a small change to the DeregisterOpts function which handles nil opts. This brings the function inline with the RegisterOpts.
2021-11-23 08:23:31 +00:00
- `-eval-priority`: Override the priority of the evaluations produced as a result
of this job deregistration. By default, this is set to the priority of the job.
Fixup for command section of website * changed list indicator from * -> - * moved in-text links to reference links * made commands `plaintext` * made command examples `console` * rewrapped text
2019-10-22 13:44:00 +00:00
- `-verbose`: Show full information.
Update website documentation
2016-01-19 23:01:26 +00:00
Fixup for command section of website * changed list indicator from * -> - * moved in-text links to reference links * made commands `plaintext` * made command examples `console` * rewrapped text
2019-10-22 13:44:00 +00:00
- `-yes`: Automatic yes to prompts.
Fixes to stop command
2016-11-04 22:25:12 +00:00
Fixup for command section of website * changed list indicator from * -> - * moved in-text links to reference links * made commands `plaintext` * made command examples `console` * rewrapped text
2019-10-22 13:44:00 +00:00
- `-purge`: Purge is used to stop the job and purge it from the system. If not
new website :sparkles:
2020-02-06 23:45:31 +00:00
set, the job will still be queryable and will be purged by the garbage
collector.
non-purge deregisters
2017-04-15 03:54:30 +00:00
multiregion: job stop across regions with -global flag (#8258) Adds a `-global` flag for stopping multiregion jobs in all regions at once. Warn the user if they attempt to stop a multiregion job in a single region.
2020-06-23 19:56:04 +00:00
- `-global`
Format docs website code and mdx
2020-09-30 13:48:40 +00:00
Stop a [multi-region] job in all its regions. By default, `job stop` will
stop only a single region at a time. Ignored for single-region jobs.
multiregion: job stop across regions with -global flag (#8258) Adds a `-global` flag for stopping multiregion jobs in all regions at once. Warn the user if they attempt to stop a multiregion job in a single region.
2020-06-23 19:56:04 +00:00
provide `-no-shutdown-delay` flag for job/alloc stop (#11596) Some operators use very long group/task `shutdown_delay` settings to safely drain network connections to their workloads after service deregistration. But during incident response, they may want to cause that drain to be skipped so they can quickly shed load. Provide a `-no-shutdown-delay` flag on the `nomad alloc stop` and `nomad job stop` commands that bypasses the delay. This sets a new desired transition state on the affected allocations that the allocation/task runner will identify during pre-kill on the client. Note (as documented here) that using this flag will almost always result in failed inbound network connections for workloads as the tasks will exit before clients receive updated service discovery information and won't be gracefully drained.
2021-12-13 19:54:53 +00:00
- `-no-shutdown-delay`
Sweep of docs for repeated words; minor edits (#14032)
2022-08-05 20:45:30 +00:00
Ignore the group and task [`shutdown_delay`] configuration so that
provide `-no-shutdown-delay` flag for job/alloc stop (#11596) Some operators use very long group/task `shutdown_delay` settings to safely drain network connections to their workloads after service deregistration. But during incident response, they may want to cause that drain to be skipped so they can quickly shed load. Provide a `-no-shutdown-delay` flag on the `nomad alloc stop` and `nomad job stop` commands that bypasses the delay. This sets a new desired transition state on the affected allocations that the allocation/task runner will identify during pre-kill on the client. Note (as documented here) that using this flag will almost always result in failed inbound network connections for workloads as the tasks will exit before clients receive updated service discovery information and won't be gracefully drained.
2021-12-13 19:54:53 +00:00
there is no delay between service deregistration and task
shutdown. Note that using this flag will result in failed network
connections to the allocations being stopped.
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
## Examples
website: update run/stop commands
2015-09-21 19:05:48 +00:00
Stop the job with ID "job1":
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
fix shell-session snippet error
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad job stop job1
Update website documentation
2016-01-19 23:01:26 +00:00
==> Monitoring evaluation "43bfe672"
website: update run/stop commands
2015-09-21 19:05:48 +00:00
Evaluation status changed: "pending" -> "complete"
Update website documentation
2016-01-19 23:01:26 +00:00
==> Evaluation "43bfe672" finished with status "complete"
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
```
command/job_stop: accept multiple jobs, stop concurrently (#12582) * command/job_stop: accept multiple jobs, stop concurrently Signed-off-by: danishprakash <grafitykoncept@gmail.com> * command/job_stop_test: add test for multiple job stops Signed-off-by: danishprakash <grafitykoncept@gmail.com> * improve output, add changelog and docs Signed-off-by: danishprakash <grafitykoncept@gmail.com> Co-authored-by: Michael Schurter <mschurter@hashicorp.com>
2022-12-16 23:46:58 +00:00
Stop multiple jobs:
```shell-session
$ nomad job stop job1 job2
==> 2022-12-16T15:19:28-08:00: Monitoring evaluation "166c39c5"
==> 2022-12-16T15:19:28-08:00: Monitoring evaluation "049404c2"
2022-12-16T15:19:28-08:00: Evaluation triggered by job "job1"
2022-12-16T15:19:28-08:00: Evaluation triggered by job "job2"
2022-12-16T15:19:28-08:00: Evaluation within deployment: "90885ce7"
2022-12-16T15:19:28-08:00: Evaluation status changed: "pending" -> "complete"
==> 2022-12-16T15:19:28-08:00: Evaluation "166c39c5" finished with status "complete"
==> 2022-12-16T15:19:28-08:00: Monitoring deployment "90885ce7"
✓ Deployment "90885ce7" successful
2022-12-16T15:19:28-08:00
ID = 90885ce7
Job ID = job1
Job Version = 0
Status = successful
Description = Deployment completed successfully
Deployed
Task Group Desired Placed Healthy Unhealthy Progress Deadline
example 1 1 1 0 2022-12-16T15:29:03-08:00
==> 2022-12-16T15:19:29-08:00: Monitoring evaluation "049404c2"
2022-12-16T15:19:29-08:00: Evaluation within deployment: "a13df8f8"
2022-12-16T15:19:29-08:00: Evaluation status changed: "pending" -> "complete"
==> 2022-12-16T15:19:29-08:00: Evaluation "049404c2" finished with status "complete"
==> 2022-12-16T15:19:29-08:00: Monitoring deployment "a13df8f8"
✓ Deployment "a13df8f8" successful
2022-12-16T15:19:29-08:00
ID = a13df8f8
Job ID = job2
Job Version = 0
Status = successful
Description = Deployment completed successfully
Deployed
Task Group Desired Placed Healthy Unhealthy Progress Deadline
example2 1 1 1 0 2022-12-16T15:29:16-08:00
```
website: update run/stop commands
2015-09-21 19:05:48 +00:00
Stop the job with ID "job1" and return immediately:
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
fix shell-session snippet error
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad job stop -detach job1
Update website documentation
2016-01-19 23:01:26 +00:00
507d26cb
website: document run, stop, eval-monitor
2015-09-18 06:39:31 +00:00
```
Fixup for command section of website * changed list indicator from * -> - * moved in-text links to reference links * made commands `plaintext` * made command examples `console` * rewrapped text
2019-10-22 13:44:00 +00:00
docs: Migrate link formats (#15779) * Adding check-legacy-links-format workflow * Adding test-link-rewrites workflow * chore: updates link checker workflow hash * Migrating links to new format Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 17:31:14 +00:00
[eval status]: /nomad/docs/commands/eval/status
[multi-region]: /nomad/docs/job-specification/multiregion
[`shutdown_delay`]: /nomad/docs/job-specification/group#shutdown_delay
Reference in a new issue Copy permalink