feat: introduce rwxNetwork setting (#746) (#750)

* feat: add rwxNetwork setting



* fix: network payload



---------


(cherry picked from commit d1949641a7b6f5055a0eba210196d5e83db08f1a)

Signed-off-by: Andy Lee <andy.lee@suse.com>
Co-authored-by: Andy Lee <andy.lee@suse.com>

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

@@ -0,0 +1,371 @@
+<script>
+import { LabeledInput } from '@components/Form/LabeledInput';
+import LabeledSelect from '@shell/components/form/LabeledSelect.vue';
+import { RadioGroup } from '@components/Form/Radio';
+import ArrayList from '@shell/components/form/ArrayList';
+import { isValidCIDR } from '@shell/utils/validators/cidr';
+import { _EDIT } from '@shell/config/query-params';
+import { Banner } from '@components/Banner';
+import { allHash } from '@shell/utils/promise';
+import { HCI } from '../../types';
+import { NETWORK_TYPE } from '../../config/types';
+
+const { L2VLAN, UNTAGGED } = NETWORK_TYPE;
+const SHARE_STORAGE_NETWORK = 'share-storage-network';
+const NETWORK = 'network';
+
+const DEFAULT_DEDICATED_NETWORK = {
+  vlan:           '',
+  clusterNetwork: '',
+  range:          '',
+  exclude:        [],
+};
+
+export default {
+  name: 'RwxNetworkSetting',
+
+  components: {
+    RadioGroup,
+    Banner,
+    ArrayList,
+    LabeledInput,
+    LabeledSelect,
+  },
+
+  props: {
+    registerBeforeHook: {
+      type:     Function,
+      required: true,
+    },
+
+    mode: {
+      type:    String,
+      default: _EDIT,
+    },
+
+    value: {
+      type:    Object,
+      default: () => {
+        return {};
+      },
+    },
+  },
+
+  async fetch() {
+    const inStore = this.$store.getters['currentProduct'].inStore;
+
+    await allHash({
+      clusterNetworks: this.$store.dispatch(`${ inStore }/findAll`, { type: HCI.CLUSTER_NETWORK }),
+      vlanStatus:      this.$store.dispatch(`${ inStore }/findAll`, { type: HCI.VLAN_STATUS }),
+    });
+  },
+
+  data() {
+    let enabled = false; // enabled / disabled options
+    let shareStorageNetwork = false; // shareStorageNetwork / dedicatedRwxNetwork options
+    let dedicatedNetwork = { ...DEFAULT_DEDICATED_NETWORK };
+    let networkType = L2VLAN;
+    let exclude = [];
+
+    try {
+      const parsedValue = JSON.parse(this.value.value || this.value.default || '{}');
+      const parsedNetwork = parsedValue?.[NETWORK] || parsedValue || {};
+
+      if (parsedValue && typeof parsedValue === 'object') {
+        shareStorageNetwork = !!parsedValue[SHARE_STORAGE_NETWORK];
+        networkType = 'vlan' in parsedNetwork ? L2VLAN : UNTAGGED;
+        dedicatedNetwork = {
+          vlan:           parsedNetwork.vlan || '',
+          clusterNetwork: parsedNetwork.clusterNetwork || '',
+          range:          parsedNetwork.range || '',
+        };
+        exclude = parsedNetwork?.exclude?.toString().split(',') || [];
+        enabled = shareStorageNetwork || !!(parsedNetwork.vlan || parsedNetwork.clusterNetwork || parsedNetwork.range);
+      }
+    } catch (error) {
+      enabled = false;
+      shareStorageNetwork = false;
+      dedicatedNetwork = { ...DEFAULT_DEDICATED_NETWORK };
+    }
+
+    return {
+      enabled,
+      shareStorageNetwork,
+      dedicatedNetwork,
+      networkType,
+      exclude,
+      defaultAddValue: '',
+    };
+  },
+
+  created() {
+    if (this.registerBeforeHook) {
+      this.registerBeforeHook(this.willSave, 'willSave');
+    }
+  },
+
+  computed: {
+    showDedicatedNetworkConfig() {
+      return this.enabled && !this.shareStorageNetwork;
+    },
+
+    showVlan() {
+      return this.networkType === L2VLAN;
+    },
+
+    networkTypes() {
+      return [L2VLAN, UNTAGGED];
+    },
+
+    clusterNetworkOptions() {
+      const inStore = this.$store.getters['currentProduct'].inStore;
+      const clusterNetworks = this.$store.getters[`${ inStore }/all`](HCI.CLUSTER_NETWORK) || [];
+      const clusterNetworksOptions = this.networkType === UNTAGGED ? clusterNetworks.filter((network) => network.id !== 'mgmt') : clusterNetworks;
+
+      return clusterNetworksOptions.map((network) => {
+        const disabled = !network.isReadyForStorageNetwork;
+
+        return {
+          label: disabled ? `${ network.id } (${ this.t('generic.notReady') })` : network.id,
+          value: network.id,
+          disabled,
+        };
+      });
+    },
+  },
+
+  methods: {
+    onUpdateEnabled() {
+      if (!this.enabled) {
+        this.shareStorageNetwork = false;
+        this.dedicatedNetwork = { ...DEFAULT_DEDICATED_NETWORK };
+      }
+
+      this.update();
+    },
+
+    onUpdateNetworkType() {
+      if (this.shareStorageNetwork) {
+        this.dedicatedNetwork = { ...DEFAULT_DEDICATED_NETWORK };
+      }
+
+      this.update();
+    },
+
+    onUpdateDedicatedType(neu) {
+      this.dedicatedNetwork.clusterNetwork = '';
+
+      if (neu === L2VLAN) {
+        this.dedicatedNetwork.vlan = '';
+      } else {
+        delete this.dedicatedNetwork.vlan;
+      }
+
+      this.update();
+    },
+
+    inputVlan(neu) {
+      if (neu === '') {
+        this.dedicatedNetwork.vlan = '';
+        this.update();
+
+        return;
+      }
+
+      const newValue = Number(neu);
+
+      if (newValue > 4094) {
+        this.dedicatedNetwork.vlan = 4094;
+      } else if (newValue < 1) {
+        this.dedicatedNetwork.vlan = 1;
+      } else {
+        this.dedicatedNetwork.vlan = newValue;
+      }
+
+      this.update();
+    },
+
+    useDefault() {
+      this.enabled = false;
+      this.shareStorageNetwork = false;
+      this.dedicatedNetwork = { ...DEFAULT_DEDICATED_NETWORK };
+      this.update();
+    },
+
+    update() {
+      const value = { [SHARE_STORAGE_NETWORK]: false };
+
+      if (this.enabled && this.shareStorageNetwork) {
+        value[SHARE_STORAGE_NETWORK] = true;
+      }
+
+      if (this.showDedicatedNetworkConfig) {
+        value[NETWORK] = {};
+
+        if (this.showVlan) {
+          value[NETWORK].vlan = this.dedicatedNetwork.vlan;
+        }
+
+        value[NETWORK].clusterNetwork = this.dedicatedNetwork.clusterNetwork;
+        value[NETWORK].range = this.dedicatedNetwork.range;
+
+        const excludeList = this.exclude.filter((ip) => ip);
+
+        if (Array.isArray(excludeList) && excludeList.length > 0) {
+          value[NETWORK].exclude = excludeList;
+        }
+      }
+
+      this.value.value = JSON.stringify(value);
+    },
+
+    willSave() {
+      this.update();
+
+      if (!this.showDedicatedNetworkConfig) {
+        return Promise.resolve();
+      }
+
+      const errors = [];
+
+      if (this.showVlan && !this.dedicatedNetwork.vlan) {
+        errors.push(this.t('validation.required', { key: this.t('harvester.setting.storageNetwork.vlan') }, true));
+      }
+
+      if (!this.dedicatedNetwork.clusterNetwork) {
+        errors.push(this.t('validation.required', { key: this.t('harvester.setting.storageNetwork.clusterNetwork') }, true));
+      }
+
+      if (!this.dedicatedNetwork.range) {
+        errors.push(this.t('validation.required', { key: this.t('harvester.setting.storageNetwork.range.label') }, true));
+      } else if (!isValidCIDR(this.dedicatedNetwork.range)) {
+        errors.push(this.t('harvester.setting.storageNetwork.range.invalid', null, true));
+      }
+
+      if (this.exclude) {
+        const hasInvalidCIDR = this.exclude.find((cidr) => {
+          return cidr && !isValidCIDR(cidr);
+        });
+
+        if (hasInvalidCIDR) {
+          errors.push(this.t('harvester.setting.storageNetwork.exclude.invalid', null, true));
+        }
+      }
+
+      if (errors.length > 0) {
+        return Promise.reject(errors);
+      }
+
+      return Promise.resolve();
+    },
+  },
+};
+</script>
+
+<template>
+  <div :class="mode">
+    <Banner color="warning">
+      <t
+        k="harvester.setting.rwxNetwork.warning"
+        :raw="true"
+      />
+    </Banner>
+    <RadioGroup
+      v-model:value="enabled"
+      class="mb-20"
+      name="rwx-network-enable"
+      :options="[true,false]"
+      :labels="[t('generic.enabled'), t('generic.disabled')]"
+      @update:value="onUpdateEnabled"
+    />
+
+    <RadioGroup
+      v-if="enabled"
+      v-model:value="shareStorageNetwork"
+      class="mb-20"
+      name="rwx-network-type"
+      :options="[true,false]"
+      :labels="[t('harvester.setting.rwxNetwork.shareStorageNetwork'), t('harvester.setting.rwxNetwork.dedicatedRwxNetwork')]"
+      @update:value="onUpdateNetworkType"
+    />
+    <Banner
+      v-if="shareStorageNetwork"
+      class="mb-20"
+      color="warning"
+    >
+      <t
+        k="harvester.setting.rwxNetwork.shareStorageNetworkWarning"
+        :raw="true"
+      />
+    </Banner>
+    <template v-if="showDedicatedNetworkConfig">
+      <LabeledSelect
+        v-model:value="networkType"
+        class="mb-20"
+        :options="networkTypes"
+        :mode="mode"
+        :label="t('harvester.fields.type')"
+        required
+        @update:value="onUpdateDedicatedType"
+      />
+
+      <LabeledInput
+        v-if="showVlan"
+        v-model:value.number="dedicatedNetwork.vlan"
+        type="number"
+        class="mb-20"
+        :mode="mode"
+        required
+        placeholder="e.g. 1 - 4094"
+        label-key="harvester.setting.storageNetwork.vlan"
+        @update:value="inputVlan"
+      />
+
+      <LabeledSelect
+        v-model:value="dedicatedNetwork.clusterNetwork"
+        label-key="harvester.setting.storageNetwork.clusterNetwork"
+        class="mb-20"
+        required
+        :options="clusterNetworkOptions"
+        @update:value="update"
+      />
+
+      <LabeledInput
+        v-model:value="dedicatedNetwork.range"
+        class="mb-5"
+        :mode="mode"
+        required
+        :placeholder="t('harvester.setting.storageNetwork.range.placeholder')"
+        label-key="harvester.setting.storageNetwork.range.label"
+        @update:value="update"
+      />
+
+      <ArrayList
+        v-model:value="exclude"
+        :show-header="true"
+        :default-add-value="defaultAddValue"
+        :mode="mode"
+        :add-label="t('harvester.setting.storageNetwork.exclude.addIp')"
+        class="mt-20"
+        @update:value="update"
+      >
+        <template #column-headers>
+          <div class="box mb-10">
+            <div class="key">
+              {{ t('harvester.setting.storageNetwork.exclude.label') }}
+            </div>
+          </div>
+        </template>
+        <template #columns="scope">
+          <div class="key">
+            <input
+              v-model="scope.row.value"
+              :placeholder="t('harvester.setting.storageNetwork.exclude.placeholder')"
+              @update:value="update"
+            />
+          </div>
+        </template>
+      </ArrayList>
+    </template>
+  </div>
+</template>

pkg/harvester/config/feature-flags.js

@@ -64,6 +64,7 @@ const FEATURE_FLAGS = {
     'clusterRegistrationTLSVerify',
     'vGPUAsPCIDevice',
     'instanceManagerResourcesSetting',
+    'rwxNetworkSetting',
   ],
 };
 

