Transition from SPDY to WebSockets #4006

seans3 · 2023-05-15T19:05:25Z

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):
- 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] - 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.

The text was updated successfully, but these errors were encountered:

seans3 · 2023-05-15T19:06:01Z

/sig api-machinery

seans3 · 2023-05-15T19:16:07Z

/sig cli
/stage alpha

deads2k · 2023-06-02T14:06:29Z

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

salehsedghpour · 2023-06-03T22:20:59Z

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 · 2023-06-09T00:41:14Z

@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 · 2023-06-21T13:49:48Z

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 · 2023-07-12T15:29:44Z

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 · 2023-07-17T20:51:37Z

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 · 2023-07-19T04:04:41Z

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 · 2023-09-29T04:34:35Z

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 · 2023-10-02T20:09:43Z

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 · 2023-10-02T20:29:21Z

/label lead-opted-in
(for 1.29)

edithturn · 2024-06-25T07:57:15Z

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 · 2024-06-25T17:36:43Z

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 · 2024-07-01T19:05:13Z

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:

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!

…r WebSocket protocol Kubernetes currently supports two streaming protocols- SPDY and WebSockets. WebSockets are replacing SPDY, see kubernetes/enhancements#4006 Out 'kubectl exec' session recording was only supporting SPDY. This change: - adds functionality to parse streaming sessions over WebSockets - for sessions that the API server proxy has determined need to be recorded, determines if the session is over SPDY or WebSockets and invoke the relevant parser accordingly - refactors the session recording logic into its own package Updates tailscale/corp#19821 Signed-off-by: Irbe Krumina <irbe@tailscale.com>

…r WebSocket protocol Kubernetes currently supports two streaming protocols- SPDY and WebSockets. WebSockets are replacing SPDY, see kubernetes/enhancements#4006 Our 'kubectl exec' session recording was only supporting SPDY. This change: - adds functionality to parse streaming sessions over WebSockets - for sessions that the API server proxy has determined need to be recorded, determines if the session is over SPDY or WebSockets and invoke the relevant parser accordingly - refactors the session recording logic into its own package Updates tailscale/corp#19821 Signed-off-by: Irbe Krumina <irbe@tailscale.com>

…Sockets sessions Kubernetes currently supports two streaming protocols, SPDY and WebSockets. WebSockets are replacing SPDY, see kubernetes/enhancements#4006. We were currently only supporting SPDY, erroring out if session was not SPDY and relying on the kube's built-in SPDY fallback. This PR: - adds support for parsing contents of 'kubectl exec' sessions streamed over WebSockets - adds logic to distinguish 'kubectl exec' requests for a SPDY/WebSockets sessions and call the relevant handler Updates tailscale/corp#19821 Signed-off-by: Irbe Krumina <irbe@tailscale.com>

seans3 self-assigned this May 15, 2023

k8s-ci-robot added the needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. label May 15, 2023

k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels May 15, 2023

k8s-ci-robot added stage/alpha Denotes an issue tracking an enhancement targeted for Alpha status sig/cli Categorizes an issue or PR as relevant to SIG CLI. labels May 15, 2023

This was referenced May 17, 2023

KEP-4006: Initial iteration of provisional WebSockets KEP #4016

Merged

Refactor wsstream library from apiserver to apimachinery kubernetes/kubernetes#118182

Merged

k8s-ci-robot added this to the v1.28 milestone Jun 2, 2023

k8s-ci-robot added the lead-opted-in Denotes that an issue has been opted in to a release label Jun 2, 2023

This was referenced Jul 1, 2023

[WIP] Refactor common remotecommand code into apimachinery from client-go kubernetes/kubernetes#119013

Closed

WebSocket Client and V5 RemoteCommand Subprotocol kubernetes/kubernetes#119157

Merged

seans3 mentioned this issue Jul 10, 2023

Stream Translator Proxy and FallbackExecutor for WebSockets kubernetes/kubernetes#119186

Merged

k8s-ci-robot removed this from the v1.28 milestone Jul 19, 2023

brianpursley mentioned this issue Jul 19, 2023

kubectl cp will return a error "Dropping out copy after 0 retries error: unexpected EOF" kubernetes/kubectl#1425

Open

torfjor mentioned this issue Sep 6, 2023

Exec with ConnectGateway + Workload Identity does not work on remote clusters it seems argoproj/argo-cd#15066

Open

3 tasks

seans3 mentioned this issue Sep 26, 2023

Portforward over WebSockets instead of SPDY kubernetes/kubernetes#120889

Closed

brianpursley mentioned this issue Oct 1, 2023

Add verbose flag to kubectl cp kubernetes/kubectl#1469

Open

seans3 mentioned this issue Jun 25, 2024

[KEP-4006] Blog Post: Streaming Transition from SPDY to WebSockets is Beta kubernetes/website#46971

Open

Stausssi mentioned this issue Jul 1, 2024

Instable conection via kubectl port-forward kubernetes/kubectl#1525

Closed

rudolfbyker mentioned this issue Jul 4, 2024

kubectl exec can unexpectedly exit 0 kubernetes/kubernetes#73056

Closed

irbekrm mentioned this issue Jul 26, 2024

cmd/k8s-operator,k8s-operator/session-recording: implement support for WebSocket protocol tailscale/tailscale#12926

Closed

irbekrm mentioned this issue Jul 29, 2024

cmd/k8s-operator,k8s-operator/sessionrecording: support recording kubectl exec sessions over WebSockets tailscale/tailscale#12947

Open

seans3 mentioned this issue Jul 30, 2024

KEP-4006: Adds GA requirement for websocket HTTPS proxy support #4777

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Transition from SPDY to WebSockets #4006

Transition from SPDY to WebSockets #4006

seans3 commented May 15, 2023 •

edited

Loading

seans3 commented May 15, 2023

seans3 commented May 15, 2023

deads2k commented Jun 2, 2023

salehsedghpour commented Jun 3, 2023

seans3 commented Jun 9, 2023

katcosgrove commented Jun 21, 2023

Rishit-dagli commented Jul 12, 2023

salehsedghpour commented Jul 17, 2023

Atharva-Shinde commented Jul 19, 2023

sanchita-07 commented Sep 29, 2023

liggitt commented Oct 2, 2023

jpbetz commented Oct 2, 2023

edithturn commented Jun 25, 2024

seans3 commented Jun 25, 2024

dipesh-rawat commented Jul 1, 2024

Transition from SPDY to WebSockets #4006

Transition from SPDY to WebSockets #4006

Comments

seans3 commented May 15, 2023 • edited Loading

Enhancement Description

seans3 commented May 15, 2023

seans3 commented May 15, 2023

deads2k commented Jun 2, 2023

salehsedghpour commented Jun 3, 2023

seans3 commented Jun 9, 2023

katcosgrove commented Jun 21, 2023

Rishit-dagli commented Jul 12, 2023

salehsedghpour commented Jul 17, 2023

Atharva-Shinde commented Jul 19, 2023

sanchita-07 commented Sep 29, 2023

liggitt commented Oct 2, 2023

jpbetz commented Oct 2, 2023

edithturn commented Jun 25, 2024

seans3 commented Jun 25, 2024

dipesh-rawat commented Jul 1, 2024

seans3 commented May 15, 2023 •

edited

Loading