tcmu-runner(8)

✨ tcmu-runner ✨

okay bestie so like. tcmu-runner(8) is the manual page for tcmu-runner, and it lives in the System Manager's Manual section 8. Let's get into it 💅

---

🌸 NAME 🌸

tcmu-runner — a daemon that handles the userspace side of the LIO TCM-User backstore. she's the little helper process holding down the whole userspace half of that operation. no cap 🫶

---

🦋 DESCRIPTION 🦋

tcmu-runner is a service that provides an operating environment for LIO TCM-User handlers. it's giving backstage crew energy — the handlers get to perform, she makes sure the stage exists.

and like, what handlers are we talking about rn? currently these include:

• handlers for Gluster glfs
• handlers for the qcow image format
• handlers for the qcow2 image format

that's the lineup ✨

---

🌈 USAGE 🌈

normally she just starts herself automatically via D-Bus system activation — like she was invited to the party before you even asked 🎀

but you can also run tcmu-runner directly as root, usually for debugging and development purposes. just know that's the manual-entry route, bestie.

---

💖 OPTIONS 💖

• -h, --help — prints usage information. when you're lost, she tells you where you are 🗺️
• -d, --debug — enables debug messages. so much talking. so many vibes. so useful when something's acting up 🔥
• -V, --version — prints tcmu-runner's version. identity check 👑

---

👑 CONFIGURING HANDLERS 👑

TCMU-backed handlers are typically configured using normal LIO configuration tools, such as targetcli. and part of doing that is entering a handler-specific configuration string. yes, that's the part where you have to actually know the string. ik ik 😭

---

🎀 CONFIGURING GLUSTER HANDLER (glfs) 🎀

this handler uses the Gluster glfs API to use Gluster as a backstore for the image file. slay, honestly.

its configuration string is:

volume@hostname/filename
volume: The volume on the Gluster server
hostname: The server's hostname
filename: The backing file

that's it. that's the whole string format. volume + @ + hostname + / + filename. periodt 💅

---

🧚 CONFIGURING QCOW HANDLER (qcow) 🧚

this handler supports the qcow, qcow2, or raw image file formats. flexible icon behavior fr fr.

its configuration string is:

path
path: The full path to a file of a supported file format. The file
must already have been created using qemu-img.

⚠️ read that last bit again bestie — the file must already have been created using qemu-img. this handler does not make it for you. no shortcuts, no takebacks 🙈

---

🍓 SEE ALSO 🍓

• qemu-img(1)
• targetcli(8)
• targetctl(8)

go read those too, they're all part of the same friend group 🌸

---

💜 AUTHOR 💜

Andy Grover <agrover@redhat.com> — thank you for your service 🫡

---

🔥 REPORTING BUGS 🔥

found something weird? report bugs via:

• <target-devel@vger.kernel.org>
• or <https://github.com/agrover/tcmu-runner/issues>

don't just sit there suffering in silence, tell the devs 💀

---

and that's the whole page, bestie!! this lil cutie comes to you from the System Manager's Manual, tcmu-runner(8) — same name up top, same name at the bottom, keeping it symmetrical and iconic as always ✨🦋💖