Add metadata to created VM - flavor, os, workload and used template (#79)

Author: rawagner

src/constants/index.js

@@ -12,6 +12,7 @@ export const ANNOTATION_DEFAULT_DISK = 'defaults.template.cnv.io/disk';
 export const ANNOTATION_DEFAULT_NETWORK = 'defaults.template.cnv.io/network';
 export const ANNOTATION_FIRST_BOOT = 'cnv.ui.firstBoot';
 export const ANNOTATION_PXE_INTERFACE = 'cnv.ui.pxeInterface';
+export const ANNOTATION_USED_TEMPLATE = 'template.cnv.ui';
 
 export const CLOUDINIT_DISK = 'cloudinitdisk';
 export const CLOUDINIT_NOCLOUD = 'cloudInitNoCloud';

src/k8s/mock_templates/fedora28.template.js

@@ -3,6 +3,7 @@ export const fedora28 = {
   kind: 'Template',
   metadata: {
     name: 'fedora-generic',
+    namespace: 'default',
     annotations: {
       'openshift.io/display-name': 'Fedora 23+ VM',
       description:

src/k8s/mock_templates/rhel-high-p.template.js

@@ -3,6 +3,7 @@ export const rhelHighPerformance = {
   kind: 'Template',
   metadata: {
     name: 'rhel-high-performance',
+    namespace: 'default',
     annotations: {
       'openshift.io/display-name': 'Red Hat Enterprise Linux 7.0+ VM High Performance',
       description:

src/k8s/mock_templates/rhel75.template.js

@@ -3,6 +3,7 @@ export const rhel75 = {
   kind: 'Template',
   metadata: {
     name: 'rhel-generic',
+    namespace: 'default',
     annotations: {
       'openshift.io/display-name': 'Red Hat Enterprise Linux 7.0+ VM',
       description:

src/k8s/mock_templates/ubuntu1804.template.js

@@ -3,6 +3,7 @@ export const ubuntu1804 = {
   kind: 'Template',
   metadata: {
     name: 'ubuntu1804',
+    namespace: 'default',
     annotations: {
       'openshift.io/display-name': 'Ubuntu 18.04 (Xenial Xerus) VM',
       description:

src/k8s/mock_templates/windows.template.js

@@ -3,6 +3,7 @@ export const windows = {
   kind: 'Template',
   metadata: {
     name: 'win2k12r2',
+    namespace: 'default',
     annotations: {
       'openshift.io/display-name': 'Microsoft Windows Server 2012 R2 VM',
       description:

src/k8s/request.js

@@ -18,7 +18,11 @@ import {
   ANNOTATION_PXE_INTERFACE,
   TEMPLATE_API_VERSION,
   PVC_ACCESSMODE_RWO,
-  CLOUDINIT_NOCLOUD
+  CLOUDINIT_NOCLOUD,
+  TEMPLATE_FLAVOR_LABEL,
+  TEMPLATE_OS_LABEL,
+  TEMPLATE_WORKLOAD_LABEL,
+  ANNOTATION_USED_TEMPLATE
 } from '../constants';
 import {
   NAMESPACE_KEY,
@@ -34,7 +38,9 @@ import {
   CLOUD_INIT_KEY,
   HOST_NAME_KEY,
   AUTHKEYS_KEY,
-  NAME_KEY
+  NAME_KEY,
+  OPERATING_SYSTEM_KEY,
+  WORKLOAD_PROFILE_KEY
 } from '../components/Wizard/CreateVmWizard/constants';
 import { VirtualMachineModel, ProcessedTemplatesModel, PersistentVolumeClaimModel } from '../models';
 import { getTemplatesWithLabels, getTemplate } from '../utils/templates';
@@ -57,6 +63,7 @@ export const createVM = (k8sCreate, templates, basicSettings, { networks }, stor
 
   return k8sCreate(ProcessedTemplatesModel, template).then(({ objects }) => {
     const vm = selectVm(objects);
+    addMetadata(vm, template, getSetting);
     modifyVmObject(vm, template, getSetting, networks, additionalStorage);
 
     if (getSetting(IMAGE_SOURCE_TYPE_KEY) === PROVISION_SOURCE_TEMPLATE) {
@@ -112,15 +119,27 @@ const resolveTemplate = (templates, basicSettings, getSetting, storage) => {
     }
   });
 
-  // processedtemplate endpoint is namespaced
-  chosenTemplate.metadata.namespace = getSetting(NAMESPACE_KEY);
-
   // make sure api version is correct
   chosenTemplate.apiVersion = TEMPLATE_API_VERSION;
 
   return chosenTemplate;
 };
 
+const addMetadata = (vm, template, getSetting) => {
+  const userTemplate = getSetting(IMAGE_SOURCE_TYPE_KEY) === PROVISION_SOURCE_TEMPLATE;
+
+  const flavor = userTemplate ? CUSTOM_FLAVOR : getSetting(FLAVOR_KEY);
+  addAnnotation(vm, TEMPLATE_FLAVOR_LABEL, flavor);
+
+  const os = userTemplate ? template.metadata.labels[TEMPLATE_OS_LABEL] : getSetting(OPERATING_SYSTEM_KEY);
+  addAnnotation(vm, TEMPLATE_OS_LABEL, os);
+
+  const workload = userTemplate ? template.metadata.labels[TEMPLATE_WORKLOAD_LABEL] : getSetting(WORKLOAD_PROFILE_KEY);
+  addAnnotation(vm, TEMPLATE_WORKLOAD_LABEL, workload);
+
+  addAnnotation(vm, ANNOTATION_USED_TEMPLATE, `${template.metadata.namespace}/${template.metadata.name}`);
+};
+
 const modifyVmObject = (vm, template, getSetting, networks, storages) => {
   setFlavor(vm, getSetting);
   setNetworks(vm, template, getSetting, networks);

src/k8s/tests/request.test.js

@@ -1,4 +1,4 @@
-import { get } from 'lodash';
+import { get, cloneDeep } from 'lodash';
 import { createVM } from '../request';
 import { settingsValue } from '../selectors';
 
@@ -10,7 +10,11 @@ import {
   PROVISION_SOURCE_URL,
   TEMPLATE_PARAM_VM_NAME,
   templates,
-  POD_NETWORK
+  POD_NETWORK,
+  TEMPLATE_FLAVOR_LABEL,
+  TEMPLATE_WORKLOAD_LABEL,
+  TEMPLATE_OS_LABEL,
+  ANNOTATION_USED_TEMPLATE
 } from '../../constants';
 
 import {
@@ -28,7 +32,8 @@ import {
   CLOUD_INIT_KEY,
   HOST_NAME_KEY,
   AUTHKEYS_KEY,
-  OPERATING_SYSTEM_KEY
+  OPERATING_SYSTEM_KEY,
+  WORKLOAD_PROFILE_KEY
 } from '../../components/Wizard/CreateVmWizard/constants';
 
 import { linuxUserTemplate } from '../mock_user_templates/linux.template';
@@ -53,6 +58,9 @@ const basicSettings = {
   },
   [OPERATING_SYSTEM_KEY]: {
     value: 'rhel7.0'
+  },
+  [WORKLOAD_PROFILE_KEY]: {
+    value: 'generic'
   }
 };
 
@@ -349,6 +357,13 @@ const testPXE = vm => {
   return vm;
 };
 
+const testMetadata = (vm, os, workload, flavor, template) => {
+  expect(vm.metadata.annotations[TEMPLATE_FLAVOR_LABEL]).toEqual(flavor);
+  expect(vm.metadata.annotations[TEMPLATE_OS_LABEL]).toEqual(os);
+  expect(vm.metadata.annotations[TEMPLATE_WORKLOAD_LABEL]).toEqual(workload);
+  expect(vm.metadata.annotations[ANNOTATION_USED_TEMPLATE]).toEqual(template);
+};
+
 describe('request.js', () => {
   it('registryImage', () => createVM(k8sCreate, templates, basicSettings, networks).then(testRegistryImage));
   it('from URL', () =>
@@ -483,4 +498,40 @@ describe('request.js', () => {
       testFirstAttachedStorage(vm, 0, 0, 2);
       return vm;
     }));
+
+  it('VM has os/flavor/workload metadata', () =>
+    createVM(k8sCreate, templates, basicSettings, pxeNetworks, attachStorageDisks).then(vm => {
+      testMetadata(
+        vm,
+        basicSettings[OPERATING_SYSTEM_KEY].value,
+        basicSettings[WORKLOAD_PROFILE_KEY].value,
+        basicSettings[FLAVOR_KEY].value,
+        'default/rhel-generic'
+      );
+      return vm;
+    }));
+  it('VM has os/flavor/workload metadata - user template without os and workload', () =>
+    createVM(k8sCreate, templates, vmUserTemplate, pxeNetworks, attachStorageDisks).then(vm => {
+      testMetadata(vm, undefined, undefined, CUSTOM_FLAVOR, 'openshift/linux-template');
+      return vm;
+    }));
+  it('VM has os/flavor/workload metadata - user template with os and workload', () => {
+    const settings = cloneDeep(vmUserTemplate);
+    settings[USER_TEMPLATE_KEY].value = 'linux-template1';
+    const userTemplate = cloneDeep(templates.find(template => template.metadata.name === 'linux-template'));
+    userTemplate.metadata.name = 'linux-template1';
+    userTemplate.metadata.labels[TEMPLATE_OS_LABEL] = 'fooOs';
+    userTemplate.metadata.labels[TEMPLATE_WORKLOAD_LABEL] = 'fooWorkload';
+
+    return createVM(k8sCreate, [...templates, userTemplate], settings, pxeNetworks, attachStorageDisks).then(vm => {
+      testMetadata(
+        vm,
+        userTemplate.metadata.labels[TEMPLATE_OS_LABEL],
+        userTemplate.metadata.labels[TEMPLATE_WORKLOAD_LABEL],
+        CUSTOM_FLAVOR,
+        `${userTemplate.metadata.namespace}/${userTemplate.metadata.name}`
+      );
+      return vm;
+    });
+  });
 });