Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add docs for nomad-alloc-restart #5565

Merged
merged 1 commit into from
Apr 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions website/source/docs/commands/alloc.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ 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 status`][status] - Display allocation status information and metadata

[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/status.html "Display allocation status information and metadata"
42 changes: 42 additions & 0 deletions website/source/docs/commands/alloc/restart.html.md.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
layout: "docs"
page_title: "Commands: alloc restart"
sidebar_current: "docs-commands-alloc-restart"
description: >
Restart a running allocation or task
---

# Command: alloc restart

The `alloc restart` command allows a user to perform an in place restart of an
an entire allocation or individual task.

## Usage

```
nomad alloc stop [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 restarted.

## General Options

<%= partial "docs/commands/_general_options" %>

## Restart Options

* `-verbose`: Display verbose output.

## Examples

```
$ nomad alloc restart eb17e557

$ nomad alloc restart eb17e557 foo
Could not find task named: foo, found:
* test
<blocking>
```

3 changes: 3 additions & 0 deletions website/source/layouts/docs.erb
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,9 @@
<li<%= sidebar_current("docs-commands-alloc-logs") %>>
<a href="/docs/commands/alloc/logs.html">logs</a>
</li>
<li<%= sidebar_current("docs-commands-alloc-restart") %>>
<a href="/docs/commands/alloc/restart.html">restart</a>
</li>
<li<%= sidebar_current("docs-commands-alloc-status") %>>
<a href="/docs/commands/alloc/status.html">status</a>
</li>
Expand Down