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 {% include 'hpc_max_gateway_tunnels' %}
  44
  45 h3(#BsubSudoUser). Containers.LSF.BsubSudoUser
  46
  47 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@:
  48
  49 <notextile>
  50 <pre>    Containers:
  51       LSF:
  52         <code class="userinput">BsubSudoUser: <b>lsfuser</b>
  53 </code></pre>
  54 </notextile>
  55
  56 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:
  57
  58 <notextile>
  59 <pre>    Containers:
  60       LSF:
  61         # Don't use sudo
  62         <code class="userinput">BsubSudoUser: <b>""</b>
  63 </code></pre>
  64 </notextile>
  65
  66
  67 h3(#BsubArgumentsList). Containers.LSF.BsubArgumentsList
  68
  69 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.
  70
  71 Template variables starting with % will be substituted as follows:
  72
  73 %U uuid
  74 %C number of VCPUs
  75 %M memory in MB
  76 %T tmp in MB
  77 %G number of GPU devices (@runtime_constraints.cuda.device_count@)
  78
  79 Use %% to express a literal %. The %%J in the default will be changed to %J, which is interpreted by @bsub@ itself.
  80
  81 For example:
  82
  83 <notextile>
  84 <pre>    Containers:
  85       LSF:
  86         <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>
  87 </pre>
  88 </notextile>
  89
  90 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.
  91
  92 h3(#BsubCUDAArguments). Containers.LSF.BsubCUDAArguments
  93
  94 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:
  95
  96 <notextile>
  97 <pre>    Containers:
  98       LSF:
  99         <code class="userinput">BsubCUDAArguments: <b>["-gpu", "num=%G"]</b></code>
 100 </pre>
 101 </notextile>
 102
 103 h3(#PollInterval). Containers.PollInterval
 104
 105 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:
 106
 107 <notextile>
 108 <pre>    Containers:
 109       <code class="userinput">PollInterval: <b>10s</b>
 110 </code></pre>
 111 </notextile>
 112
 113
 114 h3(#ReserveExtraRAM). Containers.ReserveExtraRAM: Extra RAM for jobs
 115
 116 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.
 117
 118 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).
 119
 120 <notextile>
 121 <pre>    Containers:
 122       <code class="userinput">ReserveExtraRAM: <b>256MiB</b></code>
 123 </pre>
 124 </notextile>
 125
 126
 127 h3(#CrunchRunArgumentList). Containers.CrunchRunArgumentList: Using host networking for containers
 128
 129 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.
 130
 131 <notextile>
 132 <pre>    Containers:
 133       <code class="userinput">CrunchRunArgumentsList:
 134         - <b>"-container-enable-networking=always"</b>
 135         - <b>"-container-network-mode=host"</b></code>
 136 </pre>
 137 </notextile>
 138
 139
 140 h3(#InstanceTypes). InstanceTypes: Avoid submitting jobs with unsatisfiable resource constraints
 141
 142 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".
 143
 144 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.
 145
 146 Apart from detecting non-runnable containers, the configured instance types will not have any effect on scheduling.
 147
 148 <notextile>
 149 <pre>    InstanceTypes:
 150       most-ram:
 151         VCPUs: 8
 152         RAM: 640GiB
 153         IncludedScratch: 640GB
 154       most-cpus:
 155         VCPUs: 32
 156         RAM: 256GiB
 157         IncludedScratch: 640GB
 158       gpu:
 159         VCPUs: 8
 160         RAM: 256GiB
 161         IncludedScratch: 640GB
 162         CUDA:
 163           DriverVersion: "11.4"
 164           HardwareCapability: "7.5"
 165           DeviceCount: 1
 166 </pre>
 167 </notextile>
 168
 169
 170 {% assign arvados_component = 'arvados-dispatch-lsf' %}
 171
 172 {% include 'install_packages' %}
 173
 174 {% include 'start_service' %}
 175
 176 {% include 'restart_api' %}
 177
 178 h2(#confirm-working). Confirm working installation
 179
 180 On the dispatch node, start monitoring the arvados-dispatch-lsf logs:
 181
 182 <notextile>
 183 <pre><code># <span class="userinput">journalctl -o cat -fu arvados-dispatch-lsf.service</span>
 184 </code></pre>
 185 </notextile>
 186
 187 In another terminal window, use the diagnostics tool to run a simple container.
 188
 189 <notextile>
 190 <pre><code># <span class="userinput">arvados-client sudo diagnostics</span>
 191 INFO       5: running health check (same as `arvados-server check`)
 192 INFO      10: getting discovery document from https://zzzzz.arvadosapi.com/discovery/v1/apis/arvados/v1/rest
 193 ...
 194 INFO     160: running a container
 195 INFO      ... container request submitted, waiting up to 10m for container to run
 196 </code></pre>
 197 </notextile>
 198
 199 After performing a number of other quick tests, this will submit a new container request and wait for it to finish.
 200
 201 While the diagnostics tool is waiting, the @arvados-dispatch-lsf@ logs will show details about submitting an LSF job to run the container.