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.

Sign up for GitHub

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

[KEP-4006] Docs for Transitioning from SPDY to WebSockets (Beta) #45270

Merged
merged 1 commit into from
Mar 21, 2024
Merged

[KEP-4006] Docs for Transitioning from SPDY to WebSockets (Beta) #45270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions ...reference/command-line-tools-reference/feature-gates/port-forward-websockets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: PortForwardWebsockets
content_type: feature_gate
_build:
list: never
render: false

stages:
- stage: alpha
defaultValue: false
fromVersion: "1.30"
---
Allow WebSocket streaming of the
portforward sub-protocol (`port-forward`) from clients requesting
version v2 (`v2.portforward.k8s.io`) of the sub-protocol.
6 changes: 3 additions & 3 deletions ...line-tools-reference/feature-gates/translate-stream-close-websocket-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ _build:
render: false

stages:
- stage: alpha
defaultValue: false
fromVersion: "1.29"
- stage: beta
defaultValue: true
fromVersion: "1.30"
---
Allow WebSocket streaming of the
remote command sub-protocol (`exec`, `cp`, `attach`) from clients requesting
Expand Down
8 changes: 8 additions & 0 deletions content/en/docs/reference/kubectl/kubectl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,14 @@ kubectl [flags]
</td>
</tr>

<tr>
<td colspan="2">KUBECTL_PORT_FORWARD_WEBSOCKETS</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">When set to true, the kubectl port-forward command will attempt to stream using the websockets protocol. If the upgrade to websockets fails, the commands will fallback to use the current SPDY protocol.
Copy link
Contributor

Choose a reason for hiding this comment

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

How about:

Suggested change
<td></td><td style="line-height: 130%; word-wrap: break-word;">When set to true, the kubectl port-forward command will attempt to stream using the websockets protocol. If the upgrade to websockets fails, the commands will fallback to use the current SPDY protocol.
<td></td><td style="line-height: 130%; word-wrap: break-word;">When set to true, the <tt>kubectl port-forward</tt> command attempts to stream using a <a href="https://www.w3.org/TR/websockets/">WebSocket</a>. If the upgrade to using a WebSocket fails, the kubectl tool falls back to using the <a href="https://www.chromium.org/spdy/">SPDY</a> protocol.

The suggested text avoids implying that SPDY is “current”. However, if this is different from the text already in k/k code, we should use that text from upstream as-is.

(it'd be great to get good docs into kubectl itself, where relevant)

</td>
</tr>

<tr>
<td colspan="2">KUBECTL_REMOTE_COMMAND_WEBSOCKETS</td>
</tr>
Expand Down