2017-09-16 19:05:01 +00:00
|
|
|
---
|
|
|
|
|
layout: "intro"
|
2018-06-22 20:44:39 +00:00
|
|
|
page_title: "Web UI"
|
2017-09-16 19:05:01 +00:00
|
|
|
sidebar_current: "getting-started-ui"
|
|
|
|
|
description: |-
|
|
|
|
|
Visit the Nomad Web UI to inspect jobs, allocations, and more.
|
|
|
|
|
---
|
|
|
|
|
|
2018-06-22 20:44:39 +00:00
|
|
|
# Web UI
|
2017-09-16 19:05:01 +00:00
|
|
|
|
|
|
|
|
At this point we have a fully functioning cluster with a job running in it. We have
|
|
|
|
|
learned how to inspect a job using `nomad status`, next we'll learn how to inspect
|
|
|
|
|
a job in the web client.
|
|
|
|
|
|
|
|
|
|
## Opening the Web UI
|
|
|
|
|
|
|
|
|
|
As long as Nomad is running, the Nomad UI is also running. It is hosted at the same address
|
|
|
|
|
and port as the Nomad HTTP API under the `/ui` namespace.
|
|
|
|
|
|
2018-10-08 18:42:33 +00:00
|
|
|
With Nomad running, visit `http://localhost:4646` to open the Nomad UI.
|
2017-09-16 19:05:01 +00:00
|
|
|
|
2017-09-16 19:52:53 +00:00
|
|
|
[![Nomad UI Jobs List][img-jobs-list]][img-jobs-list]
|
|
|
|
|
|
2017-11-01 19:01:54 +00:00
|
|
|
If you can't connect it's possible that Vagrant was unable to properly map the
|
|
|
|
|
port from your host to the VM. Your `vagrant up` output will contain the new
|
|
|
|
|
port mapping:
|
|
|
|
|
|
|
|
|
|
```text
|
|
|
|
|
==> default: Fixed port collision for 4646 => 4646. Now on port 2200.
|
|
|
|
|
```
|
|
|
|
|
|
2018-10-08 18:42:33 +00:00
|
|
|
In the case above you would connect to `http://localhost:2200` instead.
|
2017-11-01 19:01:54 +00:00
|
|
|
|
2017-09-16 19:05:01 +00:00
|
|
|
## Inspecting a Job
|
|
|
|
|
|
|
|
|
|
You should be automatically redirected to `/ui/jobs` upon visiting the UI in your browser. This
|
|
|
|
|
pages lists all jobs known to Nomad, regardless of status. Click the `example` job to inspect it.
|
|
|
|
|
|
2017-09-16 19:52:53 +00:00
|
|
|
[![Nomad UI Job Detail][img-job-detail]][img-job-detail]
|
|
|
|
|
|
2017-09-16 19:05:01 +00:00
|
|
|
The job detail page shows pertinent information about the job, including overall status as well as
|
|
|
|
|
allocation statuses broken down by task group. It is similar to the `nomad status` CLI command.
|
|
|
|
|
|
|
|
|
|
Click on the `cache` task group to drill into the task group detail page. This page lists each allocation
|
|
|
|
|
for the task group.
|
|
|
|
|
|
2017-09-16 19:52:53 +00:00
|
|
|
[![Nomad UI Task Group Detail][img-task-group-detail]][img-task-group-detail]
|
|
|
|
|
|
2017-09-16 19:05:01 +00:00
|
|
|
Click on the allocation in the allocations table. This page lists all tasks for an allocation as well
|
2018-03-22 20:39:18 +00:00
|
|
|
as the recent events for each task. It is similar to the `nomad alloc status` command.
|
2017-09-16 19:05:01 +00:00
|
|
|
|
2017-09-16 19:52:53 +00:00
|
|
|
[![Nomad UI Alloc Status][img-alloc-status]][img-alloc-status]
|
|
|
|
|
|
2017-09-16 19:05:01 +00:00
|
|
|
The Nomad UI offers a friendly and visual alternative experience to the CLI.
|
|
|
|
|
|
|
|
|
|
## Next Steps
|
|
|
|
|
|
|
|
|
|
We've now concluded the getting started guide, however there are a number
|
|
|
|
|
of [next steps](next-steps.html) to get started with Nomad.
|
2017-09-16 19:52:53 +00:00
|
|
|
|
|
|
|
|
[img-jobs-list]: /assets/images/intro-ui-jobs-list.png
|
|
|
|
|
[img-job-detail]: /assets/images/intro-ui-job-detail.png
|
|
|
|
|
[img-task-group-detail]: /assets/images/intro-ui-task-group-detail.png
|
|
|
|
|
[img-alloc-status]: /assets/images/intro-ui-alloc-status.png
|
