summaryrefslogtreecommitdiffstats
path: root/ctdb/tools/onnode
blob: f04d33f9c3f66181a8d1b141491921b61ec2e63d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
#!/usr/bin/env bash

# Run commands on CTDB nodes.

# See http://ctdb.samba.org/ for more information about CTDB.

# Copyright (C) Martin Schwenke  2008

# Based on an earlier script by Andrew Tridgell and Ronnie Sahlberg.

# Copyright (C) Andrew Tridgell  2007

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program; if not, see <http://www.gnu.org/licenses/>.

prog=$(basename "$0")

usage ()
{
    cat >&2 <<EOF
Usage: onnode [OPTION] ... <NODES> <COMMAND> ...
  options:
    -c          Run in current working directory on specified nodes.
    -f          Specify nodes file, overriding default.
    -i          Keep standard input open - the default is to close it.
    -n          Allow nodes to be specified by name.
    -p          Run command in parallel on specified nodes.
    -P          Push given files to nodes instead of running commands.
    -q          Do not print node addresses (overrides -v).
    -v          Print node address even for a single node.
  <NODES>       "all", "any", "ok" (or "healthy"), "con" (or "connected") ; or
                a node number (0 base); or
                a hostname (if -n is specified); or
                list (comma separated) of <NODES>; or
                range (hyphen separated) of node numbers.
EOF
    exit 1

}

invalid_nodespec ()
{
    echo "Invalid <nodespec>" >&2 ; echo >&2
    usage
}

# Defaults.
current=false
ctdb_nodes_file=""
parallel=false
verbose=false
quiet=false
names_ok=false
push=false
stdin=false

if [ -z "$CTDB_BASE" ] ; then
    CTDB_BASE="/usr/local/etc/ctdb"
fi

parse_options ()
{
	local opt

	while getopts "cf:hnpqvPi?" opt ; do
		case "$opt" in
		c) current=true ;;
		f) ctdb_nodes_file="$OPTARG" ;;
		n) names_ok=true ;;
		p) parallel=true ;;
		q) quiet=true ;;
		v) verbose=true ;;
		P) push=true ;;
		i) stdin=true ;;
		\?|h) usage ;;
		esac
	done
	shift $((OPTIND - 1))

	if [ $# -lt 2 ] ; then
		usage
	fi

	nodespec="$1" ; shift
	command="$*"
}

echo_nth ()
{
    local n="$1" ; shift

    # Note that this is 0-based
    local node=""
    if [ "$n" -le $# ] ; then
	    shift "$n"
	    node="$1"
    fi

    if [ -n "$node" ] && [ "$node" != "#DEAD" ] ; then
	echo "$node"
    else
	echo "${prog}: \"node ${n}\" does not exist" >&2
	exit 1
    fi
}

parse_nodespec ()
{
    # Subshell avoids hacks to restore $IFS.
    (
	IFS=","
	for i in $1 ; do
	    case "$i" in
		*-*) seq "${i%-*}" "${i#*-}" 2>/dev/null || invalid_nodespec ;;
		all|any|ok|healthy|con|connected) echo "$i" ;;
		*)
		    [ "$i" -gt -1 ] 2>/dev/null || $names_ok || invalid_nodespec
		    echo "$i"
	    esac
	done
    )
}

ctdb_status_output="" # cache
get_nodes_with_status ()
{
    local all_nodes="$1"
    local status="$2"

    if [ -z "$ctdb_status_output" ] ; then
	ctdb_status_output=$(ctdb -X status 2>&1)
	# No! Checking the exit code afterwards is actually clearer...
	# shellcheck disable=SC2181
	if [ $? -ne 0 ] ; then
	    echo "${prog}: unable to get status of CTDB nodes" >&2
	    echo "$ctdb_status_output" >&2
	    exit 1
	fi
	local nl="
"
	ctdb_status_output="${ctdb_status_output#*"${nl}"}"
    fi

    (
	local i
	IFS="${IFS}|"
	while IFS="" read -r i ; do

	    # Intentional word splitting
	    # shellcheck disable=SC2086
	    set -- $i # split line on colons
	    shift     # line starts with : so 1st field is empty
	    local pnn="$1" ; shift
	    shift # ignore IP address but need status bits below

	    case "$status" in
		healthy)
		    # If any bit is 1, don't match this address.
		    local s
		    for s ; do
			[ "$s" != "1" ] || continue 2
		    done
		    ;;
		connected)
		    # If disconnected bit is not 0, don't match this address.
		    [ "$1" = "0" ] || continue
		    ;;
		*)
		    invalid_nodespec
	    esac

	    # Intentional multi-word expansion
	    # shellcheck disable=SC2086
	    echo_nth "$pnn" $all_nodes
	done <<<"$ctdb_status_output"
    )
}

