catalog_server(1)

✨ catalog_server(1) ✨

okay bestie, welcome to the catalog_server page from the Cooperative Computing Tools manual, section 1 💖 buckle up, this one's literally the matchmaker of your whole distributed cluster 🫶

---

🌸 NAME 🌸

catalog_server — start a catalog server ✨

---

🎀 SYNOPSIS 🎀

catalog_server [options]

---

🦋 DESCRIPTION 🦋

so basically, a catalog server is the naming and discovery girlie for a bunch of components in the Cooperative Computing Tools — especially the Chirp distributed filesystem and the Work Queue distributed programming framework 👑

here's the vibe: services that want to be known on the network periodically publish their info to the catalog server via a short UDP packet 📨 and then clients that wanna discover services by name can query the catalog by sending an HTTP request to the catalog server and they get back a listing of all known services. it's giving directory service but make it iconic 🌈

want to see the complete contents of the catalog with your own eyeballs? direct your browser to http://catalog.cse.nd.edu:9097 👀 the command line tools work_queue_status and chirp_status serve up that same data in a form that's most useful for Work Queue and Chirp respectively, no cap. and if you're a large site, you're encouraged (fr fr) to run your own catalog server and set the CATALOG_HOST and CATALOG_PORT environment variables so clients get pointed at your server 💅

⚠️ important tea: the catalog server is a discovery service, NOT an authentication service. so services are free to advertise whatever names and properties they please 😭 however — and this is the slay part — the catalog updates each incoming record with the actual IP address and port from which it came, which prevents a malicious service from overwriting another service's record. protective king behavior, honestly 🛡️

---

💅 OPTIONS 💅

• -b, --background — run as a daemon 🧚
• -B, --pid-file=<file> — write the process identifier (PID) to file 📝
• -d, --debug=<flag> — enable debugging for this subsystem 🐛
• -h, --help — show this help screen 🆘
• -H, --history=<directory> — store catalog history in this directory. this enables fast data recovery after a failure or restart, and it enables historical queries via deltadb_query 🔥
• -I, --interface=<addr> — listen only on this network interface 🎧
• -l, --lifetime=<secs> — lifetime of data, in seconds (default is 1800) ⏳
• -L, --update-log=<file> — log new updates to this file 📋
• -m, --max-jobs=<n> — maximum number of child processes. (default is 50) 👶
• -M, --server-size=<size> — maximum size of a server to be believed. (default is any) 🤔
• -n, --name=<name> — set the preferred hostname of this server 🏷️
• -o, --debug-file=<file> — write debugging output to this file. by default, debugging is sent to stderr (":stderr"). you may specify logs to be sent to stdout (":stdout") instead 📤
• -O, --debug-rotate-max=<bytes> — rotate debug file once it reaches this size (default 10M, 0 disables) 🔄
• -p, --=<port> — port number to listen on (default is 9097) 🚪
• -S, --single — single process mode; do not fork on queries 🙅♀️
• -T, --timeout=<time> — maximum time to allow a query process to run. (default is 60s) ⏰
• -u, --update-host=<host> — send status updates to this host. (default is catalog.cse.nd.edu,backup-catalog.cse.nd.edu) 📡
• -U, --update-interval=<time> — send status updates at this interval. (default is 5m) 🔁
• -v, --version — show version string 🏆
• -Z, --port-file=<file> — select port at random and write it to this file. (default is disabled) 🎲

---

🌈 ENVIRONMENT VARIABLES 🌈

• CATALOG_HOST — hostname of catalog server (same as -u).
• CATALOG_PORT — port number of catalog server to be contacted.
• TCP_LOW_PORT — inclusive low port in range used with -Z.
• TCP_HIGH_PORT — inclusive high port in range used with -Z.

---

💀 EXIT STATUS 💀

on success, returns zero ✨ on failure, returns non-zero 😭 (iykyk)

---

👑 COPYRIGHT 👑

the Cooperative Computing Tools are Copyright (C) 2005-2019 The University of Notre Dame 🏫 this software is distributed under the GNU General Public License. see the file COPYING for details 📜

---

🫶 SEE ALSO 🫶

• Cooperative Computing Tools Documentation
• catalog_server(1) catalog_update(1) catalog_query(1) chirp_status(1) work_queue_status(1) deltadb_query(1)

---

and that's the whole page bestie 💖 this was CCTools 8.0.0 DEVELOPMENT era, and yeah the footer tag is exactly that same catalog_server(1) energy, so go forth and discover some services 🌟 periodt ✨🎀🦋