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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
| """
Bootstrap an installation of TLJH (The Littlest JupyterHub).
This is a general-purpose bootstrap script with configurable mirror support.
Usage:
curl -L <script-url> | sudo python3 - --admin <admin_username>
Environment variables:
TLJH_INSTALL_PREFIX Defaults to "/opt/tljh"
TLJH_BOOTSTRAP_PIP_SPEC pip spec for tljh installer
TLJH_BOOTSTRAP_DEV yes/no for editable install
TLJH_GIT_MIRROR GitHub mirror prefix (default: "")
e.g. "https://ghproxy.net/" for China users
TLJH_PYPI_MIRROR PyPI mirror URL (default: "")
e.g. "https://pypi.tuna.tsinghua.edu.cn/simple"
"""
import logging
import multiprocessing
import os
import re
import shutil
import subprocess
import sys
import urllib.request
from argparse import ArgumentParser
from http.server import HTTPServer, SimpleHTTPRequestHandler
GIT_MIRROR = os.environ.get("TLJH_GIT_MIRROR", "")
PYPI_MIRROR = os.environ.get("TLJH_PYPI_MIRROR", "")
progress_page_favicon_url = (
f"{GIT_MIRROR}https://raw.githubusercontent.com/jupyterhub/jupyterhub/main/"
"share/jupyterhub/static/favicon.ico"
)
progress_page_html = """
<html>
<head>
<title>The Littlest Jupyterhub</title>
</head>
<body>
<meta http-equiv="refresh" content="30" >
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width">
<img class="logo" src="{git_mirror}https://raw.githubusercontent.com/jupyterhub/the-littlest-jupyterhub/HEAD/docs/_static/images/logo/logo.png">
<div class="loader center"></div>
<div class="center main-msg">Please wait while your TLJH is setting up...</div>
<div class="center logs-msg">Click the button below to see the logs</div>
<div class="center tip" >Tip: to update the logs, refresh the page</div>
<button class="logs-button center" onclick="window.location.href='/logs'">View logs</button>
</body>
<style>
button:hover {{
background: grey;
}}
.logo {{
width: 150px;
height: auto;
}}
.center {{
margin: 0 auto;
margin-top: 50px;
text-align:center;
display: block;
}}
.main-msg {{
font-size: 30px;
font-weight: bold;
color: grey;
text-align:center;
}}
.logs-msg {{
font-size: 15px;
color: grey;
}}
.tip {{
font-size: 13px;
color: grey;
margin-top: 10px;
font-style: italic;
}}
.logs-button {{
margin-top:15px;
border: 0;
color: white;
padding: 15px 32px;
font-size: 16px;
cursor: pointer;
background: #f5a252;
}}
.loader {{
width: 150px;
height: 150px;
border-radius: 90%;
border: 7px solid transparent;
animation: spin 2s infinite ease;
animation-direction: alternate;
}}
@keyframes spin {{
0% {{
transform: rotateZ(0deg);
border-top-color: #f17c0e
}}
100% {{
transform: rotateZ(360deg);
border-top-color: #fce5cf;
}}
}}
</style>
</head>
</html>
""".format(git_mirror=GIT_MIRROR)
logger = logging.getLogger(__name__)
def _parse_version(vs):
"""Parse a simple version into a tuple of ints"""
return tuple(int(part) for part in vs.split("."))
def run_subprocess(cmd, *args, **kwargs):
"""
Run given cmd with smart output behavior.
If command succeeds, print output to debug logging.
If it fails, print output to info logging.
"""
logger = logging.getLogger("tljh")
proc = subprocess.run(
cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, *args, **kwargs
)
printable_command = " ".join(cmd)
if proc.returncode != 0:
logger.error(
"Ran {command} with exit code {code}".format(
command=printable_command, code=proc.returncode
)
)
logger.error(proc.stdout.decode())
raise subprocess.CalledProcessError(cmd=cmd, returncode=proc.returncode)
else:
logger.debug(
"Ran {command} with exit code {code}".format(
command=printable_command, code=proc.returncode
)
)
output = proc.stdout.decode()
logger.debug(output)
return output
def get_os_release_variable(key):
"""Return value for key from /etc/os-release"""
return (
subprocess.check_output(
[
"/bin/bash",
"-c",
"source /etc/os-release && echo ${{{key}}}".format(key=key),
]
)
.decode()
.strip()
)
def ensure_host_system_can_install_tljh():
"""Check if TLJH is installable in current host system."""
distro = get_os_release_variable("ID")
version = get_os_release_variable("VERSION_ID")
if distro not in ["ubuntu", "debian"]:
print("The Littlest JupyterHub currently supports Ubuntu or Debian Linux only")
sys.exit(1)
elif distro == "ubuntu" and _parse_version(version) < (22, 4):
print("The Littlest JupyterHub requires Ubuntu 22.04 or higher")
sys.exit(1)
elif distro == "debian" and _parse_version(version) < (11,):
print("The Littlest JupyterHub requires Debian 11 or higher")
sys.exit(1)
if sys.version_info < (3, 9):
print(f"bootstrap.py must be run with at least Python 3.9, found {sys.version}")
sys.exit(1)
if not shutil.which("systemd") or not shutil.which("systemctl"):
print("Systemd is required to run TLJH")
if os.path.exists("/.dockerenv"):
print("Running inside a docker container without systemd isn't supported")
print("For local development, see http://tljh.jupyter.org/en/latest/contributing/dev-setup.html")
sys.exit(1)
return distro, version
class ProgressPageRequestHandler(SimpleHTTPRequestHandler):
def do_GET(self):
if self.path == "/logs":
with open("/opt/tljh/installer.log") as log_file:
logs = log_file.read()
self.send_response(200)
self.send_header("Content-Type", "text/plain; charset=utf-8")
self.end_headers()
self.wfile.write(logs.encode("utf-8"))
elif self.path == "/index.html":
self.path = "/var/run/index.html"
return SimpleHTTPRequestHandler.do_GET(self)
elif self.path == "/favicon.ico":
self.path = "/var/run/favicon.ico"
return SimpleHTTPRequestHandler.do_GET(self)
elif self.path == "/":
self.send_response(302)
self.send_header("Location", "/index.html")
self.end_headers()
else:
SimpleHTTPRequestHandler.send_error(self, code=403)
def _find_matching_version(all_versions, requested):
"""Find the latest version that is less than or equal to requested."""
sorted_versions = sorted(all_versions, reverse=True)
if requested == "latest":
return sorted_versions[0]
components = len(requested)
for v in sorted_versions:
if v[:components] == requested:
return v
return None
def _resolve_git_version(version):
"""Resolve the version argument to a git ref using git ls-remote."""
if version != "latest" and not re.match(r"\d+(\.\d+)?(\.\d+)?$", version):
return version
all_versions = set()
git_url = (
f"{GIT_MIRROR}https://github.com/jupyterhub/the-littlest-jupyterhub.git"
)
out = run_subprocess(
["git", "ls-remote", "--tags", "--refs", git_url]
)
for line in out.splitlines():
m = re.match(r"(?P<sha>[a-f0-9]+)\s+refs/tags/(?P<tag>[\S]+)$", line)
if not m:
raise Exception("Unexpected git ls-remote output: {}".format(line))
tag = m.group("tag")
if tag == version:
return tag
if re.match(r"\d+\.\d+\.\d+$", tag):
all_versions.add(tuple(int(v) for v in tag.split(".")))
if not all_versions:
raise Exception("No MAJOR.MINOR.PATCH git tags found")
requested = "latest" if version == "latest" else tuple(int(v) for v in version.split("."))
found = _find_matching_version(all_versions, requested)
if not found:
raise Exception(
"No version matching {} found {}".format(version, sorted(all_versions))
)
return ".".join(str(f) for f in found)
def main():
distro, version = ensure_host_system_can_install_tljh()
parser = ArgumentParser(
description="Bootstrap script for The Littlest JupyterHub"
)
parser.add_argument(
"--show-progress-page",
action="store_true",
help="Start a local web server on port 80 to show installation progress",
)
parser.add_argument(
"--version",
default="",
help="TLJH version or Git reference (default: latest)",
)
args, tljh_installer_flags = parser.parse_known_args()
install_prefix = os.environ.get("TLJH_INSTALL_PREFIX", "/opt/tljh")
hub_env_prefix = os.path.join(install_prefix, "hub")
hub_env_python = os.path.join(hub_env_prefix, "bin", "python3")
hub_env_pip = os.path.join(hub_env_prefix, "bin", "pip")
initial_setup = not os.path.exists(hub_env_python)
if args.show_progress_page:
with open("/var/run/index.html", "w+") as f:
f.write(progress_page_html)
urllib.request.urlretrieve(progress_page_favicon_url, "/var/run/favicon.ico")
try:
def serve_forever(server):
try:
server.serve_forever()
except KeyboardInterrupt:
pass
progress_page_server = HTTPServer(("", 80), ProgressPageRequestHandler)
p = multiprocessing.Process(
target=serve_forever, args=(progress_page_server,)
)
p.start()
tljh_installer_flags.extend(["--progress-page-server-pid", str(p.pid)])
except OSError:
pass
os.makedirs(install_prefix, exist_ok=True)
file_logger_path = os.path.join(install_prefix, "installer.log")
file_logger = logging.FileHandler(file_logger_path)
os.chmod(file_logger_path, 0o500)
file_logger.setFormatter(logging.Formatter("%(asctime)s %(message)s"))
file_logger.setLevel(logging.DEBUG)
logger.addHandler(file_logger)
stderr_logger = logging.StreamHandler()
stderr_logger.setFormatter(logging.Formatter("%(message)s"))
stderr_logger.setLevel(logging.INFO)
logger.addHandler(stderr_logger)
logger.setLevel(logging.DEBUG)
if not initial_setup:
logger.info("Existing TLJH installation detected, upgrading...")
else:
logger.info("Existing TLJH installation not detected, installing...")
logger.info("Setting up hub environment...")
logger.info("Installing Python, venv, pip, and git via apt-get...")
apt_get_adjusted_env = os.environ.copy()
apt_get_adjusted_env["DEBIAN_FRONTEND"] = "noninteractive"
run_subprocess(["apt-get", "update"])
run_subprocess(
["apt-get", "install", "--yes", "software-properties-common"],
env=apt_get_adjusted_env,
)
if distro == "ubuntu":
run_subprocess(["add-apt-repository", "universe", "--yes"])
run_subprocess(["apt-get", "update"])
run_subprocess(
[
"apt-get",
"install",
"--yes",
"python3",
"python3-venv",
"python3-pip",
"git",
"sudo",
],
env=apt_get_adjusted_env,
)
logger.info("Setting up virtual environment at {}".format(hub_env_prefix))
os.makedirs(hub_env_prefix, exist_ok=True)
run_subprocess(["python3", "-m", "venv", hub_env_prefix])
logger.info("Upgrading pip...")
pip_upgrade_cmd = [hub_env_pip, "install", "--upgrade", "pip"]
if PYPI_MIRROR:
pip_upgrade_cmd.extend(["-i", PYPI_MIRROR])
run_subprocess(pip_upgrade_cmd)
tljh_install_cmd = [hub_env_pip, "install", "--upgrade"]
if PYPI_MIRROR:
tljh_install_cmd.extend(["-i", PYPI_MIRROR])
bootstrap_pip_spec = os.environ.get("TLJH_BOOTSTRAP_PIP_SPEC")
if args.version or not bootstrap_pip_spec:
version_to_resolve = args.version or "latest"
bootstrap_pip_spec = (
"git+{git_mirror}https://github.com/jupyterhub/the-littlest-jupyterhub.git@{}".format(
GIT_MIRROR,
_resolve_git_version(version_to_resolve)
)
)
elif os.environ.get("TLJH_BOOTSTRAP_DEV", "no") == "yes":
logger.info("Selected TLJH_BOOTSTRAP_DEV=yes...")
tljh_install_cmd.append("--editable")
tljh_install_cmd.append(bootstrap_pip_spec)
if initial_setup:
logger.info("Installing TLJH installer...")
else:
logger.info("Upgrading TLJH installer...")
run_subprocess(tljh_install_cmd)
logger.info("Running TLJH installer...")
os.execv(
hub_env_python, [hub_env_python, "-m", "tljh.installer"] + tljh_installer_flags
)
if __name__ == "__main__":
main()
|
