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

Document the use of HTTP/1 full duplex support #5818

Merged
merged 2 commits into from
Jan 23, 2024
Merged

Document the use of HTTP/1 full duplex support #5818

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8384f85
document the use of http/1 full duplex support
skonto Jan 17, 2024
68c5b66
comments
skonto Jan 23, 2024
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
2 changes: 1 addition & 1 deletion config/nav.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ nav:
- Using extensions enabled by QPOptions: serving/services/using-queue-extensions.md
# TODO: Add security section to docs?
- Configure resource requests and limits: serving/services/configure-requests-limits-services.md
- HTTPS redirection: serving/services/http-protocol.md
- Configuring HTTP: serving/services/http-protocol.md
- Volume Support: serving/services/storage.md
- Traffic management: serving/traffic-management.md
- Configuring gradual rollout of traffic to Revisions: serving/rolling-out-latest-revision.md
Expand Down
34 changes: 32 additions & 2 deletions docs/serving/services/http-protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# HTTPS redirection
# Configuring HTTP

## HTTPS redirection

Operators can force HTTPS redirection for all Services. See the `http-protocol` mentioned in the [Enabling automatic TLS certificate provisioning](../encryption/enabling-automatic-tls-certificate-provisioning.md) page for more details.

## Overriding the default HTTP behavior
### Overriding the default HTTP behavior

You can override the default behavior for each Service or global configuration.

Expand Down Expand Up @@ -50,3 +52,31 @@ You can override the default behavior for each Service or global configuration.
network:
http-protocol: "redirected"
```

## HTTP/1 Full Duplex support per workload

Knative services can turn on the support for [HTTP/1 full duplex](https://pkg.go.dev/net/http#ResponseController.EnableFullDuplex) end-to-end on the data path.
This should be used in scenarios where the [related Golang issue](https://github.com/golang/go/issues/40747) is hit eg. the application server writes back to QP's reverse proxy before the latter has consumed the whole request.
For more details on why the issue appears see [here](https://github.com/golang/go/issues/40747#issuecomment-1382404132).

### Configure HTTP/1 Full Duplex support

In order to enable the HTTP/1 full duplex support you can set the corresponding annotation at the service level as follows:

```yaml
apiVersion: serving.knative.dev/v1
kind: Service
metadata:
name: example-service
namespace: default
annotations:
features.knative.dev/http-full-duplex: "Enabled"
spec:
Copy link
Member

Choose a reason for hiding this comment

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

does the casing matter? eg. I assume "enabled" works?

Copy link
Member

Choose a reason for hiding this comment

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

I haven't tested this specific case, but usually all our flags are string.EqualFold'ded.

template:
spec:
...
```

!!! warning

Copy link
Member

Choose a reason for hiding this comment

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

I probably would move that to the top of the YAML. Other than that LGTM

Test with your http clients before enabling, as older clients may not provide support for HTTP/1 full duplex.
Loading