20755: Merge branch 'main' into 20755-ec2-multiple-subnets
[arvados.git] / doc / _includes / _singularity_mksquashfs_configuration.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(#singularity_mksquashfs_configuration). Singularity mksquashfs configuration
8
9 {% if show_docker_warning != nil %}
10 {% include 'notebox_begin_warning' %}
11 This section is only relevant when using Singularity. Skip this section when using Docker.
12 {% include 'notebox_end' %}
13 {% endif %}
14
15 Docker images are converted on the fly by @mksquashfs@, which can consume a considerable amount of RAM. The RAM usage of mksquashfs can be restricted in @/etc/singularity/singularity.conf@ with a line like @mksquashfs mem = 256M@. The amount of memory made available for mksquashfs should be configured lower than the smallest amount of memory requested by a container on the cluster to avoid the conversion being killed for using too much memory. The default memory allocation in CWL is 256M, so that is also a good choice for the @mksquashfs mem@ setting.