Skip to content

Commit 9d5a94f

Browse files
authored
docs(container): add more information about some arguments of container (#2961)
* docs(serverless): document unit and default value of timeout Default value can be found here: https://github.com/scaleway/terraform-provider-scaleway/blob/8041a68b95e3b1d0f537ab8c15ea9719008b277c/internal/services/container/container.go#L108 * docs(serverless): how to handle deprecation of max_concurrency * docs(serverless): fix typo
1 parent 8041a68 commit 9d5a94f

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/data-sources/container.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ In addition to all arguments above, the following attributes are exported:
9393

9494
- `sandbox` - Execution environment of the container.
9595

96-
- `heath_check` - Health check configuration block of the container.
96+
- `health_check` - Health check configuration block of the container.
9797
- `http` - HTTP health check configuration.
9898
- `path` - Path to use for the HTTP health check.
9999
- `failure_threshold` - Number of consecutive health check failures before considering the container unhealthy.

docs/resources/container.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,23 +68,23 @@ The following arguments are supported:
6868

6969
- `cpu_limit` - (Optional) The amount of vCPU computing resources to allocate to each container.
7070

71-
- `timeout` - (Optional) The maximum amount of time your container can spend processing a request before being stopped.
71+
- `timeout` - (Optional) The maximum amount of time in seconds your container can spend processing a request before being stopped. Default to `300` seconds.
7272

7373
- `privacy` - (Optional) The privacy type defines the way to authenticate to your container. Please check our dedicated [section](https://www.scaleway.com/en/developers/api/serverless-containers/#protocol-9dd4c8).
7474

7575
- `registry_image` - (Optional) The registry image address (e.g., `rg.fr-par.scw.cloud/$NAMESPACE/$IMAGE`)
7676

7777
- `registry_sha256` - (Optional) The sha256 of your source registry image, changing it will re-apply the deployment. Can be any string.
7878

79-
- `max_concurrency` - (Optional) The maximum number of simultaneous requests your container can handle at the same time.
79+
- `max_concurrency` - (Deprecated) The maximum number of simultaneous requests your container can handle at the same time. Use `scaling_option.concurrent_requests_threshold` instead.
8080

8181
- `protocol` - (Optional) The communication [protocol](https://www.scaleway.com/en/developers/api/serverless-containers/#path-containers-update-an-existing-container) `http1` or `h2c`. Defaults to `http1`.
8282

8383
- `http_option` - (Optional) Allows both HTTP and HTTPS (`enabled`) or redirect HTTP to HTTPS (`redirected`). Defaults to `enabled`.
8484

8585
- `sandbox` - (Optional) Execution environment of the container.
8686

87-
- `heath_check` - (Optional) Health check configuration block of the container.
87+
- `health_check` - (Optional) Health check configuration block of the container.
8888
- `http` - HTTP health check configuration.
8989
- `path` - Path to use for the HTTP health check.
9090
- `failure_threshold` - Number of consecutive health check failures before considering the container unhealthy.

0 commit comments

Comments
 (0)