From b8ad0fa39dd392e89d11c344b75cb85e61b771d3 Mon Sep 17 00:00:00 2001 From: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com> Date: Sat, 17 Aug 2024 05:08:51 -0700 Subject: [PATCH 1/5] Remove specific Kubernetes version instructions and link to the Vitess Operator Compatibility Matrix Removed specific Kubernetes version instructions from examples/operator/README.md. Added a link to the Vitess Operator Compatibility Matrix for up-to-date Kubernetes version information. This change centralizes Kubernetes version recommendations and ensures users are directed to the most current documentation. Related Issue: [#1022](https://github.com/vitessio/website/issues/1022) Signed-off-by: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com> --- examples/operator/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/operator/README.md b/examples/operator/README.md index 9182b25340c..80cf3c3f540 100644 --- a/examples/operator/README.md +++ b/examples/operator/README.md @@ -1,8 +1,8 @@ # Instructions - + **Note**: For the best experience, it is recommended to use the latest stable version of Kubernetes. Please refer to the [Vitess Operator Compatibility Matrix](https://github.com/planetscale/vitess-operator#compatibility) to ensure compatibility with your Kube ``` # Start minikube -minikube start --cpus=8 --memory=11000 --disk-size=50g --kubernetes-version=v1.25.8 +minikube start --cpus=8 --memory=11000 --disk-size=50g # Install Operator kubectl apply -f operator.yaml From a78e8c1ef5a5e732e2ca2ce84ccfc52583e8972d Mon Sep 17 00:00:00 2001 From: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com> Date: Sat, 17 Aug 2024 08:28:14 -0700 Subject: [PATCH 2/5] Remove specific Kubernetes version instructions and link to the Vitess Operator Compatibility Matrix Signed-off-by: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com> --- examples/operator/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/operator/README.md b/examples/operator/README.md index 80cf3c3f540..a26422adf43 100644 --- a/examples/operator/README.md +++ b/examples/operator/README.md @@ -1,5 +1,5 @@ # Instructions - **Note**: For the best experience, it is recommended to use the latest stable version of Kubernetes. Please refer to the [Vitess Operator Compatibility Matrix](https://github.com/planetscale/vitess-operator#compatibility) to ensure compatibility with your Kube + **Note**: For the best experience, Please refer to the [Vitess Operator Compatibility Matrix](https://github.com/planetscale/vitess-operator#compatibility) to ensure compatibility with your Kube ``` # Start minikube minikube start --cpus=8 --memory=11000 --disk-size=50g From 6f2432e8643df9a7c5a4b7c3e659006dcf0e660f Mon Sep 17 00:00:00 2001 From: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com> Date: Wed, 21 Aug 2024 23:20:22 -0700 Subject: [PATCH 3/5] Update examples/operator/README.md Co-authored-by: Matt Lord Signed-off-by: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com> --- examples/operator/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/operator/README.md b/examples/operator/README.md index a26422adf43..c14d8013aaf 100644 --- a/examples/operator/README.md +++ b/examples/operator/README.md @@ -1,5 +1,5 @@ # Instructions - **Note**: For the best experience, Please refer to the [Vitess Operator Compatibility Matrix](https://github.com/planetscale/vitess-operator#compatibility) to ensure compatibility with your Kube + **Note**: For the best experience, please refer to the [Vitess Operator Compatibility Matrix](https://github.com/planetscale/vitess-operator#compatibility) to ensure compatibility between your version of Vitess and Kubernetes. ``` # Start minikube minikube start --cpus=8 --memory=11000 --disk-size=50g From 5224ac1078a9f68c9b1cc6292ba1a073867eec2f Mon Sep 17 00:00:00 2001 From: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com> Date: Thu, 22 Aug 2024 00:09:35 -0700 Subject: [PATCH 4/5] Update README.md Signed-off-by: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com> --- examples/operator/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/examples/operator/README.md b/examples/operator/README.md index c14d8013aaf..c2c232a6bc2 100644 --- a/examples/operator/README.md +++ b/examples/operator/README.md @@ -1,5 +1,7 @@ # Instructions - **Note**: For the best experience, please refer to the [Vitess Operator Compatibility Matrix](https://github.com/planetscale/vitess-operator#compatibility) to ensure compatibility between your version of Vitess and Kubernetes. +{{< info >}} +For the best experience, please refer to the [Vitess Operator Compatibility Matrix](https://github.com/planetscale/vitess-operator#compatibility) to ensure compatibility between your version of Vitess and Kubernetes. +{{< /info >}} ``` # Start minikube minikube start --cpus=8 --memory=11000 --disk-size=50g From 3808f0e8fe9e938901c227e3e07f00b31466891e Mon Sep 17 00:00:00 2001 From: anshikavashistha <93611566+anshikavashistha@users.noreply.github.com> Date: Mon, 26 Aug 2024 06:48:51 -0700 Subject: [PATCH 5/5] Update README.md Signed-off-by: anshikavashistha <93611566+anshikavashistha@users.noreply.github.com> --- examples/operator/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/operator/README.md b/examples/operator/README.md index c2c232a6bc2..38d9fe4d6ed 100644 --- a/examples/operator/README.md +++ b/examples/operator/README.md @@ -1,6 +1,6 @@ # Instructions {{< info >}} -For the best experience, please refer to the [Vitess Operator Compatibility Matrix](https://github.com/planetscale/vitess-operator#compatibility) to ensure compatibility between your version of Vitess and Kubernetes. +For the best experience, please refer to the [Vitess Operator Compatibility Matrix](https://github.com/planetscale/vitess-operator#compatibility) to ensure compatibility between your version of Vitess and Kubernetes. You would then specify the appropriate Kubernetes version to Minikube using the `--kubernetes-version` flag. {{< /info >}} ``` # Start minikube