doc/install/crunch2-lsf/install-dispatch.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install the LSF dispatcher
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 {% include 'notebox_begin_warning' %}
  13 @arvados-dispatch-lsf@ is only relevant for on premises clusters that will spool jobs to LSF. Skip this section if you use Slurm or if you are installing a cloud cluster.
  14 {% include 'notebox_end' %}
  15
  16 h2(#overview). Overview
  17
  18 Containers can be dispatched to an LSF cluster.  The dispatcher sends work to the cluster using LSF's @bsub@ command, so it works in a variety of LSF configurations.
  19
  20 In order to run containers, you must choose a user that has permission to set up FUSE mounts and run Singularity/Docker containers on each compute node.  This install guide refers to this user as the @crunch@ user.  We recommend you create this user on each compute node with the same UID and GID, and add it to the @fuse@ and @docker@ system groups to grant it the necessary permissions.  However, you can run the dispatcher under any account with sufficient permissions across the cluster.
  21
  22 Set up all of your compute nodes with "Docker":../crunch2/install-compute-node-singularity.html or "Singularity":../crunch2/install-compute-node-docker.html.
  23
  24 *Current limitations*:
  25 * Arvados container priority is not propagated to LSF job priority. This can cause inefficient use of compute resources, and even deadlock if there are fewer compute nodes than concurrent Arvados workflows.
  26 * Combining LSF with docker may not work, depending on LSF configuration and user/group IDs (if LSF only sets up the configured user's primary group ID when executing the crunch-run process on a compute node, it may not have permission to connect to the docker daemon).
  27
  28 h2(#update-config). Update config.yml
  29
  30 Arvados-dispatch-lsf reads the common configuration file at @/etc/arvados/config.yml@.
  31
  32 Add a DispatchLSF entry to the Services section, using the hostname where @arvados-dispatch-lsf@ will run, and an available port:
  33
  34 <notextile>
  35 <pre>    Services:
  36       DispatchLSF:
  37         InternalURLs:
  38           "http://<code class="userinput">hostname.zzzzz.arvadosapi.com:9007</code>": {}</pre>
  39 </notextile>
  40
  41 Review the following configuration parameters and adjust as needed.
  42
  43 h3(#BsubSudoUser). Containers.LSF.BsubSudoUser
  44
  45 arvados-dispatch-lsf uses @sudo@ to execute @bsub@, for example @sudo -E -u crunch bsub [...]@. This means the @crunch@ account must exist on the hosts where LSF jobs run ("execution hosts"), as well as on the host where you are installing the Arvados LSF dispatcher (the "submission host"). To use a user account other than @crunch@, configure @BsubSudoUser@:
  46
  47 <notextile>
  48 <pre>    Containers:
  49       LSF:
  50         <code class="userinput">BsubSudoUser: <b>lsfuser</b>
  51 </code></pre>
  52 </notextile>
  53
  54 Alternatively, you can arrange for the arvados-dispatch-lsf process to run as an unprivileged user that has a corresponding account on all compute nodes, and disable the use of @sudo@ by specifying an empty string:
  55
  56 <notextile>
  57 <pre>    Containers:
  58       LSF:
  59         # Don't use sudo
  60         <code class="userinput">BsubSudoUser: <b>""</b>
  61 </code></pre>
  62 </notextile>
  63
  64
  65 h3(#BsubArgumentsList). Containers.LSF.BsubArgumentsList
  66
  67 When arvados-dispatch-lsf invokes @bsub@, you can add arguments to the command by specifying @BsubArgumentsList@.  You can use this to send the jobs to specific cluster partitions or add resource requests.  Set @BsubArgumentsList@ to an array of strings.
  68
  69 Template variables starting with % will be substituted as follows:
  70
  71 %U uuid
  72 %C number of VCPUs
  73 %M memory in MB
  74 %T tmp in MB
  75 %G number of GPU devices (@runtime_constraints.cuda.device_count@)
  76
  77 Use %% to express a literal %. The %%J in the default will be changed to %J, which is interpreted by @bsub@ itself.
  78
  79 For example:
  80
  81 <notextile>
  82 <pre>    Containers:
  83       LSF:
  84         <code class="userinput">BsubArgumentsList: <b>["-o", "/tmp/crunch-run.%%J.out", "-e", "/tmp/crunch-run.%%J.err", "-J", "%U", "-n", "%C", "-D", "%MMB", "-R", "rusage[mem=%MMB:tmp=%TMB] span[hosts=1]", "-R", "select[mem>=%MMB]", "-R", "select[tmp>=%TMB]", "-R", "select[ncpus>=%C]"]</b></code>
  85 </pre>
  86 </notextile>
  87
  88 Note that the default value for @BsubArgumentsList@ uses the @-o@ and @-e@ arguments to write stdout/stderr data to files in @/tmp@ on the compute nodes, which is helpful for troubleshooting installation/configuration problems. Ensure you have something in place to delete old files from @/tmp@, or adjust these arguments accordingly.
  89
  90 h3(#BsubCUDAArguments). Containers.LSF.BsubCUDAArguments
  91
  92 If the container requests access to GPUs (@runtime_constraints.cuda.device_count@ of the container request is greater than zero), the command line arguments in @BsubCUDAArguments@ will be added to the command line _after_ @BsubArgumentsList@.  This should consist of the additional @bsub@ flags your site requires to schedule the job on a node with GPU support.  Set @BsubCUDAArguments@ to an array of strings.  For example:
  93
  94 <notextile>
  95 <pre>    Containers:
  96       LSF:
  97         <code class="userinput">BsubCUDAArguments: <b>["-gpu", "num=%G"]</b></code>
  98 </pre>
  99 </notextile>
 100
 101 h3(#PollInterval). Containers.PollInterval
 102
 103 arvados-dispatch-lsf polls the API server periodically for new containers to run.  The @PollInterval@ option controls how often this poll happens.  Set this to a string of numbers suffixed with one of the time units @s@, @m@, or @h@.  For example:
 104
 105 <notextile>
 106 <pre>    Containers:
 107       <code class="userinput">PollInterval: <b>10s</b>
 108 </code></pre>
 109 </notextile>
 110
 111
 112 h3(#ReserveExtraRAM). Containers.ReserveExtraRAM: Extra RAM for jobs
 113
 114 Extra RAM to reserve (in bytes) on each LSF job submitted by Arvados, which is added to the amount specified in the container's @runtime_constraints@.  If not provided, the default value is zero.
 115
 116 Supports suffixes @KB@, @KiB@, @MB@, @MiB@, @GB@, @GiB@, @TB@, @TiB@, @PB@, @PiB@, @EB@, @EiB@ (where @KB@ is 10[^3^], @KiB@ is 2[^10^], @MB@ is 10[^6^], @MiB@ is 2[^20^] and so forth).
 117
 118 <notextile>
 119 <pre>    Containers:
 120       <code class="userinput">ReserveExtraRAM: <b>256MiB</b></code>
 121 </pre>
 122 </notextile>
 123
 124
 125 h3(#CrunchRunArgumentList). Containers.CrunchRunArgumentList: Using host networking for containers
 126
 127 Older Linux kernels (prior to 3.18) have bugs in network namespace handling which can lead to compute node lockups.  This by is indicated by blocked kernel tasks in "Workqueue: netns cleanup_net".   If you are experiencing this problem, as a workaround you can disable use of network namespaces by Docker across the cluster.  Be aware this reduces container isolation, which may be a security risk.
 128
 129 <notextile>
 130 <pre>    Containers:
 131       <code class="userinput">CrunchRunArgumentsList:
 132         - <b>"-container-enable-networking=always"</b>
 133         - <b>"-container-network-mode=host"</b></code>
 134 </pre>
 135 </notextile>
 136
 137
 138 h3(#InstanceTypes). InstanceTypes: Avoid submitting jobs with unsatisfiable resource constraints
 139
 140 LSF does not provide feedback when a submitted job's RAM, CPU, or disk space constraints cannot be satisfied by any node: the job will wait in the queue indefinitely with "pending" status, reported by Arvados as "queued".
 141
 142 As a workaround, you can configure @InstanceTypes@ with your LSF cluster's compute node sizes. Arvados will use these sizes to determine when a container is impossible to run, and cancel it instead of submitting an LSF job.
 143
 144 Apart from detecting non-runnable containers, the configured instance types will not have any effect on scheduling.
 145
 146 <notextile>
 147 <pre>    InstanceTypes:
 148       most-ram:
 149         VCPUs: 8
 150         RAM: 640GiB
 151         IncludedScratch: 640GB
 152       most-cpus:
 153         VCPUs: 32
 154         RAM: 256GiB
 155         IncludedScratch: 640GB
 156       gpu:
 157         VCPUs: 8
 158         RAM: 256GiB
 159         IncludedScratch: 640GB
 160         CUDA:
 161           DriverVersion: "11.4"
 162           HardwareCapability: "7.5"
 163           DeviceCount: 1
 164 </pre>
 165 </notextile>
 166
 167
 168 {% assign arvados_component = 'arvados-dispatch-lsf' %}
 169
 170 {% include 'install_packages' %}
 171
 172 {% include 'start_service' %}
 173
 174 {% include 'restart_api' %}
 175
 176 h2(#confirm-working). Confirm working installation
 177
 178 On the dispatch node, start monitoring the arvados-dispatch-lsf logs:
 179
 180 <notextile>
 181 <pre><code># <span class="userinput">journalctl -o cat -fu arvados-dispatch-lsf.service</span>
 182 </code></pre>
 183 </notextile>
 184
 185 In another terminal window, use the diagnostics tool to run a simple container.
 186
 187 <notextile>
 188 <pre><code># <span class="userinput">arvados-client sudo diagnostics</span>
 189 INFO       5: running health check (same as `arvados-server check`)
 190 INFO      10: getting discovery document from https://zzzzz.arvadosapi.com/discovery/v1/apis/arvados/v1/rest
 191 ...
 192 INFO     160: running a container
 193 INFO      ... container request submitted, waiting up to 10m for container to run
 194 </code></pre>
 195 </notextile>
 196
 197 After performing a number of other quick tests, this will submit a new container request and wait for it to finish.
 198
 199 While the diagnostics tool is waiting, the @arvados-dispatch-lsf@ logs will show details about submitting an LSF job to run the container.