ui: Add optional memory max to task details ribbon (#10459)

This is the first step in #10268. If a maximum is not specified, the task group sum uses the memory number instead. The maximum is only shown when it’s higher than the memory sum.
hashicorp · Apr 28, 2021 · f16cdea · f16cdea
1 parent 638a0da
commit f16cdea
Show file tree

Hide file tree

Showing 9 changed files with 38 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,7 @@ IMPROVEMENTS:
  * networking: Added support for interpolating host network names with node attributes. [[GH-10196](https://github.com/hashicorp/nomad/issues/10196)]
  * nomad/structs: Removed deprecated Node.Drain field, added API extensions to restore it [[GH-10202](https://github.com/hashicorp/nomad/issues/10202)]
  * ui: Added a job reversion button [[GH-10336](https://github.com/hashicorp/nomad/pull/10336)]
+ * ui: Added memory maximum to task group ribbon [[GH-10459](https://github.com/hashicorp/nomad/pull/10459)]
  * ui: Updated global search to use fuzzy search API [[GH-10412](https://github.com/hashicorp/nomad/pull/10412)]
 
 BUG FIXES:

diff --git a/ui/app/models/resources.js b/ui/app/models/resources.js
@@ -5,6 +5,7 @@ import { fragmentArray } from 'ember-data-model-fragments/attributes';
 export default class Resources extends Fragment {
   @attr('number') cpu;
   @attr('number') memory;
+  @attr('number') memoryMax;
   @attr('number') disk;
   @attr('number') iops;
   @fragmentArray('network', { defaultValue: () => [] }) networks;

diff --git a/ui/app/models/task-group.js b/ui/app/models/task-group.js
@@ -36,6 +36,13 @@ export default class TaskGroup extends Fragment {
   @sumAggregation('tasks', 'reservedMemory') reservedMemory;
   @sumAggregation('tasks', 'reservedDisk') reservedDisk;
 
+  @computed('tasks.@each.{reservedMemory,reservedMemoryMax}')
+  get reservedMemoryMax() {
+    return this.get('tasks')
+      .map(t => t.get('reservedMemoryMax') || t.get('reservedMemory'))
+      .reduce((sum, count) => sum + count, 0);
+  }
+
   @attr('number') reservedEphemeralDisk;
 
   @computed('job.latestFailureEvaluation.failedTGAllocs.[]', 'name')

diff --git a/ui/app/models/task.js b/ui/app/models/task.js
@@ -30,6 +30,7 @@ export default class Task extends Fragment {
   }
 
   @attr('number') reservedMemory;
+  @attr('number') reservedMemoryMax;
   @attr('number') reservedCPU;
   @attr('number') reservedDisk;
   @attr('number') reservedEphemeralDisk;

diff --git a/ui/app/serializers/task.js b/ui/app/serializers/task.js
@@ -6,6 +6,7 @@ export default class Task extends ApplicationSerializer {
     const resources = hash.Resources;
     if (resources) {
       hash.ReservedMemory = resources.MemoryMB;
+      hash.ReservedMemoryMax = resources.MemoryMaxMB;
       hash.ReservedCPU = resources.CPU;
       hash.ReservedDisk = resources.DiskMB;
       hash.ReservedEphemeralDisk = hash.EphemeralDisk.SizeMB;

diff --git a/ui/app/templates/jobs/job/task-group.hbs b/ui/app/templates/jobs/job/task-group.hbs
@@ -31,7 +31,13 @@
 
       <span class="pair" data-test-task-group-tasks><span class="term"># Tasks</span> {{this.model.tasks.length}}</span>
       <span class="pair" data-test-task-group-cpu><span class="term">Reserved CPU</span> {{format-scheduled-hertz this.model.reservedCPU}}</span>
-      <span class="pair" data-test-task-group-mem><span class="term">Reserved Memory</span> {{format-scheduled-bytes this.model.reservedMemory start="MiB"}}</span>
+      <span class="pair" data-test-task-group-mem>
+        <span class="term">Reserved Memory</span>
+        {{format-scheduled-bytes this.model.reservedMemory start="MiB"}}
+        {{#if (gt this.model.reservedMemoryMax this.model.reservedMemory)}}
+          ({{format-scheduled-bytes this.model.reservedMemoryMax start="MiB"}} Max)
+        {{/if}}
+      </span>
       <span class="pair" data-test-task-group-disk><span class="term">Reserved Disk</span> {{format-scheduled-bytes this.model.reservedEphemeralDisk start="MiB"}}</span>
       {{#if this.model.scaling}}
         <span class="pair" data-test-task-group-min><span class="term">Count Range</span>

diff --git a/ui/mirage/common.js b/ui/mirage/common.js
@@ -24,7 +24,7 @@ export const HOSTS = provide(100, () => {
 export const STORAGE_PROVIDERS = ['ebs', 'zfs', 'nfs', 'cow', 'moo'];
 
 export function generateResources(options = {}) {
-  return {
+  const resources = {
     Cpu: {
       CpuShares: options.CPU || faker.helpers.randomize(CPU_RESERVATIONS),
     },
@@ -37,6 +37,15 @@ export function generateResources(options = {}) {
     Networks: generateNetworks(options.networks),
     Ports: generatePorts(options.networks),
   };
+
+  if (faker.random.boolean()) {
+    const higherMemoryReservations = MEMORY_RESERVATIONS.filter(mb => mb > resources.Memory.MemoryMB);
+    resources.Memory.MemoryMaxMB = faker.helpers.randomize(higherMemoryReservations) || resources.Memory.MemoryMB + 1;
+  } else {
+    resources.Memory.MemoryMaxMB = 0;
+  }
+
+  return resources;
 }
 
 export function generateNetworks(options = {}) {

diff --git a/ui/mirage/factories/task.js b/ui/mirage/factories/task.js
@@ -26,6 +26,7 @@ export default Factory.extend({
     return {
       CPU: resources.Cpu.CpuShares,
       MemoryMB: resources.Memory.MemoryMB,
+      MemoryMaxMB: resources.Memory.MemoryMaxMB,
       DiskMB: resources.Disk.DiskMB,
     };
   },

diff --git a/ui/tests/acceptance/task-group-detail-test.js b/ui/tests/acceptance/task-group-detail-test.js
@@ -82,6 +82,7 @@ module('Acceptance | task group detail', function(hooks) {
   test('/jobs/:id/:task-group should list high-level metrics for the allocation', async function(assert) {
     const totalCPU = tasks.mapBy('resources.CPU').reduce(sum, 0);
     const totalMemory = tasks.mapBy('resources.MemoryMB').reduce(sum, 0);
+    const totalMemoryMax = tasks.map(t => t.resources.MemoryMaxMB || t.resources.MemoryMB).reduce(sum, 0);
     const totalDisk = taskGroup.ephemeralDisk.SizeMB;
 
     await TaskGroup.visit({ id: job.id, name: taskGroup.name });
@@ -92,9 +93,16 @@ module('Acceptance | task group detail', function(hooks) {
       `Reserved CPU ${formatScheduledHertz(totalCPU, 'MHz')}`,
       'Aggregated CPU reservation for all tasks'
     );
+
+    let totalMemoryMaxAddendum = '';
+
+    if (totalMemoryMax > totalMemory) {
+      totalMemoryMaxAddendum = ` (${formatScheduledBytes(totalMemoryMax, 'MiB')} Max)`;
+    }
+
     assert.equal(
       TaskGroup.mem,
-      `Reserved Memory ${formatScheduledBytes(totalMemory, 'MiB')}`,
+      `Reserved Memory ${formatScheduledBytes(totalMemory, 'MiB')}${totalMemoryMaxAddendum}`,
       'Aggregated Memory reservation for all tasks'
     );
     assert.equal(