From 9c3b212b39144edc11991a97f1724c5f9b3beeb0 Mon Sep 17 00:00:00 2001 From: Michael Lange Date: Thu, 22 Aug 2019 11:49:24 -0700 Subject: [PATCH] Screenshots for the operating a job guide --- .../images/guide-ui-img-alloc-preempted.png | 3 ++ .../images/guide-ui-img-alloc-preempter.png | 3 ++ .../guide-ui-img-alloc-reschedule-details.png | 3 ++ .../guide-ui-img-alloc-reschedule-icon.png | 3 ++ ...uide-ui-img-alloc-resource-utilization.png | 3 ++ .../guide-ui-img-alloc-stop-restart.png | 3 ++ .../guide-ui-img-alloc-unhealthy-driver.png | 3 ++ .../guide-ui-img-job-definition-edit.png | 3 ++ .../guide-ui-img-job-deployment-canary.png | 3 ++ .../images/guide-ui-img-job-filters.png | 3 ++ .../assets/images/guide-ui-img-job-stop.png | 3 ++ .../images/guide-ui-img-periodic-force.png | 3 ++ .../images/guide-ui-img-task-events.png | 3 ++ .../assets/images/guide-ui-img-task-logs.png | 3 ++ .../guides/web-ui/operating-a-job.html.md | 46 +++++++++++++------ 15 files changed, 73 insertions(+), 15 deletions(-) create mode 100644 website/source/assets/images/guide-ui-img-alloc-preempted.png create mode 100644 website/source/assets/images/guide-ui-img-alloc-preempter.png create mode 100644 website/source/assets/images/guide-ui-img-alloc-reschedule-details.png create mode 100644 website/source/assets/images/guide-ui-img-alloc-reschedule-icon.png create mode 100644 website/source/assets/images/guide-ui-img-alloc-resource-utilization.png create mode 100644 website/source/assets/images/guide-ui-img-alloc-stop-restart.png create mode 100644 website/source/assets/images/guide-ui-img-alloc-unhealthy-driver.png create mode 100644 website/source/assets/images/guide-ui-img-job-definition-edit.png create mode 100644 website/source/assets/images/guide-ui-img-job-deployment-canary.png create mode 100644 website/source/assets/images/guide-ui-img-job-filters.png create mode 100644 website/source/assets/images/guide-ui-img-job-stop.png create mode 100644 website/source/assets/images/guide-ui-img-periodic-force.png create mode 100644 website/source/assets/images/guide-ui-img-task-events.png create mode 100644 website/source/assets/images/guide-ui-img-task-logs.png diff --git a/website/source/assets/images/guide-ui-img-alloc-preempted.png b/website/source/assets/images/guide-ui-img-alloc-preempted.png new file mode 100644 index 000000000..c5cc388fb --- /dev/null +++ b/website/source/assets/images/guide-ui-img-alloc-preempted.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:125e79d094bc6af3b3d48e5bfc7c88b17cddb34f7a158f8d7642edf49509b4ec +size 403239 diff --git a/website/source/assets/images/guide-ui-img-alloc-preempter.png b/website/source/assets/images/guide-ui-img-alloc-preempter.png new file mode 100644 index 000000000..25472ab16 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-alloc-preempter.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3700ff5d94dbf5129528d8800341e3c9edab63ac033b43b6576fa718128480ee +size 152905 diff --git a/website/source/assets/images/guide-ui-img-alloc-reschedule-details.png b/website/source/assets/images/guide-ui-img-alloc-reschedule-details.png new file mode 100644 index 000000000..26cc3bdd5 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-alloc-reschedule-details.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e21bc8e9602945593fa1e800158865a3de440c2ce3637156e715da906a01b08e +size 156820 diff --git a/website/source/assets/images/guide-ui-img-alloc-reschedule-icon.png b/website/source/assets/images/guide-ui-img-alloc-reschedule-icon.png new file mode 100644 index 000000000..f16ec1b7f --- /dev/null +++ b/website/source/assets/images/guide-ui-img-alloc-reschedule-icon.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d8baed11142da35c41a50c8f36abbfac64bdb0545289a4314255037b5ff88418 +size 132740 diff --git a/website/source/assets/images/guide-ui-img-alloc-resource-utilization.png b/website/source/assets/images/guide-ui-img-alloc-resource-utilization.png new file mode 100644 index 000000000..a8c92de71 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-alloc-resource-utilization.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:228cac137b0eecdbed9f93d3ba7830d640584b3e9f496d2ec270e055c85ff8c7 +size 454348 diff --git a/website/source/assets/images/guide-ui-img-alloc-stop-restart.png b/website/source/assets/images/guide-ui-img-alloc-stop-restart.png new file mode 100644 index 000000000..05407d4ea --- /dev/null +++ b/website/source/assets/images/guide-ui-img-alloc-stop-restart.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:946ce79ac8cccf1a9eb0ceb5959b9f93ee2a9f58c7ffe58039a82e9aff1ca529 +size 218558 diff --git a/website/source/assets/images/guide-ui-img-alloc-unhealthy-driver.png b/website/source/assets/images/guide-ui-img-alloc-unhealthy-driver.png new file mode 100644 index 000000000..16313ca57 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-alloc-unhealthy-driver.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2e56347c650730944fbc24ceb9eca3e3d0d7a8f27987ed58324642815ae1fde4 +size 199433 diff --git a/website/source/assets/images/guide-ui-img-job-definition-edit.png b/website/source/assets/images/guide-ui-img-job-definition-edit.png new file mode 100644 index 000000000..e63775a23 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-job-definition-edit.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd4e7a7769f3ecdc627014ffb478a2bdabd6fec56e1d06adcc0e9e534a73bdef +size 539988 diff --git a/website/source/assets/images/guide-ui-img-job-deployment-canary.png b/website/source/assets/images/guide-ui-img-job-deployment-canary.png new file mode 100644 index 000000000..3097245c0 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-job-deployment-canary.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99a79c3c40695f06dab9d3f607b8c93ae8405db6bf12a843f502e762e7835f82 +size 433732 diff --git a/website/source/assets/images/guide-ui-img-job-filters.png b/website/source/assets/images/guide-ui-img-job-filters.png new file mode 100644 index 000000000..66a832dcc --- /dev/null +++ b/website/source/assets/images/guide-ui-img-job-filters.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:69f606fe5993badbb707d7a950045267afeec64e61af08bc634da580121f000e +size 64485 diff --git a/website/source/assets/images/guide-ui-img-job-stop.png b/website/source/assets/images/guide-ui-img-job-stop.png new file mode 100644 index 000000000..743db2a4b --- /dev/null +++ b/website/source/assets/images/guide-ui-img-job-stop.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:88b882d0489ba6fb8c3c08ddafc67f535a5134f68d4490ee05354cdba9d4cb5c +size 109072 diff --git a/website/source/assets/images/guide-ui-img-periodic-force.png b/website/source/assets/images/guide-ui-img-periodic-force.png new file mode 100644 index 000000000..7052dfaf8 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-periodic-force.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b0034d0869dc1374bf86d4524da9db53da649f6dcd81c9dcd7e7daf3f8946155 +size 231232 diff --git a/website/source/assets/images/guide-ui-img-task-events.png b/website/source/assets/images/guide-ui-img-task-events.png new file mode 100644 index 000000000..5e9fce3ad --- /dev/null +++ b/website/source/assets/images/guide-ui-img-task-events.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e27af3015f84154bb14885f3a26c01af4fff347221f547137d8911e99d2de4f4 +size 494895 diff --git a/website/source/assets/images/guide-ui-img-task-logs.png b/website/source/assets/images/guide-ui-img-task-logs.png new file mode 100644 index 000000000..8f9132cb0 --- /dev/null +++ b/website/source/assets/images/guide-ui-img-task-logs.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f3d731ba068cd81a9c36449733390ac8311c67a1a91e791565532b5cdd54ecfc +size 445708 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 da50c10bb..16b646594 100644 --- a/website/source/guides/web-ui/operating-a-job.html.md +++ b/website/source/guides/web-ui/operating-a-job.html.md @@ -21,7 +21,7 @@ information such as a visual representation of all allocation statuses. This view will also live-update as jobs get submitted, get purged, and change status. -~> Screenshot (Jobs List) +[![Jobs List][img-jobs-list]][img-jobs-list] ## Filtering Jobs @@ -36,7 +36,7 @@ those matching certain facets. The Web UI has four facets you can filter by: based on job names up to the first occurrence of `-`, `.`, and `_`. Only prefixes that match multiple jobs are included. -~> Screenshot (Zoom in on job filters, with one open) +[![Job Filters][img-job-filters]][img-job-filters] ## Monitoring an Allocation @@ -51,7 +51,7 @@ Web UI uses these metrics to create time-series graphs for the current session. When viewing an allocation, resource utilization will automatically start logging. -~> Screenshot (resource tuilization) +[![Allocation Resource Utilization][img-alloc-resource-utilization]][img-alloc-resource-utilization] ### Task Events @@ -60,7 +60,7 @@ issues in the event that the task fails to start. Task events are listed on the Task Detail page and live-update as Nomad handles managing the task. -~> Screenshot (task events) +[![Task Events][img-task-events]][img-task-events] ### Rescheduled Allocations @@ -77,9 +77,9 @@ 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. -~> Screenshot (reschedule icon) +[![Allocation Reschedule Icon][img-alloc-reschedule-iconj]][img-alloc-reschedule-icon] -~> Screenshot (reschedule section on alloc detail) +[![Allocation Reschedule Details][img-alloc-reschedule-details]][img-alloc-reschedule-details] ### Unhealthy Driver @@ -90,7 +90,7 @@ monitor pertinent conditions including driver health. The Web UI denotes when a driver an allocation depends on is unhealthy on the client node the allocation is running on. -~> Screenshot (unhealthy driver) +[![Allocation Unhealthy Driver][img-alloc-unhealthy-driver]][img-alloc-unhealthy-driver] ### Preempted Allocations @@ -103,9 +103,9 @@ preempted as well as the opposite: what allocations an allocation preempted. Thi to traverse down from a job to a preempted allocation, to the allocation that caused the preemption, to the job that the preempting allocation is for. -~> Screenshot (preempter) +[![Allocation Preempter][img-alloc-preempter]][img-alloc-preempter] -~> Screenshot (preemptions) +[![Allocation Preempted][img-alloc-preempted]][img-alloc-preempted] ## Reviewing Logs for a Task @@ -117,7 +117,7 @@ The Web UI will first attempt to directly connecto to the client node the task i Typically, client nodes are not accessible from the public internet. If this is the case, the Web UI will fall back and proxy to the client node from the server node with no loss of functionality. -~> Screenshot (task logs) +[![Task Logs][img-task-logs]][img-task-logs] ~> Not all browsers support streaming http requests. In the event that streaming is not supported, logs will still be followed using interval polling. @@ -134,7 +134,7 @@ Nomad will mark the allocation as complete and perform a reschedule onto a diffe Both of these features are also available in the Web UI. -~> Screenshot (allocation stop and restart) +[![Allocation Stop and Restart][img-alloc-stop-restart]][img-alloc-stop-restart] ## Forcing a Periodic Instance @@ -143,7 +143,7 @@ waiting for the period duration to elapse. Nomad calls this a [periodic force](/docs/commands/job/periodic-force.html) and it can be done from the Web UI on the Job Overview page for a periodic job. -~> Screenshot (periodic force) +[![Periodic Force][img-periodic-force]][img-periodic-force] ## Submitting a New Version of a Job @@ -151,7 +151,7 @@ From the Job Definition page, a job can be edited. After clicking the Edit butto corner of the code window, the job definition JSON becomes editable. The edits can then be planned and scheduled. -~> Screenshot (definition edit) +[![Job Definition Edit][img-job-definition-edit]][img-job-definition-edit] ~> Since each job within a namespace must have a unique name, it is possible to submit a new version of a job from the Run Job screen. Always review the plan output! @@ -169,14 +169,14 @@ Optionally, a job may use canary deployments to allow for additional health chec before a full roll out. If a job uses canaries and is not configured to automatically promote the canary, the canary promotion operation can be done from the Job Overview page in the Web UI. -~> Screenshot (job deployment with canary link) +[![Job Deployment with Canary Promotion][img-job-deployment-canary]][img-job-deployment-canary] ## Stopping a Job Jobs can be stopped from the Job Overview page. Stopping a job will gracefully stop all allocations, marking them as complete, and freeing up resources in the cluster. -~> Screenshot (job stop) +[![Job Stop][img-job-stop]][img-job-stop] ## Access Control @@ -200,3 +200,19 @@ the rest of your infrastructure, as code. By checking in your job definition files as source control, you will always have a log of changes to assist in debugging issues, rolling back versions, and collaborating on changes using development best practices like code review. + +[img-jobs-list]: /assets/images/guide-ui-jobs-list.png +[img-job-filters]: /assets/images/guide-ui-img-job-filters.png +[img-alloc-resource-utilization]: /assets/images/guide-ui-img-alloc-resource-utilization.png +[img-task-events]: /assets/images/guide-ui-img-task-events.png +[img-alloc-reschedule-icon]: /assets/images/guide-ui-img-alloc-reschedule-icon.png +[img-alloc-reschedule-details]: /assets/images/guide-ui-img-alloc-reschedule-details.png +[img-alloc-unhealthy-driver]: /assets/images/guide-ui-img-alloc-unhealthy-driver.png +[img-alloc-preempter]: /assets/images/guide-ui-img-alloc-preempter.png +[img-alloc-preempted]: /assets/images/guide-ui-img-alloc-preempted.png +[img-task-logs]: /assets/images/guide-ui-img-task-logs.png +[img-alloc-stop-restart]: /assets/images/guide-ui-img-alloc-stop-restart.png +[img-periodic-force]: /assets/images/guide-ui-img-periodic-force.png +[img-job-definition-edit]: /assets/images/guide-ui-img-job-definition-edit.png +[img-job-deployment-canary]: /assets/images/guide-ui-img-job-deployment-canary.png +[img-job-stop]: /assets/images/guide-ui-img-job-stop.png