Transition from SPDY to WebSockets

[seans3]

Enhancement Description

• One-line enhancement description (can be used as a release note): Transition the bi-directional streaming protocol of Kubernetes clients from SPDY/3.1 to WebSockets.

• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/tree/master/keps/sig-api-machinery/4006-transition-spdy-to-websockets

• Discussion Link:

  • SIG API Machinery Video
  • SIG API Machinery Notes

• Primary contact (assignee): @seans3

• Responsible SIGs: SIG API Machinery, SIG CLI

• Enhancement target (which target equals to which milestone):

  • Alpha release target (x.y): 1.29
  • Beta release target (x.y): 1.31
  • Stable release target (x.y): 1.32

• Alpha

  • KEP (k/enhancements) update PR(s):
    • KEP-4006: Initial iteration of provisional WebSockets KEP #4016
    • Update WebSocket KEP (4006) to reflect latest understanding #4169
  • Code (k/k) update PR(s):
    • WebSocket Client and V5 RemoteCommand Subprotocol kubernetes#119157
    • Stream Translator Proxy and FallbackExecutor for WebSockets kubernetes#119186
    • PortForward: Tunnel SPDY through WebSockets kubernetes#123413
  • Docs (k/website) update PR(s):
    • Document Kubernetes' use of WebSockets (replacement for SPDY / KEP 4006) website#43620

• Beta

  • KEP (k/enhancements) update PR(s):
    • KEP-4006: RemoteCommand as Beta, and initial PortForward over WebSockets as Alpha #4416
    • KEP-4006: PortForward Websockets graduates to Beta #4666
  • Code (k/k) update PR(s):
    • RemoteCommand over WebSockets to Beta kubernetes#123281
    • PortForward over Websockets Graduates to Beta kubernetes#125528
  • Docs (k/website) update(s):
    • [KEP-4006] Docs for Transitioning from SPDY to WebSockets (Beta) website#45270
    • [KEP-4006] PLACEHOLDER - Docs for PortForward over WebSockets Feature Gates (Beta) website#46955

Please keep this description up to date. This will help the Enhancement Team to track the evolution of the enhancement efficiently.

[seans3]

/sig api-machinery

[seans3]

/sig cli
/stage alpha

[deads2k]

/milestone v1.28
/label lead-opted-in

[salehsedghpour]

Hello @seans3 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 01:00 UTC Friday, 16th June 2023.

This enhancement is targeting for stage alpha for 1.28 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: 1.28
• KEP readme has a updated detailed test plan section filled out
• KEP readme has up to date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements.

For this KEP, we would just need to update the following:

• Ensure that the PRs are merged.

The status of this enhancement is marked as at risk. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[seans3]

@salehsedghpour

Hello. Since the PRR reviewer @deads2k approved the KEP and since the KEP has been merged, I believe this KEP is now ready for v1.28. Please let me know if there are any other tasks needed for this release.

Thanks.

[katcosgrove]

Hello @seans3! 1.28 Docs Shadow here.

Does this enhancement work planned for 1.28 require any new docs or modification to existing docs?

If so, please follows the steps here to open a PR against dev-1.28 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday 20th July 2023.

Also, take a look at Documenting for a release to get yourself familiarize with the docs requirement for the release.

Thank you!

[Rishit-dagli]

Hey @seans3 , could you please create a docs PR even if it is a draft PR with no content yet against dev-1.28 branch in the k/website repo. The deadline to create this draft PR is Thursday 20th July 2023.

[salehsedghpour]

Hey again @seans3 👋
Just checking in as we approach Code freeze at 01:00 UTC Friday, 19th July 2023 .

I don't see any code (k/k) update PR(s) in the issue description so if there are any k/k related PR(s) that we should be tracking for this KEP please link them in the issue description above.

As always, we are here to help if any questions come up. Thanks!

[Atharva-Shinde]

Hello @seans3 👋, 1.28 Enhancements Lead here.

Unfortunately, the implementation (code related) PRs associated with this enhancement are not in the merge-ready state by code-freeze and hence this enhancement is now removed from the v1.28 milestone.

If you still wish to progress this enhancement in v1.28, please file an exception request. Thanks!

/milestone clear

[sanchita-07]

Hello @seans3 👋, 1.29 Enhancements team here!

Just checking in as we approach enhancements freeze on 01:00 UTC, Friday, 6th October, 2023.

This enhancement is targeting for stage alpha for 1.29 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: 1.29. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here).

