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

PR for SRVKS-1174: Document how users can utilize full duplex support for http1 #76331

Merged

Conversation

kaldesai
Copy link

@kaldesai kaldesai commented May 22, 2024

Affected versions for cherry-picking:

  • serverless-docs-1.33
  • serverless-docs-1.32

Tracking JIRA: https://issues.redhat.com/browse/SRVKS-1174

Doc preview:

I have created an HTTP configuration section, which now includes:

  • Global HTTPS redirection
  • HTTPS redirection per service
  • Full duplex support for HTTP/1 (Newly added)

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 22, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented May 22, 2024

@kaldesai: This pull request references SRVKS-1174 which is a valid jira issue.

In response to this:

Tracking JIRA: https://issues.redhat.com/browse/SRVKS-1174

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 22, 2024
@kaldesai
Copy link
Author

kaldesai commented May 22, 2024

/label serverless

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 22, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented May 22, 2024

@kaldesai: This pull request references SRVKS-1174 which is a valid jira issue.

In response to this:

Affected versions for cherry-picking:
serverless-docs-1.33
serverless-docs-1.32

Tracking JIRA: https://issues.redhat.com/browse/SRVKS-1174

Doc preview:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented May 22, 2024

@kaldesai: This pull request references SRVKS-1174 which is a valid jira issue.

In response to this:

Affected versions for cherry-picking:

  • serverless-docs-1.33
  • serverless-docs-1.32

Tracking JIRA: https://issues.redhat.com/browse/SRVKS-1174

Doc preview:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 22, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented May 22, 2024

@kaldesai: This pull request references SRVKS-1174 which is a valid jira issue.

In response to this:

Affected versions for cherry-picking:

  • serverless-docs-1.33
  • serverless-docs-1.32

Tracking JIRA: https://issues.redhat.com/browse/SRVKS-1174

Doc preview:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@kaldesai
Copy link
Author

/label serverless

@openshift-ci openshift-ci bot added the serverless Label for all Serverless PRs label May 22, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented May 22, 2024

@kaldesai: This pull request references SRVKS-1174 which is a valid jira issue.

In response to this:

Affected versions for cherry-picking:

  • serverless-docs-1.33
  • serverless-docs-1.32

Tracking JIRA: https://issues.redhat.com/browse/SRVKS-1174

Doc preview:

I have created an HTTP configuration section, which now includes:

  • Global HTTPS redirection
  • HTTPS redirection per service
  • Full duplex support for HTTP/1 (Newly added)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@kaldesai
Copy link
Author

@skonto is now ready for review. Can you please take a look and let me know?

name: example-service
namespace: default
annotations:
features.knative.dev/http-full-duplex: "Enabled"
Copy link
Contributor

@maschmid maschmid May 23, 2024

Choose a reason for hiding this comment

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

The annotation should be on the revision template, not Service,

this was fixed upstream in knative/docs#5839 (see the updated example there)

Copy link

Choose a reason for hiding this comment

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

@kaldesai
Copy link
Author

@maschmid @skonto Incorporated your suggestions and changed the content. Can you please take a look?

@skonto
Copy link

skonto commented May 28, 2024

LGTM in general

I would add a pointer to the related Golang issue so people know when to use that. Copying from the upstream docs.

This should be used in scenarios where the related Golang issue is hit ...

@kaldesai
Copy link
Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label May 29, 2024
@adellape adellape self-assigned this May 29, 2024
@adellape adellape added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label May 29, 2024
@adellape adellape added this to the Continuous Release milestone May 29, 2024
Copy link
Contributor

@adellape adellape left a comment

Choose a reason for hiding this comment

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

If you end up changing the topic_map per suggestion, please re-run this through the peer-review queue. Also reminder to squash (and remove WIP from PR title) before merge-review. Thanks!


You can enable the HTTP/1 full duplex support for a service by configuring the `features.knative.dev/http-full-duplex` annotation.

NOTE: Verify your HTTP clients before enabling, as older clients may not provide support for HTTP/1 full duplex.
Copy link
Contributor

Choose a reason for hiding this comment

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

  • Style guide for admonitions
  • [ISG] Use "earlier" for "older"
  • [ISG] Use "might" for "may"
Suggested change
NOTE: Verify your HTTP clients before enabling, as older clients may not provide support for HTTP/1 full duplex.
[NOTE]
====
Verify your HTTP clients before enabling, as earlier version clients might not provide support for HTTP/1 full duplex.
====

Copy link
Author

Choose a reason for hiding this comment

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

Done!

Comment on lines +173 to +181
- Name: HTTP configuration
Dir: http-configuration
Topics:
- Name: Global HTTPS redirection
File: https-redirect-global
- Name: HTTPS redirection per service
File: https-redirect-per-service
- Name: Full duplex support for HTTP/1
File: http1-full-duplex-support
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this need to be a full subdirectory? Especially considering each of the 3 assemblies only have 1 module in each (with no TOCs).

Could this instead just be a single new "HTTP configuration" assembly that include::s the 3 modules (the 2 old ones and the 1 new one)? I feel like that would still satisfy the Jira ticket's request to "create another section".

Copy link
Author

Choose a reason for hiding this comment

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

Yes, it does need to be a full subdirectory as each assemblies are going to expand by the upcoming next release and will contain the multiple modules. That is why I created like that. :)

@adellape adellape added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels May 29, 2024
Copy link

openshift-ci bot commented May 31, 2024

@kaldesai: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@kaldesai
Copy link
Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label May 31, 2024
@mburke5678 mburke5678 added merge-review-in-progress Signifies that the merge review team is reviewing this PR ok-to-merge and removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels May 31, 2024
@mburke5678
Copy link
Contributor

@kaldesai I think this PR is OK to merge. When you are ready, remove the do-not-merge label and let us know.

@kaldesai kaldesai changed the title WIP PR for SRVKS-1174: Document how users can utilize full duplex support for http1 PR for SRVKS-1174: Document how users can utilize full duplex support for http1 May 31, 2024
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2024
@kaldesai
Copy link
Author

@mburke5678 I have removed the do-not-merge label, you can go ahead and merge this. Thank you! :)

1 similar comment
@kaldesai
Copy link
Author

kaldesai commented Jun 4, 2024

@mburke5678 I have removed the do-not-merge label, you can go ahead and merge this. Thank you! :)

@mburke5678 mburke5678 merged commit 0b338e7 into openshift:serverless-docs-main Jun 4, 2024
3 checks passed
@mburke5678
Copy link
Contributor

/cherrypick serverless-docs-1.33

@mburke5678
Copy link
Contributor

/cherrypick serverless-docs-1.32

@openshift-cherrypick-robot

@mburke5678: new pull request created: #76865

In response to this:

/cherrypick serverless-docs-1.33

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #76866

In response to this:

/cherrypick serverless-docs-1.32

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. ok-to-merge peer-review-done Signifies that the peer review team has reviewed this PR serverless Label for all Serverless PRs size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants