add disclaimer in the documentation about vitess compatibility

Signed-off-by: Florent Poinsard <[email protected]>
planetscale · Oct 9, 2024 · 2f9c6fb · 2f9c6fb
1 parent 31b57bd
commit 2f9c6fb
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/docs/api/index.html b/docs/api/index.html
@@ -6552,7 +6552,13 @@ <h3 id="planetscale.com/v2.VitessKeyspaceTemplateImages">VitessKeyspaceTemplateI
 <p>
 <p>VitessKeyspaceTemplateImages specifies user-definable container images to
 use for this keyspace. The images defined here by the user will override
-those defined at the top-level in VitessCluster.spec.images</p>
+those defined at the top-level in VitessCluster.spec.images.</p>
+<p>While this field allows you to set a different set of Vitess version for
+some components of Vitess than the version defined at the top level, it
+is important to note that Vitess only ensure compatibility between one
+version and the next and previous one. For instance: N is only compatible
+with N+1 and N-1. Do be careful when specifying multiple versions across
+your cluster so that they respect this compatibility rule.</p>
 <p>Note: this structure is a copy of VitessKeyspaceImages, once we have gotten
 rid of MysqldImage and replaced it by MysqldImageNew (planned for v2.15), we
 should be able to remove VitessKeyspaceTemplateImages entirely and just use

diff --git a/pkg/apis/planetscale/v2/vitesskeyspace_types.go b/pkg/apis/planetscale/v2/vitesskeyspace_types.go
@@ -189,7 +189,14 @@ type VitessKeyspaceTemplate struct {
 
 // VitessKeyspaceTemplateImages specifies user-definable container images to
 // use for this keyspace. The images defined here by the user will override
-// those defined at the top-level in VitessCluster.spec.images
+// those defined at the top-level in VitessCluster.spec.images.
+//
+// While this field allows you to set a different set of Vitess version for
+// some components of Vitess than the version defined at the top level, it
+// is important to note that Vitess only ensure compatibility between one
+// version and the next and previous one. For instance: N is only compatible
+// with N+1 and N-1. Do be careful when specifying multiple versions across
+// your cluster so that they respect this compatibility rule.
 //
 // Note: this structure is a copy of VitessKeyspaceImages, once we have gotten
 // rid of MysqldImage and replaced it by MysqldImageNew (planned for v2.15), we