-
Notifications
You must be signed in to change notification settings - Fork 209
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Outdated --kubernetes-version references #1022
Comments
@GuptaManan100 @frouioui @Verolop what would you recommend? |
I like option A as it has a single point of maintenance. We would only need to update the compatibility table of the vitess operator. However, as a user, I think it is nice to just be able to copy/paste command lines from the getting started guide. I think we should remove the instructions in I lean more towards an option between A and B where we would continue updating the vitess operator compatibility table, and start updating the getting started guide with the proper kubernetes versions. But I do not have strong opinions. |
…s 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: [vitessio#1022](vitessio/website#1022) Signed-off-by: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com>
- Removed specific Kubernetes version instructions from the `content/en/docs/11.0/get-started/operator.md`. - Added a reference to the Vitess Operator Compatibility Matrix for up-to-date Kubernetes version recommendations. - Updated the Vitess Operator Compatibility Matrix to reflect supported Kubernetes versions. **Related Issue:** [vitessio#1022](vitessio#1022) Signed-off-by: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com>
@frouioui @deepthi I have gone through the release notes of Vitess-operator but want to discuss regarding the modifications on Compatiblity Matrix . |
I think we can close this given vitessio/vitess#16610 |
It doesn't appear to me that vitessio/vitess#16610 fixes this (bug #1022) issue, as this references Getting Started along with README.md. For example, this file (and for the other versions, not just 20.0): https://github.com/vitessio/website/blob/prod/content/en/docs/20.0/get-started/operator.md -> The example there today is:
|
The latest Getting Started: Operator suggests installing an oldish and specific version of Kubernetes:
References:
There's also a similar (but older) reference in
vitess.git
's example operator readme:Suggestion is to either:
A. Remove the
--kubernetes-version
parameter and instead rely upon the prerequisites documentation it links to.B. Or only add
--kubernetes-version
to older versioned docs if the latest stable isn't supported, and if it won't change.Option (B) risks becoming outdated (e.g.,
examples/operator/README.md
) although--kubernetes-version=v1.19.16
may be appropriate fordocs/11.0/
anddocs/12.0/
today, although the prerequisites matrix is missing v11.0 so I'm not sure.FWIW I prefer (A) to avoid future doc maintenance and bug reports like this. Regardless, I can create a PR if folks agree upon a solution as I'm not familiar enough with Vitess to know for certain.
Related: I hoped
--kubernetes-version=
didn't require a patch version but it appears required, else the likes of--kubernetes-version=v1.19
would be possible with (B).The text was updated successfully, but these errors were encountered: