mirror of
https://github.com/kemko/nomad.git
synced 2026-01-03 08:55:43 +03:00
53b083b8c5
* Move commands from docs to its own root-level directory * temporarily use modified dev-portal branch with nomad ia changes * explicitly clone nomad ia exp branch * retrigger build, fixed dev-portal broken build * architecture, concepts and get started individual pages * fix get started section destinations * reference section * update repo comment in website-build.sh to show branch * docs nav file update capitalization * update capitalization to force deploy * remove nomad-vs-kubernetes dir; move content to what is nomad pg * job section * Nomad operations category, deploy section * operations category, govern section * operations - manage * operations/scale; concepts scheduling fix * networking * monitor * secure section * remote auth-methods folder and move up pages to sso; linkcheck * Fix install2deploy redirects * fix architecture redirects * Job section: Add missing section index pages * Add section index pages so breadcrumbs build correctly * concepts/index fix front matter indentation * move task driver plugin config to new deploy section * Finish adding full URL to tutorials links in nav * change SSO to Authentication in nav and file system * Docs NomadIA: Move tutorials into NomadIA branch (#26132) * Move governance and policy from tutorials to docs * Move tutorials content to job-declare section * run jobs section * stateful workloads * advanced job scheduling * deploy section * manage section * monitor section * secure/acl and secure/authorization * fix example that contains an unseal key in real format * remove images from sso-vault * secure/traffic * secure/workload-identities * vault-acl change unseal key and root token in command output sample * remove lines from sample output * fix front matter * move nomad pack tutorials to tools * search/replace /nomad/tutorials links * update acl overview with content from deleted architecture/acl * fix spelling mistake * linkcheck - fix broken links * fix link to Nomad variables tutorial * fix link to Prometheus tutorial * move who uses Nomad to use cases page; move spec/config shortcuts add dividers * Move Consul out of Integrations; move namespaces to govern * move integrations/vault to secure/vault; delete integrations * move ref arch to docs; rename Deploy Nomad back to Install Nomad * address feedback * linkcheck fixes * Fixed raw_exec redirect * add info from /nomad/tutorials/manage-jobs/jobs * update page content with newer tutorial * link updates for architecture sub-folders * Add redirects for removed section index pages. Fix links. * fix broken links from linkcheck * Revert to use dev-portal main branch instead of nomadIA branch * build workaround: add intro-nav-data.json with single entry * fix content-check error * add intro directory to get around Vercel build error * workound for emtpry directory * remove mdx from /intro/ to fix content-check and git snafu * Add intro index.mdx so Vercel build should work --------- Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
75 lines
2.2 KiB
Plaintext
75 lines
2.2 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'nomad alloc pause command reference'
|
|
description: |
|
|
The `nomad alloc pause` command overrides the schedule for tasks using time-based execution, forcing the task to either stop or run.
|
|
---
|
|
|
|
# `nomad alloc pause` command reference
|
|
|
|
Override the schedule for tasks using time based execution.
|
|
|
|
<EnterpriseAlert />
|
|
|
|
~> **Note:** Time based task execution is an experimental feature and subject
|
|
to change. This feature is supported for select customers. Please refer to the
|
|
[Upgrade Guide][upgrade] to find breaking changes.
|
|
|
|
## Usage
|
|
|
|
```plaintext
|
|
nomad alloc pause [options] <allocation> <command>
|
|
```
|
|
|
|
The `alloc pause` command allows a user to override the schedule for tasks
|
|
that use time based execution. A user may override a task's
|
|
[`schedule`][schedule] and force it to run or stop. The `schedule` will be
|
|
ignored until a user resets the override.
|
|
|
|
When ACLs are enabled, this command requires the `job-submit` capability for
|
|
the allocation's namespace.
|
|
|
|
## Options
|
|
|
|
- `-state`: Override the current scheduled task state to be the specified state
|
|
or reset to the scheduled state. Must be one of `pause`, `run`, or
|
|
`scheduled`. When set to `pause` the task is halted. When set to `run` the
|
|
task is started. When set to `scheduled` the task respects its
|
|
[`schedule`][schedule].
|
|
|
|
- `-status`: Get the current time based task execution state.
|
|
|
|
- `-task`: Override the schedule of the specified task. May also be specified
|
|
as a positional argument.
|
|
|
|
- `-verbose`: Show full information.
|
|
|
|
## Examples
|
|
|
|
The following command stops the `schedtask` task of the allocation `4d37a9d1`
|
|
overriding the task's [`schedule`][schedule] block:
|
|
|
|
```shell-session
|
|
$ nomad alloc pause -state=pause 4d37a9d1 schedtask
|
|
```
|
|
|
|
The following command runs the task overriding the tasks current state or
|
|
schedule:
|
|
|
|
```shell-session
|
|
$ nomad alloc pause -state=pause 4d37a9d1 schedtask
|
|
```
|
|
|
|
The following command returns the task to its [`schedule`][schedule]:
|
|
|
|
```shell-session
|
|
$ nomad alloc pause -state=scheduled 4d37a9d1 schedtask
|
|
```
|
|
|
|
## General options
|
|
|
|
@include 'general_options.mdx'
|
|
|
|
[schedule]: /nomad/docs/job-specification/schedule
|
|
[upgrade]: /nomad/docs/upgrade/upgrade-specific
|