Merge pull request #129 from harvester/mergify/bp/release-harvester-v1.5/pr-119

Add VlanL2Network / UntaggedNetwork types in network-storage setting (backport #119)

pkg/harvester/components/settings/storage-network.vue

@@ -12,6 +12,9 @@ import { NODE } from '@shell/config/types';
 import { HCI } from '../../types';
 import { DOC } from '../../config/doc-links';
 import { docLink } from '../../utils/feature-flags';
+import { NETWORK_TYPE } from '../../config/types';
+
+const { L2VLAN, UNTAGGED } = NETWORK_TYPE;
 
 export default {
   name: 'HarvesterEditStorageNetwork',
@@ -57,11 +60,14 @@ export default {
   data() {
     let parsedDefaultValue = {};
     let openVlan = false;
+    let networkType = L2VLAN;
 
     try {
       parsedDefaultValue = JSON.parse(this.value.value);
+      networkType = 'vlan' in parsedDefaultValue ? L2VLAN : UNTAGGED; // backend doesn't provide networkType, so we check if vlan is provided instead
       openVlan = true;
     } catch (error) {
+      networkType = L2VLAN;
       parsedDefaultValue = {
         vlan:           '',
         clusterNetwork: '',
@@ -73,6 +79,7 @@ export default {
 
     return {
       openVlan,
+      networkType,
       errors:          [],
       exclude,
       parsedDefaultValue,
@@ -87,16 +94,35 @@ export default {
   },
 
   computed: {
+    showVlan() {
+      return this.networkType === L2VLAN;
+    },
+    networkTypes() {
+      const types = [L2VLAN];
+
+      if (this.untaggedNetworkSettingEnabled) {
+        types.push(UNTAGGED);
+      }
+
+      return types;
+    },
     storageNetworkExampleLink() {
       const version = this.$store.getters['harvester-common/getServerVersion']();
 
       return docLink(DOC.STORAGE_NETWORK_EXAMPLE, version);
     },
+
+    untaggedNetworkSettingEnabled() {
+      return this.$store.getters['harvester-common/getFeatureEnabled']('untaggedNetworkSetting');
+    },
+
     clusterNetworkOptions() {
       const inStore = this.$store.getters['currentProduct'].inStore;
       const clusterNetworks = this.$store.getters[`${ inStore }/all`](HCI.CLUSTER_NETWORK) || [];
+      // untaggedNetwork filter out mgmt cluster network
+      const clusterNetworksOptions = this.networkType === UNTAGGED ? clusterNetworks.filter((net) => net.id !== 'mgmt') : clusterNetworks;
 
-      return clusterNetworks.map((n) => {
+      return clusterNetworksOptions.map((n) => {
         const disabled = !n.isReadyForStorageNetwork;
 
         return {
@@ -108,7 +134,50 @@ export default {
     },
   },
 
+  watch: {
+    networkType: {
+      handler(neu) {
+        this.parsedDefaultValue.clusterNetwork = '';
+
+        if (neu === L2VLAN) {
+          this.parsedDefaultValue.vlan = '';
+        } else {
+          delete this.parsedDefaultValue.vlan;
+        }
+      },
+      deep: true
+    }
+  },
+
   methods: {
+    inputVlan(neu) {
+      if (neu === '') {
+        this.parsedDefaultValue.vlan = '';
+
+        return;
+      }
+      const newValue = Number(neu);
+
+      if (newValue > 4094) {
+        this.parsedDefaultValue.vlan = 4094;
+      } else if (newValue < 1) {
+        this.parsedDefaultValue.vlan = 1;
+      } else {
+        this.parsedDefaultValue.vlan = newValue;
+      }
+    },
+
+    useDefault() {
+      this.openVlan = false;
+      this.networkType = L2VLAN;
+      this.parsedDefaultValue = {
+        vlan:           '',
+        clusterNetwork: '',
+        range:          '',
+        exclude:        []
+      };
+    },
+
     update() {
       const exclude = this.exclude.filter((ip) => ip);
 
@@ -138,7 +207,7 @@ export default {
           errors.push(this.t('harvester.setting.storageNetwork.range.invalid', null, true));
         }
 
-        if (!this.parsedDefaultValue.vlan) {
+        if (this.networkType === L2VLAN && !this.parsedDefaultValue.vlan) {
           errors.push(this.t('validation.required', { key: this.t('harvester.setting.storageNetwork.vlan') }, true));
         }
 
@@ -191,13 +260,25 @@ export default {
     />
 
     <div v-if="openVlan">
+      <LabeledSelect
+        v-model:value="networkType"
+        class="mb-20"
+        :options="networkTypes"
+        :mode="mode"
+        :label="t('harvester.fields.type')"
+        required
+      />
+
       <LabeledInput
+        v-if="showVlan"
         v-model:value.number="parsedDefaultValue.vlan"
         type="number"
         class="mb-20"
         :mode="mode"
         required
+        placeholder="e.g. 1 - 4094"
         label-key="harvester.setting.storageNetwork.vlan"
+        @update:value="inputVlan"
       />
 
       <LabeledSelect

pkg/harvester/config/feature-flags.js

@@ -48,7 +48,8 @@ const featuresV142 = [
 // TODO: add v1.5.0 official release note
 const featuresV150 = [
   ...featuresV142,
-  'tpmPersistentState'
+  'tpmPersistentState',
+  'untaggedNetworkSetting'
 ];
 
 export const RELEASE_FEATURES = {

pkg/harvester/config/settings.ts

@@ -65,7 +65,9 @@ export const HCI_ALLOWED_SETTINGS = {
   [HCI_SETTING.SUPPORT_BUNDLE_EXPIRATION]:              {},
   [HCI_SETTING.SUPPORT_BUNDLE_NODE_COLLECTION_TIMEOUT]: { featureFlag: 'supportBundleNodeCollectionTimeoutSetting' },
   [HCI_SETTING.SUPPORT_BUNDLE_IMAGE]:                   { kind: 'json', from: 'import' },
-  [HCI_SETTING.STORAGE_NETWORK]:                        { kind: 'custom', from: 'import' },
+  [HCI_SETTING.STORAGE_NETWORK]:                        {
+    kind: 'custom', from: 'import', canReset: true
+  },
   [HCI_SETTING.VM_FORCE_RESET_POLICY]:                  { kind: 'json', from: 'import' },
   [HCI_SETTING.SSL_CERTIFICATES]:                       { kind: 'json', from: 'import' },
   [HCI_SETTING.SSL_PARAMETERS]:                         {

pkg/harvester/config/types.js

@@ -2,3 +2,8 @@ export const BACKUP_TYPE = {
   BACKUP:   'backup',
   SNAPSHOT: 'snapshot'
 };
+
+export const NETWORK_TYPE = {
+  L2VLAN:   'L2VlanNetwork',
+  UNTAGGED: 'UntaggedNetwork'
+};

pkg/harvester/edit/harvesterhci.io.networkattachmentdefinition.vue

@@ -11,6 +11,9 @@ import { HCI as HCI_LABELS_ANNOTATIONS } from '@pkg/harvester/config/labels-anno
 import CreateEditView from '@shell/mixins/create-edit-view';
 import { allHash } from '@shell/utils/promise';
 import { HCI } from '../types';
+import { NETWORK_TYPE } from '../config/types';
+
+const { L2VLAN, UNTAGGED } = NETWORK_TYPE;
 
 const AUTO = 'auto';
 const MANUAL = 'manual';
@@ -48,7 +51,7 @@ export default {
       config.bridge = config.bridge.slice(0, -3);
     }
 
-    const type = this.value.vlanType || 'L2VlanNetwork' ;
+    const type = this.value.vlanType || L2VLAN ;
 
     return {
       config,
@@ -101,15 +104,15 @@ export default {
     },
 
     networkType() {
-      return ['L2VlanNetwork', 'UntaggedNetwork'];
+      return [L2VLAN, UNTAGGED];
     },
 
     isUntaggedNetwork() {
       if (this.isView) {
-        return this.value.vlanType === 'UntaggedNetwork';
+        return this.value.vlanType === UNTAGGED;
       }
 
-      return this.type === 'UntaggedNetwork';
+      return this.type === UNTAGGED;
     }
   },
 

pkg/harvester/l10n/en-us.yaml

@@ -1027,7 +1027,7 @@ harvester:
         invalid: '"Exclude list" is invalid.'
         addIp: Add Exclude IP
       warning: 'WARNING: <br/> Any change to storage-network requires shutting down all virtual machines before applying this setting. <br/> Users have to ensure the cluster network is configured and VLAN Configuration will cover all nodes and ensure the network connectivity is working and expected in all nodes.'
-      tip: 'Specify an IP range in the IPv4 CIDR format. <code>Number of IPs Required = Number of Nodes * 4 + Number of Disks * 2 + Number of Images to Download/Upload </code>. For more information about storage network settings, see the <a href="{url}" target="_blank">documentation</a>.'
+      tip: 'Specify an IP range in the IPv4 CIDR format. <code>Number of IPs Required = Number of Nodes * 2 + Number of Disks * 2 + Number of Images to Download/Upload </code>. For more information about storage network settings, see the <a href="{url}" target="_blank">documentation</a>.'
     vmForceDeletionPolicy:
       period: Period
     ratio : Ratio

pkg/harvester/models/k8s.cni.cncf.io.networkattachmentdefinition.js

@@ -1,5 +1,8 @@
 import SteveModel from '@shell/plugins/steve/steve-class';
 import { HCI } from '@shell/config/labels-annotations';
+import { NETWORK_TYPE } from '../config/types';
+
+const { UNTAGGED } = NETWORK_TYPE;
 
 export default class NetworkAttachmentDef extends SteveModel {
   applyDefaults() {
@@ -42,7 +45,7 @@ export default class NetworkAttachmentDef extends SteveModel {
   }
 
   get vlanId() {
-    return this.vlanType === 'UntaggedNetwork' ? 'N/A' : this.parseConfig.vlan;
+    return this.vlanType === UNTAGGED ? 'N/A' : this.parseConfig.vlan;
   }
 
   get customValidationRules() {
@@ -65,7 +68,7 @@ export default class NetworkAttachmentDef extends SteveModel {
     const route = annotations[HCI.NETWORK_ROUTE];
     let config = {};
 
-    if (this.vlanType === 'UntaggedNetwork') {
+    if (this.vlanType === UNTAGGED) {
       return 'N/A';
     }