Skip to content
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.

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

feat: support to specify volume mode when creating clusters #5333

Merged
merged 1 commit into from
Oct 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 16 additions & 17 deletions apis/apps/v1alpha1/cluster_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -414,10 +414,12 @@ type ClusterComponentVolumeClaimTemplate struct {
}

func (r *ClusterComponentVolumeClaimTemplate) toVolumeClaimTemplate() corev1.PersistentVolumeClaimTemplate {
t := corev1.PersistentVolumeClaimTemplate{}
t.ObjectMeta.Name = r.Name
t.Spec = r.Spec.ToV1PersistentVolumeClaimSpec()
return t
return corev1.PersistentVolumeClaimTemplate{
ObjectMeta: metav1.ObjectMeta{
Name: r.Name,
},
Spec: r.Spec.ToV1PersistentVolumeClaimSpec(),
}
}

type PersistentVolumeClaimSpec struct {
Expand All @@ -438,34 +440,31 @@ type PersistentVolumeClaimSpec struct {
// More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1.
// +optional
StorageClassName *string `json:"storageClassName,omitempty" protobuf:"bytes,5,opt,name=storageClassName"`
// TODO:
// // preferStorageClassNames added support specifying storageclasses.storage.k8s.io names, in order
// // to adapt multi-cloud deployment, where storageclasses are all distinctly different among clouds.
// // +listType=set
// // +optional
// PreferSCNames []string `json:"preferStorageClassNames,omitempty"`
// volumeMode defines what type of volume is required by the claim.
// +optional
VolumeMode *corev1.PersistentVolumeMode `json:"volumeMode,omitempty" protobuf:"bytes,6,opt,name=volumeMode,casttype=PersistentVolumeMode"`
}

// ToV1PersistentVolumeClaimSpec converts to corev1.PersistentVolumeClaimSpec.
func (r *PersistentVolumeClaimSpec) ToV1PersistentVolumeClaimSpec() corev1.PersistentVolumeClaimSpec {
return corev1.PersistentVolumeClaimSpec{
AccessModes: r.AccessModes,
Resources: r.Resources,
StorageClassName: r.GetStorageClassName(viper.GetString(constant.CfgKeyDefaultStorageClass)),
StorageClassName: r.getStorageClassName(viper.GetString(constant.CfgKeyDefaultStorageClass)),
VolumeMode: r.VolumeMode,
}
}

// GetStorageClassName returns PersistentVolumeClaimSpec.StorageClassName if a value is assigned; otherwise,
// getStorageClassName returns PersistentVolumeClaimSpec.StorageClassName if a value is assigned; otherwise,
// it returns preferSC argument.
func (r *PersistentVolumeClaimSpec) GetStorageClassName(preferSC string) *string {
func (r *PersistentVolumeClaimSpec) getStorageClassName(preferSC string) *string {
if r.StorageClassName != nil && *r.StorageClassName != "" {
return r.StorageClassName
}

if preferSC == "" {
return nil
if preferSC != "" {
return &preferSC
}
return &preferSC
return nil
}

type Affinity struct {
Expand Down
21 changes: 16 additions & 5 deletions apis/apps/v1alpha1/cluster_types_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ import (
. "github.com/onsi/gomega"

"github.com/spf13/viper"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/apimachinery/pkg/util/yaml"

"github.com/apecloud/kubeblocks/internal/constant"
)

var _ = Describe("", func() {

It("test GetMinAvailable", func() {
prefer := intstr.IntOrString{}
clusterCompSpec := &ClusterComponentSpec{}
Expand All @@ -56,7 +56,8 @@ var _ = Describe("", func() {
pvcSpec := r.ToV1PersistentVolumeClaimSpec()
Expect(pvcSpec.AccessModes).Should(BeEquivalentTo(r.AccessModes))
Expect(pvcSpec.Resources).Should(BeEquivalentTo(r.Resources))
Expect(pvcSpec.StorageClassName).Should(BeEquivalentTo(r.GetStorageClassName(viper.GetString(constant.CfgKeyDefaultStorageClass))))
Expect(pvcSpec.StorageClassName).Should(BeEquivalentTo(r.getStorageClassName(viper.GetString(constant.CfgKeyDefaultStorageClass))))
Expect(pvcSpec.VolumeMode).Should(BeEquivalentTo(r.VolumeMode))
})

It("test ToV1PersistentVolumeClaimSpec with default storage class", func() {
Expand All @@ -68,14 +69,24 @@ var _ = Describe("", func() {
viper.Set(constant.CfgKeyDefaultStorageClass, "")
})

It("test GetStorageClassName", func() {
It("test ToV1PersistentVolumeClaimSpec with volume mode", func() {
for _, mode := range []corev1.PersistentVolumeMode{corev1.PersistentVolumeBlock, corev1.PersistentVolumeFilesystem} {
r := PersistentVolumeClaimSpec{
VolumeMode: &mode,
}
pvcSpec := r.ToV1PersistentVolumeClaimSpec()
Expect(pvcSpec.VolumeMode).Should(BeEquivalentTo(r.VolumeMode))
}
})

It("test getStorageClassName", func() {
preferSC := "prefer-sc"
r := PersistentVolumeClaimSpec{}
r.StorageClassName = nil
Expect(r.GetStorageClassName(preferSC)).Should(BeEquivalentTo(&preferSC))
Expect(r.getStorageClassName(preferSC)).Should(BeEquivalentTo(&preferSC))
scName := "test-sc"
r.StorageClassName = &scName
Expect(r.GetStorageClassName(preferSC)).Should(BeEquivalentTo(&scName))
Expect(r.getStorageClassName(preferSC)).Should(BeEquivalentTo(&scName))
})

It("test IsDeleting", func() {
Expand Down
5 changes: 5 additions & 0 deletions apis/apps/v1alpha1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions config/crd/bases/apps.kubeblocks.io_clusters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,10 @@ spec:
description: 'storageClassName is the name of the
StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1.'
type: string
volumeMode:
description: volumeMode defines what type of volume
is required by the claim.
type: string
type: object
required:
- name
Expand Down
4 changes: 2 additions & 2 deletions controllers/apps/components/base_stateful.go
Original file line number Diff line number Diff line change
Expand Up @@ -220,9 +220,9 @@ func (c *statefulComponentBase) Restart(reqCtx intctrlutil.RequestCtx, cli clien
func (c *statefulComponentBase) ExpandVolume(reqCtx intctrlutil.RequestCtx, cli client.Client) error {
for _, vct := range c.runningWorkload.Spec.VolumeClaimTemplates {
var proto *corev1.PersistentVolumeClaimTemplate
for _, v := range c.Component.VolumeClaimTemplates {
for i, v := range c.Component.VolumeClaimTemplates {
if v.Name == vct.Name {
proto = &v
proto = &c.Component.VolumeClaimTemplates[i]
break
}
}
Expand Down
4 changes: 4 additions & 0 deletions deploy/helm/crds/apps.kubeblocks.io_clusters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,10 @@ spec:
description: 'storageClassName is the name of the
StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1.'
type: string
volumeMode:
description: volumeMode defines what type of volume
is required by the claim.
type: string
type: object
required:
- name
Expand Down