Files
nomad/website/content/docs/commands/alloc/index.mdx
Juana De La Cuesta 712c669657 cli: add -json and -t flag for alloc checks command (#16405)
* cli: add -json flag to alloc checks for completion

* CLI: Expand test to include testing the json flag for allocation checks

* Documentation: Add the checks command

* Documentation: Add example for alloc check command

* Update website/content/docs/commands/alloc/checks.mdx

Co-authored-by: James Rasell <jrasell@users.noreply.github.com>

* CLI: Add template flag to alloc checks command

* Update website/content/docs/commands/alloc/checks.mdx

Co-authored-by: James Rasell <jrasell@users.noreply.github.com>

* CLI: Extend test to include -t flag for alloc checks

* func: add changelog for added flags to alloc checks

* cli[doc]: Make usage section on alloc checks clearer

* Update website/content/docs/commands/alloc/checks.mdx

Co-authored-by: James Rasell <jrasell@users.noreply.github.com>

* Delete modd.conf

* cli[doc]: add -t flag to command description for alloc checks

---------

Co-authored-by: James Rasell <jrasell@users.noreply.github.com>
Co-authored-by: Juanita De La Cuesta Morales <juanita.delacuestamorales@juanita.delacuestamorales-LHQ7X0QG9X>
2023-03-10 16:58:53 +01:00

36 lines
1.5 KiB
Plaintext

---
layout: docs
page_title: 'Commands: alloc'
description: |
The alloc command is used to interact with allocations.
---
# Command: alloc
The `alloc` command is used to interact with allocations.
## Usage
Usage: `nomad alloc <subcommand> [options]`
Run `nomad alloc <subcommand> -h` for help on that subcommand. The following
subcommands are available:
- [`alloc checks`][checks] - Outputs service health check status information.
- [`alloc exec`][exec] - Run a command in a running allocation
- [`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
[checks]: /nomad/docs/commands/alloc/checks 'Outputs service health check status information'
[exec]: /nomad/docs/commands/alloc/exec 'Run a command in a running allocation'
[fs]: /nomad/docs/commands/alloc/fs 'Inspect the contents of an allocation directory'
[logs]: /nomad/docs/commands/alloc/logs 'Streams the logs of a task'
[restart]: /nomad/docs/commands/alloc/restart 'Restart a running allocation or task'
[signal]: /nomad/docs/commands/alloc/signal 'Signal a running allocation'
[status]: /nomad/docs/commands/alloc/status 'Display allocation status information and metadata'
[stop]: /nomad/docs/commands/alloc/stop 'Stop and reschedule a running allocation'