mirror of
https://github.com/kemko/nomad.git
synced 2026-01-07 10:55:42 +03:00
* 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>
77 lines
2.1 KiB
Plaintext
77 lines
2.1 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'nomad ui command reference'
|
|
description: |
|
|
The `nomad ui` command opens the Nomad Web UI. Provide a node, job, or allocation identifier to open that object's UI page in your browser. Authenticate with an access control list (ACL) token. Use the `show-url` flag to return the UI's URL.
|
|
---
|
|
|
|
# `nomad ui` command reference
|
|
|
|
The `ui` command is used to open the Nomad Web UI.
|
|
|
|
## Usage
|
|
|
|
```plaintext
|
|
nomad ui [options] <identifier>
|
|
```
|
|
|
|
The `ui` command can be called with no arguments, in which case the UI homepage
|
|
will be opened in the default browser.
|
|
|
|
An identifier may be provided, in which case the UI will be opened to view the
|
|
details for that object. Supported identifiers are jobs, allocations and nodes.
|
|
|
|
If ACLs are enabled, the web UI will start in an unauthenticated state and you
|
|
may see a 403 Unauthorized page if anonymous read access is denied. The `nomad ui -authenticate` option will exchange your command line client's Nomad ACL
|
|
token for a one-time token, which is passed to the web UI. That one-time token
|
|
will be exchanged for your Nomad ACL token and stored in the browser's local
|
|
storage for authentication.
|
|
|
|
## Options
|
|
|
|
- `-authenticate`: Exchange your Nomad ACL token for a one-time token in the
|
|
web UI.
|
|
|
|
- `-show-url`: Show the Nomad UI URL instead of opening with the default browser.
|
|
|
|
## Examples
|
|
|
|
Open the UI homepage:
|
|
|
|
```shell-session
|
|
$ nomad ui
|
|
Opening URL "http://127.0.0.1:4646"
|
|
```
|
|
|
|
Open the UI directly to look at a job:
|
|
|
|
```shell-session
|
|
$ nomad ui redis-job
|
|
http://127.0.0.1:4646/ui/jobs/redis-job
|
|
```
|
|
|
|
Open the UI directly to look at an allocation:
|
|
|
|
```shell-session
|
|
$ nomad ui d4005969
|
|
Opening URL "http://127.0.0.1:4646/ui/allocations/d4005969-b16f-10eb-4fe1-a5374986083d"
|
|
```
|
|
|
|
Open the UI and authenticate using your ACL token:
|
|
|
|
```shell-session
|
|
$ NOMAD_ACL_TOKEN=e9674b26-763b-4637-a28f-0df95c53cdda nomad ui -authenticate
|
|
Opening URL "http://127.0.0.1:4646" with token
|
|
```
|
|
|
|
Show the UI URL without opening the browser:
|
|
|
|
```shell-session
|
|
$ nomad ui -show-url
|
|
URL for web UI: http://127.0.0.1:4646
|
|
```
|
|
|
|
## General options
|
|
|
|
@include 'general_options.mdx'
|