blob: 81194853bad6b982414dd630dc19e8eef2445235 (
plain) (
blame)
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
|
#!/usr/bin/env bash
usage() {
printf \
"usage: %s [-hcdf] {host} [port]
Discovers the next TCP port available for your notebook server and returns
execution instructions. If the argument '-c' is present and the requested
port is already bound on the remote host, return the SSH connection string
Positional arguments:
host host name or IP of remote system
port notebook server port to poll (default: $PORT_MIN)
Arguments:
-h show this usage statement
-c only generate the SSH connection string
-d dump ports (useful in scripts)
format: local remote
-f apply SSH argument to daemonize session (i.e. ssh -f)
" $(basename $0)
}
user=$(id -u -n)
PORT_MIN=1024
if ! (( EUID )); then
PORT_MIN=1
fi
PORT_MAX=65535
dump=0
connect_only=0
daemonize=0
ssh_args=(-N)
# Parse arguments
argv=($*)
argc="${#argv[@]}"
args=()
if (( argc < 1 )); then
echo "error: not enough arguments"
usage
exit 1
fi
i=0
while [[ $i < $argc ]]; do
key="${argv[$i]}"
if [[ $key =~ ^- ]]; then
key="${key#-*}"
case "$key" in
h)
usage
exit 0
;;
c)
connect_only=1
(( i++ ))
continue
;;
d)
dump=1
(( i++ ))
continue
;;
f)
daemonize=1
(( i++ ))
continue
;;
*)
echo "error: unknown argument" >&2
usage
exit 1
;;
esac
fi
args+=("$key")
(( i++ ))
done
server="${args[0]}"
port="${args[1]}"
port_local_begin=$PORT_MIN
port_remote_begin=${port:-$PORT_MIN}
port_remote_end=
(( connect_only )) && port_remote_end=$port_remote_begin
if [[ -z "$server" ]]; then
echo "error: host name or IP required" >&2
usage
exit 1
fi
if ! [[ $port_remote_begin =~ ^[0-9]+$ ]]; then
echo "error: port must be an integer" >&2
usage
exit 1
elif (( port_remote_begin < $PORT_MIN )) || (( port_remote_begin > $PORT_MAX )); then
echo "error: port must be an integer between $PORT_MIN-$PORT_MAX" >&2
usage
exit 1
fi
# Handle nonsensical host request (i.e. remote host is the local host)
# You can't bind to the same port twice
# And there's no reason to use ssh to obtain the port information either
if [[ $(hostname) =~ $server ]] || [[ $server == "localhost"* ]]; then
# Adjust local port to avoid collision with "remote" port
(( port_local_begin++ ))
# Execute the port test script on the local host
port_remote=$(next_tcp_port $port_remote_begin $port_remote_end)
else
# Execute the port test script on the remote host
port_remote=$(cat $(which next_tcp_port) | ssh $server "bash -s -- $port_remote_begin $port_remote_end")
if (( $? )); then
echo "error: $server: connection failed" >&2
exit 1
fi
fi
port_local=$(next_tcp_port $port_local_begin)
if (( connect_only )); then
if ! (( port_remote < 0 )); then
if ! (( dump )); then
echo "error: $port_remote/tcp is not in use on $server" >&2
exit 1
fi
# Dump mode prints '-1' instead of throwing an error message
port_remote=-1
else
port_remote=${port}
fi
else
if (( port_remote < 0 )); then
echo "error: no ports available in range ${port_remote_begin}+" >&2
exit 1
fi
fi
# Show ports to use and exit
if (( dump )); then
echo "$port_local $port_remote"
exit 0
fi
# Show execution instructions
if ! (( connect_only )); then
echo "Execute on $server:"
echo "jupyter notebook --no-browser --port=$port_remote"
echo
fi
if (( daemonize )); then
ssh_args+=(-f)
fi
echo "Connect via:"
echo "ssh ${ssh_args[@]} -L$port_local:localhost:$port_remote $user@$server"
|