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

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

Merged
merged 1 commit into from
Mar 21, 2024

Conversation

seans3
Copy link
Contributor

@seans3 seans3 commented Feb 22, 2024

  • Updates control plane feature flag: TranslateStreamCloseWebsocketRequests to Beta
  • Adds new control plane feature flag: PortForwardWebsockets as Alpha
  • Adds new kubectl feature flag: KUBECTL_PORT_FORWARD_WEBSOCKETS

kubernetes/enhancements#4006

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 22, 2024
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 22, 2024
Copy link

netlify bot commented Feb 22, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 2c8bbd2
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/65d6dc1a4c4469000878b6e6
😎 Deploy Preview https://deploy-preview-45270--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 22, 2024
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Feb 22, 2024
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 22, 2024
@seans3
Copy link
Contributor Author

seans3 commented Feb 22, 2024

/cc @fsmunoz

Copy link
Member

@dipesh-rawat dipesh-rawat left a comment

Choose a reason for hiding this comment

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

@seans3 We should consider setting the dev-1.30 branch as the target branch rather than the main branch for this pull request. Since the change is related to the feature in v1.30.

@seans3 seans3 changed the base branch from main to dev-1.30 February 22, 2024 05:14
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 22, 2024
@seans3 seans3 changed the base branch from dev-1.30 to main February 22, 2024 05:16
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 22, 2024
@k8s-ci-robot k8s-ci-robot removed the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 22, 2024
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 22, 2024
@seans3 seans3 changed the base branch from main to dev-1.30 February 22, 2024 05:31
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 22, 2024
@seans3
Copy link
Contributor Author

seans3 commented Feb 22, 2024

Sean Sullivan We should consider setting the dev-1.30 branch as the target branch rather than the main branch for this pull request. Since the change is related to the feature in v1.30.

@dipesh-rawat

Fixed. Please let me know if this does it. Thanks.

@fsmunoz
Copy link
Contributor

fsmunoz commented Feb 22, 2024

Thank you @seans3, looks good, I've updated the tracking sheet.

@katcosgrove
Copy link
Contributor

Hey @seans3! Just a reminder that this needs to be reviewed and ready to merge by Docs Freeze on March 26, including a technical review. An exception request will be required if you cannot meet that deadline. Thank you!

cc: @aojea @soltysh @deads2k @liggitt

@aojea
Copy link
Member

aojea commented Mar 15, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 15, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: f56d8fd401b9c8ad4031fea77a7187d0d732126d

@drewhagen
Copy link
Member

@kubernetes/sig-docs-en-reviews Can we get a review of the content from docs on this one? The deadline is March 26th 2024 18:00 PT to get this into the release. Thanks!

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

/lgtm

<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)

@sftim
Copy link
Contributor

sftim commented Mar 21, 2024

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 21, 2024
@k8s-ci-robot k8s-ci-robot merged commit 753073b into kubernetes:dev-1.30 Mar 21, 2024
6 checks passed
@drewhagen
Copy link
Member

/milestone 1.30

@k8s-ci-robot k8s-ci-robot added this to the 1.30 milestone Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants