ui: add Upgrade Storage Class selector for v1.10+ upgrade flows (#1249)

Add a StorageClass selector to online and air-gapped upgrade pages when
the repositoryStorageClass feature is enabled (v1.10+).

- Online: stores selection in harvesterhci.io/upgrade-storage-class annotation
- Air-gapped: stores selection in image spec.targetStorageClassName
- Selector locked while uploaded image exists; unlocked on switch to URL
- Hidden on pre-v1.10 clusters

Signed-off-by: pohanhuang <pohan.huang@suse.com>
This commit is contained in:
Po Han Huang authored and GitHub committed 2026-11-17 22:34:32 +08:00
1 parent 6a20578424
commit aa5a501c29
10 files changed
+475 -12

No files matched your search

+38 -5
View File
@@ -6,26 +6,30 @@ import ModalWithCard from '@shell/components/ModalWithCard';
import LabeledSelect from '@shell/components/form/LabeledSelect';
import { Banner } from '@components/Banner';
import { HCI as HCI_ANNOTATIONS } from '@pkg/harvester/config/labels-annotations';
import { STORAGE_CLASS } from '@shell/config/types';
import { HCI } from '../types';
import UpgradeInfo from './UpgradeInfo';
import UpgradeRepositoryStorageClass, { getUpgradeRepositoryStorageClassDefault } from './UpgradeRepositoryStorageClass';
export default {
name: 'HarvesterUpgrade',
components: {
Checkbox, ModalWithCard, LabeledSelect, Banner, UpgradeInfo
Checkbox, ModalWithCard, LabeledSelect, Banner, UpgradeInfo, UpgradeRepositoryStorageClass
},
async fetch() {
const inStore = this.$store.getters['currentProduct'].inStore;
const res = await allHash({
upgradeVersion: this.$store.dispatch(`${ inStore }/findAll`, { type: HCI.SETTING }),
versions: this.$store.dispatch(`${ inStore }/findAll`, { type: HCI.VERSION }),
upgrade: this.$store.dispatch(`${ inStore }/findAll`, { type: HCI.UPGRADE }),
upgradeVersion: this.$store.dispatch(`${ inStore }/findAll`, { type: HCI.SETTING }),
versions: this.$store.dispatch(`${ inStore }/findAll`, { type: HCI.VERSION }),
upgrade: this.$store.dispatch(`${ inStore }/findAll`, { type: HCI.UPGRADE }),
storageClasses: this.$store.dispatch(`${ inStore }/findAll`, { type: STORAGE_CLASS }),
});
this.upgrade = res.upgrade;
this.storageClassName = getUpgradeRepositoryStorageClassDefault(res.storageClasses);
},
data() {
@@ -35,6 +39,7 @@ export default {
errors: '',
selectMode: true,
version: '',
storageClassName: '',
enableLogging: true,
skipSingleReplicaDetachedVol: false,
readyReleaseNote: false,
@@ -59,6 +64,10 @@ export default {
return this.versionOptions.length > 0 && !this.isUpgradeInProgress;
},
canSubmitUpgrade() {
return this.readyReleaseNote && (!this.repositoryStorageClassEnabled || !!this.storageClassName);
},
versionOptions() {
const versions = this.$store.getters['harvester/all'](HCI.VERSION) || [];
@@ -75,6 +84,16 @@ export default {
return this.$store.getters['harvester/schemaFor'](HCI.UPGRADE_LOG);
},
storageClasses() {
const inStore = this.$store.getters['currentProduct'].inStore;
return this.$store.getters[`${ inStore }/all`](STORAGE_CLASS) || [];
},
repositoryStorageClassEnabled() {
return this.$store.getters['harvester-common/getFeatureEnabled']('repositoryStorageClass');
},
skipSingleReplicaDetachedVolFeatureEnabled() {
return this.$store.getters['harvester-common/getFeatureEnabled']('skipSingleReplicaDetachedVol');
},
@@ -124,6 +143,13 @@ export default {
upgradeValue.spec.logEnabled = this.enableLogging;
}
if (this.repositoryStorageClassEnabled && this.storageClassName) {
upgradeValue.metadata.annotations = {
...upgradeValue.metadata.annotations,
[HCI_ANNOTATIONS.UPGRADE_STORAGE_CLASS]: this.storageClassName
};
}
const proxyResource = await this.$store.dispatch('harvester/create', upgradeValue);
try {
@@ -204,6 +230,13 @@ export default {
:clearable="true"
/>
<UpgradeRepositoryStorageClass
v-if="repositoryStorageClassEnabled"
v-model:value="storageClassName"
class="mb-10"
:storage-classes="storageClasses"
/>
<div
v-if="canEnableLogging"
class="mb-5"
@@ -263,7 +296,7 @@ export default {
<t k="generic.close" />
</button>
<button
:disabled="!readyReleaseNote"
:disabled="!canSubmitUpgrade"
class="btn role-tertiary bg-primary"
@click.prevent="handleUpgrade"
>
@@ -0,0 +1,83 @@
<script>
import LabeledSelect from '@shell/components/form/LabeledSelect';
import { LVM_DRIVER } from '../models/harvester/storage.k8s.io.storageclass';
import { isInternalStorageClass } from '../utils/storage-class';
export function getUpgradeRepositoryStorageClassDefault(storageClasses) {
return storageClasses.find((storageClass) => storageClass.isDefault &&
!storageClass.parameters?.backingImage &&
storageClass.provisioner !== LVM_DRIVER &&
!isInternalStorageClass(storageClass.name))?.name || '';
}
export default {
name: 'UpgradeRepositoryStorageClass',
components: { LabeledSelect },
props: {
value: {
type: String,
default: '',
},
storageClasses: {
type: Array,
default: () => [],
},
disabled: {
type: Boolean,
default: false,
},
},
emits: ['update:value'],
computed: {
storageClassOptions() {
const t = this.$store.getters['i18n/t'];
return this.storageClasses
.filter((storageClass) => !storageClass.parameters?.backingImage && storageClass.provisioner !== LVM_DRIVER)
.map((storageClass) => {
let label = storageClass.isDefault ? `${ storageClass.name } (${ t('generic.default') })` : storageClass.name;
let disabled = false;
if (isInternalStorageClass(storageClass.name)) {
label += ` (${ t('harvester.storage.internal.label') })`;
disabled = true;
}
return {
label,
value: storageClass.name,
disabled
};
});
},
},
};
</script>
<template>
<LabeledSelect
:value="value"
:label="t('harvester.upgradePage.repositoryStorageClass')"
:tooltip="t('harvester.upgradePage.repositoryStorageClassTooltip')"
:placeholder="t('harvester.upgradePage.repositoryStorageClassPlaceholder')"
:options="storageClassOptions"
:disabled="disabled"
required
@update:value="$emit('update:value', $event)"
>
<template #no-options="{ searching }">
<span
v-if="!searching"
class="text-muted"
>
{{ t('harvester.upgradePage.repositoryStorageClassNoOptions', null, true) }}
</span>
</template>
</LabeledSelect>
</template>
@@ -0,0 +1,86 @@
import { HCI as HCI_ANNOTATIONS } from '@pkg/harvester/config/labels-annotations';
import HarvesterUpgrade from '../HarvesterUpgrade.vue';
const save = jest.fn().mockResolvedValue();
const upgrade = { notifyGeneratedName: jest.fn(), save };
function createForm(storageClassName = '', repositoryStorageClassEnabled = true) {
return {
version: 'v1.10.0',
storageClassName,
repositoryStorageClassEnabled,
canEnableLogging: false,
enableLogging: true,
skipSingleReplicaDetachedVolFeatureEnabled: false,
skipSingleReplicaDetachedVol: false,
cancel: jest.fn(),
errors: '',
$store: { dispatch: jest.fn().mockResolvedValue(upgrade) }
};
}
describe('component: HarvesterUpgrade', () => {
it('uses the shared Upgrade Repository StorageClass selector', () => {
expect(HarvesterUpgrade.components.UpgradeRepositoryStorageClass).toBeDefined();
});
it('leaves the default empty when it is unavailable for upgrade repositories', async() => {
const form = {
upgrade: [],
storageClassName: 'previous',
$store: {
getters: { currentProduct: { inStore: 'harvester' } },
dispatch: jest.fn()
.mockResolvedValueOnce([])
.mockResolvedValueOnce([])
.mockResolvedValueOnce([])
.mockResolvedValueOnce([
{
name: 'lvm-local', isDefault: true, provisioner: 'lvm.driver.harvesterhci.io'
},
{ name: 'fast' }
])
}
};
await HarvesterUpgrade.fetch.call(form);
expect(form.storageClassName).toBe('');
});
it('blocks the upgrade when no StorageClass is selected', () => {
const canSubmitUpgrade = HarvesterUpgrade.computed.canSubmitUpgrade;
expect(canSubmitUpgrade.call({
readyReleaseNote: true,
repositoryStorageClassEnabled: true,
storageClassName: ''
})).toBe(false);
});
it('saves the selected StorageClass as an Upgrade annotation', async() => {
const form = createForm('fast');
await HarvesterUpgrade.methods.handleUpgrade.call(form);
expect(form.$store.dispatch).toHaveBeenCalledWith('harvester/create', expect.objectContaining({
metadata: expect.objectContaining({ annotations: { [HCI_ANNOTATIONS.UPGRADE_STORAGE_CLASS]: 'fast' } }),
spec: { version: 'v1.10.0' }
}));
});
it('omits the repository StorageClass when the feature is disabled', async() => {
const form = createForm('fast', false);
await HarvesterUpgrade.methods.handleUpgrade.call(form);
expect(form.$store.dispatch).toHaveBeenCalledWith('harvester/create', {
type: 'harvesterhci.io.upgrade',
metadata: {
generateName: 'hvst-upgrade-',
namespace: 'harvester-system'
},
spec: { version: 'v1.10.0' }
});
});
});
@@ -0,0 +1,40 @@
import UpgradeRepositoryStorageClass, { getUpgradeRepositoryStorageClassDefault } from '../UpgradeRepositoryStorageClass.vue';
const storageClasses = [
{ name: 'fast', isDefault: true },
{ name: 'image-cache', parameters: { backingImage: 'image' } },
{ name: 'lvm-local', provisioner: 'lvm.driver.harvesterhci.io' },
{ name: 'longhorn-static' },
{ name: 'slow' }
];
describe('component: UpgradeRepositoryStorageClass', () => {
it('omits backing-image and LVM StorageClasses while disabling internal classes', () => {
const form = {
storageClasses,
$store: { getters: { 'i18n/t': (key) => key } }
};
expect(UpgradeRepositoryStorageClass.computed.storageClassOptions.call(form)).toStrictEqual([
{
label: 'fast (generic.default)', value: 'fast', disabled: false
},
{
label: 'longhorn-static (harvester.storage.internal.label)', value: 'longhorn-static', disabled: true
},
{
label: 'slow', value: 'slow', disabled: false
},
]);
});
it('does not use an unavailable StorageClass as the default', () => {
expect(getUpgradeRepositoryStorageClassDefault([
{
name: 'lvm-local', isDefault: true, provisioner: 'lvm.driver.harvesterhci.io'
},
{ name: 'longhorn-static' },
{ name: 'fast' }
])).toBe('');
});
});
+1
View File
@@ -86,6 +86,7 @@ const FEATURE_FLAGS = {
'maintenanceModeConditions',
'maintenanceModeDrainTimeoutSetting',
'componentHealth',
'repositoryStorageClass',
'shutdownVMOnMigrationFailure',
],
};
@@ -47,6 +47,7 @@ export const HCI = {
OS_UPGRADE_IMAGE: 'harvesterhci.io/os-upgrade-image',
LATEST_UPGRADE: 'harvesterhci.io/latestUpgrade',
UPGRADE_STATE: 'harvesterhci.io/upgradeState',
UPGRADE_STORAGE_CLASS: 'harvesterhci.io/upgrade-storage-class',
REAY_MESSAGE: 'harvesterhci.io/read-message',
DYNAMIC_SSHKEYS_NAMES: 'harvesterhci.io/dynamic-ssh-key-names',
DYNAMIC_SSHKEYS_USERS: 'harvesterhci.io/dynamic-ssh-key-users',
+4
View File
@@ -1273,6 +1273,10 @@ harvester:
currentVersion: CURRENT VERSION
versionLabel: AVAILABLE COMPATIBLE VERSIONS
enableLogging: Enable Logging
repositoryStorageClass: Upgrade Storage Class
repositoryStorageClassTooltip: Select the StorageClass for the temporary upgrade repository volume that stores the ISO during the upgrade.
repositoryStorageClassPlaceholder: Select a StorageClass
repositoryStorageClassNoOptions: No StorageClasses are available.
skipSingleReplicaDetachedVol: Skip checking single-replica detached volumes
upgradeNode: Upgrading Node
upgradeSysService: Upgrading System Service
@@ -0,0 +1,175 @@
import { shallowMount } from '@vue/test-utils';
import { HCI as HCI_ANNOTATIONS } from '@pkg/harvester/config/labels-annotations';
import HarvesterAirgapUpgrade from '../index.vue';
function createForm(overrides = {}) {
const image = {
metadata: { annotations: {} },
spec: {
displayName: 'upgrade.iso',
url: 'https://example.com/upgrade.iso',
},
save: jest.fn(),
};
const imageResult = {
id: 'harvester-system/upgrade-image',
notifyGeneratedName: jest.fn(),
uploadImage: jest.fn().mockResolvedValue({}),
};
image.save.mockResolvedValue(imageResult);
return {
imageSource: 'new',
sourceType: 'upload',
storageClassName: 'fast',
repositoryStorageClassEnabled: true,
uploadImageId: '',
imageId: '',
imageValue: image,
value: {
metadata: { annotations: {} }, spec: {}, save: jest.fn().mockResolvedValue(), notifyGeneratedName: jest.fn()
},
canEnableLogging: false,
skipSingleReplicaDetachedVolFeatureEnabled: false,
skipSingleReplicaDetachedVol: false,
allOSImages: [],
errors: [],
file: {},
done: jest.fn(),
preprocessImageName: HarvesterAirgapUpgrade.methods.preprocessImageName,
$store: { getters: { 'i18n/t': (key) => key } },
...overrides,
};
}
describe('page: HarvesterAirgapUpgrade', () => {
it('uses the shared Upgrade Repository StorageClass selector', () => {
expect(HarvesterAirgapUpgrade.components.UpgradeRepositoryStorageClass).toBeDefined();
});
it('leaves the default empty when it is unavailable for upgrade repositories', async() => {
const form = {
storageClassName: 'previous',
initImageValue: jest.fn(),
$store: {
dispatch: jest.fn()
.mockResolvedValueOnce([])
.mockResolvedValueOnce([
{
name: 'lvm-local', isDefault: true, provisioner: 'lvm.driver.harvesterhci.io'
},
{ name: 'fast' }
])
.mockResolvedValueOnce({})
}
};
await HarvesterAirgapUpgrade.fetch.call(form);
expect(form.storageClassName).toBe('');
});
it('prevents file upload until an upgrade StorageClass is selected', () => {
const disableUploadButton = HarvesterAirgapUpgrade.computed.disableUploadButton;
expect(disableUploadButton.call({
sourceType: 'upload',
isUploading: false,
repositoryStorageClassEnabled: true,
storageClassName: ''
})).toBe(true);
});
it('unlocks the StorageClass selector after switching an uploaded image to URL', async() => {
const wrapper = shallowMount(HarvesterAirgapUpgrade, {
global: {
mocks: {
$store: {
getters: {
'harvester-common/getFeatureEnabled': (feature) => feature === 'repositoryStorageClass',
'harvester/all': () => [],
'harvester/schemaFor': () => false,
},
dispatch: jest.fn().mockResolvedValue({
metadata: { annotations: {} },
spec: {
checksum: '', displayName: '', sourceType: 'upload', url: ''
},
}),
},
t: (key) => key,
},
stubs: {
CruResource: { template: '<div><slot /></div>' },
UpgradeRepositoryStorageClass: {
props: ['disabled'],
template: '<div data-testid="storage-class" :data-disabled="disabled" />',
},
},
},
});
await wrapper.setData({
value: {},
imageValue: {
spec: {
checksum: '', displayName: '', sourceType: 'upload', url: ''
},
remove: jest.fn().mockResolvedValue(),
},
sourceType: 'upload',
uploadController: { abort: jest.fn() },
uploadImageId: 'harvester-system/upgrade-image',
});
expect(wrapper.find('[data-testid="storage-class"]').attributes('data-disabled')).toBe('true');
await wrapper.setData({ sourceType: 'download' });
expect(wrapper.find('[data-testid="storage-class"]').attributes('data-disabled')).toBe('false');
});
it('saves an uploaded upgrade image on the selected StorageClass', async() => {
const form = createForm();
await HarvesterAirgapUpgrade.methods.uploadFile.call(form, { name: 'upgrade.iso' });
expect(form.imageValue.spec.targetStorageClassName).toBe('fast');
expect(form.uploadImageId).toBe('harvester-system/upgrade-image');
});
it('saves a downloaded upgrade image on the selected StorageClass', async() => {
const form = createForm({ sourceType: 'download' });
await HarvesterAirgapUpgrade.methods.save.call(form, jest.fn());
expect(form.imageValue.spec.targetStorageClassName).toBe('fast');
});
it('keeps the legacy StorageClass when the feature is disabled', async() => {
const form = createForm({ repositoryStorageClassEnabled: false });
await HarvesterAirgapUpgrade.methods.uploadFile.call(form, { name: 'upgrade.iso' });
expect(form.imageValue.spec.targetStorageClassName).toBe('longhorn-static');
});
it('does not change the StorageClass of an existing image', async() => {
const form = createForm({
imageSource: 'exist',
imageId: 'harvester-system/existing-image',
});
form.imageValue.spec.targetStorageClassName = 'existing-class';
await HarvesterAirgapUpgrade.methods.save.call(form, jest.fn());
expect(form.imageValue.spec.targetStorageClassName).toBe('existing-class');
});
it('does not add an Upgrade StorageClass annotation when the image selects the class', async() => {
const form = createForm({ uploadImageId: 'harvester-system/upgrade-image' });
await HarvesterAirgapUpgrade.methods.save.call(form, jest.fn());
expect(form.value.metadata.annotations[HCI_ANNOTATIONS.UPGRADE_STORAGE_CLASS]).toBeUndefined();
});
});
@@ -11,6 +11,8 @@ import { HCI } from '../../../../types';
import { PRODUCT_NAME as HARVESTER_PRODUCT } from '../../../../config/harvester';
import ImagePercentageBar from '@shell/components/formatter/ImagePercentageBar';
import { Banner } from '@components/Banner';
import { STORAGE_CLASS } from '@shell/config/types';
import UpgradeRepositoryStorageClass, { getUpgradeRepositoryStorageClassDefault } from '../../../../components/UpgradeRepositoryStorageClass';
import isEmpty from 'lodash/isEmpty';
const IMAGE_METHOD = {
@@ -25,13 +27,18 @@ const UPLOAD = 'upload';
export default {
name: 'HarvesterAirgapUpgrade',
components: {
Checkbox, CruResource, LabeledSelect, LabeledInput, RadioGroup, UpgradeInfo, ImagePercentageBar, Banner
Checkbox, CruResource, LabeledSelect, LabeledInput, RadioGroup, UpgradeInfo, UpgradeRepositoryStorageClass, ImagePercentageBar, Banner
},
inheritAttrs: false,
async fetch() {
await this.$store.dispatch('harvester/findAll', { type: HCI.IMAGE });
const [, storageClasses] = await Promise.all([
this.$store.dispatch('harvester/findAll', { type: HCI.IMAGE }),
this.$store.dispatch('harvester/findAll', { type: STORAGE_CLASS })
]);
this.storageClassName = getUpgradeRepositoryStorageClassDefault(storageClasses);
const value = await this.$store.dispatch('harvester/create', {
type: HCI.UPGRADE,
@@ -65,6 +72,7 @@ export default {
uploadResult: null,
imageValue: null,
enableLogging: true,
storageClassName: '',
IMAGE_METHOD,
skipSingleReplicaDetachedVol: false,
errors: [],
@@ -122,6 +130,18 @@ export default {
return this.$store.getters['harvester/schemaFor'](HCI.UPGRADE_LOG);
},
storageClasses() {
return this.$store.getters['harvester/all'](STORAGE_CLASS) || [];
},
canSubmitUpgrade() {
return this.enableUpgrade && (!this.repositoryStorageClassEnabled || !this.createNewImage || !!this.storageClassName);
},
repositoryStorageClassEnabled() {
return this.$store.getters['harvester-common/getFeatureEnabled']('repositoryStorageClass');
},
uploadProgress() {
const image = this.$store.getters['harvester/byId'](HCI.IMAGE, this.imageValue.id);
@@ -165,7 +185,7 @@ export default {
},
disableUploadButton() {
return this.sourceType === UPLOAD && this.isUploading;
return this.sourceType === UPLOAD && (this.isUploading || (this.repositoryStorageClassEnabled && !this.storageClassName));
},
},
@@ -229,7 +249,7 @@ export default {
}
this.imageValue.spec.sourceType = DOWNLOAD;
this.imageValue.spec.targetStorageClassName = 'longhorn-static';
this.imageValue.spec.targetStorageClassName = this.repositoryStorageClassEnabled ? this.storageClassName : 'longhorn-static';
res = await this.imageValue.save();
res.notifyGeneratedName?.();
@@ -251,7 +271,10 @@ export default {
this.value.spec.logEnabled = this.enableLogging;
}
if (this.skipSingleReplicaDetachedVolFeatureEnabled) {
this.value.metadata.annotations = { [HCI_ANNOTATIONS.SKIP_SINGLE_REPLICA_DETACHED_VOL]: JSON.stringify(this.skipSingleReplicaDetachedVol) };
this.value.metadata.annotations = {
...this.value.metadata.annotations,
[HCI_ANNOTATIONS.SKIP_SINGLE_REPLICA_DETACHED_VOL]: JSON.stringify(this.skipSingleReplicaDetachedVol)
};
}
await this.value.save();
this.value.notifyGeneratedName?.();
@@ -288,7 +311,7 @@ export default {
this.imageValue.spec.url = '';
try {
this.imageValue.spec.targetStorageClassName = 'longhorn-static';
this.imageValue.spec.targetStorageClassName = this.repositoryStorageClassEnabled ? this.storageClassName : 'longhorn-static';
const res = await this.imageValue.save();
@@ -354,6 +377,10 @@ export default {
watch: {
async sourceType(neu) {
if (neu === DOWNLOAD) {
this.uploadImageId = '';
}
if (neu === DOWNLOAD && this.imageValue && this.uploadController) {
if (this.uploadController) {
this.uploadController.abort();
@@ -412,7 +439,7 @@ export default {
:errors="errors"
:can-yaml="false"
finish-button-mode="upgrade"
:validation-passed="enableUpgrade"
:validation-passed="canSubmitUpgrade"
:cancel-event="true"
@finish="save"
@cancel="done"
@@ -481,6 +508,14 @@ export default {
required
/>
<UpgradeRepositoryStorageClass
v-if="repositoryStorageClassEnabled"
v-model:value="storageClassName"
class="mb-20"
:disabled="uploadImageId !== ''"
:storage-classes="storageClasses"
/>
<LabeledInput
v-model:value="imageValue.spec.checksum"
class="mb-10"
@@ -21,6 +21,11 @@ describe('featureEnabled', () => {
expect(featureEnabled('vncPreserveSession', 'v1.7.0')).toBe(true);
});
it('should enable repositoryStorageClass only from Harvester v1.10.0', () => {
expect(featureEnabled('repositoryStorageClass', 'v1.9.1')).toBe(false);
expect(featureEnabled('repositoryStorageClass', 'v1.10.0')).toBe(true);
});
it('should return false for unknown features', () => {
expect(featureEnabled('doesNotExist', 'v1.8.0')).toBe(false);
});