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

Test & Document Kubernetes Version and API Support #1095

Closed
4 tasks done
shaneutt opened this issue Mar 11, 2021 · 9 comments
Closed
4 tasks done

Test & Document Kubernetes Version and API Support #1095

shaneutt opened this issue Mar 11, 2021 · 9 comments

Comments

@shaneutt
Copy link
Contributor

shaneutt commented Mar 11, 2021

Problem Statement

We need an authoritative source of truth as to which k8s versions are "supported" by which version of KIC.

Proposed solution

We call a version supported if:

The version compatibility matrix lives here.

Acceptance Criteria

  • e2e testing added to verify versions 1.17-1.21 on production quality cluster deployment (GKE)
  • starting with KIC 2.0, each version marked as "supported" is covered by automated integration tests (Test KIC against multiple k8s versions #1542)
  • Releases are blocked (by manual process or by CI/automation) if the criteria above are not met.
    • Possible solutions: add an entry to the release checklist, or add CI/automation that blocks a release if the criteria are not met.
  • optional: expose the compatibility test results in a visible place to end-users
    • Possible solution: link from changelog/release notes to the CI results page

Issues

Pull Requests

NOTES

Original spike: #1043

@mflendrich
Copy link
Contributor

Instead of targetting 2.0 specifically, maybe we could do it once and for all by:

I don't see why we'd need to treat the 2.0 release in any special manner.

@shaneutt
Copy link
Contributor Author

Instead of targetting 2.0 specifically, maybe we could do it once and for all by:

* introducing automated testing for the k8s versions promised to be supported #1053

* updating our release procedure to always update docs
  ?

I don't see why we'd need to treat the 2.0 release in any special manner.

Ok I'm persuaded we don't need to do this specifically in 2.0 scope (though I would like to for documentation's sake). I've moved this out fo the milestone and reworded it for later grooming, and we can add it as a stretch goal for 2.0 later if we like.

@shaneutt
Copy link
Contributor Author

actually for now I'll just close this and bookmark it for myself and perhaps we can come back to it at a later time if we feel so inclined.

@mflendrich mflendrich changed the title KIC 2.0 - Document Kubernetes Version Support Document Kubernetes Version Support Mar 18, 2021
@mflendrich mflendrich reopened this Mar 18, 2021
@shaneutt
Copy link
Contributor Author

Re-open context: we're going to check requirements with @eskibars and then groom this for a later scope.

@mflendrich
Copy link
Contributor

@mflendrich to deduplicate version support issues we have (they exist in several places)

@mflendrich mflendrich changed the title Document Kubernetes Version Support Document Kubernetes Version and API Support Apr 28, 2021
@shaneutt
Copy link
Contributor Author

While it doesn't resolve this, the following commit does add the version options we need for this in the KTF: Kong/kubernetes-testing-framework@b45df3e

@mflendrich mflendrich removed their assignment Jul 7, 2021
@shaneutt
Copy link
Contributor Author

shaneutt commented Jul 7, 2021

With the above changes to KTF we can prove version compatibility using our integration testing suite, I would like to see this be the way in which we move forward, and document results. Additionally I think we should make some hard calls to NOT support Kubernetes older than v1.16

@shaneutt shaneutt changed the title Document Kubernetes Version and API Support Test & Document Kubernetes Version and API Support Jul 23, 2021
@shaneutt shaneutt self-assigned this Jul 23, 2021
@shaneutt
Copy link
Contributor Author

shaneutt commented Aug 3, 2021

The v2.0.0-alpha.3 release and the successful workflow thereof is the validation of the CI portions of this PR:

Now Kong/docs.konghq.com#3081 has been made to be the last PR needed to finally resolve this issue by adding the relevant documentation.

I'm considering the optional part of the AC resolved by virtue of our CI workflows being publicly available for releases.

@shaneutt
Copy link
Contributor Author

shaneutt commented Aug 4, 2021

As per a recent @Kong/team-k8s discussion the remaining work (which is all documentation) does not need to block the beta release here. I'm separating the remaining documentation work into its own issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants