Skip to content

Commit 4867d9d

Browse files
mikeeemsfussell
mikeee
and
msfussell
authored
docs: update max-body-size documentation (#4873)
* docs: update max-body-size documentation closes #4670 Signed-off-by: Mike Nguyen <[email protected]> * docs: update max-body-size documentation and deprecation notices closes #4670 Signed-off-by: Mike Nguyen <[email protected]> * docs: clarify deprecation notice closes #4670 Signed-off-by: Mike Nguyen <[email protected]> * Update daprdocs/content/en/operations/configuration/increase-request-size.md Signed-off-by: Mark Fussell <[email protected]> * tidy Signed-off-by: Mike Nguyen <[email protected]> --------- Signed-off-by: Mike Nguyen <[email protected]> Signed-off-by: Mark Fussell <[email protected]> Co-authored-by: Mark Fussell <[email protected]>
1 parent 2f7d17d commit 4867d9d

File tree

2 files changed

+26
-21
lines changed

2 files changed

+26
-21
lines changed

‎daprdocs/content/en/operations/configuration/increase-request-size.md‎

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
11
---
22
type: docs
3-
title: "How-To: Handle large http body requests"
4-
linkTitle: "HTTP request body size"
3+
title: "How-To: Handle larger body requests"
4+
linkTitle: "Request body size"
55
weight: 6000
66
description: "Configure http requests that are bigger than 4 MB"
77
---
88

9-
By default, Dapr has a limit for the request body size, set to 4MB. You can change this by defining:
10-
- The `dapr.io/http-max-request-size` annotation, or
11-
- The `--dapr-http-max-request-size` flag.
9+
{{% alert title="Note" color="primary" %}}
10+
The existing flag/annotation`dapr-http-max-request-size` has been deprecated and updated to `max-body-size`.
11+
{{% /alert %}}
12+
13+
By default, Dapr has a limit for the request body size, set to 4MB. You can change this for both HTTP and gRPC requests by defining:
14+
- The `dapr.io/max-body-size` annotation, or
15+
- The `--max-body-size` flag.
1216

1317
{{< tabpane text=true >}}
1418

1519
<!--self hosted-->
1620
{{% tab "Self-hosted" %}}
1721

18-
When running in self-hosted mode, use the `--dapr-http-max-request-size` flag to configure Dapr to use non-default request body size:
22+
When running in self-hosted mode, use the `--max-body-size` flag to configure Dapr to use non-default request body size:
1923

2024
```bash
21-
dapr run --dapr-http-max-request-size 16 node app.js
25+
dapr run --max-body-size 16 node app.js
2226
```
23-
This tells Dapr to set maximum request body size to `16` MB.
24-
2527
{{% /tab %}}
2628

2729
<!--kubernetes-->
@@ -50,14 +52,16 @@ spec:
5052
dapr.io/enabled: "true"
5153
dapr.io/app-id: "myapp"
5254
dapr.io/app-port: "8000"
53-
dapr.io/http-max-request-size: "16"
55+
dapr.io/max-body-size: "16"
5456
#...
5557
```
5658

5759
{{% /tab %}}
5860

5961
{{< /tabpane >}}
6062

63+
This tells Dapr to set the maximum request body size to `16` MB for both HTTP and gRPC requests.
64+
6165
## Related links
6266

6367
[Dapr Kubernetes pod annotations spec]({{% ref arguments-annotations-overview.md %}})

‎daprdocs/content/en/operations/support/breaking-changes-and-deprecations.md‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -58,17 +58,18 @@ After announcing a future breaking change, the change will happen in 2 releases
5858

5959
## Announced deprecations
6060

61-
| Feature | Deprecation announcement | Removal |
62-
|-----------------------|-----------------------|------------------------- |
63-
| GET /v1.0/shutdown API (Users should use [POST API]({{% ref kubernetes-job.md %}}) instead) | 1.2.0 | 1.4.0 |
64-
| Java domain builder classes deprecated (Users should use [setters](https://github.com/dapr/java-sdk/issues/587) instead) | Java SDK 1.3.0 | Java SDK 1.5.0 |
65-
| Service invocation will no longer provide a default content type header of `application/json` when no content-type is specified. You must explicitly [set a content-type header]({{% ref "service_invocation_api.md#request-contents" %}}) for service invocation if your invoked apps rely on this header. | 1.7.0 | 1.9.0 |
66-
| gRPC service invocation using `invoke` method is deprecated. Use proxy mode service invocation instead. See [How-To: Invoke services using gRPC ]({{% ref howto-invoke-services-grpc.md %}}) to use the proxy mode.| 1.9.0 | 1.10.0 |
67-
| The CLI flag `--app-ssl` (in both the Dapr CLI and daprd) has been deprecated in favor of using `--app-protocol` with values `https` or `grpcs`. [daprd:6158](https://github.com/dapr/dapr/issues/6158) [cli:1267](https://github.com/dapr/cli/issues/1267)| 1.11.0 | 1.13.0 |
68-
| Hazelcast PubSub Component | 1.9.0 | 1.11.0 |
69-
| Twitter Binding Component | 1.10.0 | 1.11.0 |
70-
| NATS Streaming PubSub Component | 1.11.0 | 1.13.0 |
71-
| Workflows API Alpha1 `/v1.0-alpha1/workflows` being deprecated in favor of Workflow Client | 1.15.0 | 1.17.0 |
61+
| Feature | Deprecation announcement | Removal |
62+
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|----------------|
63+
| GET /v1.0/shutdown API (Users should use [POST API]({{% ref kubernetes-job.md %}}) instead) | 1.2.0 | 1.4.0 |
64+
| Java domain builder classes deprecated (Users should use [setters](https://github.com/dapr/java-sdk/issues/587) instead) | Java SDK 1.3.0 | Java SDK 1.5.0 |
65+
| Service invocation will no longer provide a default content type header of `application/json` when no content-type is specified. You must explicitly [set a content-type header]({{% ref "service_invocation_api.md#request-contents" %}}) for service invocation if your invoked apps rely on this header. | 1.7.0 | 1.9.0 |
66+
| gRPC service invocation using `invoke` method is deprecated. Use proxy mode service invocation instead. See [How-To: Invoke services using gRPC ]({{% ref howto-invoke-services-grpc.md %}}) to use the proxy mode. | 1.9.0 | 1.10.0 |
67+
| The CLI flag `--app-ssl` (in both the Dapr CLI and daprd) has been deprecated in favor of using `--app-protocol` with values `https` or `grpcs`. [daprd:6158](https://github.com/dapr/dapr/issues/6158) [cli:1267](https://github.com/dapr/cli/issues/1267) | 1.11.0 | 1.13.0 |
68+
| Hazelcast PubSub Component | 1.9.0 | 1.11.0 |
69+
| Twitter Binding Component | 1.10.0 | 1.11.0 |
70+
| NATS Streaming PubSub Component | 1.11.0 | 1.13.0 |
71+
| Workflows API Alpha1 `/v1.0-alpha1/workflows` being deprecated in favor of Workflow Client | 1.15.0 | 1.17.0 |
72+
| Migration of `http-max-request-size` flags/annotations to `max-body-size`. See [How-To: Handle larger body requests]({{% ref increase-request-size.md %}}) | 1.14.0 | 1.17.0 |
7273

7374
## Related links
7475

0 commit comments

Comments
 (0)