Skip to content

Limit the number of allowed instances sets in v1 #4290

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

Merged
merged 1 commit into from
Sep 16, 2025
Merged

Limit the number of allowed instances sets in v1 #4290

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
5 changes: 4 additions & 1 deletion config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11683,6 +11683,7 @@ spec:
required:
- dataVolumeClaimSpec
type: object
maxItems: 16
minItems: 1
type: array
x-kubernetes-list-map-keys:
Expand Down Expand Up @@ -18412,7 +18413,9 @@ spec:
- fieldPath: .config.parameters.log_directory
message: all instances need an additional volume to log in "/volumes"
rule: self.?config.parameters.log_directory.optMap(v, type(v) != string
|| !v.startsWith("/volumes") || self.instances.all(i, i.?volumes.additional.hasValue())).orValue(true)
|| !v.startsWith("/volumes") || self.instances.all(i, i.?volumes.additional.hasValue()
&& i.volumes.additional.exists(volume, v.startsWith("/volumes/" +
volume.name)))).orValue(true)
status:
description: PostgresClusterStatus defines the observed state of PostgresCluster
properties:
Expand Down
30 changes: 18 additions & 12 deletions internal/testing/validation/postgrescluster/postgres_config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,33 +226,39 @@ func TestPostgresConfigParametersV1(t *testing.T) {
message: `"/pgwal/logs/postgres"`,
},

// Directories inside /volumes are acceptable, but every instance set needs additional volumes.
//
// TODO(validation): This could be more precise and check the directory name of each additional
// volume, but Kubernetes 1.33 incorrectly estimates the cost of volume.name:
// https://github.com/kubernetes-sigs/controller-tools/pull/1270#issuecomment-3272211184
// Directories inside /volumes are acceptable, but every instance set needs the correct additional volume.
{
name: "two instance sets and two additional volumes",
value: "/volumes/anything",
name: "two instance sets and two correct additional volumes",
value: "/volumes/yep",
instances: `[
{ name: one, dataVolumeClaimSpec: ` + volume + `, volumes: { additional: [{ name: dir, claimName: a }] } },
{ name: two, dataVolumeClaimSpec: ` + volume + `, volumes: { additional: [{ name: dir, claimName: b }] } },
{ name: one, dataVolumeClaimSpec: ` + volume + `, volumes: { additional: [{ name: yep, claimName: a }] } },
{ name: two, dataVolumeClaimSpec: ` + volume + `, volumes: { additional: [{ name: yep, claimName: b }] } },
]`,
valid: true,
},
{
name: "two instance sets and one correct additional volume",
value: "/volumes/yep",
instances: `[
{ name: one, dataVolumeClaimSpec: ` + volume + `, volumes: { additional: [{ name: yep, claimName: a }] } },
{ name: two, dataVolumeClaimSpec: ` + volume + `, volumes: { additional: [{ name: diff, claimName: b }] } },
]`,
valid: false,
message: `all instances need an additional volume`,
},
{
name: "two instance sets and one additional volume",
value: "/volumes/anything",
value: "/volumes/yep",
instances: `[
{ name: one, dataVolumeClaimSpec: ` + volume + `, volumes: { additional: [{ name: dir, claimName: a }] } },
{ name: one, dataVolumeClaimSpec: ` + volume + `, volumes: { additional: [{ name: yep, claimName: a }] } },
{ name: two, dataVolumeClaimSpec: ` + volume + ` },
]`,
valid: false,
message: `all instances need an additional volume`,
},
{
name: "two instance sets and no additional volumes",
value: "/volumes/anything",
value: "/volumes/yep",
instances: `[
{ name: one, dataVolumeClaimSpec: ` + volume + ` },
{ name: two, dataVolumeClaimSpec: ` + volume + ` },
Expand Down
8 changes: 3 additions & 5 deletions pkg/apis/postgres-operator.crunchydata.com/v1/postgrescluster_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,7 @@ import (
//
// +kubebuilder:validation:XValidation:fieldPath=`.config.parameters.log_directory`,message=`all instances need "volumes.temp" to log in "/pgtmp"`,rule=`self.?config.parameters.log_directory.optMap(v, type(v) != string || !v.startsWith("/pgtmp/logs/postgres") || self.instances.all(i, i.?volumes.temp.hasValue())).orValue(true)`
// +kubebuilder:validation:XValidation:fieldPath=`.config.parameters.log_directory`,message=`all instances need "walVolumeClaimSpec" to log in "/pgwal"`,rule=`self.?config.parameters.log_directory.optMap(v, type(v) != string || !v.startsWith("/pgwal/logs/postgres") || self.instances.all(i, i.?walVolumeClaimSpec.hasValue())).orValue(true)`
//
// +kubebuilder:validation:XValidation:fieldPath=`.config.parameters.log_directory`,message=`all instances need an additional volume to log in "/volumes"`,rule=`self.?config.parameters.log_directory.optMap(v, type(v) != string || !v.startsWith("/volumes") || self.instances.all(i, i.?volumes.additional.hasValue())).orValue(true)`
//
// TODO: Also check the above path against volume names: `i.?volumes.additional.hasValue() && i.volumes.additional.exists(directory.startsWith("/volumes/" + volume.name))`
// https://github.com/kubernetes-sigs/controller-tools/pull/1270#issuecomment-3272211184
// +kubebuilder:validation:XValidation:fieldPath=`.config.parameters.log_directory`,message=`all instances need an additional volume to log in "/volumes"`,rule=`self.?config.parameters.log_directory.optMap(v, type(v) != string || !v.startsWith("/volumes") || self.instances.all(i, i.?volumes.additional.hasValue() && i.volumes.additional.exists(volume, v.startsWith("/volumes/" + volume.name)))).orValue(true)`
type PostgresClusterSpec struct {
// +optional
Metadata *v1beta1.Metadata `json:"metadata,omitempty"`
Expand Down Expand Up @@ -110,9 +106,11 @@ type PostgresClusterSpec struct {

// Specifies one or more sets of PostgreSQL pods that replicate data for
// this cluster.
// ---
// +listType=map
// +listMapKey=name
// +kubebuilder:validation:MinItems=1
// +kubebuilder:validation:MaxItems=16
// +operator-sdk:csv:customresourcedefinitions:type=spec,order=2
InstanceSets []PostgresInstanceSetSpec `json:"instances"`

Expand Down
Loading