mirror of
https://github.com/kemko/nomad.git
synced 2026-01-04 01: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>
118 lines
3.4 KiB
Plaintext
118 lines
3.4 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'nomad alloc fs command reference'
|
|
description: |
|
|
The `nomad alloc fs` lets you navigate an allocation working directory on a Nomad client.
|
|
---
|
|
|
|
# `nomad alloc fs` command reference
|
|
|
|
**Alias: `nomad fs`**
|
|
|
|
The `alloc fs` command allows a user to navigate an [allocation working
|
|
directory] on a Nomad client. The following functionalities are available -
|
|
`cat`, `tail`, `ls` and `stat`.
|
|
|
|
- `cat`: If the target path is a file, Nomad will `cat` the file.
|
|
|
|
- `tail`: If the target path is a file and `-tail` flag is specified, Nomad will
|
|
`tail` the file.
|
|
|
|
- `ls`: If the target path is a directory, Nomad displays the name of a file and
|
|
directories and their associated information.
|
|
|
|
- `stat`: If the `-stat` flag is used, Nomad will display information about a
|
|
file.
|
|
|
|
## Usage
|
|
|
|
```plaintext
|
|
nomad alloc fs [options] <allocation> <path>
|
|
```
|
|
|
|
This command accepts a single allocation ID (unless the `-job` flag is
|
|
specified, in which case an allocation is chosen from the given job) and a
|
|
path. The path is optional and relative to the root of the [allocation working
|
|
directory].
|
|
|
|
When ACLs are enabled, this command requires a token with the `read-fs`,
|
|
`read-job`, and `list-jobs` capabilities for the allocation's namespace.
|
|
|
|
### Use Job ID instead of Allocation ID
|
|
|
|
Setting the `-job` flag causes a random allocation of the specified job to be
|
|
selected. Nomad prefers selecting a running allocation ID for the job, but
|
|
if no running allocations for the job are found, Nomad uses a dead
|
|
allocation.
|
|
|
|
```plaintext
|
|
nomad alloc fs -job <job-id> <path>
|
|
```
|
|
|
|
This can be useful for debugging a job that has multiple allocations, and it is
|
|
not required to observe a specific allocation.
|
|
|
|
## Options
|
|
|
|
- `-H`: Machine friendly output.
|
|
|
|
- `-verbose`: Display verbose output.
|
|
|
|
- `-job=<job-name|job-id>`: Use a random allocation from the specified job or
|
|
job ID prefix, preferring a running allocation.
|
|
|
|
- `-group=<group-name>`: Specifies the task group where the task is located
|
|
when a random allocation is selected
|
|
|
|
- `-stat`: Show stat information instead of displaying the file, or listing the
|
|
directory.
|
|
|
|
- `-f`: Causes the output to not stop when the end of the file is reached, but
|
|
rather to wait for additional output.
|
|
|
|
- `-tail`: Show the files contents with offsets relative to the end of the file.
|
|
If no offset is given, -n is defaulted to 10.
|
|
|
|
- `-n`: Sets the tail location in best effort number of lines relative to the
|
|
end of the file.
|
|
|
|
- `-c`: Sets the tail location in number of bytes relative to the end of the file.
|
|
|
|
## Examples
|
|
|
|
```shell-session
|
|
$ nomad alloc fs eb17e557
|
|
Mode Size Modified Time Name
|
|
drwxrwxr-x 4096 28 Jan 16 05:39 UTC alloc/
|
|
drwxrwxr-x 4096 28 Jan 16 05:39 UTC redis/
|
|
-rw-rw-r-- 0 28 Jan 16 05:39 UTC redis_exit_status
|
|
|
|
|
|
$ nomad alloc fs eb17e557 redis/local
|
|
Mode Size Modified Time Name
|
|
-rw-rw-rw- 0 28 Jan 16 05:39 UTC redis.stderr
|
|
-rw-rw-rw- 17 28 Jan 16 05:39 UTC redis.stdout
|
|
|
|
|
|
$ nomad alloc fs -stat eb17e557 redis/local/redis.stdout
|
|
Mode Size Modified Time Name
|
|
-rw-rw-rw- 17 28 Jan 16 05:39 UTC redis.stdout
|
|
|
|
|
|
$ nomad alloc fs eb17e557 redis/local/redis.stdout
|
|
foobar
|
|
baz
|
|
|
|
$ nomad alloc fs -tail -f -n 3 eb17e557 redis/local/redis.stdout
|
|
foobar
|
|
baz
|
|
bam
|
|
<blocking>
|
|
```
|
|
|
|
## General options
|
|
|
|
@include 'general_options.mdx'
|
|
|
|
[allocation working directory]: /nomad/docs/reference/runtime-environment-settings#task-directories 'Task Directories'
|