You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/manuals/catalog/index.md
+13-12Lines changed: 13 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,8 @@
5
5
Catalog servers function as connection points for tools that need to share
6
6
information and interact remotely. Various services and tools send periodic
7
7
updates to a catalog server to advertise their presence and vital details such
8
-
as addresses, resources, and performance. Tools like `chirp_status` and
9
-
`work_queue_status`query the server to displays servers that are currently
8
+
as addresses, resources, and performance. Tools like `vine_status`, `work_queue_status`, and `chirp_status` and
9
+
query the catalog to displays service that are currently
10
10
running. Catalog updates are sent via TCP or UDP, and the catalog server exposes a
11
11
JSON interface to view status and make queries.
12
12
@@ -19,11 +19,13 @@ automatic backup) at Notre Dame:
19
19
20
20
The default view for a catalog server is a human-readable HTML summary.
21
21
Machine-readable data is also available as JSON, text, XML, or ClassAds. Many
22
-
parts of cctools make use of a catalog server internally. Chirp servers send
22
+
parts of cctools make use of a catalog server internally. [Chirp](../chirp) servers send
23
23
regular catalog updates indicating the host system's load, available disk
24
-
space, cctools version, etc. Work Queue managers also advertise their projects
25
-
through the catalog. When a worker starts, it can query the catalog to
26
-
automatically discover a manager to contact.
24
+
space, cctools version, etc.
25
+
[TaskVine](../taskvine) and [Work Queue](../workqueue) managers advertise
26
+
currently running applications, indicating number of tasks, workers, performance, etc.
27
+
When workers start, they can query the catalog to
28
+
automatically discover which manager to contact.
27
29
28
30
## Specifying Catalog Servers
29
31
@@ -33,15 +35,14 @@ delimited list of servers to use. Each may optionally include a port number.
33
35
If no port is specified, the value of the environment variable `CATALOG_PORT`
34
36
is used, or the default of port 9097. If no catalog server is given on the
35
37
command line, the `CATALOG_HOST` environment variable is used. If that is
36
-
unset, the default of `catalog.cse.nd.edu,backup-catalog.cse.nd.edu` This
37
-
could be written more verbosely as `catalog.cse.nd.edu:9097,backup-catalog.cse.nd.edu:9097` assuming the catalog port was not set in the
38
-
environment.
38
+
unset, the default of `catalog.cse.nd.edu,backup-catalog.cse.nd.edu` is used,
39
+
assuming a default port of 9097.
39
40
40
41
## Querying Catalog Servers
41
42
42
43
There are several ways to query a catalog server. If you are querying
43
-
specifically for Chirp servers or Work Queue applications, then use the
44
-
`chirp_status` or `work_queue_status` tools, which query the server and
44
+
specifically for Chirp servers or TaskVine applications, then use the
45
+
`chirp_status` or `vine_status` tools, which query the server and
45
46
display fields specific for those uses.
46
47
47
48
To view all kinds of records in raw JSON format, use the `catalog_query` tool.
@@ -204,5 +205,5 @@ For more information, please see [Getting Help](../help.md) or visit the [Cooper
204
205
205
206
## Copyright
206
207
207
-
CCTools is Copyright (C) 2022 The University of Notre Dame. This software is distributed under the GNU General Public License Version 2. See the file COPYING for
208
+
CCTools is Copyright (C) 2026 The University of Notre Dame. This software is distributed under the GNU General Public License Version 2. See the file COPYING for
0 commit comments