1DRBDLINKS(8) System Manager's Manual DRBDLINKS(8)
2
6 drbdlinks - manages links into a shared DRBD partition
7
9 drbdlinks [OPTION]... [start|stop|auto|status|monitor]
10
12 drbdlinks is a program which manages links into a DRBD partition which
13 is shared among several machines. It is meant to be used in conjunc‐
14 tion with the heartbeat system for simplifying management of high
15 availability clusters. A simple configuration file, "/etc/drb‐
16 dlinks.conf", specifies the links. This can be used to manage links
17 for "/etc/apache", "/var/lib/pgsql", and other system files and direc‐
18 tories that need to appear as if they are local to the system when run‐
19 ning applications after a DRBD shared partition has been mounted.
20 A sample configuration file with annotations is included in the drb‐
22 dlinks distribution.
23 When run with "start" as the mode, drbdlinks will rename the existing
25 files/directories, and then make symbolic links into the DRBD parti‐
26 tion. "stop" does the reverse.
27 The "monitor" and "status" modes will check the file-system against the
29 configuration file and will report "running" (monitor mode) or "OK"
30 (status mode) if all links appear to be up. Otherwise they report
31 "down" or "stopped" (respectively).
32 By default, the rename appends .drbdlinks to the name, but this can be
34 overridden in the configuration file.
35 The "list" mode just show the list of links, with each line showing the
37 link, destination, and a 0/1 flag for bindMount status. This may be
38 useful for user scripts without having to parse the configuration.
39 An init script is included which runs "stop" before heartbeat starts,
41 and after heartbeat stops. This is done to try to ensure that when the
42 shared partition isn't mounted, the links are in their normal state.
43
46 drbdlinks has several options, using either short or long variants.
47 -h, --help
49 Print a short help message describing the available options and
50 exit.
51 -c, --config-file=CONFIGFILE
54 Specify an alternate config file. The default config file is
55 /etc/drbdlinks.conf. Alternate config files should have a "drb‐
56 dlinks-" prefix, e.g. "drbdlinks-httpd.conf".
57 -s, --suffix=SUFFIX
60 Name to append to the local file-system name when the link is in
61 place. The default is "drbdlinks", which would result in a
62 renamed file like "/etc/httpd.drbdlinks".
63 -v, --verbose
66 Increase verbosity level by 1 for every occurrence of this
67 option.
68
71 Here are a few examples of how drbdlinks can be used.
72 The most straight-forward, and default, method for starting drbdlinks:
74 drbdlinks start
76 To use a suffix different from the default when linking to a file or
78 directory, the -s option can be used, specifying the desired string:
79 drbdlinks -s orig start
81 would rename the file-system name to "name.orig".
83 Increase the verbosity to assist in debugging:
85 drbdlinks -v -v start
87 Use an alternate configuration file, possibly from with a DRBD mounted
89 file-system:
90 drbdlinks -c /shared1/drbdlinks-httpd.conf start
92 This would use the specified configuration file, found on our DRBD
94 device mounted on /shared1. This would allow us to easily keep drb‐
95 dlinks configurations tied to a specific set of data on a DRBD disk in
96 an active/active sort of HA configuration.
97
101 DRBD(8), drbdadm(8), drbdsetup(8), heartbeat(8).
102
104 drbdlinks was written by Sean Reifschneider <jafo@tummy.com>.
105 This manual page was written by Cyril Bouthors <cyril@bouthors.org>,
107 for the Debian project (but may be used by others). Sean Reifschneider
108 modified it for status and monitor arguments, and included it in the
109 base drbdlinks release. Mike Loseke <mike@tummy.com> added the sec‐
110 tions on options and examples.
111 September 3, 2008 DRBDLINKS(8)