Skip to content
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

doc: add Kubernetes compatibility table #2404

Merged
merged 3 commits into from
Nov 26, 2021

Conversation

agaudreault
Copy link
Contributor

@agaudreault agaudreault commented Oct 25, 2021

Description

With the changes made in #2281, It breaks the backward compatibility to k8s 1.18. I think this field could be used to indicates that the chart now with default appVersion: 0.10.0 only works with k8s version >= 1.19.0.

Fixes #ISSUE

Checklist

  • Unit tests updated
  • End user documentation updated

@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Oct 25, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @agaudreault-jive!

It looks like this is your first PR to kubernetes-sigs/external-dns 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/external-dns has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 25, 2021
@agaudreault
Copy link
Contributor Author

I signed it

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Oct 25, 2021
@agaudreault
Copy link
Contributor Author

/assign @Raffo

@Raffo
Copy link
Contributor

Raffo commented Nov 7, 2021

/assign @stevehipwell

@stevehipwell
Copy link
Contributor

@agaudreault-jive thanks for the PR and the thought you've given but the kubeVersion field in a chart is a hard limit and should only be set if the chart resources aren't compatible with older Kubernetes versions. AFAIK this chart will work fine with older Kubernetes versions assuming that the image tag is changed to use a suitable image version. My suggestion would be to update the project README with a compatibility table and then reference that from the chart README and maybe call out on the chart README the current limit and how to install on an older K8s version.

FYI the correct pattern for a release line constraint is >=x.y-0 (so for v1.19 it would be >= 1.19-0), this will work for all actual pre-releases and more importantly it will also work for distros such as EKS where suffixes like -eks-1234 are added to the versions which appear to the constraints as pre-releases.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Nov 23, 2021

CLA Signed

The committers are authorized under a signed CLA.

@agaudreault agaudreault changed the title doc(chart): add kubeVersion information doc: add Kubernetes compatibility table Nov 23, 2021
@stevehipwell
Copy link
Contributor

@Raffo this is no longer a chart PR, so back to you. FWIW I think this change would be useful.

@stevehipwell stevehipwell removed their assignment Nov 24, 2021
@Raffo
Copy link
Contributor

Raffo commented Nov 26, 2021

Thank you so much, this makes totally sense.

Copy link
Contributor

@Raffo Raffo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 26, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: agaudreault-jive, Raffo

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 26, 2021
@k8s-ci-robot k8s-ci-robot merged commit ced50bf into kubernetes-sigs:master Nov 26, 2021
@agaudreault agaudreault deleted the patch-1 branch November 26, 2021 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants