Merge pull request #728 from qJkee/OCPEDGE-1230

OCPEDGE-1230: add metadata size field

Author: openshift-merge-bot[bot]

api/v1alpha1/lvmcluster_types.go

@@ -68,8 +68,38 @@ type ThinPoolConfig struct {
 	// It can be between 64Ki and 1Gi due to the underlying limitations of lvm2.
 	// +optional
 	ChunkSize *resource.Quantity `json:"chunkSize,omitempty"`
+
+	// MetadataSize specifies metadata size for thin pool. It used only when MetadataSizeCalculationPolicy
+	// is set to Static. No MetadataSize with a MetadataSizeCalculationPolicy set to Static will result in
+	// default metadata size of 1Gi. It can be between 2Mi and 16Gi due to the underlying limitations of lvm2.
+	// +optional
+	MetadataSize *resource.Quantity `json:"metadataSize,omitempty"`
+
+	// MetadataSizeCalculationPolicy specifies the policy to calculate metadata size for the underlying volume.
+	// When set to Host, the metadata size is calculated based on lvm2 default settings
+	// When set to Static, the metadata size is calculated based on the static size attribute provided within MetadataSize
+	// +kubebuilder:default=Host
+	// +kubebuilder:validation:Enum=Host;Static
+	// +required
+	MetadataSizeCalculationPolicy MetadataSizePolicy `json:"metadataSizeCalculationPolicy,omitempty"`
 }
 
+// MetadataSizePolicy specifies the policy to calculate the metadata size for the underlying volume.
+type MetadataSizePolicy string
+
+const (
+	// MetadataSizePolicyHost calculates the metadata size based on the lvm2 default settings.
+	MetadataSizePolicyHost MetadataSizePolicy = "Host"
+	// MetadataSizePolicyStatic calculates the metadata size based on a static size attribute.
+	MetadataSizePolicyStatic MetadataSizePolicy = "Static"
+)
+
+var (
+	ThinPoolMetadataSizeMinimum = resource.MustParse("2Mi")
+	ThinPoolMetadataSizeMaximum = resource.MustParse("16Gi")
+	ThinPoolMetadataSizeDefault = resource.MustParse("1Gi")
+)
+
 // ChunkSizeCalculationPolicy specifies the policy to calculate the chunk size for the underlying volume.
 // for more information, see man lvm.
 type ChunkSizeCalculationPolicy string

api/v1alpha1/lvmcluster_webhook.go

@@ -56,6 +56,7 @@ var (
 	ErrEmptyPathsWithMultipleDeviceClasses                   = errors.New("path list should not be empty when there are multiple deviceClasses")
 	ErrDuplicateLVMCluster                                   = errors.New("duplicate LVMClusters are not allowed, remove the old LVMCluster or work with the existing instance")
 	ErrThinPoolConfigCannotBeChanged                         = errors.New("ThinPoolConfig can not be changed")
+	ErrThinPoolMetadataSizeCanOnlyBeIncreased                = errors.New("thin pool metadata size can only be increased")
 	ErrNodeSelectorCannotBeChanged                           = errors.New("NodeSelector can not be changed")
 	ErrDevicePathsCannotBeAddedInUpdate                      = errors.New("device paths can not be added after a device class has been initialized")
 	ErrForceWipeOptionCannotBeChanged                        = errors.New("ForceWipeDevicesAndDestroyAllData can not be changed")
@@ -126,6 +127,11 @@ func (v *lvmClusterValidator) ValidateCreate(ctx context.Context, obj runtime.Ob
 		return warnings, err
 	}
 
+	metadataWarnings, err := v.verifyMetadataSize(l)
+	if err != nil {
+		return warnings, err
+	}
+	warnings = append(warnings, metadataWarnings...)
 	return warnings, nil
 }
 
@@ -197,6 +203,21 @@ func (v *lvmClusterValidator) ValidateUpdate(_ context.Context, old, new runtime
 			} else if !reflect.DeepEqual(newThinPoolConfig.ChunkSize, oldThinPoolConfig.ChunkSize) {
 				return warnings, fmt.Errorf("ThinPoolConfig.ChunkSize is invalid: %w", ErrThinPoolConfigCannotBeChanged)
 			}
+
+			if newThinPoolConfig.MetadataSizeCalculationPolicy == MetadataSizePolicyStatic {
+				if newThinPoolConfig.MetadataSize == nil {
+					warnings = append(warnings, "thin pool metadata size is unset. LVMS operator will automatically set it to 1Gb and grow metadata size if needed")
+					newThinPoolConfig.MetadataSize = &ThinPoolMetadataSizeDefault
+				}
+				if oldThinPoolConfig.MetadataSizeCalculationPolicy == MetadataSizePolicyStatic {
+					if oldThinPoolConfig.MetadataSize == nil {
+						oldThinPoolConfig.MetadataSize = &ThinPoolMetadataSizeDefault
+					}
+					if newThinPoolConfig.MetadataSize.Value() < oldThinPoolConfig.MetadataSize.Value() {
+						return warnings, fmt.Errorf("ThinPoolConfig.MetadataSize is invalid: %w", ErrThinPoolMetadataSizeCanOnlyBeIncreased)
+					}
+				}
+			}
 		}
 
 		newNodeSelector := deviceClass.NodeSelector
