From 8e7a51daec012b6ced5352b792c944f22411857d Mon Sep 17 00:00:00 2001 From: Vince Date: Thu, 15 Aug 2019 12:17:52 +0200 Subject: [PATCH] Clarify --cpu mapping for docker-local scheduler --- docs/advanced-usage/resource-management.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/advanced-usage/resource-management.md b/docs/advanced-usage/resource-management.md index 6e489d0b8..33c7b738a 100644 --- a/docs/advanced-usage/resource-management.md +++ b/docs/advanced-usage/resource-management.md @@ -27,6 +27,12 @@ Valid resource options include: - `--network-ingress` - `--network-egress` +For example, when using the docker-local scheduler the `--cpu` resource limit maps to the `--cpus` Docker run flag. From the Docker docs on the `--cpus` flag: + +> Specify how much of the available CPU resources a container can use. For instance, if the host machine has two CPUs and you set `--cpus="1.5"`, the container is guaranteed at most one and a half of the CPUs. This is the equivalent of setting `--cpu-period="100000"` and `--cpu-quota="150000"`. + +So setting `resource:limit` for cpu to 100 when using the docker-local scheduler means your app can access at most 100 CPUs. If you have fewer than 100 CPUs on your server, then your app will be able to access all of them. + Resource limits and reservations are applied only during the `run` and `deploy` phases of an application, and will not impact the `build` phase of an application. ### Resource Limits