From ccbec417e7ba24aa9cb9865252c8694d5e759043 Mon Sep 17 00:00:00 2001 From: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com> Date: Sun, 11 Aug 2024 02:42:09 -0700 Subject: [PATCH 1/2] Document Kubernetes version support and recommendations for Vitess operator This PR adds documentation on the supported and recommended Kubernetes versions for the Vitess operator, including the support policy schedule and guarantees for explicitly supported cloud providers. Signed-off-by: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com> --- .../en/docs/operator/kubernetes-versions.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 content/en/docs/operator/kubernetes-versions.md diff --git a/content/en/docs/operator/kubernetes-versions.md b/content/en/docs/operator/kubernetes-versions.md new file mode 100644 index 000000000..5644fee58 --- /dev/null +++ b/content/en/docs/operator/kubernetes-versions.md @@ -0,0 +1,23 @@ +# Kubernetes Version Support and Recommendations + +The Vitess operator supports a range of Kubernetes versions, with varying levels of support and recommendation. + +## Support Policy Schedule + +The following schedule outlines when a Kubernetes version will start being supported, become the primary recommendation, and eventually stop being supported: + +* **Support start**: When a new Kubernetes version is released, we will start supporting it within 2-3 months, pending compatibility testing. +* **Primary recommendation**: We will recommend the latest Kubernetes version that has been supported for at least 6 months, and has been tested extensively with the Vitess operator. +* **Support end**: We will stop supporting a Kubernetes version 12 months after its initial release, or when it reaches end-of-life (EOL) according to the Kubernetes project, whichever comes first. + +## Recommended Kubernetes Versions + +The Vitess operator recommends using Kubernetes versions 1.15 through 1.17, which have been extensively tested and validated. + +## Cloud Provider Support + +For explicitly supported cloud providers, such as GKE and EKS, we guarantee to support at least one Kubernetes version that overlaps with the versions they offer. + +## Current Recommendation + +As of the latest Vitess operator release (2.0.0), we recommend using Kubernetes 1.16, which is the primary version tested against. From a6a6fa0f6b331c815ea9886edcfc53f3f78d82fb Mon Sep 17 00:00:00 2001 From: anshikavashistha Date: Thu, 15 Aug 2024 05:47:33 -0700 Subject: [PATCH 2/2] Document --keep_data behavior for Complete --- .../en/docs/18.0/reference/vreplication/movetables.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/content/en/docs/18.0/reference/vreplication/movetables.md b/content/en/docs/18.0/reference/vreplication/movetables.md index 4ac34730c..5042fdf95 100644 --- a/content/en/docs/18.0/reference/vreplication/movetables.md +++ b/content/en/docs/18.0/reference/vreplication/movetables.md @@ -258,6 +258,15 @@ See https://github.com/vitessio/vitess/pull/13895 and https://github.com/vitessi and more details. +#### --keep-data +**optional**\ +**default** false + +
+ +During `Complete` or `Cancel` operations, Keeps the original source table data that was copied by the MoveTables workflow. This is useful for retaining data for verification or other purposes. +
+ #### --rename-tables **optional**\ **default** false