@@ -518,3 +539,28 @@ func (v *lvmClusterValidator) verifyChunkSize(l *LVMCluster) error {
 
 	return nil
 }
+
+func (v *lvmClusterValidator) verifyMetadataSize(l *LVMCluster) ([]string, error) {
+	warnings := make([]string, 0)
+	for _, dc := range l.Spec.Storage.DeviceClasses {
+		if dc.ThinPoolConfig == nil {
+			continue
+		}
+		if dc.ThinPoolConfig.MetadataSizeCalculationPolicy == MetadataSizePolicyHost && dc.ThinPoolConfig.MetadataSize != nil {
+			return warnings, fmt.Errorf("metadata size can not be set when metadata size calculation policy is set to Host")
+		}
+		if dc.ThinPoolConfig.MetadataSizeCalculationPolicy == MetadataSizePolicyStatic && dc.ThinPoolConfig.MetadataSize == nil {
+			warnings = append(warnings, "metadata size in unset. LVMS will set it to 1Gi by default")
+			dc.ThinPoolConfig.MetadataSize = &ThinPoolMetadataSizeDefault
+		}
+		if dc.ThinPoolConfig.MetadataSize != nil {
+			if dc.ThinPoolConfig.ChunkSize.Cmp(ThinPoolMetadataSizeMinimum) < 0 {
+				return warnings, fmt.Errorf("metadata size must be greater than or equal to %s", ThinPoolMetadataSizeMinimum.String())
+			}
+			if dc.ThinPoolConfig.MetadataSize.Cmp(ThinPoolMetadataSizeMaximum) > 0 {
+				return warnings, fmt.Errorf("metadata size must be less than or equal to %s", ThinPoolMetadataSizeMaximum.String())
+			}
+		}
+	}
+	return warnings, nil
+}

api/v1alpha1/zz_generated.deepcopy.go

@@ -213,6 +213,26 @@ spec:
                               - Host
                               - Static
                               type: string
+                            metadataSize:
+                              anyOf:
+                              - type: integer
+                              - type: string
+                              description: |-
+                                MetadataSize specifies metadata size for thin pool. It used only when MetadataSizeCalculationPolicy
+                                is set to Static. No MetadataSize with a MetadataSizeCalculationPolicy set to Static will result in
+                                default metadata size of 1Gi. It can be between 2Mi and 16Gi due to the underlying limitations of lvm2.
+                              pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                              x-kubernetes-int-or-string: true
+                            metadataSizeCalculationPolicy:
+                              default: Host
+                              description: |-
+                                MetadataSizeCalculationPolicy specifies the policy to calculate metadata size for the underlying volume.
+                                When set to Host, the metadata size is calculated based on lvm2 default settings
+                                When set to Static, the metadata size is calculated based on the static size attribute provided within MetadataSize
+                              enum:
+                              - Host
+                              - Static
+                              type: string
                             name:
                               description: Name specifies a name for the thin pool.
                               type: string
@@ -235,6 +255,7 @@ spec:
                               type: integer
                           required:
                           - chunkSizeCalculationPolicy
+                          - metadataSizeCalculationPolicy
                           - name
                           - overprovisionRatio
                           type: object

bundle/manifests/lvm.topolvm.io_lvmclusters.yaml

@@ -176,6 +176,26 @@ spec:
                     - Host
                     - Static
                     type: string
+                  metadataSize:
+                    anyOf:
+                    - type: integer
+                    - type: string
+                    description: |-
+                      MetadataSize specifies metadata size for thin pool. It used only when MetadataSizeCalculationPolicy
+                      is set to Static. No MetadataSize with a MetadataSizeCalculationPolicy set to Static will result in
+                      default metadata size of 1Gi. It can be between 2Mi and 16Gi due to the underlying limitations of lvm2.
+                    pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                    x-kubernetes-int-or-string: true
+                  metadataSizeCalculationPolicy:
+                    default: Host
+                    description: |-
+                      MetadataSizeCalculationPolicy specifies the policy to calculate metadata size for the underlying volume.
+                      When set to Host, the metadata size is calculated based on lvm2 default settings
+                      When set to Static, the metadata size is calculated based on the static size attribute provided within MetadataSize
+                    enum:
+                    - Host
+                    - Static
+                    type: string
                   name:
                     description: Name specifies a name for the thin pool.
                     type: string
@@ -197,6 +217,7 @@ spec:
                     type: integer
                 required:
                 - chunkSizeCalculationPolicy
+                - metadataSizeCalculationPolicy
                 - name
                 - overprovisionRatio
                 type: object