mirror of
https://github.com/kemko/nomad.git
synced 2026-01-06 10:25:42 +03:00
docs: Add nomad alloc signal docs
This commit is contained in:
@@ -20,11 +20,13 @@ subcommands are available:
|
||||
* [`alloc fs`][fs] - Inspect the contents of an allocation directory
|
||||
* [`alloc logs`][logs] - Streams the logs of a task
|
||||
* [`alloc restart`][restart] - Restart a running allocation or task
|
||||
* [`alloc signal`][signal] - Signal a running allocation
|
||||
* [`alloc status`][status] - Display allocation status information and metadata
|
||||
* [`alloc stop`][stop] - Stop and reschedule a running allocation
|
||||
|
||||
[fs]: /docs/commands/alloc/fs.html "Inspect the contents of an allocation directory"
|
||||
[logs]: /docs/commands/alloc/logs.html "Streams the logs of a task"
|
||||
[restart]: /docs/commands/alloc/restart.html "Restart a running allocation or task"
|
||||
[status]: /docs/commands/alloc/signal.html "Signal a running allocation"
|
||||
[status]: /docs/commands/alloc/status.html "Display allocation status information and metadata"
|
||||
[stop]: /docs/commands/alloc/stop.html "Stop and reschedule a running allocation"
|
||||
|
||||
44
website/source/docs/commands/alloc/signal.html.md.erb
Normal file
44
website/source/docs/commands/alloc/signal.html.md.erb
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
layout: "docs"
|
||||
page_title: "Commands: alloc signal"
|
||||
sidebar_current: "docs-commands-alloc-signal"
|
||||
description: >
|
||||
Signal a running allocation or task
|
||||
---
|
||||
|
||||
# Command: alloc signal
|
||||
|
||||
The `alloc signal` command allows a user to perform an in place signal of an
|
||||
an entire allocation or individual task.
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
nomad alloc signal [options] <allocation> <task>
|
||||
```
|
||||
|
||||
This command accepts a single allocation ID and a task name. The task name must
|
||||
be part of the allocation and the task must be currently running. The task name
|
||||
is optional and if omitted every task in the allocation will be signaled.
|
||||
|
||||
## General Options
|
||||
|
||||
<%= partial "docs/commands/_general_options" %>
|
||||
|
||||
## Signal Options
|
||||
|
||||
* `-s`: Signal to send to the tasks. Valid options depend on the driver.
|
||||
|
||||
* `-verbose`: Display verbose output.
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ nomad alloc signal eb17e557
|
||||
|
||||
$ nomad alloc signal eb17e557 foo
|
||||
Could not find task named: foo, found:
|
||||
* test
|
||||
<blocking>
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user