mirror of
https://github.com/kemko/nomad.git
synced 2026-01-06 02:15: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>
87 lines
2.2 KiB
Plaintext
87 lines
2.2 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'nomad alloc checks command reference'
|
|
description: |
|
|
The `nomad alloc checks` command displays service health check status information for an allocation.
|
|
---
|
|
|
|
# `nomad alloc checks` command reference
|
|
|
|
|
|
The `alloc checks` command outputs the latest health check status information for checks in the allocation.
|
|
|
|
## Usage
|
|
|
|
```plaintext
|
|
nomad alloc checks [options] <allocation>
|
|
```
|
|
|
|
Outputs the latest health check status information for services in the allocation
|
|
using the Nomad service discovery provider. This command accepts an allocation
|
|
ID or prefix as the sole argument.
|
|
|
|
When ACLs are enabled, this command requires a token with the 'read-job' capability
|
|
for the allocation's namespace. The 'list-jobs' capability is required to run the
|
|
command with an allocation ID prefix instead of the exact allocation ID.
|
|
|
|
## Options
|
|
|
|
- `-verbose`: Display verbose output.
|
|
|
|
- `-json`: Output the allocation in its JSON format.
|
|
|
|
- `-t`: Format and display the health checks status using a Go template.
|
|
|
|
## Examples
|
|
|
|
Show checks of an alloc health check using its short ID:
|
|
|
|
```shell-session
|
|
$ nomad alloc checks e0fdbd85
|
|
|
|
Status of 1 Nomad Service Checks
|
|
|
|
ID = 9f4e18fd0867cebb19a8fac3d7a1cf27
|
|
Name = alive
|
|
Group = example.cache[0]
|
|
Task = (group)
|
|
Service = redis-cache
|
|
Status = success
|
|
Mode = healthiness
|
|
Timestamp = 2023-03-09T16:10:23+01:00
|
|
Output = nomad: tcp ok
|
|
```
|
|
|
|
The `-json` flag can be used to get the health checks status in json format:
|
|
|
|
```shell-session
|
|
nomad alloc checks -json 54fde4f8
|
|
|
|
{
|
|
"9810e90177a4c21ce3bfe04dc7da6131": {
|
|
"Check": "alive",
|
|
"Group": "example.cache[0]",
|
|
"ID": "9810e90177a4c21ce3bfe04dc7da6131",
|
|
"Mode": "healthiness",
|
|
"Output": "nomad: tcp ok",
|
|
"Service": "redis-cache",
|
|
"Status": "success",
|
|
"StatusCode": 0,
|
|
"Task": "",
|
|
"Timestamp": 1678444309
|
|
}
|
|
}
|
|
```
|
|
|
|
Or use the `-t` flag to format and display the health checks using a Go template:
|
|
|
|
```shell-session
|
|
$ nomad alloc checks -t '{{range .}}{{ printf "%s: %s\n" .ID .Status }}{{end}}' 54
|
|
|
|
9810e90177a4c21ce3bfe04dc7da6131: success
|
|
```
|
|
|
|
## General options
|
|
|
|
@include 'general_options.mdx'
|