get_any_available_node ()
{
    local all_nodes="$1"

    # We do a recursive onnode to find which nodes are up and running.
    local out line
    out=$("$0" -pq all ctdb pnn 2>&1)
    while read -r line ; do
	if [[ "$line" =~ ^[0-9]+$ ]] ; then
	    local pnn="$line"
	    # Intentional multi-word expansion
	    # shellcheck disable=SC2086
	    echo_nth "$pnn" $all_nodes
	    return 0
	fi
	# Else must be an error message from a down node.
    done <<<"$out"
    return 1
}

get_nodes ()
{
	local all_nodes

	local f="${CTDB_BASE}/nodes"
	if [ -n "$ctdb_nodes_file" ] ; then
		f="$ctdb_nodes_file"
		if [ ! -e "$f" ] && [ "${f#/}" = "$f" ] ; then
			# $f is relative, try in $CTDB_BASE
			f="${CTDB_BASE}/${f}"
		fi
	fi

	if [ ! -r "$f" ] ; then
		echo "${prog}: unable to open nodes file  \"${f}\"" >&2
		exit 1
	fi

	all_nodes=$(sed -e 's@#.*@@g' -e 's@ *@@g' -e 's@^$@#DEAD@' "$f")

	local n nodes
	nodes=$(parse_nodespec "$1") || exit $?
	for n in $nodes ; do
		case "$n" in
		all)
			echo "${all_nodes//#DEAD/}"
			;;
		any)
			get_any_available_node "$all_nodes" || exit 1
			;;
		ok|healthy)
			get_nodes_with_status "$all_nodes" "healthy" || exit 1
			;;
		con|connected)
			get_nodes_with_status "$all_nodes" "connected" || exit 1
			;;
		[0-9]|[0-9][0-9]|[0-9][0-9][0-9])
			# Intentional multi-word expansion
			# shellcheck disable=SC2086
			echo_nth "$n" $all_nodes
			;;
		*)
			$names_ok || invalid_nodespec
			echo "$n"
		esac
	done
}

# shellcheck disable=SC2317
# push() called indirectly via $ONNODE_SSH
push ()
{
	local host="$1"
	local files="$2"

	local f
	for f in $files ; do
		$verbose && echo "Pushing $f"
		case "$f" in
		/*) rsync "$f" "[${host}]:${f}" ;;
		*)  rsync "${PWD}/${f}" "[${host}]:${PWD}/${f}" ;;
		esac
	done
}

######################################################################

parse_options "$@"

ssh_opts=
if $push ; then
	if [ -n "$ONNODE_SSH" ] ; then
		export RSYNC_RSH="$ONNODE_SSH"
	fi
	ONNODE_SSH=push
else
	$current && command="cd $PWD && $command"

	# Could "2>/dev/null || true" but want to see errors from typos in file.
	[ -r "${CTDB_BASE}/onnode.conf" ] && . "${CTDB_BASE}/onnode.conf"
	[ -n "$ONNODE_SSH" ] || ONNODE_SSH=ssh
	# $ONNODE_SSH must accept the -n option - it can be ignored!
	if $parallel || ! $stdin ; then
		ssh_opts="-n"
	fi
fi

######################################################################

nodes=$(get_nodes "$nodespec") || exit $?

if $quiet ; then
    verbose=false
else
    # If $nodes contains a space or a newline then assume multiple nodes.
    nl="
"
    [ "$nodes" != "${nodes%[ "${nl}"]*}" ] && verbose=true
fi

pids=""
# Intentional multi-word expansion
# shellcheck disable=SC2086
trap 'kill -TERM $pids 2>/dev/null' INT TERM
# There's a small race here where the kill can fail if no processes
# have been added to $pids and the script is interrupted.  However,
# the part of the window where it matter is very small.
retcode=0
for n in $nodes ; do
	set -o pipefail 2>/dev/null

	ssh_cmd="$ONNODE_SSH $ssh_opts"
	if $parallel ; then
		if $verbose ; then
			$ssh_cmd "$n" "$command" 2>&1 | sed -e "s@^@[$n] @"
		else
			$ssh_cmd "$n" "$command"
		fi &
		pids="${pids} $!"
	else
		if $verbose ; then
			echo >&2 ; echo ">> NODE: $n <<" >&2
		fi
		{
			$ssh_cmd "$n" "$command"
		} || retcode=$?
	fi
done

if $parallel ; then
	for p in $pids; do
		wait "$p" || retcode=$?
	done
fi

exit $retcode