CONFIG-GFSD(8)

💖 config-gfsd(8) — the Gfarm file spool node setup bestie 💖

okay so. hi. welcome to config-gfsd, a manual page from the Gfarm family of man pages, and honestly? she's a lot. but we're gonna get through her together. 🫶

---

✨ NAME ✨

config-gfsd — set up a file spool node of Gfarm. that's it. that's the job. 🎀

---

✨ SYNOPSIS ✨

config-gfsd [options]

---

✨ DESCRIPTION ✨

okay so config-gfsd is a utility that sets up a file spool node of the Gfarm file system. the server program that actually is a file spool node is called gfsd, and config-gfsd is the little fairy godmother that gets her dressed for the ball. 🧚

ngl, you gotta run config-gfsd with root privilege — unless you're using the file system for private purposes, like development, evaluation, or testing of Gfarm. in that case? you're free, bestie. live your truth. 💅

config-gfsd assumes that the configuration file %%SYSCONFDIR%%/gfarm2.conf (or %%SYSCONFDIR%%/gfsd.conf when you're in private mode) already exists on the host. if it's missing? please copy the file from the metadata server. don't skip this step, i'm begging. 😭

here's the whole glow-up routine, in order:

1. Create a spool directory.
2. Update the Gfarm configuration file %%SYSCONFDIR%%/gfarm2.conf or %%SYSCONFDIR%%/gfsd.conf.
3. Create a script (or a configuration file) to start/stop gfsd.

on most systems, config-gfsd puts a start/stop script gfsd (or gfsd-ADDRESS in case of the private mode) onto either /etc/init.d or /etc/rc.d/init.d, depending on the operating system. classic behavior. iconic even.

on Linux with systemd — think Red Hat Enterprise Linux 7 or later — config-gfsd puts the unit configuration file gfsd.service (or gfsd-ADDRESS.service in case of the private mode) onto /etc/systemd/system, and then it executes systemctl enable gfsd.service (or systemctl enable gfsd-ADDRESS.service respectively). systemd girlies rise up 🔥

4. In case of the private mode, config-gfsd registers the host as a file spool node to the metadata server, by executing the gfhost -c command. in the non-private mode, it just shows you how to register the host as a file spool node to the metadata server, like this:

Please ask admin_user to register your host by the following command:

/usr/bin/gfhost -c -a x86_64-centos7.0-linux -p 600 -n 2 ext540

(yes it's giving "here's a note for your mom". very demure.)

5. In case of the private mode, config-gfsd starts gfsd. in the non-private mode, it shows you how to start gfsd, like as follows:

After that, start gfsd by the following command as a root:

systemctl start gfsd.service

6. Puts the script unconfig-gfsd.sh on %%SYSCONFDIR%%. this script does the unconfiguration of gfsd. it stops gfsd and removes all files created by config-gfsd — including unconfig-gfsd.sh itself. she takes herself out too. main character exit. 👑

---

before you set up a file spool node using config-gfsd, it is recommended to execute config-gfsd -t. with the -t option, the setup is not performed. instead, it shows you the values of all configurable parameters:

$ config-gfsd -t

prefix                 [--prefix]:
hostname                     [-h]: host1.example.org
listen address               [-l]: (all local IP addresses)
architecture                 [-a]: x86_64-centos6.5-linux
port                         [-p]: 600
ncpu                         [-n]: 8
spool directory                  : /var/gfarm-spool
rc script                        : /etc/init.d/gfsd
gfarm client conf file           : /etc/gfarm2.conf
gfsd pid file                    : /var/run/gfsd.pid

the option name surrounded by [ ] means that you can specify a value with that option. so like, if it's in brackets, it's adjustable. if it's not? that's just the vibe. 🌸

---

✨ OPTIONS ✨

• --prefix path — configure some paths related to gfsd. specifically, the followings are affected. (yes, it touches a lot. she's thorough.)
  • the spool directory of gfsd. that is PREFIX/var/gfarm-spool.
  • the directory to put a PID file of gfsd. that is PREFIX/var/run.
  • the directory of configuration files. that is PREFIX/etc.
  • the directory of the start/stop script for gfsd. that is PREFIX/etc/init.d or PREFIX/rc.d/init.d/etc, depending on operating systems.
  • if systemd is running on the host, there is a special exception. when an empty prefix is given by the --prefix option on such host, config-gfsd doesn't put a unit configuration file for systemd. instead, it puts the traditional start/stop script at PREFIX/etc/init.d. plot twist 🫢
  • the unconfiguration script unconfig-gfsd.sh. that is PREFIX/etc/unconfig-gfsd.sh.

the default is "" (empty).

• -a architecture — specify the architecture of the host. config-gfsd gives this value to gfhost -c as an argument of the -a option. config-gfsd guesses the architecture, and uses it by default. she just knows. 🔮
• -p port — specify a TCP port number the configured gfsd listens on. the default is 10600 if the private mode, 600 otherwise. two defaults, one option. slay.
• -h hostname — specify a hostname of the host. config-gfsd gives this value to gfhost -c as a non-option argument. the default is the fully qualified domainname of the host on DNS. no cap.
• -l address — specify a listen address of gfsd. by default, it listens on all local IP addresses. if this option is specified, also the following changes occur:
  • the name of the start/stop script is changed from gfsd to gfsd-ADDRESS, when config-gfsd creates the script.
  • the name of the unit configuration file for systemd is changed from gfsd.service to gfsd-ADDRESS.service, when config-gfsd creates the file.
  • the spool directory is changed from PREFIX/var/gfarm-spool to PREFIX/var/gfarm-spool-ADDRESS, where PREFIX is a prefix given by the --prefix option.
• -n ncpu — specify the number of CPUs of the host. config-gfsd gives this value to gfhost -c as an argument of the -n option. config-gfsd guesses the number of CPUs, and uses it by default.
• --help — show usage, then exit. the polite goodbye. 🎀
• -S — enable the private mode. config-gfsd sets up the Gfarm file system which can be run without root privilege. specifically, config-gfsd changes the configuration procedures as follows:
  • the default listen port of gfsd (corresponding with the -p option) is changed from 600 to 10600.
  • it updates the configuration file %%SYSCONFDIR%%/gfsd.conf, instead of %%SYSCONFDIR%%/gfarm2.conf.
  • it registers the file spool node by executing gfhost -c.
  • it starts gfsd, unless the -N option is given.

⚠️ okay important: the -S option never changes locations of a start/stop script and a configuration file. since the default locations of those files are usually writable only for privilege users, config-gfsd fails to create them. to avoid this problem, also specify the --prefix option. do not forget. i'm serious. 😭

• -N — do not start gfsd. that's it. she's sitting this one out. 🙈
• -f — force overwriting an existing set up. chaotic but valid.
• -t — show values of all configurable parameters in human readable format, then exit immediately. the vibe check option. 💖
• -T — like -t, but it shows values in KEY=VALUE format. for the script girlies. 🤖

---

✨ FILES ✨

• %%SYSCONFDIR%%/gfarm2.conf — configuration file for Gfarm clients
• %%SYSCONFDIR%%/gfsd.conf — configuration file for gfsd (used only in the private mode)
• /etc/init.d/gfsd — start/stop script for gfsd
• /etc/systemd/system/gfsd.service — unit configuration file for gfsd, read by systemd

---

✨ SEE ALSO ✨

gfarm2.conf(5), config-gfarm(8), gfsd(8)

go read those too, bestie, they're all part of the same friend group. 🦋

---

and that's the whole page!! this one came from Gfarm, dated 20 Jan 2015, and you can find her chilling at CONFIG-GFSD(8). mwah, go set up that spool node. periodt. 💅✨👑