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

Jump to bottom

Add ScyllaDBCluster webhook validation #2271

Open

zimnx wants to merge 2 commits into scylladb:master from zimnx:scylladbcluster-webhook

+2,526 −0

Collaborator

zimnx commented Dec 16, 2024 •

edited

Loading

Description of your changes:

Adds validation rules for v1alpha1.ScyllaDBCluster to existing validating webhook.

Which issue is resolved by this Pull Request:
Resolves #2280

zimnx added kind/feature priority/important-soon labels

Contributor

scylla-operator-bot bot commented Dec 16, 2024

@zimnx: GitHub didn't allow me to request PR reviews from the following users: zimnx.

Note that only scylladb members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

Description of your changes:

Adds validation rules for v1alpha1.ScyllaDBCluster to existing validating webhook.

Which issue is resolved by this Pull Request:
Resolves #

/cc

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

scylla-operator-bot bot added the do-not-merge/work-in-progress label

Contributor

scylla-operator-bot bot commented Dec 16, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zimnx

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [zimnx]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

scylla-operator-bot bot added approved size/XXL labels

zimnx force-pushed the scylladbcluster-webhook branch 3 times, most recently from 9a65306 to 6ae7f48 Compare

December 16, 2024 19:57

zimnx added 2 commits

December 17, 2024 17:15


          Add ScyllaDBCluster webhook validation

f76bbf0


          Update autogenerated

38ef9a7

zimnx force-pushed the scylladbcluster-webhook branch from 6ae7f48 to 38ef9a7 Compare

December 17, 2024 16:15

zimnx changed the title ~~[WIP] Add ScyllaDBCluster webhook validation~~ Add ScyllaDBCluster webhook validation

scylla-operator-bot bot removed the do-not-merge/work-in-progress label

Collaborator Author

zimnx commented Dec 18, 2024

/cc rzetelskik
/cc tnozicka

Ready to review

scylla-operator-bot bot requested review from rzetelskik and tnozicka

December 18, 2024 13:30

rzetelskik reviewed

View reviewed changes

Member

rzetelskik left a comment

first batch

pkg/api/scylla/validation/scylladbcluster_validation.go

+              	if spec.MinReadySeconds != nil && *spec.MinReadySeconds < 0 {
+              		allErrs = append(allErrs, apimachineryvalidation.ValidateNonnegativeField(int64(*spec.MinReadySeconds), fldPath.Child("minReadySeconds"))...)
+              	}

Member

rzetelskik Dec 27, 2024

ReadinessGates validation is missing: see e.g. https://github.com/kubernetes/kubernetes/blob/v1.32.0/pkg/apis/core/validation/validation.go#L3736-L3742

pkg/api/scylla/validation/scylladbcluster_validation.go


		func ValidateScyllaDBClusterDatacenterTemplate(dcTemplate scyllav1alpha1.ScyllaDBClusterDatacenterTemplate, fldPath field.Path) field.ErrorList {
		allErrs := field.ErrorList{}

Member

rzetelskik Dec 27, 2024

metadata validation is missing (labels, annotations, especially pod-specific)

pkg/api/scylla/validation/scylladbcluster_validation.go


		func ValidateScyllaDBClusterDatacenterTemplate(dcTemplate scyllav1alpha1.ScyllaDBClusterDatacenterTemplate, fldPath field.Path) field.ErrorList {
		allErrs := field.ErrorList{}

Member

rzetelskik Dec 27, 2024

seems like placement should be validated as well?

pkg/api/scylla/validation/scylladbcluster_validation.go

Comment on lines +109 to +132

+              		if dcTemplate.ScyllaDB.Storage != nil {
+              			if dcTemplate.ScyllaDB.Storage.Metadata != nil {
+              				allErrs = append(allErrs, apimachinerymetav1validation.ValidateLabels(dcTemplate.ScyllaDB.Storage.Metadata.Labels, fldPath.Child("scyllaDB", "storage", "metadata", "labels"))...)
+              				allErrs = append(allErrs, apimachineryvalidation.ValidateAnnotations(dcTemplate.ScyllaDB.Storage.Metadata.Annotations, fldPath.Child("scyllaDB", "storage", "metadata", "annotations"))...)
+              			}
+              			storageCapacity, err := resource.ParseQuantity(dcTemplate.ScyllaDB.Storage.Capacity)
+              			if err != nil {
+              				allErrs = append(allErrs, field.Invalid(fldPath.Child("scyllaDB", "storage", "capacity"), dcTemplate.ScyllaDB.Storage.Capacity, fmt.Sprintf("unable to parse capacity: %v", err)))
+              			} else if storageCapacity.CmpInt64(0) <= 0 {
+              				allErrs = append(allErrs, field.Invalid(fldPath.Child("scyllaDB", "storage", "capacity"), dcTemplate.ScyllaDB.Storage.Capacity, "must be greater than zero"))
+              			}
+              			if dcTemplate.ScyllaDB.Storage.StorageClassName != nil {
+              				for _, msg := range apimachineryvalidation.NameIsDNSSubdomain(*dcTemplate.ScyllaDB.Storage.StorageClassName, false) {
+              					allErrs = append(allErrs, field.Invalid(fldPath.Child("scyllaDB", "storage", "storageClassName"), *dcTemplate.ScyllaDB.Storage.StorageClassName, msg))
+              				}
+              			}
+              		}
+              		if dcTemplate.ScyllaDB.CustomConfigMapRef != nil {
+              			for _, msg := range apimachineryvalidation.NameIsDNSSubdomain(*dcTemplate.ScyllaDB.CustomConfigMapRef, false) {
+              				allErrs = append(allErrs, field.Invalid(fldPath.Child("scyllaDB", "customConfigMapRef"), *dcTemplate.ScyllaDB.CustomConfigMapRef, msg))
+              			}

Member

rzetelskik Dec 27, 2024

Seems to duplicate with types_scylladbdatacenter.go. Also why isn't this split into functions?

pkg/api/scylla/validation/scylladbcluster_validation.go

Comment on lines +137 to +141

+              		if dcTemplate.ScyllaDBManagerAgent.CustomConfigSecretRef != nil {
+              			for _, msg := range apimachineryvalidation.NameIsDNSSubdomain(*dcTemplate.ScyllaDBManagerAgent.CustomConfigSecretRef, false) {
+              				allErrs = append(allErrs, field.Invalid(fldPath.Child("scyllaDBManagerAgent", "customConfigSecretRef"), *dcTemplate.ScyllaDBManagerAgent.CustomConfigSecretRef, msg))
+              			}
+              		}

Member

rzetelskik Dec 27, 2024

ditto

pkg/api/scylla/validation/scylladbcluster_validation.go

Comment on lines +164 to +167

+              	var supportedServiceTypes = []scyllav1alpha1.NodeServiceType{
+              		scyllav1alpha1.NodeServiceTypeHeadless,
+              		scyllav1alpha1.NodeServiceTypeLoadBalancer,
+              	}

Member

rzetelskik Dec 27, 2024

clusterIP should also be supported: https://github.com/scylladb/scylla-operator-enterprise/pull/41#discussion_r1688275789

pkg/api/scylla/validation/scylladbcluster_validation.go

Comment on lines +195 to +203

+              	var allowedNodeServiceTypesByBroadcastAddressType = map[scyllav1alpha1.BroadcastAddressType][]scyllav1alpha1.NodeServiceType{
+              		scyllav1alpha1.BroadcastAddressTypePodIP: {
+              			scyllav1alpha1.NodeServiceTypeHeadless,
+              			scyllav1alpha1.NodeServiceTypeLoadBalancer,
+              		},
+              		scyllav1alpha1.BroadcastAddressTypeServiceLoadBalancerIngress: {
+              			scyllav1alpha1.NodeServiceTypeLoadBalancer,
+              		},
+              	}

Member

rzetelskik Dec 27, 2024

ditto

pkg/api/scylla/validation/scylladbcluster_validation.go

+              			}
+              			if !isDatacenterStatusUpToDate(old, oldDCStatus) {
+              				allErrs = append(allErrs, field.InternalError(fldPath.Child("datacenters").Index(i), fmt.Errorf("datacenters %q can't be removed because its status, that's used to determine node count, is not yet up to date with the generation of this resource; please retry later", removedDCName)))

Member

rzetelskik Dec 27, 2024

Suggested change

      
            				allErrs = append(allErrs, field.InternalError(fldPath.Child("datacenters").Index(i), fmt.Errorf("datacenters %q can't be removed because its status, that's used to determine node count, is not yet up to date with the generation of this resource; please retry later", removedDCName)))
          
            				allErrs = append(allErrs, field.InternalError(fldPath.Child("datacenters").Index(i), fmt.Errorf("datacenter %q can't be removed because its status, that's used to determine node count, is not yet up to date with the generation of this resource; please retry later", removedDCName)))

pkg/api/scylla/validation/scylladbcluster_validation.go

+              				return dcStatus.Name == removedDCName
+              			})
+              			if !ok {
+              				continue

Member

rzetelskik Dec 27, 2024

shouldn't this also result in an error? Isn't no status equivalent to out-of-date status?

pkg/api/scylla/validation/scylladbcluster_validation.go

+              			}
+              			if oldDCStatus.Nodes != nil && *oldDCStatus.Nodes != 0 {
+              				allErrs = append(allErrs, field.Forbidden(fldPath.Child("datacenters").Index(i), fmt.Sprintf("datacenter %q can't be removed because the nodes are being scaled down", removedDCName)))

Member

rzetelskik Dec 27, 2024

nit: its nodes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved kind/feature priority/important-soon size/XXL