Skip to content

Commit a89ce55

Browse files
committed
Update documentation on resources and timeouts
1 parent c3b17aa commit a89ce55

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,15 @@ Before following the examples, you need to:
399399
* [Mount subpath](../examples/kubernetes/volume_path/README.md)
400400
* [Use Access Points](../examples/kubernetes/access_points/README.md)
401401

402+
## Resource limits
403+
The controller container has different memory / CPU requirements based on the workload scale, concurrency, and configurations. When configuring your controller with `delete-access-point-root-dir=true`, we recommend setting higher resource limits if your workload requires many concurrent volume deletions. For example, for a workload that requires 100 concurrent PVC deletions, we recommend setting a minimum CPU limit of 3000m and a minimum memory limit of 2.5 GiB.
404+
405+
Alternatively, if you would prefer not to allocate these resources to your controller container, we advise lowering concurrency by lowering the `--worker-threads` argument of the [external-provisioner](https://github.com/kubernetes-csi/external-provisioner).
406+
407+
## Timeouts
408+
For most highly concurrent workloads, we recommend increasing the default timeout argument set in the [external-provisioner](https://github.com/kubernetes-csi/external-provisioner) from 15 seconds to 60 seconds. This will avoid provisioning failures due to throttling and resource contention in the controller container.
409+
410+
402411
## Using botocore to retrieve mount target ip address when dns name cannot be resolved
403412
* Amazon EFS CSI driver supports using botocore to retrieve mount target ip address when dns name cannot be resolved, e.g., when user is mounting a file system in another VPC, botocore comes preinstalled on efs-csi-driver which can solve this DNS issue.
404413
* IAM policy prerequisites to use this feature :

0 commit comments

Comments
 (0)