Skip to content

Commit b4587dc

Browse files
cbandycbandy
committed
Replace our CRD validation patch with CEL rules
The JSON patch was awkward to maintain, and we forgot to update it when we added PVCs to our APIs. I considered defining these rules on a shared Go type in our API package, but I did not like the type conversion it requires in our controller and test code. Issue: PGO-1748
1 parent e991f04 commit b4587dc

File tree

5 files changed

+86
-94
lines changed

5 files changed

+86
-94
lines changed

‎build/crd/postgresclusters/kustomization.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,6 @@ resources:
55
- generated/postgres-operator.crunchydata.com_postgresclusters.yaml
66

77
patches:
8-
- target:
9-
group: apiextensions.k8s.io
10-
version: v1
11-
kind: CustomResourceDefinition
12-
name: postgresclusters.postgres-operator.crunchydata.com
13-
path: validation.yaml
148
- target:
159
group: apiextensions.k8s.io
1610
version: v1

‎build/crd/postgresclusters/validation.yaml‎

Lines changed: 0 additions & 63 deletions
This file was deleted.

‎config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml‎

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2913,7 +2913,6 @@ spec:
29132913
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
29142914
items:
29152915
type: string
2916-
minItems: 1
29172916
type: array
29182917
x-kubernetes-list-type: atomic
29192918
dataSource:
@@ -3027,11 +3026,7 @@ spec:
30273026
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
30283027
otherwise to an implementation-defined value. Requests cannot exceed Limits.
30293028
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
3030-
required:
3031-
- storage
30323029
type: object
3033-
required:
3034-
- requests
30353030
type: object
30363031
selector:
30373032
description: selector is a label query over
@@ -3110,10 +3105,14 @@ spec:
31103105
description: volumeName is the binding reference
31113106
to the PersistentVolume backing this claim.
31123107
type: string
3113-
required:
3114-
- accessModes
3115-
- resources
31163108
type: object
3109+
x-kubernetes-validations:
3110+
- message: missing accessModes
3111+
rule: has(self.accessModes) && size(self.accessModes)
3112+
> 0
3113+
- message: missing storage request
3114+
rule: has(self.resources) && has(self.resources.requests)
3115+
&& has(self.resources.requests.storage)
31173116
required:
31183117
- volumeClaimSpec
31193118
type: object
@@ -6365,6 +6364,13 @@ spec:
63656364
to the PersistentVolume backing this claim.
63666365
type: string
63676366
type: object
6367+
x-kubernetes-validations:
6368+
- message: missing accessModes
6369+
rule: has(self.accessModes) && size(self.accessModes)
6370+
> 0
6371+
- message: missing storage request
6372+
rule: has(self.resources) && has(self.resources.requests)
6373+
&& has(self.resources.requests.storage)
63686374
required:
63696375
- volumeClaimSpec
63706376
type: object
@@ -10039,7 +10045,6 @@ spec:
1003910045
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
1004010046
items:
1004110047
type: string
10042-
minItems: 1
1004310048
type: array
1004410049
x-kubernetes-list-type: atomic
1004510050
dataSource:
@@ -10149,11 +10154,7 @@ spec:
1014910154
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
1015010155
otherwise to an implementation-defined value. Requests cannot exceed Limits.
1015110156
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
10152-
required:
10153-
- storage
1015410157
type: object
10155-
required:
10156-
- requests
1015710158
type: object
1015810159
selector:
1015910160
description: selector is a label query over volumes to consider
@@ -10231,10 +10232,13 @@ spec:
1023110232
description: volumeName is the binding reference to the
1023210233
PersistentVolume backing this claim.
1023310234
type: string
10234-
required:
10235-
- accessModes
10236-
- resources
1023710235
type: object
10236+
x-kubernetes-validations:
10237+
- message: missing accessModes
10238+
rule: has(self.accessModes) && size(self.accessModes) > 0
10239+
- message: missing storage request
10240+
rule: has(self.resources) && has(self.resources.requests)
10241+
&& has(self.resources.requests.storage)
1023810242
metadata:
1023910243
description: Metadata contains metadata for custom resources
1024010244
properties:
@@ -10602,6 +10606,13 @@ spec:
1060210606
the PersistentVolume backing this claim.
1060310607
type: string
1060410608
type: object
10609+
x-kubernetes-validations:
10610+
- message: missing accessModes
10611+
rule: has(self.accessModes) && size(self.accessModes)
10612+
> 0
10613+
- message: missing storage request
10614+
rule: has(self.resources) && has(self.resources.requests)
10615+
&& has(self.resources.requests.storage)
1060510616
name:
1060610617
description: |-
1060710618
The name for the tablespace, used as the path name for the volume.
@@ -10848,7 +10859,6 @@ spec:
1084810859
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
1084910860
items:
1085010861
type: string
10851-
minItems: 1
1085210862
type: array
1085310863
x-kubernetes-list-type: atomic
1085410864
dataSource:
@@ -10958,11 +10968,7 @@ spec:
1095810968
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
1095910969
otherwise to an implementation-defined value. Requests cannot exceed Limits.
1096010970
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
10961-
required:
10962-
- storage
1096310971
type: object
10964-
required:
10965-
- requests
1096610972
type: object
1096710973
selector:
1096810974
description: selector is a label query over volumes to consider
@@ -11040,10 +11046,13 @@ spec:
1104011046
description: volumeName is the binding reference to the
1104111047
PersistentVolume backing this claim.
1104211048
type: string
11043-
required:
11044-
- accessModes
11045-
- resources
1104611049
type: object
11050+
x-kubernetes-validations:
11051+
- message: missing accessModes
11052+
rule: has(self.accessModes) && size(self.accessModes) > 0
11053+
- message: missing storage request
11054+
rule: has(self.resources) && has(self.resources.requests)
11055+
&& has(self.resources.requests.storage)
1104711056
required:
1104811057
- dataVolumeClaimSpec
1104911058
type: object

