Add the overcommit ratios to the compute offering form

Until now the only way to set an offering's ratio was the API or a
direct row write, because service offering details are free-form
key/value and the form has no generic editor for them.

Two optional admin-only fields, blank by default:

  blank  -> inherit the cluster factor
  1      -> not overcommitted
  4      -> four times oversubscribed

Rejected below 1 in the browser as well as on the server.

Also fixed two things the new fields would otherwise have tripped over:

  - serviceofferingdetails[0] was hardcoded for ImplicitDedicationMode
    in the add and clone views, so a second detail at index 0 would
    have silently replaced it. Both now use a running index.
  - clone copied the whole details map into the external details
    widget, which would have re-submitted the ratios as
    External:cpuOvercommitRatio. It now lifts them into the new fields.

The offering details tab shows both, and no longer renders an empty row
for a detail the offering does not have.

updateServiceOffering takes only externaldetails, so the ratios are set
at create or clone time.

Signed-off-by: Brad House <bhouse@nexthop.ai>

Author: bhouse-nexthop

ui/public/locales/en.json

@@ -716,6 +716,8 @@
 "label.cpuload": "% CPU in use",
 "label.cpumaxdeviation": "Deviation",
 "label.cpunumber": "CPU cores",
+"label.cpuovercommitratio": "CPU overcommit ratio",
+"label.cpuovercommitratio.tooltip": "Overrides the cluster cpu.overprovisioning.factor for Instances created from this offering. Must be at least 1, where 1 means CPU is not overcommitted. Leave blank to use the cluster setting.",
 "label.cpusockets": "The number of CPU sockets",
 "label.cpuspeed": "CPU (in MHz)",
 "label.cputotal": "Total CPU",
@@ -1741,6 +1743,8 @@
 "label.memoryallocatedgb": "Memory allocated",
 "label.memorylimit": "Memory limits (MiB)",
 "label.memorymaxdeviation": "Deviation",
+"label.memoryovercommitratio": "Memory overcommit ratio",
+"label.memoryovercommitratio.tooltip": "Overrides the cluster mem.overprovisioning.factor for Instances created from this offering. Must be at least 1, where 1 means memory is not overcommitted. Leave blank to use the cluster setting.",
 "label.memorytotal": "Memory total",
 "label.memorytotalgb": "Memory total",
 "label.memoryused": "Used memory",
@@ -3761,6 +3765,7 @@
 "message.error.nexus1000v.password": "Please enter Nexus 1000v password.",
 "message.error.nexus1000v.username": "Please enter Nexus 1000v username.",
 "message.error.number": "Please enter a valid number.",
+"message.error.overcommit.ratio": "Please enter a number of 1 or greater.",
 "message.error.parent.subnet": "Please choose a parent subnet",
 "message.error.password": "Enter your password",
 "message.error.path": "Please enter path",
@@ -4000,6 +4005,7 @@
 "message.offering.internet.protocol.warning": "WARNING: IPv6 supported Networks use static routing and will require upstream routes to be configured manually.",
 "message.offering.ipv6.warning": "Please refer documentation for creating IPv6 enabled Network/VPC offering <a href='http://docs.cloudstack.apache.org/en/latest/plugins/ipv6.html#isolated-network-and-vpc-tier'>IPv6 support in CloudStack - Isolated Networks and VPC Network Tiers</a>",
 "message.oobm.configured": "Successfully configured out-of-band management for host",
+"message.overcommit.ratio.inherit.cluster": "Leave blank to use the cluster setting",
 "message.ovf.configurations": "OVF configurations available for the selected appliance. Please select the desired value. Incompatible compute offerings will get disabled.",
 "message.password.reset.failed": "Failed to reset password.",
 "message.password.reset.success": "Password has been reset successfully. Please login using your new credentials.",

ui/src/components/offering/ComputeOfferingForm.vue

@@ -134,6 +134,35 @@
       </a-col>
     </a-row>
 
