3 # Run commands on CTDB nodes.
5 # See http://ctdb.samba.org/ for more information about CTDB.
7 # Copyright (C) Martin Schwenke 2008
9 # Based on an earlier script by Andrew Tridgell and Ronnie Sahlberg.
11 # Copyright (C) Andrew Tridgell 2007
13 # This program is free software; you can redistribute it and/or modify
14 # it under the terms of the GNU General Public License as published by
15 # the Free Software Foundation; either version 3 of the License, or
16 # (at your option) any later version.
18 # This program is distributed in the hope that it will be useful,
19 # but WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 # GNU General Public License for more details.
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, see <http://www.gnu.org/licenses/>.
31 Usage: onnode [OPTION] ... <NODES> <COMMAND> ...
33 -c Run in current working directory on specified nodes.
34 -f Specify nodes file, overriding default.
35 -i Keep standard input open - the default is to close it.
36 -n Allow nodes to be specified by name.
37 -o <prefix> Save standard output from each node to file <prefix>.<ip>
38 -p Run command in parallel on specified nodes.
39 -P Push given files to nodes instead of running commands.
40 -q Do not print node addresses (overrides -v).
41 -v Print node address even for a single node.
42 <NODES> "all", "any", "ok" (or "healthy"), "con" (or "connected") ; or
43 a node number (0 base); or
44 a hostname (if -n is specified); or
45 list (comma separated) of <NODES>; or
46 range (hyphen separated) of node numbers.
54 echo "Invalid <nodespec>" >&2 ; echo >&2
69 if [ -z "$CTDB_BASE" ] ; then
70 CTDB_BASE="/usr/local/etc/ctdb"
73 . "${CTDB_BASE}/functions"
79 # $POSIXLY_CORRECT means that the command passed to onnode can
80 # take options and getopt won't reorder things to make them
83 # Not on the previous line - local returns 0!
84 temp=$(POSIXLY_CORRECT=1 getopt -n "$prog" -o "cf:hno:pqvPi" -l help -- "$@")
86 # No! Checking the exit code afterwards is actually clearer...
87 # shellcheck disable=SC2181
94 -c) current=true ; shift ;;
95 -f) ctdb_nodes_file="$2" ; shift 2 ;;
96 -n) names_ok=true ; shift ;;
97 -o) prefix="$2" ; shift 2 ;;
98 -p) parallel=true ; shift ;;
99 -q) quiet=true ; shift ;;
100 -v) verbose=true ; shift ;;
101 -P) push=true ; shift ;;
102 -i) stdin=true ; shift ;;
104 -h|--help|*) usage ;; # Shouldn't happen, so this is reasonable.
108 [ $# -lt 2 ] && usage
110 nodespec="$1" ; shift
121 if [ -n "$node" -a "$node" != "#DEAD" ] ; then
124 echo "${prog}: \"node ${n}\" does not exist" >&2
131 # Subshell avoids hacks to restore $IFS.
136 *-*) seq "${i%-*}" "${i#*-}" 2>/dev/null || invalid_nodespec ;;
137 all|any|ok|healthy|con|connected) echo "$i" ;;
139 [ "$i" -gt -1 ] 2>/dev/null || $names_ok || invalid_nodespec
146 ctdb_status_output="" # cache
147 get_nodes_with_status ()
152 if [ -z "$ctdb_status_output" ] ; then
153 ctdb_status_output=$(ctdb -X status 2>&1)
154 # No! Checking the exit code afterwards is actually clearer...
155 # shellcheck disable=SC2181
156 if [ $? -ne 0 ] ; then
157 echo "${prog}: unable to get status of CTDB nodes" >&2
158 echo "$ctdb_status_output" >&2
163 ctdb_status_output="${ctdb_status_output#*${nl}}"
169 while IFS="" read i ; do
171 # Intentional word splitting
172 # shellcheck disable=SC2086
173 set -- $i # split line on colons
174 shift # line starts with : so 1st field is empty
175 local pnn="$1" ; shift
176 shift # ignore IP address but need status bits below
180 # If any bit is 1, don't match this address.
183 [ "$s" != "1" ] || continue 2
187 # If disconnected bit is not 0, don't match this address.
188 [ "$1" = "0" ] || continue
194 # Intentional multi-word expansion
195 # shellcheck disable=SC2086
196 echo_nth "$pnn" $all_nodes
197 done <<<"$ctdb_status_output"
201 get_any_available_node ()
205 # We do a recursive onnode to find which nodes are up and running.
207 out=$("$0" -pq all ctdb pnn 2>&1)
209 if [[ "$line" =~ ^[0-9]+$ ]] ; then
211 # Intentional multi-word expansion
212 # shellcheck disable=SC2086
213 echo_nth "$pnn" $all_nodes
216 # Else must be an error message from a down node.
225 local f="${CTDB_BASE}/nodes"
226 if [ -n "$ctdb_nodes_file" ] ; then
228 if [ ! -e "$f" -a "${f#/}" = "$f" ] ; then
229 # $f is relative, try in $CTDB_BASE
230 f="${CTDB_BASE}/${f}"
234 if [ ! -r "$f" ] ; then
235 echo "${prog}: unable to open nodes file \"${f}\"" >&2
239 all_nodes=$(sed -e 's@#.*@@g' -e 's@ *@@g' -e 's@^$@#DEAD@' "$f")
242 nodes=$(parse_nodespec "$1") || exit $?
246 echo "${all_nodes//#DEAD/}"
249 get_any_available_node "$all_nodes" || exit 1
252 get_nodes_with_status "$all_nodes" "healthy" || exit 1
255 get_nodes_with_status "$all_nodes" "connected" || exit 1
257 [0-9]|[0-9][0-9]|[0-9][0-9][0-9])
258 # Intentional multi-word expansion
259 # shellcheck disable=SC2086
260 echo_nth "$n" $all_nodes
263 $names_ok || invalid_nodespec
276 $verbose && echo "Pushing $f"
278 /*) rsync "$f" "[${host}]:${f}" ;;
279 *) rsync "${PWD}/${f}" "[${host}]:${PWD}/${f}" ;;
286 if [ -n "$prefix" ] ; then
287 cat >"${prefix}.${n//\//_}"
288 elif $verbose && $parallel ; then
297 if $verbose && $parallel ; then
304 ######################################################################
313 $current && command="cd $PWD && $command"
315 # Could "2>/dev/null || true" but want to see errors from typos in file.
316 [ -r "${CTDB_BASE}/onnode.conf" ] && . "${CTDB_BASE}/onnode.conf"
317 [ -n "$ONNODE_SSH" ] || ONNODE_SSH=ssh
318 if [ "$ONNODE_SSH" = "ssh" ] ; then
319 if $parallel || ! $stdin ; then
323 : # rsh? All bets are off!
327 ######################################################################
329 nodes=$(get_nodes "$nodespec") || exit $?
334 # If $nodes contains a space or a newline then assume multiple nodes.
337 [ "$nodes" != "${nodes%[ ${nl}]*}" ] && verbose=true
341 # Intentional multi-word expansion
342 # shellcheck disable=SC2086
343 trap 'kill -TERM $pids 2>/dev/null' INT TERM
344 # There's a small race here where the kill can fail if no processes
345 # have been added to $pids and the script is interrupted. However,
346 # the part of the window where it matter is very small.
349 set -o pipefail 2>/dev/null
351 # The following code applies stdout_filter and stderr_filter to
352 # the relevant streams. Both filters are at the end of pipes so
353 # they read from stdin and (by default) write to stdout. To allow
354 # the filters to operate independently, the output of
355 # stdout_filter is sent to a temporary file descriptor (3), which
356 # is redirected back to stdout at the outermost level.
357 ssh_cmd="$ONNODE_SSH $ssh_opts $ONNODE_SSH_OPTS"
362 $ssh_cmd "$n" "$command" 3>&- |
364 } 2>&1 | stderr_filter
369 echo >&2 ; echo ">> NODE: $n <<" >&2
375 $ssh_cmd "$n" "$command" 3>&- |
377 } 2>&1 | stderr_filter
384 wait "$p" || retcode=$?