Add support for user-defined per-keyspace images

Signed-off-by: Max Englander <[email protected]>

deploy/crds/planetscale.com_vitessclusters.yaml

@@ -1172,6 +1172,28 @@ spec:
                       type: string
                     durabilityPolicy:
                       type: string
+                    images:
+                      properties:
+                        mysqld:
+                          properties:
+                            mariadb103Compatible:
+                              type: string
+                            mariadbCompatible:
+                              type: string
+                            mysql56Compatible:
+                              type: string
+                            mysql80Compatible:
+                              type: string
+                          type: object
+                        mysqldExporter:
+                          type: string
+                        vtbackup:
+                          type: string
+                        vtorc:
+                          type: string
+                        vttablet:
+                          type: string
+                      type: object
                     name:
                       maxLength: 63
                       minLength: 1

docs/api/index.html

@@ -4770,10 +4770,11 @@ <h3 id="planetscale.com/v2.VitessKeyspace">VitessKeyspace
 </em>
 </td>
 <td>
-<p>Images are not customizable by users at the keyspace level because version
-skew across the cluster is discouraged except during rolling updates,
-in which case this field is automatically managed by the VitessCluster
-controller that owns this VitessKeyspace.</p>
+<p>Images are inherited from the VitessCluster spec, unless the user has
+specified keyspace-level overrides. Version skew across the cluster is
+discouraged except during rolling updates, in which case this field is
+automatically managed by the VitessCluster controller that owns this
+VitessKeyspace.</p>
 </td>
 </tr>
 <tr>
@@ -5078,6 +5079,7 @@ <h3 id="planetscale.com/v2.VitessKeyspaceImages">VitessKeyspaceImages
 <p>
 (<em>Appears on:</em>
 <a href="#planetscale.com/v2.VitessKeyspaceSpec">VitessKeyspaceSpec</a>, 
+<a href="#planetscale.com/v2.VitessKeyspaceTemplate">VitessKeyspaceTemplate</a>, 
 <a href="#planetscale.com/v2.VitessShardSpec">VitessShardSpec</a>)
 </p>
 <p>
@@ -5557,10 +5559,11 @@ <h3 id="planetscale.com/v2.VitessKeyspaceSpec">VitessKeyspaceSpec
 </em>
 </td>
 <td>
-<p>Images are not customizable by users at the keyspace level because version
-skew across the cluster is discouraged except during rolling updates,
-in which case this field is automatically managed by the VitessCluster
-controller that owns this VitessKeyspace.</p>
+<p>Images are inherited from the VitessCluster spec, unless the user has
+specified keyspace-level overrides. Version skew across the cluster is
+discouraged except during rolling updates, in which case this field is
+automatically managed by the VitessCluster controller that owns this
+VitessKeyspace.</p>
 </td>
 </tr>
 <tr>
@@ -5936,6 +5939,24 @@ <h3 id="planetscale.com/v2.VitessKeyspaceTemplate">VitessKeyspaceTemplate
 <p>Annotations can optionally be used to attach custom annotations to the VitessKeyspace object.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>images</code></br>
+<em>
+<a href="#planetscale.com/v2.VitessKeyspaceImages">
+VitessKeyspaceImages
+</a>
+</em>
+</td>
+<td>
+<p>Users are encouraged to let the VitessCluster controller automatically
+propagate image changes from the VitessCluster to the VitessKeyspace
+via rolling updates.</p>
+<p>For special cases, users may specify per-VitessKeyspace images. An
+example: migrating from MySQL 5.7 to MySQL 8.0 via a <code>MoveTables</code>
+operation, after which the source keyspace is destroyed.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="planetscale.com/v2.VitessKeyspaceTurndownPolicy">VitessKeyspaceTurndownPolicy

pkg/apis/planetscale/v2/vitesskeyspace_defaults.go

@@ -69,3 +69,23 @@ func DefaultVitessKeyspaceImages(dst *VitessKeyspaceImages, clusterDefaults *Vit
 		dst.MysqldExporter = clusterDefaults.MysqldExporter
 	}
 }
+
+// MergeVitessKeyspaceImages takes non-empty image values from a non-nil src
+// and sets them on dst.
+func MergeVitessKeyspaceImages(dst *VitessKeyspaceImages, src *VitessKeyspaceImages) {
+	if src.Vttablet != "" {
+		dst.Vttablet = src.Vttablet
+	}
+	if src.Vtorc != "" {
+		dst.Vtorc = src.Vtorc
+	}
+	if src.Vtbackup != "" {
+		dst.Vtbackup = src.Vtbackup
+	}
+	if src.Mysqld != nil {
+		dst.Mysqld = src.Mysqld
+	}
+	if dst.MysqldExporter != "" {
+		dst.MysqldExporter = src.MysqldExporter
+	}
+}

pkg/apis/planetscale/v2/vitesskeyspace_types.go

@@ -51,10 +51,11 @@ type VitessKeyspaceSpec struct {
 	// GlobalLockserver are the params to connect to the global lockserver.
 	GlobalLockserver VitessLockserverParams `json:"globalLockserver"`
 
-	// Images are not customizable by users at the keyspace level because version
-	// skew across the cluster is discouraged except during rolling updates,
-	// in which case this field is automatically managed by the VitessCluster
-	// controller that owns this VitessKeyspace.
+	// Images are inherited from the VitessCluster spec, unless the user has
+	// specified keyspace-level overrides. Version skew across the cluster is
+	// discouraged except during rolling updates, in which case this field is
+	// automatically managed by the VitessCluster controller that owns this
+	// VitessKeyspace.
 	Images VitessKeyspaceImages `json:"images,omitempty"`
 
 	// ImagePullPolicies are inherited from the VitessCluster spec.
@@ -178,6 +179,15 @@ type VitessKeyspaceTemplate struct {
 
 	// Annotations can optionally be used to attach custom annotations to the VitessKeyspace object.
 	Annotations map[string]string `json:"annotations,omitempty"`
+
+	// Users are encouraged to let the VitessCluster controller automatically
+	// propagate image changes from the VitessCluster to the VitessKeyspace
+	// via rolling updates.
+	//
+	// For special cases, users may specify per-VitessKeyspace images. An
+	// example: migrating from MySQL 5.7 to MySQL 8.0 via a `MoveTables`
+	// operation, after which the source keyspace is destroyed.
+	Images VitessKeyspaceImages `json:"images,omitempty"`
 }
 
 // VitessOrchestratorSpec specifies deployment parameters for vtorc.

pkg/controller/vitesscluster/reconcile_keyspaces.go

@@ -149,6 +149,9 @@ func newVitessKeyspace(key client.ObjectKey, vt *planetscalev2.VitessCluster, pa
 	images := planetscalev2.VitessKeyspaceImages{}
 	planetscalev2.DefaultVitessKeyspaceImages(&images, &vt.Spec.Images)
 
+	// Apply user-defined overrides for images.
+	planetscalev2.MergeVitessKeyspaceImages(&images, &keyspace.Images)
+
 	// Copy parent labels map and add keyspace-specific label.
 	labels := make(map[string]string, len(parentLabels)+1)
 	for k, v := range parentLabels {