+    <a-row :gutter="12" v-if="isAdmin()">
+      <a-col :md="12" :lg="12">
+        <a-form-item name="cpuovercommitratio" ref="cpuovercommitratio">
+          <template #label>
+            <tooltip-label :title="$t('label.cpuovercommitratio')" :tooltip="$t('label.cpuovercommitratio.tooltip')"/>
+          </template>
+          <a-input
+            v-model:value="form.cpuovercommitratio"
+            type="number"
+            min="1"
+            step="0.1"
+            :placeholder="$t('message.overcommit.ratio.inherit.cluster')"/>
+        </a-form-item>
+      </a-col>
+      <a-col :md="12" :lg="12">
+        <a-form-item name="memoryovercommitratio" ref="memoryovercommitratio">
+          <template #label>
+            <tooltip-label :title="$t('label.memoryovercommitratio')" :tooltip="$t('label.memoryovercommitratio.tooltip')"/>
+          </template>
+          <a-input
+            v-model:value="form.memoryovercommitratio"
+            type="number"
+            min="1"
+            step="0.1"
+            :placeholder="$t('message.overcommit.ratio.inherit.cluster')"/>
+        </a-form-item>
+      </a-col>
+    </a-row>
+
     <a-row :gutter="12">
       <a-col :md="12" :lg="12">
         <a-form-item v-if="isAdmin() || isDomainAdminAllowedToInformTags" name="hosttags" ref="hosttags">

ui/src/components/view/DetailsTab.vue

@@ -42,7 +42,7 @@
     size="small"
     :dataSource="fetchDetails()">
     <template #renderItem="{item}">
