diff --git a/website/source/assets/images/guide-ui-img-client-allocations.png b/website/source/assets/images/guide-ui-img-client-allocations.png new file mode 100644 index 000000000..0986fe0b7 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-client-allocations.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d5334f679407c8759dd0d2132f4daa05acce498b1e3486ceb4ba89505fae8a3 +size 125159 diff --git a/website/source/assets/images/guide-ui-img-client-attributes.png b/website/source/assets/images/guide-ui-img-client-attributes.png new file mode 100644 index 000000000..f1faa745d --- /dev/null +++ b/website/source/assets/images/guide-ui-img-client-attributes.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3098e24d692bbd64bf8b353518e786e260909c85075f85702a328799eea390fd +size 237381 diff --git a/website/source/assets/images/guide-ui-img-client-detail.png b/website/source/assets/images/guide-ui-img-client-detail.png new file mode 100644 index 000000000..b6158bc27 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-client-detail.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d1ded4aecb4660087d293bfbe0969b13c4c872b854077c6d1901f3e3ff413106 +size 749741 diff --git a/website/source/assets/images/guide-ui-img-client-drain.png b/website/source/assets/images/guide-ui-img-client-drain.png new file mode 100644 index 000000000..78054f347 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-client-drain.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ebe53ef480cd64fe43ae72e41d4785fa693cbf7e63cfb6fb1163e3bffc3bf657 +size 38626 diff --git a/website/source/assets/images/guide-ui-img-client-driver-status.png b/website/source/assets/images/guide-ui-img-client-driver-status.png new file mode 100644 index 000000000..22c87eb98 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-client-driver-status.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5a395e7312eb0d33b9c300d24ae411ea33c771e45edaf5e9a83004c21395a320 +size 91616 diff --git a/website/source/assets/images/guide-ui-img-client-events.png b/website/source/assets/images/guide-ui-img-client-events.png new file mode 100644 index 000000000..843b0e666 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-client-events.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e648babc4f4eca05cd607f52de7113d87b754b964069b353ae8c59ec47da7b5a +size 60057 diff --git a/website/source/assets/images/guide-ui-img-client-resource-utilization.png b/website/source/assets/images/guide-ui-img-client-resource-utilization.png new file mode 100644 index 000000000..7e6a96fa1 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-client-resource-utilization.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b162c1ff5886d191bc27bc37de2b270466fa7c9c4fe23075538d45b840b3f2d0 +size 295868 diff --git a/website/source/assets/images/guide-ui-img-clients-filters.png b/website/source/assets/images/guide-ui-img-clients-filters.png new file mode 100644 index 000000000..026872f85 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-clients-filters.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e2d5ae4843a3c4c6542f5b7a01e70ad2691563542e496bf03b965caeb161927 +size 47888 diff --git a/website/source/assets/images/guide-ui-img-clients-list.png b/website/source/assets/images/guide-ui-img-clients-list.png new file mode 100644 index 000000000..de111f27f --- /dev/null +++ b/website/source/assets/images/guide-ui-img-clients-list.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0e4a0e520104c4a8701e60116395e62114ea006312ae441c745b2b55814aa186 +size 302500 diff --git a/website/source/assets/images/guide-ui-img-server-detail.png b/website/source/assets/images/guide-ui-img-server-detail.png new file mode 100644 index 000000000..510d07411 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-server-detail.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:977294bd5c3fcecacd7f6b491ecfd7186506c5a8e76905d6f9b5e2add4a83730 +size 195138 diff --git a/website/source/assets/images/guide-ui-img-servers-list.png b/website/source/assets/images/guide-ui-img-servers-list.png new file mode 100644 index 000000000..0dfd3b5a5 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-servers-list.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0a04335c208dc9b69eaa3b9b7f796349bac435fc1812662a84bda9e645726be +size 181803 diff --git a/website/source/guides/web-ui/inspecting-the-cluster.html.md b/website/source/guides/web-ui/inspecting-the-cluster.html.md index e94a39ff3..ad97d4db0 100644 --- a/website/source/guides/web-ui/inspecting-the-cluster.html.md +++ b/website/source/guides/web-ui/inspecting-the-cluster.html.md @@ -9,7 +9,7 @@ description: |- # Inspecting the Cluster 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. ## 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. -~> Screenshot (Clients list) +[![Clients List][img-clients-list]][img-clients-list] ## 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. 2. **State:** The state of the cluster, including Initializing, Ready, Down, Ineligible, and 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. -~> Screenshot (Zoom in on client filters, with one open) +[![Clients filters][img-clients-filters]][img-clients-filters] ## 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 to always present up-to-date information. -~> Screenshot (Client Detail) +[![Client Detail][img-client-detail]][img-client-detail] ### 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. -~> Screenshot (resource utilization) +[![Client Resource Utilization][img-client-resource-utilization]][img-client-resource-utilization] ### Allocations @@ -64,14 +64,14 @@ garbage-collected. This is presented in a searchable table which can additionally be filtered to only preempted allocations. -~> Screenshot (client node alloc table) +[![Client Allocations][img-client-allocations]][img-client-allocations] ### Client Events 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. -~> Screenshot (client node events) +[![Client Events][img-client-events]][img-client-events] ### 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 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 @@ -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 is also presented on the Client Detail page. -~> Screenshot (client attributes) +[![Client Attributes][img-client-attributes]][img-client-attributes] ## 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 details of how the drain is performed. -~> Screenshot (client detail drain) +[![Client Drain][img-client-drain]][img-client-drain] ## 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 seven. -~> Screenshot (servers list) +[![Servers List][img-servers-list]][img-servers-list] ## Inspecting an Individual Server 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 @@ -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 anonymous users from having write permissions as well as how to continue to use Web UI write 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 diff --git a/website/source/guides/web-ui/operating-a-job.html.md b/website/source/guides/web-ui/operating-a-job.html.md index 16b646594..c31ad2306 100644 --- a/website/source/guides/web-ui/operating-a-job.html.md +++ b/website/source/guides/web-ui/operating-a-job.html.md @@ -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 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]