12430: Expand output_glob documentation.
[arvados.git] / doc / _includes / _container_runtime_constraints.liquid
1 {% comment %}
2 Copyright (C) The Arvados Authors. All rights reserved.
3
4 SPDX-License-Identifier: CC-BY-SA-3.0
5 {% endcomment %}
6
7 h2. Runtime constraints
8
9 Runtime constraints restrict the container's access to compute resources and the outside world (in addition to its explicitly stated inputs and output).
10
11 table(table table-bordered table-condensed).
12 |_. Key|_. Type|_. Description|_. Notes|
13 |ram|integer|Number of ram bytes to be used to run this process.|Optional. However, a ContainerRequest that is in "Committed" state must provide this.|
14 |vcpus|integer|Number of cores to be used to run this process.|Optional. However, a ContainerRequest that is in "Committed" state must provide this.|
15 |keep_cache_disk|integer|When the container process accesses data from Keep via the filesystem, that data will be cached on disk, up to this amount in bytes.|Optional. If your cluster is configured to use a disk cache by default, the default size will match your @ram@ constraint, bounded between 2GiB and 32GiB.|
16 |keep_cache_ram|integer|When the container process accesses data from Keep via the filesystem, that data will be cached in memory, up to this amount in bytes.|Optional. If your cluster is configured to use a RAM cache by default, the administrator sets a default cache size.|
17 |API|boolean|When set, ARVADOS_API_HOST and ARVADOS_API_TOKEN will be set, and container will have networking enabled to access the Arvados API server.|Optional.|
18 |cuda|object|Request CUDA GPU support, see below|Optional.|
19
20 h3. CUDA GPU support
21
22 table(table table-bordered table-condensed).
23 |_. Key|_. Type|_. Description|_. Notes|
24 |device_count|int|Number of GPUs to request.|Count greater than 0 enables CUDA GPU support.|
25 |driver_version|string|Minimum CUDA driver version, in "X.Y" format.|Required when device_count > 0|
26 |hardware_capability|string|Minimum CUDA hardware capability, in "X.Y" format.|Required when device_count > 0|