-      <a-list-item v-if="(item in dataResource && !customDisplayItems.includes(item)) || (offeringDetails.includes(item) && dataResource.serviceofferingdetails)">
+      <a-list-item v-if="(item in dataResource && !customDisplayItems.includes(item)) || (offeringDetails.includes(item) && dataResource.serviceofferingdetails?.[item] !== undefined)">
         <div style="width: 100%">
           <strong>{{ item === 'service' ? $t('label.supportedservices') :
            $route.meta.name === 'cniconfiguration' && item === 'userdata' ? $t('label.' + String($route.meta.name).toLowerCase()) :
@@ -120,7 +120,7 @@
               </span>
             </div>
           </div>
-          <div v-else-if="$route.meta.name === 'computeoffering' && offeringDetails.includes(item)">
+          <div v-else-if="['computeoffering', 'systemoffering'].includes($route.meta.name) && offeringDetails.includes(item)">
             {{ dataResource.serviceofferingdetails[item] }}
           </div>
           <div v-else-if="item === 'headers'" style="white-space: pre-line;">
@@ -416,7 +416,7 @@ export default {
       return null
     },
     offeringDetails () {
-      return ['maxcpunumber', 'mincpunumber', 'minmemory', 'maxmemory']
+      return ['maxcpunumber', 'mincpunumber', 'minmemory', 'maxmemory', 'cpuOvercommitRatio', 'memoryOvercommitRatio']
     },
     ipV6Address () {
       if (this.dataResource.nic && this.dataResource.nic.length > 0) {

ui/src/config/section/offering.js

@@ -45,7 +45,7 @@ export default {
       },
       columns: ['name', 'displaytext', 'state', 'cpunumber', 'cpuspeed', 'memory', 'gpu', 'domain', 'zone', 'order'],
       details: () => {
-        var fields = ['name', 'id', 'displaytext', 'offerha', 'provisioningtype', 'storagetype', 'iscustomized', 'iscustomizediops', 'limitcpuuse', 'cpunumber', 'cpuspeed', 'memory', 'hosttags', 'tags', 'storageaccessgroups', 'storagetags', 'domain', 'zone', 'created', 'dynamicscalingenabled', 'diskofferingstrictness', 'encryptroot', 'purgeresources', 'leaseduration', 'gpucardid', 'gpucardname', 'vgpuprofileid', 'vgpuprofilename', 'gpucount', 'gpudisplay', 'leaseexpiryaction', 'externaldetails']
+        var fields = ['name', 'id', 'displaytext', 'offerha', 'provisioningtype', 'storagetype', 'iscustomized', 'iscustomizediops', 'limitcpuuse', 'cpunumber', 'cpuspeed', 'memory', 'cpuOvercommitRatio', 'memoryOvercommitRatio', 'hosttags', 'tags', 'storageaccessgroups', 'storagetags', 'domain', 'zone', 'created', 'dynamicscalingenabled', 'diskofferingstrictness', 'encryptroot', 'purgeresources', 'leaseduration', 'gpucardid', 'gpucardname', 'vgpuprofileid', 'vgpuprofilename', 'gpucount', 'gpudisplay', 'leaseexpiryaction', 'externaldetails']
         if (store.getters.apis.createServiceOffering &&
           store.getters.apis.createServiceOffering.params.filter(x => x.name === 'storagepolicy').length > 0) {
           fields.splice(6, 0, 'vspherestoragepolicy')
@@ -167,7 +167,7 @@ export default {
       params: { issystem: 'true', isrecursive: 'true' },
       columns: ['name', 'state', 'systemvmtype', 'cpunumber', 'cpuspeed', 'memory', 'storagetype', 'offerha', 'order'],
       filters: ['active', 'inactive'],
-      details: ['name', 'id', 'displaytext', 'systemvmtype', 'provisioningtype', 'storagetype', 'iscustomized', 'limitcpuuse', 'cpunumber', 'cpuspeed', 'memory', 'storagetags', 'hosttags', 'tags', 'domain', 'zone', 'created', 'dynamicscalingenabled', 'diskofferingstrictness'],
+      details: ['name', 'id', 'displaytext', 'systemvmtype', 'provisioningtype', 'storagetype', 'iscustomized', 'limitcpuuse', 'cpunumber', 'cpuspeed', 'memory', 'cpuOvercommitRatio', 'memoryOvercommitRatio', 'storagetags', 'hosttags', 'tags', 'domain', 'zone', 'created', 'dynamicscalingenabled', 'diskofferingstrictness'],
       resourceType: 'ServiceOffering',
       tabs: [
         {

ui/src/views/offering/AddComputeOffering.vue

@@ -76,6 +76,15 @@ export default {
           return Promise.resolve()
         }
       },
+      overCommitRatioRule: {
+        type: 'number',
+        validator: async (rule, value) => {
+          if (value && (isNaN(value) || value < 1)) {
+            return Promise.reject(this.$t('message.error.overcommit.ratio'))
+          }
+          return Promise.resolve()
+        }
+      },
       storageType: 'shared',
       provisioningType: 'thin',
       cacheMode: 'none',
@@ -193,6 +202,8 @@ export default {
           { required: true, message: this.$t('message.error.required.input') },
           this.naturalNumberRule
         ],
+        cpuovercommitratio: [this.overCommitRatioRule],
+        memoryovercommitratio: [this.overCommitRatioRule],
         networkrate: [this.naturalNumberRule],
         rootdisksize: [this.naturalNumberRule],
         diskbytesreadrate: [this.naturalNumberRule],
@@ -434,13 +445,25 @@ export default {
          values.deploymentplanner != null && values.deploymentplanner.length > 0) {
           params.deploymentplanner = values.deploymentplanner
         }
+        var detailIndex = 0
         if ('deploymentplanner' in values &&
          values.deploymentplanner !== undefined &&
          values.deploymentplanner === 'ImplicitDedicationPlanner' &&
          values.plannermode !== undefined &&
          values.plannermode !== '') {
-          params['serviceofferingdetails[0].key'] = 'ImplicitDedicationMode'
-          params['serviceofferingdetails[0].value'] = values.plannermode
+          params['serviceofferingdetails[' + detailIndex + '].key'] = 'ImplicitDedicationMode'
+          params['serviceofferingdetails[' + detailIndex + '].value'] = values.plannermode
+          detailIndex++
+        }
+        if (values.cpuovercommitratio !== undefined && values.cpuovercommitratio !== null && values.cpuovercommitratio !== '') {
+          params['serviceofferingdetails[' + detailIndex + '].key'] = 'cpuOvercommitRatio'
+          params['serviceofferingdetails[' + detailIndex + '].value'] = values.cpuovercommitratio
+          detailIndex++
+        }
+        if (values.memoryovercommitratio !== undefined && values.memoryovercommitratio !== null && values.memoryovercommitratio !== '') {
+          params['serviceofferingdetails[' + detailIndex + '].key'] = 'memoryOvercommitRatio'
+          params['serviceofferingdetails[' + detailIndex + '].value'] = values.memoryovercommitratio
+          detailIndex++
         }
         if ('isvolatile' in values && values.isvolatile !== undefined) {
           params.isvolatile = values.isvolatile === true

ui/src/views/offering/CloneComputeOffering.vue

@@ -99,6 +99,15 @@ export default {
           return Promise.resolve()
         }
       },
+      overCommitRatioRule: {
+        type: 'number',
+        validator: async (rule, value) => {
+          if (value && (isNaN(value) || value < 1)) {
+            return Promise.reject(this.$t('message.error.overcommit.ratio'))
+          }
+          return Promise.resolve()
+        }
+      },
       storageType: 'shared',
       provisioningType: 'thin',
       cacheMode: 'none',
@@ -216,6 +225,8 @@ export default {
           { required: true, message: this.$t('message.error.required.input') },
           this.naturalNumberRule
         ],
+        cpuovercommitratio: [this.overCommitRatioRule],
+        memoryovercommitratio: [this.overCommitRatioRule],
         networkrate: [this.naturalNumberRule],
         rootdisksize: [this.naturalNumberRule],
         diskbytesreadrate: [this.naturalNumberRule],
@@ -379,9 +390,20 @@ export default {
         this.handleDeploymentPlannerChange(r.deploymentplanner)
       }
 
-      if (r.serviceofferingdetails && Object.keys(r.serviceofferingdetails).length > 0) {
-        this.externalDetailsEnabled = true
-        this.form.externaldetails = r.serviceofferingdetails
+      if (r.serviceofferingdetails) {
+        const details = Object.assign({}, r.serviceofferingdetails)
+        if (details.cpuOvercommitRatio) {
+          this.form.cpuovercommitratio = details.cpuOvercommitRatio
+          delete details.cpuOvercommitRatio
+        }
+        if (details.memoryOvercommitRatio) {
+          this.form.memoryovercommitratio = details.memoryOvercommitRatio
+          delete details.memoryOvercommitRatio
+        }
+        if (Object.keys(details).length > 0) {
+          this.externalDetailsEnabled = true
+          this.form.externaldetails = details
+        }
       }
     },
     fetchGPUCards () {
@@ -577,13 +599,25 @@ export default {
            values.deploymentplanner != null && values.deploymentplanner.length > 0) {
           params.deploymentplanner = values.deploymentplanner
         }
+        var detailIndex = 0
         if ('deploymentplanner' in values &&
            values.deploymentplanner !== undefined &&
            values.deploymentplanner === 'ImplicitDedicationPlanner' &&
            values.plannermode !== undefined &&
            values.plannermode !== '') {
-          params['serviceofferingdetails[0].key'] = 'ImplicitDedicationMode'
-          params['serviceofferingdetails[0].value'] = values.plannermode
+          params['serviceofferingdetails[' + detailIndex + '].key'] = 'ImplicitDedicationMode'
+          params['serviceofferingdetails[' + detailIndex + '].value'] = values.plannermode
+          detailIndex++
+        }
+        if (values.cpuovercommitratio !== undefined && values.cpuovercommitratio !== null && values.cpuovercommitratio !== '') {
+          params['serviceofferingdetails[' + detailIndex + '].key'] = 'cpuOvercommitRatio'
+          params['serviceofferingdetails[' + detailIndex + '].value'] = values.cpuovercommitratio
+          detailIndex++
+        }
+        if (values.memoryovercommitratio !== undefined && values.memoryovercommitratio !== null && values.memoryovercommitratio !== '') {
+          params['serviceofferingdetails[' + detailIndex + '].key'] = 'memoryOvercommitRatio'
+          params['serviceofferingdetails[' + detailIndex + '].value'] = values.memoryovercommitratio
+          detailIndex++
         }
         if ('isvolatile' in values && values.isvolatile !== undefined) {
           params.isvolatile = values.isvolatile === true