Skip to content

{vm,vl,vt}cluster: fixed volume names while using useLegacyNaming #2386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
AndrewChubatiuk wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

{vm,vl,vt}cluster: fixed volume names while using useLegacyNaming #2386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions api/operator/v1/cluster_types_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,3 +164,77 @@ func TestVTCluster_PrefixedName(t *testing.T) {
f("myapp", true, vmv1beta1.ClusterComponentInsert, "myapp-vtinsert")
f("myapp", true, vmv1beta1.ClusterComponentStorage, "myapp-vtstorage")
}

//nolint:dupl
func TestVLCluster_GetStorageVolumeName(t *testing.T) {
f := func(cr *VLCluster, want string) {
t.Helper()
assert.Equal(t, want, cr.GetStorageVolumeName())
}

// nil cluster — default name, no panic
f(nil, "vlstorage-db")

// no VLStorage — default name
f(&VLCluster{}, "vlstorage-db")

// VLStorage without storage spec — default name
f(&VLCluster{Spec: VLClusterSpec{VLStorage: &VLStorage{}}}, "vlstorage-db")

// VLStorage with storage spec but empty volume name — default name
f(&VLCluster{Spec: VLClusterSpec{VLStorage: &VLStorage{Storage: &vmv1beta1.StorageSpec{}}}}, "vlstorage-db")

// useLegacyNaming without explicit volume name — legacy name
f(&VLCluster{Spec: VLClusterSpec{UseLegacyNaming: true, VLStorage: &VLStorage{}}}, "vlstorage-volume")

// explicit volume claim template name wins regardless of useLegacyNaming
f(&VLCluster{
Spec: VLClusterSpec{
UseLegacyNaming: true,
VLStorage: &VLStorage{
Storage: &vmv1beta1.StorageSpec{
VolumeClaimTemplate: vmv1beta1.EmbeddedPersistentVolumeClaim{
EmbeddedObjectMetadata: vmv1beta1.EmbeddedObjectMetadata{Name: "custom-storage"},
},
},
},
},
}, "custom-storage")
}

//nolint:dupl
func TestVTCluster_GetStorageVolumeName(t *testing.T) {
f := func(cr *VTCluster, want string) {
t.Helper()
assert.Equal(t, want, cr.GetStorageVolumeName())
}

// nil cluster — default name, no panic
f(nil, "vtstorage-db")

// no Storage — default name
f(&VTCluster{}, "vtstorage-db")

// Storage without storage spec — default name
f(&VTCluster{Spec: VTClusterSpec{Storage: &VTStorage{}}}, "vtstorage-db")

// Storage with storage spec but empty volume name — default name
f(&VTCluster{Spec: VTClusterSpec{Storage: &VTStorage{Storage: &vmv1beta1.StorageSpec{}}}}, "vtstorage-db")

// useLegacyNaming without explicit volume name — legacy name
f(&VTCluster{Spec: VTClusterSpec{UseLegacyNaming: true, Storage: &VTStorage{}}}, "vtstorage-volume")

// explicit volume claim template name wins regardless of useLegacyNaming
f(&VTCluster{
Spec: VTClusterSpec{
UseLegacyNaming: true,
Storage: &VTStorage{
Storage: &vmv1beta1.StorageSpec{
VolumeClaimTemplate: vmv1beta1.EmbeddedPersistentVolumeClaim{
EmbeddedObjectMetadata: vmv1beta1.EmbeddedObjectMetadata{Name: "custom-storage"},
},
},
},
},
}, "custom-storage")
}
9 changes: 6 additions & 3 deletions api/operator/v1/vlcluster_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,9 +596,12 @@ type VLStorage struct {
}

