ganeti-listrunner(8)

📦
version 3.1.0~rc2 · 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute

💅 ganeti-listrunner(8) — the vibe

okay so bestie, meet ganeti-listrunner from the Ganeti family, living its best life in Version 3.1.0~rc2. It's a tool that runs commands in parallel across a whole squad of machines, and honestly? It eats. ✨

🌸 NAME 🌸

ganeti-listrunner — run commands in parallel over multiple machines. periodt. 💖

✨ SYNOPSIS ✨

ganeti-listrunner -l logdir {-x executable | -c shell-cmd} {-f hostfile
| -h hostlist} [-a aux-file] [-b batch-size] [-u username] [-A]

🦋 DESCRIPTION 🦋

So ganeti-listrunner is literally a tool for running commands in parallel over multiple machines. It's giving "group chat but for servers."

Here's the thing that makes it different from dsh or other tools: it asks for the password once (as long as you're not using ssh-agent), and then it reuses that password to connect to every single machine. Which means it's super easy to use even when public key authentication or Kerberos authentication just... isn't available. no cap. 🔥

It can run either:

  • a command, or
  • a script (which gets uploaded first and deleted after execution) 👑

...on a list of hosts that you give it either:

  • via a file (one host per line), or
  • as a comma-separated list right there on the commandline.

The output (stdout and stderr are merged) of the remote execution gets written to a logfile. And bestie, it's one logfile per host. Every single one gets its own. 🎀

💅 OPTIONS 💅

The options you can pass to the program are, and I quote, as follows:

  • -l logdir — the directory under which the logfiles files should be written. 🍓
  • -x executable — the executable to copy and run on the target hosts. 🧚
  • -c shell-cmd — the shell command to run on the remote hosts. ✨
  • -f hostfile — the file with the target hosts, one hostname per line. 📄
  • -h hostlist — comma-separated list of target hosts. 📋
  • -a aux-file — a file to copy to the target hosts. You can pass this multiple times, and in that case all the files get copied to the temporary directory. The executable or the shell command will be run from the (temporary) directory where these files have been copied. 🎀
  • -b batch-size — the host list gets split into batches of batch-size which are processed in parallel. The default is 15, and you should increase it if you need faster processing. 🏃♀️
  • -u username — username to connect as instead of the default root username. 👑
  • -A — use an existing ssh-agent instead of password authentication. 🔑
  • --args — arguments to pass to executable (that's -x). 🌈

😭 EXIT STATUS 😭

The exist status of the command will be zero, unless it was aborted in some way (e.g. ^C). Like, if you panic-ctrl-C it, all bets are off, bestie. 💀

🌟 EXAMPLE 🌟

Run a command on a list of hosts:

listrunner -l logdir -c "uname -a" -h host1,host2,host3

Upload a script, some auxiliary files and run the script:

listrunner -l logdir -x runme.sh \
  -a seed.dat -a golden.dat \
  -h host1,host2,host3

Look at that backslash continuation. iconic. 💅

🫶 SEE ALSO 🫶

dsh(1), cssh(1)

🐛 REPORTING BUGS 🐛

Found a bug? Report it to the project's issue tracker, or contact the developers using the Ganeti mailing list. They're nice, fr fr. 🙈

🌈 SEE ALSO (the extended cinematic universe) 🌈

Ganeti overview and specifications:

Ganeti commands:

Ganeti daemons:

Ganeti htools:

Copyright (C) 2006-2015 Google Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

and that's the whole page bestie 🫶 brought to you by the Ganeti crew, Version 3.1.0~rc2, courtesy of Ganeti and ganeti-listrunner(8). go run some commands in parallel, you absolute icon 💖✨🎀

📦 where this page comes from