pkg/harvester/config/settings.ts

@@ -20,6 +20,7 @@ export const HCI_SETTING = {
   SUPPORT_BUNDLE_IMAGE:                   'support-bundle-image',
   SUPPORT_BUNDLE_NODE_COLLECTION_TIMEOUT: 'support-bundle-node-collection-timeout',
   STORAGE_NETWORK:                        'storage-network',
+  RWX_NETWORK:                            'rwx-network',
   VM_FORCE_RESET_POLICY:                  'vm-force-reset-policy',
   SSL_CERTIFICATES:                       'ssl-certificates',
   SSL_PARAMETERS:                         'ssl-parameters',
@@ -81,6 +82,9 @@ export const HCI_ALLOWED_SETTINGS = {
   [HCI_SETTING.STORAGE_NETWORK]:                        {
     kind: 'custom', from: 'import', canReset: true
   },
+  [HCI_SETTING.RWX_NETWORK]:                            {
+    kind: 'custom', from: 'import', canReset: true, featureFlag: 'rwxNetworkSetting'
+  },
   [HCI_SETTING.VM_FORCE_RESET_POLICY]:                  { kind: 'json', from: 'import' },
   [HCI_SETTING.SSL_CERTIFICATES]:                       { kind: 'json', from: 'import' },
   [HCI_SETTING.SSL_PARAMETERS]:                         {

pkg/harvester/l10n/en-us.yaml

@@ -1280,6 +1280,11 @@ harvester:
         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 * 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>.'
+    rwxNetwork:
+      warning: 'WARNING: <br/> Any change to rwx-network requires longhorn RWX volumes detached 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.'
+      shareStorageNetwork: Share Storage Network
+      dedicatedRwxNetwork: Dedicated RWX Network
+      shareStorageNetworkWarning: The rwx-network is governed by storage-network, and changes here won't take effect until share-storage-network is set to false.
     vmForceDeletionPolicy:
       period: Period
       vmMigrationTimeout: VM Migration Timeout
@@ -1998,6 +2003,7 @@ advancedSettings:
     'harv-vm-force-reset-policy': Configuration for the force-reset action when a virtual machine is stuck on a node that is down.
     'harv-ssl-parameters': Custom SSL Parameters for TLS validation.
     'harv-storage-network': 'Longhorn storage-network setting.'
+    'harv-rwx-network': 'Configure RWX network behavior for shared or dedicated storage network usage.'
     'harv-support-bundle-namespaces': Select additional namespaces to include in the support bundle.
     'harv-auto-disk-provision-paths': Specify the disks(using glob pattern) that Harvester will automatically add as virtual machine storage.
     'harv-support-bundle-image': Support bundle image configuration. Find different versions in <a href="https://hub.docker.com/r/rancher/support-bundle-kit/tags" target="_blank">rancher/support-bundle-kit</a>.