6926b9d3dcd5e7fe851dc1783069e9cda22d0222
[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_ram|integer|Number of keep cache bytes to be used to run this process.|Optional.|
16 |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.|
17 |cuda|object|Request CUDA GPU support, see below|Optional.|
18
19 h3. CUDA GPU support
20
21 table(table table-bordered table-condensed).
22 |device_count|int|Number of GPUs to request.|Required to request a GPU node.|
23 |driver_version|string|Minimum CUDA driver version.|Optional.|
24 |hardware_capability|string|Minimum CUDA hardware capability.|Optional.|