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.30
  • Stable release target (x.y): 1.31
• 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
  • Docs (k/website) update PR(s):
    Document Kubernetes' use of WebSockets (replacement for SPDY / KEP 4006) website#43620

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)

[sanchita-07]

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

Apologies for any confusion, @liggitt. The box was left unchecked because the latest-milestone was set for v1.28. We need to mark the status implementable for v1.29 which I think has been addressed by the PR #4169.

Just to clarify, when the KEP is targeting for stable and the code PRs are merged as well as the feature gates are removed, then we mark the status as implemented.

I hope this clarifies any uncertainties.

[sanchita-07]

Hi @seans3 , checking in once more as we approach the 1.29 enhancement freeze deadline on 01:00 UTC, Friday, 6th October, 2023. The status of this enhancement is marked as at risk for enhancement freeze. It looks like #4169 will address the requirements. Let me know if I missed anything. Thanks!

[liggitt]

@sanchita-07 #4169 is merged, can you confirm this is tracked for 1.29?

[npolshakova]

With KEP PR #4169 approved, the enhancement is ready for the enhancements freeze. The status is now marked as tracked for enhancement freeze for 1.29. 🚀 Thank you!

[taniaduggal]

Hey there @seans3 👋, v1.29 Docs team shadow here.
Does this enhancement work planned for v1.29 require any new docs or modifications to existing docs?
If so, please follow the steps here to open a PR against dev-1.29 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday, 19 October 2023.
Also, take a look at Documenting for a release to get yourself familiarized with the docs requirement for the release.
Thank you!

[taniaduggal]

Hey there @seans3 👋, The deadline to open a placeholder PR against k/website for required documentation is Thursday, 19 October. Could you please update me on the status of docs for this enhancement? Thank you!

[seans3]

Hey there Sean Sullivan 👋, The deadline to open a placeholder PR against k/website for required documentation is Thursday, 19 October. Could you please update me on the status of docs for this enhancement? Thank you!

Hello. Sorry for the delay. The placeholder PR for the docs for this enhancement is at: kubernetes/website#43620

Please let me know if there is anything else required. Thanks.

[sanchita-07]

Hey again @seans3 👋, 1.29 Enhancements team here.

Just checking in as we approach code freeze at 01:00 UTC Wednesday 1st November 2023:

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.

For this enhancement, it looks like the following PRs are open and need to be merged before code freeze:

• Stream Translator Proxy and FallbackExecutor for WebSockets #119186
• [WIP] Portforward over WebSockets instead of SPDY #120889

Are there additional code related PRs that need to be merged for 1.29? It looks like kubernetes/kubernetes#120889 is mentioned and needs to be included in the issue description.

With all this, the status of this KEP is at risk for code freeze.

Also, please let me know if there are other PRs in k/k we should be tracking for this KEP.
As always, we are here to help if any questions come up. Thanks!

[liggitt]

@sanchita-07, #120889 is not targeting 1.29, only #119186 is (and that is now in the merge queue)

[sanchita-07]

Thanks @liggitt for mentioning :)

With all the PRs related to the enhancement are linked in the above issue description and :

• WebSocket Client and V5 RemoteCommand Subprotocol kubernetes#119157 merged
• Stream Translator Proxy and FallbackExecutor for WebSockets kubernetes#119186 having approved and lgtm label

This enhancement is now Tracked for Code Freeze. Thanks!

[a-mccarthy]

Hi @seans3, 👋 from the v1.29 Release Team-Communications! We would like to check if you have any plans to publish a blog for this KEP regarding new features, removals, and deprecations for this release.

If so, you need to open a PR placeholder in the website repository.
The deadline will be on Tuesday 14th November 2023 (after the Docs deadline PR ready for review)

Here is the 1.29 calendar