Screenshots for the inspecting the cluster guide

This commit is contained in:
Michael Lange 2019-09-27 19:10:24 -07:00
parent 9c3b212b39
commit 089cadde3a
13 changed files with 59 additions and 14 deletions

Binary file not shown.

Binary file not shown.

BIN
website/source/assets/images/guide-ui-img-client-detail.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
website/source/assets/images/guide-ui-img-client-drain.png (Stored with Git LFS) Normal file

Binary file not shown.

Binary file not shown.

BIN
website/source/assets/images/guide-ui-img-client-events.png (Stored with Git LFS) Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
website/source/assets/images/guide-ui-img-clients-list.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
website/source/assets/images/guide-ui-img-server-detail.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
website/source/assets/images/guide-ui-img-servers-list.png (Stored with Git LFS) Normal file

Binary file not shown.

View file

@ -9,7 +9,7 @@ description: |-
# Inspecting the Cluster # Inspecting the Cluster
The Web UI can be a powerful tool for keeping tabs on the state of the Nomad cluster from an The Web UI can be a powerful tool for keeping tabs on the state of the Nomad cluster from an
operator's perspective. The Web UI will show all client nodes, show driver health for client nodes, operator's perspective. This includes showing all client nodes, showing driver health for client nodes,
driver status, resource utilization, allocations by client node, and more. driver status, resource utilization, allocations by client node, and more.
## Reviewing All Clients ## Reviewing All Clients
@ -22,7 +22,7 @@ allocations are running in it.
This view will also live-update as the state of client nodes change. This view will also live-update as the state of client nodes change.
~> Screenshot (Clients list) [![Clients List][img-clients-list]][img-clients-list]
## Filtering Clients ## Filtering Clients
@ -33,10 +33,10 @@ down to only those matching certain facets. The Web UI has three facets you can
of each client node in the cluster. of each client node in the cluster.
2. **State:** The state of the cluster, including Initializing, Ready, Down, Ineligible, and 2. **State:** The state of the cluster, including Initializing, Ready, Down, Ineligible, and
Draining. Draining.
3. **Datacenter:** The datacenter the client node is in, including a dynamicaly generated list based 3. **Datacenter:** The datacenter the client node is in, including a dynamically generated list based
on all the datacenters in the cluster. on all the datacenters in the cluster.
~> Screenshot (Zoom in on client filters, with one open) [![Clients filters][img-clients-filters]][img-clients-filters]
## Inspecting an Individual Client ## Inspecting an Individual Client
@ -44,7 +44,7 @@ From the Clients List page, clicking a client node in the table will direct you
page for the client node. This page includes all information about the client node is live-updated page for the client node. This page includes all information about the client node is live-updated
to always present up-to-date information. to always present up-to-date information.
~> Screenshot (Client Detail) [![Client Detail][img-client-detail]][img-client-detail]
### Resource Utilization ### Resource Utilization
@ -53,7 +53,7 @@ uses these metrics to create time-series graphics for the current session.
When viewing a client node, resource utilization will automatically start logging. When viewing a client node, resource utilization will automatically start logging.
~> Screenshot (resource utilization) [![Client Resource Utilization][img-client-resource-utilization]][img-client-resource-utilization]
### Allocations ### Allocations
@ -64,14 +64,14 @@ garbage-collected.
This is presented in a searchable table which can additionally be filtered to only preempted This is presented in a searchable table which can additionally be filtered to only preempted
allocations. allocations.
~> Screenshot (client node alloc table) [![Client Allocations][img-client-allocations]][img-client-allocations]
### Client Events ### Client Events
Client nodes will also emit events on meaningful state changes, such as when the node becomes ready Client nodes will also emit events on meaningful state changes, such as when the node becomes ready
for scheduling or when a driver becomes unhealthy. for scheduling or when a driver becomes unhealthy.
~> Screenshot (client node events) [![Client Events][img-client-events]][img-client-events]
### Driver Status ### Driver Status
@ -79,7 +79,7 @@ Task drivers are additional services running on a client node. Nomad will finger
communicate with the task driver to determine if the driver is available and healthy. This communicate with the task driver to determine if the driver is available and healthy. This
information is reported through the Web UI on the Client Detail page. information is reported through the Web UI on the Client Detail page.
~> Screenshot (driver status) [![Client Driver Status][img-client-driver-status]][img-client-driver-status]
### Attributes ### Attributes
@ -91,7 +91,7 @@ In addition to the hardware attributes, Nomad operators can annotate
[a client node with metadata](/docs/configuration/client.html#meta) as part of the client configuration. This metadata [a client node with metadata](/docs/configuration/client.html#meta) as part of the client configuration. This metadata
is also presented on the Client Detail page. is also presented on the Client Detail page.
~> Screenshot (client attributes) [![Client Attributes][img-client-attributes]][img-client-attributes]
## When a Node is Draining ## When a Node is Draining
@ -106,7 +106,7 @@ scheduling.
Since drains can be configured in a variety of ways, the Client Detail page will also present the Since drains can be configured in a variety of ways, the Client Detail page will also present the
details of how the drain is performed. details of how the drain is performed.
~> Screenshot (client detail drain) [![Client Drain][img-client-drain]][img-client-drain]
## Reviewing All Servers ## Reviewing All Servers
@ -116,13 +116,13 @@ availability. From any page, the Servers List page can be accessed from the left
Here you can see every server node. This will be a small list—typically three, but maybe five or Here you can see every server node. This will be a small list—typically three, but maybe five or
seven. seven.
~> Screenshot (servers list) [![Servers List][img-servers-list]][img-servers-list]
## Inspecting an Individual Server ## Inspecting an Individual Server
Clicking a server node on the Servers List will expand the tags table for the server node. Clicking a server node on the Servers List will expand the tags table for the server node.
~> Screenshot (server node) [![Server Detail][img-server-detail]][img-server-detail]
## Access Control ## Access Control
@ -136,3 +136,15 @@ By default, all features—read and write—are available to all users of the We
[Securing the Web UI with ACLs](/guides/web-ui/securing.html) guide to learn how to prevent [Securing the Web UI with ACLs](/guides/web-ui/securing.html) guide to learn how to prevent
anonymous users from having write permissions as well as how to continue to use Web UI write anonymous users from having write permissions as well as how to continue to use Web UI write
features as a privileged user. features as a privileged user.
[img-client-allocations]: /assets/images/guide-ui-img-client-allocations.png
[img-client-attributes]: /assets/images/guide-ui-img-client-attributes.png
[img-client-detail]: /assets/images/guide-ui-img-client-detail.png
[img-client-drain]: /assets/images/guide-ui-img-client-drain.png
[img-client-driver-status]: /assets/images/guide-ui-img-client-driver-status.png
[img-client-events]: /assets/images/guide-ui-img-client-events.png
[img-client-resource-utilization]: /assets/images/guide-ui-img-client-resource-utilization.png
[img-clients-filters]: /assets/images/guide-ui-img-clients-filters.png
[img-clients-list]: /assets/images/guide-ui-img-clients-list.png
[img-server-detail]: /assets/images/guide-ui-img-server-detail.png
[img-servers-list]: /assets/images/guide-ui-img-servers-list.png

View file

@ -77,7 +77,7 @@ rescheduled successor. Since Nomad handles all of this automatically, the Web UI
explain the state of allocations through iconography and linking previous and next allocations in a explain the state of allocations through iconography and linking previous and next allocations in a
reschedule chain. reschedule chain.
[![Allocation Reschedule Icon][img-alloc-reschedule-iconj]][img-alloc-reschedule-icon] [![Allocation Reschedule Icon][img-alloc-reschedule-icon]][img-alloc-reschedule-icon]
[![Allocation Reschedule Details][img-alloc-reschedule-details]][img-alloc-reschedule-details] [![Allocation Reschedule Details][img-alloc-reschedule-details]][img-alloc-reschedule-details]