For this KEP, please update the latest-milestone to v1.29 and the alpha milestone to 1.29 in the kep.yaml.

The status of this enhancement is marked as at risk for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well.

Thank you!

[liggitt]

• KEP status is marked as implementable for latest-milestone: 1.29. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.

that doesn't really make sense... the KEP is still in alpha and is remaining implementable for 1.29 in alpha, not completing

[jpbetz]

/label lead-opted-in
(for 1.29)

[dipesh-rawat]

Hello @seans3 👋, 1.31 Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 14th June 2024 / 19:00 PDT Thursday 13th June 2024.

This enhancement is targeting for stage beta for 1.31 (correct me, if otherwise).

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: v1.31. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here).

For this KEP, we would just need to update the following:

• Please update kep.yaml to reflect latest-milestone: v1.31 and beta for v1.31.
  (I see PR-4666 is already open, and once merged, it will resolve these issues)

The status of this enhancement is marked as at risk for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[seans3]

Hello Sean Sullivan 👋, 1.31 Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 14th June 2024 / 19:00 PDT Thursday 13th June 2024.

This enhancement is targeting for stage beta for 1.31 (correct me, if otherwise).

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: v1.31. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here).

For this KEP, we would just need to update the following:

• Please update kep.yaml to reflect latest-milestone: v1.31 and beta for v1.31.
  (I see PR-4666 is already open, and once merged, it will resolve these issues)

Thanks for the update Dipesh. The PR you reference above has been sent out for review, and it already has one LGTM. I believe it is in good shape to be merged before the enhancements freeze. Please let me know if there are any other issues to address. Thanks.

The status of this enhancement is marked as at risk for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[dipesh-rawat]

Hello @seans3 👋, 1.31 Enhancements team here.

Now that PR #4666 has been merged, all the KEP requirements in place and merged into k/enhancements, this enhancement is all good for the upcoming enhancements freeze. 🚀

The status of this enhancement is marked as tracked for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[salaxander]

Hello @danielvegamyhre 👋, 1.31 Docs Shadow here.

