Support subPath in generated container (zalando#452)

redbaron · FxKu · commit 3553144cdad5 · 2019-06-17T15:49:01.000+02:00
* mounted volumes now provide a subPath
diff --git a/docs/reference/cluster_manifest.md b/docs/reference/cluster_manifest.md
@@ -282,6 +282,9 @@ properties of the persistent storage that stores postgres data.
   documentation](https://kubernetes.io/docs/concepts/storage/storage-classes/)
   for the details on storage classes. Optional.
 
+* **subPath**
+  Subpath to use when mounting volume into Spilo container
+
 ### Sidecar definitions
 
 Those parameters are defined under the `sidecars` key. They consist of a list
diff --git a/pkg/apis/acid.zalan.do/v1/postgresql_type.go b/pkg/apis/acid.zalan.do/v1/postgresql_type.go
@@ -82,6 +82,7 @@ type MaintenanceWindow struct {
 type Volume struct {
 	Size         string `json:"size"`
 	StorageClass string `json:"storageClass"`
+	SubPath      string `json:"subPath,omitempty"`
 }
 
 // PostgresqlParam describes PostgreSQL version and pairs of configuration parameter name - values.
diff --git a/pkg/apis/acid.zalan.do/v1/util_test.go b/pkg/apis/acid.zalan.do/v1/util_test.go
@@ -181,7 +181,8 @@ var unmarshalCluster = []struct {
 	    "teamId": "ACID",
 	    "volume": {
 	      "size": "5Gi",
-	      "storageClass": "SSD"
+	      "storageClass": "SSD",
+	      "subPath": "subdir"
 	    },
 	    "numberOfInstances": 2,
 	    "users": {
@@ -263,6 +264,7 @@ var unmarshalCluster = []struct {
 				Volume: Volume{
 					Size:         "5Gi",
 					StorageClass: "SSD",
+					SubPath:      "subdir",
 				},
 				Patroni: Patroni{
 					InitDB: map[string]string{
@@ -311,7 +313,7 @@ var unmarshalCluster = []struct {
 			},
 			Error: "",
 		},
-		marshal: []byte(`{"kind":"Postgresql","apiVersion":"acid.zalan.do/v1","metadata":{"name":"acid-testcluster1","creationTimestamp":null},"spec":{"postgresql":{"version":"9.6","parameters":{"log_statement":"all","max_connections":"10","shared_buffers":"32MB"}},"volume":{"size":"5Gi","storageClass":"SSD"},"patroni":{"initdb":{"data-checksums":"true","encoding":"UTF8","locale":"en_US.UTF-8"},"pg_hba":["hostssl all all 0.0.0.0/0 md5","host    all all 0.0.0.0/0 md5"],"ttl":30,"loop_wait":10,"retry_timeout":10,"maximum_lag_on_failover":33554432,"slots":{"permanent_logical_1":{"database":"foo","plugin":"pgoutput","type":"logical"}}},"resources":{"requests":{"cpu":"10m","memory":"50Mi"},"limits":{"cpu":"300m","memory":"3000Mi"}},"teamId":"ACID","allowedSourceRanges":["127.0.0.1/32"],"numberOfInstances":2,"users":{"zalando":["superuser","createdb"]},"maintenanceWindows":["Mon:01:00-06:00","Sat:00:00-04:00","05:00-05:15"],"clone":{"cluster":"acid-batman"}},"status":{"PostgresClusterStatus":""}}`),
+		marshal: []byte(`{"kind":"Postgresql","apiVersion":"acid.zalan.do/v1","metadata":{"name":"acid-testcluster1","creationTimestamp":null},"spec":{"postgresql":{"version":"9.6","parameters":{"log_statement":"all","max_connections":"10","shared_buffers":"32MB"}},"volume":{"size":"5Gi","storageClass":"SSD", "subPath": "subdir"},"patroni":{"initdb":{"data-checksums":"true","encoding":"UTF8","locale":"en_US.UTF-8"},"pg_hba":["hostssl all all 0.0.0.0/0 md5","host    all all 0.0.0.0/0 md5"],"ttl":30,"loop_wait":10,"retry_timeout":10,"maximum_lag_on_failover":33554432,"slots":{"permanent_logical_1":{"database":"foo","plugin":"pgoutput","type":"logical"}}},"resources":{"requests":{"cpu":"10m","memory":"50Mi"},"limits":{"cpu":"300m","memory":"3000Mi"}},"teamId":"ACID","allowedSourceRanges":["127.0.0.1/32"],"numberOfInstances":2,"users":{"zalando":["superuser","createdb"]},"maintenanceWindows":["Mon:01:00-06:00","Sat:00:00-04:00","05:00-05:15"],"clone":{"cluster":"acid-batman"}},"status":{"PostgresClusterStatus":""}}`),
 		err:     nil},
 	// example with teamId set in input
 	{
diff --git a/pkg/cluster/k8sres.go b/pkg/cluster/k8sres.go
@@ -342,11 +342,12 @@ func isBootstrapOnlyParameter(param string) bool {
 		param == "track_commit_timestamp"
 }
 
-func generateVolumeMounts() []v1.VolumeMount {
+func generateVolumeMounts(volume acidv1.Volume) []v1.VolumeMount {
 	return []v1.VolumeMount{
 		{
 			Name:      constants.DataVolumeName,
 			MountPath: constants.PostgresDataMount, //TODO: fetch from manifest
+			SubPath:   volume.SubPath,
 		},
 	}
 }
@@ -800,7 +801,7 @@ func (c *Cluster) generateStatefulSet(spec *acidv1.PostgresSpec) (*v1beta1.State
 	// pickup the docker image for the spilo container
 	effectiveDockerImage := util.Coalesce(spec.DockerImage, c.OpConfig.DockerImage)
 
-	volumeMounts := generateVolumeMounts()
+	volumeMounts := generateVolumeMounts(spec.Volume)
 
 	// generate the spilo container
 	c.logger.Debugf("Generating Spilo container, environment variables: %v", spiloEnvVars)

Original file line number	Diff line number	Diff line change
`@@ -82,6 +82,7 @@ type MaintenanceWindow struct {`
`82`	`82`	`type Volume struct {`
`83`	`83`	Size string `json:"size"`
`84`	`84`	StorageClass string `json:"storageClass"`
	`85`	+ SubPath string `json:"subPath,omitempty"`
`85`	`86`	`}`
`86`	`87`
`87`	`88`	`// PostgresqlParam describes PostgreSQL version and pairs of configuration parameter name - values.`
Original file line number	Diff line number	Diff line change
`@@ -342,11 +342,12 @@ func isBootstrapOnlyParameter(param string) bool {`
`342`	`342`	`param == "track_commit_timestamp"`
`343`	`343`	`}`
`344`	`344`
`345`		`-func generateVolumeMounts() []v1.VolumeMount {`
	`345`	`+func generateVolumeMounts(volume acidv1.Volume) []v1.VolumeMount {`
`346`	`346`	`return []v1.VolumeMount{`
`347`	`347`	`{`
`348`	`348`	`Name: constants.DataVolumeName,`
`349`	`349`	`MountPath: constants.PostgresDataMount, //TODO: fetch from manifest`
	`350`	`+ SubPath: volume.SubPath,`
`350`	`351`	`},`
`351`	`352`	`}`
`352`	`353`	`}`
`@@ -800,7 +801,7 @@ func (c Cluster) generateStatefulSet(spec acidv1.PostgresSpec) (*v1beta1.State`
`800`	`801`	`// pickup the docker image for the spilo container`
`801`	`802`	`effectiveDockerImage := util.Coalesce(spec.DockerImage, c.OpConfig.DockerImage)`
`802`	`803`
`803`		`- volumeMounts := generateVolumeMounts()`
	`804`	`+ volumeMounts := generateVolumeMounts(spec.Volume)`
`804`	`805`
`805`	`806`	`// generate the spilo container`
`806`	`807`	`c.logger.Debugf("Generating Spilo container, environment variables: %v", spiloEnvVars)`