‎pkg/apis/postgres-operator.crunchydata.com/v1beta1/pgbackrest_types.go‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,20 @@ type RepoHostStatus struct {
342342
type RepoPVC struct {
343343

344344
// Defines a PersistentVolumeClaim spec used to create and/or bind a volume
345+
// ---
345346
// +kubebuilder:validation:Required
347+
//
348+
// NOTE(validation): Every PVC must have at least one accessMode. NOTE(KEP-4153)
349+
// TODO(k8s-1.28): fieldPath=`.accessModes`,reason="FieldValueRequired"
350+
// - https://releases.k8s.io/v1.25.0/pkg/apis/core/validation/validation.go#L2098-L2100
351+
// - https://releases.k8s.io/v1.31.0/pkg/apis/core/validation/validation.go#L2292-L2294
352+
// +kubebuilder:validation:XValidation:rule=`has(self.accessModes) && size(self.accessModes) > 0`,message=`missing accessModes`
353+
//
354+
// NOTE(validation): Every PVC must have a positive storage request. NOTE(KEP-4153)
355+
// TODO(k8s-1.28): fieldPath=`.resources.requests.storage`,reason="FieldValueRequired"
356+
// - https://releases.k8s.io/v1.25.0/pkg/apis/core/validation/validation.go#L2126-L2133
357+
// - https://releases.k8s.io/v1.31.0/pkg/apis/core/validation/validation.go#L2318-L2325
358+
// +kubebuilder:validation:XValidation:rule=`has(self.resources) && has(self.resources.requests) && has(self.resources.requests.storage)`,message=`missing storage request`
346359
VolumeClaimSpec corev1.PersistentVolumeClaimSpec `json:"volumeClaimSpec"`
347360
}
348361

‎pkg/apis/postgres-operator.crunchydata.com/v1beta1/postgrescluster_types.go‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,20 @@ type PostgresInstanceSetSpec struct {
450450

451451
// Defines a PersistentVolumeClaim for PostgreSQL data.
452452
// More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
453+
// ---
453454
// +kubebuilder:validation:Required
455+
//
456+
// NOTE(validation): Every PVC must have at least one accessMode. NOTE(KEP-4153)
457+
// TODO(k8s-1.28): fieldPath=`.accessModes`,reason="FieldValueRequired"
458+
// - https://releases.k8s.io/v1.25.0/pkg/apis/core/validation/validation.go#L2098-L2100
459+
// - https://releases.k8s.io/v1.31.0/pkg/apis/core/validation/validation.go#L2292-L2294
460+
// +kubebuilder:validation:XValidation:rule=`has(self.accessModes) && size(self.accessModes) > 0`,message=`missing accessModes`
461+
//
462+
// NOTE(validation): Every PVC must have a positive storage request. NOTE(KEP-4153)
463+
// TODO(k8s-1.28): fieldPath=`.resources.requests.storage`,reason="FieldValueRequired"
464+
// - https://releases.k8s.io/v1.25.0/pkg/apis/core/validation/validation.go#L2126-L2133
465+
// - https://releases.k8s.io/v1.31.0/pkg/apis/core/validation/validation.go#L2318-L2325
466+
// +kubebuilder:validation:XValidation:rule=`has(self.resources) && has(self.resources.requests) && has(self.resources.requests.storage)`,message=`missing storage request`
454467
DataVolumeClaimSpec corev1.PersistentVolumeClaimSpec `json:"dataVolumeClaimSpec"`
455468

456469
// Priority class name for the PostgreSQL pod. Changing this value causes
@@ -491,7 +504,20 @@ type PostgresInstanceSetSpec struct {
491504

492505
// Defines a separate PersistentVolumeClaim for PostgreSQL's write-ahead log.
493506
// More info: https://www.postgresql.org/docs/current/wal.html
494-
// +optional
507+
// ---
508+
// +kubebuilder:validation:Optional
509+
//
510+
// NOTE(validation): Every PVC must have at least one accessMode. NOTE(KEP-4153)
511+
// TODO(k8s-1.28): fieldPath=`.accessModes`,reason="FieldValueRequired"
512+
// - https://releases.k8s.io/v1.25.0/pkg/apis/core/validation/validation.go#L2098-L2100
513+
// - https://releases.k8s.io/v1.31.0/pkg/apis/core/validation/validation.go#L2292-L2294
514+
// +kubebuilder:validation:XValidation:rule=`has(self.accessModes) && size(self.accessModes) > 0`,message=`missing accessModes`
515+
//
516+
// NOTE(validation): Every PVC must have a positive storage request. NOTE(KEP-4153)
517+
// TODO(k8s-1.28): fieldPath=`.resources.requests.storage`,reason="FieldValueRequired"
518+
// - https://releases.k8s.io/v1.25.0/pkg/apis/core/validation/validation.go#L2126-L2133
519+
// - https://releases.k8s.io/v1.31.0/pkg/apis/core/validation/validation.go#L2318-L2325
520+
// +kubebuilder:validation:XValidation:rule=`has(self.resources) && has(self.resources.requests) && has(self.resources.requests.storage)`,message=`missing storage request`
495521
WALVolumeClaimSpec *corev1.PersistentVolumeClaimSpec `json:"walVolumeClaimSpec,omitempty"`
496522

497523
// The list of tablespaces volumes to mount for this postgrescluster
@@ -520,7 +546,20 @@ type TablespaceVolume struct {
520546

521547
// Defines a PersistentVolumeClaim for a tablespace.
522548
// More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
549+
// ---
523550
// +kubebuilder:validation:Required
551+
//
552+
// NOTE(validation): Every PVC must have at least one accessMode. NOTE(KEP-4153)
553+
// TODO(k8s-1.28): fieldPath=`.accessModes`,reason="FieldValueRequired"
554+
// - https://releases.k8s.io/v1.25.0/pkg/apis/core/validation/validation.go#L2098-L2100
555+
// - https://releases.k8s.io/v1.31.0/pkg/apis/core/validation/validation.go#L2292-L2294
556+
// +kubebuilder:validation:XValidation:rule=`has(self.accessModes) && size(self.accessModes) > 0`,message=`missing accessModes`
557+
//
558+
// NOTE(validation): Every PVC must have a positive storage request. NOTE(KEP-4153)
559+
// TODO(k8s-1.28): fieldPath=`.resources.requests.storage`,reason="FieldValueRequired"
560+
// - https://releases.k8s.io/v1.25.0/pkg/apis/core/validation/validation.go#L2126-L2133
561+
// - https://releases.k8s.io/v1.31.0/pkg/apis/core/validation/validation.go#L2318-L2325
562+
// +kubebuilder:validation:XValidation:rule=`has(self.resources) && has(self.resources.requests) && has(self.resources.requests.storage)`,message=`missing storage request`
524563
DataVolumeClaimSpec corev1.PersistentVolumeClaimSpec `json:"dataVolumeClaimSpec"`
525564
}
526565

0 commit comments

Comments
 (0)