Is the work done in this PR (kubernetes/website#45270) the only docs needed for the 1.31 milestone?

Thanks!

[danielvegamyhre]

Hello @danielvegamyhre 👋, 1.31 Docs Shadow here.

Is the work done in this PR (kubernetes/website#45270) the only docs needed for the 1.31 milestone?

Thanks!

I wasn't involved in this KEP, I think you may have tagged the wrong person

[salaxander]

Hello @danielvegamyhre 👋, 1.31 Docs Shadow here.
Is the work done in this PR (kubernetes/website#45270) the only docs needed for the 1.31 milestone?
Thanks!

I wasn't involved in this KEP, I think you may have tagged the wrong person

My mistake! That tag was meant for @seans3 :)

[seans3]

Hello @danielvegamyhre 👋, 1.31 Docs Shadow here.
Is the work done in this PR (kubernetes/website#45270) the only docs needed for the 1.31 milestone?
Thanks!

I wasn't involved in this KEP, I think you may have tagged the wrong person

My mistake! That tag was meant for @seans3 :)

Hello @salaxander. There will be another PR to update docs for v1.31. It won't be very large, but the PR will document that the PortForward feature gates will not be necessary, since this subprotocol will graduate to Beta and will be turned on by default (currently the PortFoward part is Alpha). Please let me know if you have any other questions. Thanks :)

[edithturn]

Hello, @seans3!

👋 from the v1.31 Communications Team!

We'd love for you to opt in to write a feature blog about your enhancement!
Some reasons why you might want to write a blog for this feature include (but are not limited to) if this introduces breaking changes, is important to our users, or has been in progress for a long time and is graduating.

To opt in, let us know and open a Feature Blog placeholder PR against the website repository by 3rd July, 2024. For more information about writing a blog see the blog contribution guidelines.

Note: In your placeholder PR, use XX characters for the blog date in the front matter and file name. We will work with you on updating the PR with the publication date once we have a final number of feature blogs for this release.

[Princesso]

Hello @danielvegamyhre 👋, 1.31 Docs Shadow here.
Is the work done in this PR (kubernetes/website#45270) the only docs needed for the 1.31 milestone?
Thanks!

I wasn't involved in this KEP, I think you may have tagged the wrong person

My mistake! That tag was meant for @seans3 :)

Hello @salaxander. There will be another PR to update docs for v1.31. It won't be very large, but the PR will document that the PortForward feature gates will not be necessary, since this subprotocol will graduate to Beta and will be turned on by default (currently the PortFoward part is Alpha). Please let me know if you have any other questions. Thanks :)

Hi @seans3 👋, 1.31 Docs Lead here.
Since this enhancement needs a docs update, please follow the steps here to open a PR against dev-1.31 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday June 27, 2024 18:00 PDT.

Thank you!

[seans3]

Hello, @seans3!

👋 from the v1.31 Communications Team!

We'd love for you to opt in to write a feature blog about your enhancement! Some reasons why you might want to write a blog for this feature include (but are not limited to) if this introduces breaking changes, is important to our users, or has been in progress for a long time and is graduating.

To opt in, let us know and open a Feature Blog placeholder PR against the website repository by 3rd July, 2024. For more information about writing a blog see the blog contribution guidelines.

Note: In your placeholder PR, use XX characters for the blog date in the front matter and file name. We will work with you on updating the PR with the publication date once we have a final number of feature blogs for this release.

I am interested in writing a blog post about this feature, and I will follow the instructions to create the placeholder by July 3rd. :)

[seans3]

Hello @danielvegamyhre 👋, 1.31 Docs Shadow here.
Is the work done in this PR (kubernetes/website#45270) the only docs needed for the 1.31 milestone?
Thanks!

I wasn't involved in this KEP, I think you may have tagged the wrong person

My mistake! That tag was meant for @seans3 :)

Hello @salaxander. There will be another PR to update docs for v1.31. It won't be very large, but the PR will document that the PortForward feature gates will not be necessary, since this subprotocol will graduate to Beta and will be turned on by default (currently the PortFoward part is Alpha). Please let me know if you have any other questions. Thanks :)

Hi @seans3 👋, 1.31 Docs Lead here. Since this enhancement needs a docs update, please follow the steps here to open a PR against dev-1.31 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday June 27, 2024 18:00 PDT.

Thank you!

Placeholder complete. Please let me know if there is anything else I need to currently do. Thanks.

kubernetes/website#46955

[edithturn]

Hello, @seans3!
👋 from the v1.31 Communications Team!
We'd love for you to opt in to write a feature blog about your enhancement! Some reasons why you might want to write a blog for this feature include (but are not limited to) if this introduces breaking changes, is important to our users, or has been in progress for a long time and is graduating.
To opt in, let us know and open a Feature Blog placeholder PR against the website repository by 3rd July, 2024. For more information about writing a blog see the blog contribution guidelines.
Note: In your placeholder PR, use XX characters for the blog date in the front matter and file name. We will work with you on updating the PR with the publication date once we have a final number of feature blogs for this release.

I am interested in writing a blog post about this feature, and I will follow the instructions to create the placeholder by July 3rd. :)

Thank you @seans3 , let us know if you need any help, please :)

[seans3]

Hello, @seans3!
👋 from the v1.31 Communications Team!
We'd love for you to opt in to write a feature blog about your enhancement! Some reasons why you might want to write a blog for this feature include (but are not limited to) if this introduces breaking changes, is important to our users, or has been in progress for a long time and is graduating.
To opt in, let us know and open a Feature Blog placeholder PR against the website repository by 3rd July, 2024. For more information about writing a blog see the blog contribution guidelines.
Note: In your placeholder PR, use XX characters for the blog date in the front matter and file name. We will work with you on updating the PR with the publication date once we have a final number of feature blogs for this release.

I am interested in writing a blog post about this feature, and I will follow the instructions to create the placeholder by July 3rd. :)

Thank you Sean Sullivan , let us know if you need any help, please :)

Blog Placeholder PR: kubernetes/website#46971

Please let me know if there is anything else I currently need to do. Thanks.

[dipesh-rawat]

Hey again @seans3 👋, 1.31 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Wednesday 24th July 2024 / 19:00 PDT Tuesday 23rd July 2024.

Here's where this enhancement currently stands:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PR/s are ready to be merged (they have approved and lgtm labels applied) by the code freeze deadline. This includes tests.

With all the implementation(code related) PRs merged as per the issue description:

• RemoteCommand over WebSockets to Beta kubernetes#123281
• PortForward over Websockets Graduates to Beta kubernetes#125528

Additionally, please let me know if there are any other PRs in k/k not listed in the description that we should track for this KEP, so that we can maintain accurate status.

This enhancement is now marked as tracked for code freeze for the 1.31 Code Freeze!