// GetStorageVolumeName returns formatted name for vlstorage volume
func (cr *VLStorage) GetStorageVolumeName() string {
if cr.Storage != nil && cr.Storage.VolumeClaimTemplate.Name != "" {
return cr.Storage.VolumeClaimTemplate.Name
func (cr *VLCluster) GetStorageVolumeName() string {
if cr != nil && cr.Spec.VLStorage != nil && cr.Spec.VLStorage.Storage != nil && len(cr.Spec.VLStorage.Storage.VolumeClaimTemplate.Name) > 0 {
return cr.Spec.VLStorage.Storage.VolumeClaimTemplate.Name
}
if cr != nil && cr.Spec.UseLegacyNaming {
return "vlstorage-volume"
}
return "vlstorage-db"
}
Expand Down
9 changes: 6 additions & 3 deletions api/operator/v1/vtcluster_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,9 +506,12 @@ type VTStorage struct {
}

// GetStorageVolumeName returns formatted name for vtstorage volume
func (cr *VTStorage) GetStorageVolumeName() string {
if cr.Storage != nil && cr.Storage.VolumeClaimTemplate.Name != "" {
return cr.Storage.VolumeClaimTemplate.Name
func (cr *VTCluster) GetStorageVolumeName() string {
if cr != nil && cr.Spec.Storage != nil && cr.Spec.Storage.Storage != nil && len(cr.Spec.Storage.Storage.VolumeClaimTemplate.Name) > 0 {
return cr.Spec.Storage.Storage.VolumeClaimTemplate.Name
}
if cr != nil && cr.Spec.UseLegacyNaming {
return "vtstorage-volume"
}
return "vtstorage-db"
}
Expand Down
19 changes: 12 additions & 7 deletions api/operator/v1beta1/vmcluster_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,18 +689,23 @@ type VMRestoreOnStartConfig struct {
}

// GetStorageVolumeName returns formatted name for vmstorage volume
func (cr *VMStorage) GetStorageVolumeName() string {
if cr.Storage != nil && cr.Storage.VolumeClaimTemplate.Name != "" {
return cr.Storage.VolumeClaimTemplate.Name
func (cr *VMCluster) GetStorageVolumeName() string {
if cr != nil && cr.Spec.VMStorage != nil && cr.Spec.VMStorage.Storage != nil && len(cr.Spec.VMStorage.Storage.VolumeClaimTemplate.Name) > 0 {
return cr.Spec.VMStorage.Storage.VolumeClaimTemplate.Name
}
if cr != nil && cr.Spec.UseLegacyNaming {
return "vmstorage-volume"
}
return "vmstorage-db"
}

// GetCacheMountVolumeName returns formatted name for vmselect volume
func (cr *VMSelect) GetCacheMountVolumeName() string {
storageSpec := cr.StorageSpec
if storageSpec != nil && storageSpec.VolumeClaimTemplate.Name != "" {
return storageSpec.VolumeClaimTemplate.Name
func (cr *VMCluster) GetCacheMountVolumeName() string {
if cr != nil && cr.Spec.VMSelect != nil && cr.Spec.VMSelect.StorageSpec != nil && len(cr.Spec.VMSelect.StorageSpec.VolumeClaimTemplate.Name) > 0 {
return cr.Spec.VMSelect.StorageSpec.VolumeClaimTemplate.Name
}
if cr != nil && cr.Spec.UseLegacyNaming {
return "cache-volume"
}
return "vmselect-cachedir"
}
Expand Down
72 changes: 72 additions & 0 deletions api/operator/v1beta1/vmcluster_types_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,3 +353,75 @@ func TestVMCluster_PrefixedName(t *testing.T) {
f("myapp", true, ClusterComponentInsert, "myapp-vminsert")
f("myapp", true, ClusterComponentStorage, "myapp-vmstorage")
}

func TestVMCluster_GetStorageVolumeName(t *testing.T) {
f := func(cr *VMCluster, want string) {
t.Helper()
assert.Equal(t, want, cr.GetStorageVolumeName())
}

// nil cluster — default name
f(nil, "vmstorage-db")

// no VMStorage — default name
f(&VMCluster{}, "vmstorage-db")

// VMStorage without storage spec — default name
f(&VMCluster{Spec: VMClusterSpec{VMStorage: &VMStorage{}}}, "vmstorage-db")

// VMStorage with storage spec but empty volume name — default name
f(&VMCluster{Spec: VMClusterSpec{VMStorage: &VMStorage{Storage: &StorageSpec{}}}}, "vmstorage-db")

// useLegacyNaming without explicit volume name — legacy name
f(&VMCluster{Spec: VMClusterSpec{UseLegacyNaming: true, VMStorage: &VMStorage{}}}, "vmstorage-volume")

// nil cluster with implicit useLegacyNaming — still safe, default name
f((*VMCluster)(nil), "vmstorage-db")

// explicit volume claim template name wins regardless of useLegacyNaming
f(&VMCluster{
Spec: VMClusterSpec{
UseLegacyNaming: true,
VMStorage: &VMStorage{
Storage: &StorageSpec{
VolumeClaimTemplate: EmbeddedPersistentVolumeClaim{
EmbeddedObjectMetadata: EmbeddedObjectMetadata{Name: "custom-storage"},
},
},
},
},
}, "custom-storage")
}

func TestVMCluster_GetCacheMountVolumeName(t *testing.T) {
f := func(cr *VMCluster, want string) {
t.Helper()
assert.Equal(t, want, cr.GetCacheMountVolumeName())
}

// nil cluster — default name
f(nil, "vmselect-cachedir")

// no VMSelect — default name
f(&VMCluster{}, "vmselect-cachedir")

// VMSelect without storage spec — default name
f(&VMCluster{Spec: VMClusterSpec{VMSelect: &VMSelect{}}}, "vmselect-cachedir")

// useLegacyNaming without explicit volume name — legacy name
f(&VMCluster{Spec: VMClusterSpec{UseLegacyNaming: true, VMSelect: &VMSelect{}}}, "cache-volume")

// explicit volume claim template name wins regardless of useLegacyNaming
f(&VMCluster{
Spec: VMClusterSpec{
UseLegacyNaming: true,
VMSelect: &VMSelect{
StorageSpec: &StorageSpec{
VolumeClaimTemplate: EmbeddedPersistentVolumeClaim{
EmbeddedObjectMetadata: EmbeddedObjectMetadata{Name: "custom-cache"},
},
},
},
},
}, "custom-cache")
}
2 changes: 2 additions & 0 deletions docs/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ aliases:

## tip

@vrutkovs vrutkovs Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### API breaking change
`GetStorageVolumeName` / `GetCacheMountVolumeName` moved from component types to cluster types

* BUGFIX: [vlcluster](https://docs.victoriametrics.com/operator/resources/vlcluster/), [vtcluster](https://docs.victoriametrics.com/operator/resources/vtcluster/), [vmcluster](https://docs.victoriametrics.com/operator/resources/vmcluster/): fix `useLegacyNaming` not applying to storage/cache PVC volume names. See [#2385](https://github.com/VictoriaMetrics/operator/issues/2385).

## [v0.73.1](https://github.com/VictoriaMetrics/operator/releases/tag/v0.73.1)
**Release date:** 08 July 2026

Expand Down
4 changes: 2 additions & 2 deletions internal/controller/operator/factory/vlcluster/vlstorage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ func buildVLStorageSTSSpec(cr *vmv1.VLCluster) (*appsv1.StatefulSet, error) {
}
build.StatefulSetAddCommonParams(stsSpec, &cr.Spec.VLStorage.CommonAppsParams)
storageSpec := cr.Spec.VLStorage.Storage
if err := storageSpec.IntoSTSVolume(cr.Spec.VLStorage.GetStorageVolumeName(), &stsSpec.Spec); err != nil {
if err := storageSpec.IntoSTSVolume(cr.GetStorageVolumeName(), &stsSpec.Spec); err != nil {
return nil, err
}
stsSpec.Spec.VolumeClaimTemplates = append(stsSpec.Spec.VolumeClaimTemplates, cr.Spec.VLStorage.ClaimTemplates...)
Expand Down Expand Up @@ -271,7 +271,7 @@ func buildVLStoragePodSpec(cr *vmv1.VLCluster) (*corev1.PodTemplateSpec, error)

volumes = append(volumes, cr.Spec.VLStorage.Volumes...)
vmMounts = append(vmMounts, corev1.VolumeMount{
Name: cr.Spec.VLStorage.GetStorageVolumeName(),
Name: cr.GetStorageVolumeName(),
MountPath: cr.Spec.VLStorage.StorageDataPath,
})

Expand Down
8 changes: 4 additions & 4 deletions internal/controller/operator/factory/vmcluster/vmcluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ func genVMSelectSpec(cr *vmv1beta1.VMCluster) (*appsv1.StatefulSet, error) {
}
build.StatefulSetAddCommonParams(stsSpec, &cr.Spec.VMSelect.CommonAppsParams)
if cr.Spec.VMSelect.CacheMountPath != "" {
if err := cr.Spec.VMSelect.StorageSpec.IntoSTSVolume(cr.Spec.VMSelect.GetCacheMountVolumeName(), &stsSpec.Spec); err != nil {
if err := cr.Spec.VMSelect.StorageSpec.IntoSTSVolume(cr.GetCacheMountVolumeName(), &stsSpec.Spec); err != nil {
return nil, err
}
}
Expand Down Expand Up @@ -655,7 +655,7 @@ func makePodSpecForVMSelect(cr *vmv1beta1.VMCluster) (*corev1.PodTemplateSpec, e

if cr.Spec.VMSelect.CacheMountPath != "" {
vmMounts = append(vmMounts, corev1.VolumeMount{
Name: cr.Spec.VMSelect.GetCacheMountVolumeName(),
Name: cr.GetCacheMountVolumeName(),
MountPath: cr.Spec.VMSelect.CacheMountPath,
})
args = append(args, fmt.Sprintf("-cacheDataPath=%s", cr.Spec.VMSelect.CacheMountPath))
Expand Down Expand Up @@ -1006,7 +1006,7 @@ func buildVMStorageSpec(ctx context.Context, cr *vmv1beta1.VMCluster) (*appsv1.S
}
build.StatefulSetAddCommonParams(stsSpec, &cr.Spec.VMStorage.CommonAppsParams)
storageSpec := cr.Spec.VMStorage.Storage
if err := storageSpec.IntoSTSVolume(cr.Spec.VMStorage.GetStorageVolumeName(), &stsSpec.Spec); err != nil {
if err := storageSpec.IntoSTSVolume(cr.GetStorageVolumeName(), &stsSpec.Spec); err != nil {
return nil, err
}
stsSpec.Spec.VolumeClaimTemplates = append(stsSpec.Spec.VolumeClaimTemplates, cr.Spec.VMStorage.ClaimTemplates...)
Expand Down Expand Up @@ -1111,7 +1111,7 @@ func makePodSpecForVMStorage(ctx context.Context, cr *vmv1beta1.VMCluster) (*cor
vmMounts := make([]corev1.VolumeMount, 0)

vmMounts = append(vmMounts, corev1.VolumeMount{
Name: cr.Spec.VMStorage.GetStorageVolumeName(),
Name: cr.GetStorageVolumeName(),
MountPath: cr.Spec.VMStorage.StorageDataPath,
})
args = append(args, fmt.Sprintf("-storageDataPath=%s", cr.Spec.VMStorage.StorageDataPath))
Expand Down
4 changes: 2 additions & 2 deletions internal/controller/operator/factory/vtcluster/storage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ func buildVTStorageSTSSpec(cr *vmv1.VTCluster) (*appsv1.StatefulSet, error) {
}
build.StatefulSetAddCommonParams(stsSpec, &cr.Spec.Storage.CommonAppsParams)
storageSpec := cr.Spec.Storage.Storage
if err := storageSpec.IntoSTSVolume(cr.Spec.Storage.GetStorageVolumeName(), &stsSpec.Spec); err != nil {
if err := storageSpec.IntoSTSVolume(cr.GetStorageVolumeName(), &stsSpec.Spec); err != nil {
return nil, err
}
stsSpec.Spec.VolumeClaimTemplates = append(stsSpec.Spec.VolumeClaimTemplates, cr.Spec.Storage.ClaimTemplates...)
Expand Down Expand Up @@ -268,7 +268,7 @@ func buildVTStoragePodSpec(cr *vmv1.VTCluster) (*corev1.PodTemplateSpec, error)

volumes = append(volumes, cr.Spec.Storage.Volumes...)
vmMounts = append(vmMounts, corev1.VolumeMount{
Name: cr.Spec.Storage.GetStorageVolumeName(),
Name: cr.GetStorageVolumeName(),
MountPath: cr.Spec.Storage.StorageDataPath,
})

Expand Down
2 changes: 1 addition & 1 deletion test/e2e/vmcluster_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1474,7 +1474,7 @@ up{baz="bar"} 123
var pvc corev1.PersistentVolumeClaim
nsn := types.NamespacedName{
Namespace: namespace,
Name: fmt.Sprintf("%s-%s-0", cr.Spec.VMStorage.GetStorageVolumeName(), cr.PrefixedName(vmv1beta1.ClusterComponentStorage)),
Name: fmt.Sprintf("%s-%s-0", cr.GetStorageVolumeName(), cr.PrefixedName(vmv1beta1.ClusterComponentStorage)),
}
Expect(k8sClient.Get(ctx, nsn, &pvc)).ToNot(HaveOccurred())
},
Expand Down
Loading