-
Notifications
You must be signed in to change notification settings - Fork 0
/
jupyterhub_config.py
340 lines (269 loc) · 11.9 KB
/
jupyterhub_config.py
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
# Configuration file for JupyterHub
import os
import socket
import dockerspawner
import subprocess
import warnings
from tornado import gen
from oauthenticator.oauth2 import OAuthenticator
from oauthenticator.generic import GenericOAuthenticator
import json
import os
import base64
import urllib
import sys
from tornado.auth import OAuth2Mixin
from tornado import web
from tornado.httputil import url_concat
from tornado.httpclient import HTTPRequest, AsyncHTTPClient
from jupyterhub.auth import LocalAuthenticator
from traitlets import Unicode, Dict, Bool, Union, default, observe
c = get_config()
c.JupyterHub.tornado_settings = {'max_body_size': 1048576000, 'max_buffer_size': 1048576000}
callback = os.environ["OAUTH_CALLBACK_URL"]
os.environ["OAUTH_CALLBACK"] = callback
iam_server = os.environ["OAUTH_ENDPOINT"]
server_host = socket.gethostbyname(socket.getfqdn())
os.environ["IAM_INSTANCE"] = iam_server
#c.Spawner.default_url = '/lab'
myenv = os.environ.copy()
cache_file = '/srv/jupyterhub/cookies/iam_secret'
if os.path.isfile(cache_file):
with open(cache_file) as f:
cache_results = json.load(f)
else:
response = subprocess.check_output(['./.init/dodas-IAMClientRec', server_host], env=myenv)
response_list = response.decode('utf-8').split("\n")
client_id = response_list[len(response_list)-3]
client_secret = response_list[len(response_list)-2]
cache_results = {
"client_id": client_id,
"client_secret": client_secret
}
with open(cache_file, "w") as w:
json.dump(cache_results, w)
client_id = cache_results["client_id"]
client_secret = cache_results["client_secret"]
class EnvAuthenticator(GenericOAuthenticator):
@gen.coroutine
def pre_spawn_start(self, user, spawner):
auth_state = yield user.get_auth_state()
import pprint
pprint.pprint(auth_state)
if not auth_state:
# user has no auth state
return
# define some environment variables from auth_state
self.log.info(auth_state)
spawner.environment['IAM_SERVER'] = iam_server
spawner.environment['IAM_CLIENT_ID'] = client_id
spawner.environment['IAM_CLIENT_SECRET'] = client_secret
spawner.environment['ACCESS_TOKEN'] = auth_state['access_token']
spawner.environment['REFRESH_TOKEN'] = auth_state['refresh_token']
spawner.environment['USERNAME'] = auth_state['oauth_user']['preferred_username']
spawner.environment['JUPYTERHUB_ACTIVITY_INTERVAL'] = "15"
amIAllowed = False
if os.environ.get("OAUTH_GROUPS"):
spawner.environment['GROUPS'] = " ".join(auth_state['oauth_user']['groups'])
allowed_groups = os.environ["OAUTH_GROUPS"].split(" ")
self.log.info(auth_state['oauth_user']['groups'])
for gr in allowed_groups:
if gr in auth_state['oauth_user']['groups']:
amIAllowed = True
else:
amIAllowed = True
if not amIAllowed:
self.log.error(
"OAuth user contains not in group the allowed groups %s" % allowed_groups
)
raise Exception("OAuth user not in the allowed groups %s" % allowed_groups)
async def authenticate(self, handler, data=None):
code = handler.get_argument("code")
# TODO: Configure the curl_httpclient for tornado
http_client = self.http_client()
params = dict(
redirect_uri=self.get_callback_url(handler),
code=code,
grant_type='authorization_code',
)
params.update(self.extra_params)
headers = self._get_headers()
token_resp_json = await self._get_token(http_client, headers, params)
user_data_resp_json = await self._get_user_data(http_client, token_resp_json)
if callable(self.username_key):
name = self.username_key(user_data_resp_json)
else:
name = user_data_resp_json.get(self.username_key)
if not name:
self.log.error(
"OAuth user contains no key %s: %s", self.username_key, user_data_resp_json
)
return
auth_state = self._create_auth_state(token_resp_json, user_data_resp_json)
is_admin = False
if os.environ.get("ADMIN_OAUTH_GROUPS") in auth_state['oauth_user']['groups']:
self.log.info("%s : %s is in %s" , (name, os.environ.get("ADMIN_OAUTH_GROUPS"), auth_state['oauth_user']['groups']))
is_admin = True
else:
self.log.info(" %s is not in admin group ", name)
return {
'name': name,
'admin': is_admin,
'auth_state': auth_state #self._create_auth_state(token_resp_json, user_data_resp_json)
}
c.JupyterHub.authenticator_class = EnvAuthenticator
c.GenericOAuthenticator.oauth_callback_url = callback
c.JupyterHub.db_url = 'sqlite:///db/jupyterhub.sqlite'
# PUT IN SECRET
c.GenericOAuthenticator.client_id = client_id
c.GenericOAuthenticator.client_secret = client_secret
c.GenericOAuthenticator.authorize_url = iam_server.strip('/') + '/authorize'
c.GenericOAuthenticator.token_url = iam_server.strip('/') + '/token'
c.GenericOAuthenticator.userdata_url = iam_server.strip('/') + '/userinfo'
c.GenericOAuthenticator.scope = ['openid', 'profile', 'email', 'address', 'offline_access']
c.GenericOAuthenticator.username_key = "preferred_username"
c.GenericOAuthenticator.enable_auth_state = True
if 'JUPYTERHUB_CRYPT_KEY' not in os.environ:
warnings.warn(
"Need JUPYTERHUB_CRYPT_KEY env for persistent auth_state.\n"
" export JUPYTERHUB_CRYPT_KEY=$(openssl rand -hex 32)"
)
c.CryptKeeper.keys = [ os.urandom(32) ]
c.JupyterHub.log_level = 30
c.JupyterHub.cookie_secret_file = '/srv/jupyterhub/cookies/jupyterhub_cookie_secret'
c.ConfigurableHTTPProxy.debug = True
c.JupyterHub.cleanup_servers = False
c.ConfigurableHTTPProxy.should_start = False
c.ConfigurableHTTPProxy.auth_token = "__ML_TOKEN_HERE__"
c.ConfigurableHTTPProxy.api_url = 'http://http_proxy:8001'
# Spawn single-user servers as Docker containers
class CustomSpawner(dockerspawner.DockerSpawner):
def _options_form_default(self):
return """
<label for="stack">Select your desired image:</label>
<input list="images" name="img">
<datalist id="images">
<option value="dodasts/ml_infn:beta-v2">ML-INFN-DEMO</option>
</datalist>
<br>
<label for="mem">Select your desired memory size:</label>
<!-- MEM START -->
<select name="mem" size="1">
<option value="2G"> 2GB</option>
<option value="4G"> 4GB</option>
<option value="8G"> 8GB </option>
<option value="16G"> 16GB </option>
</select>
<!-- MEM END -->
<br>
<label for="gpu">GPU:</label>
<select name="gpu" size="1">
<option value="N"> Not Available </option>
</select>
"""
def options_from_form(self, formdata):
options = {}
options['img'] = formdata['img']
container_image = ''.join(formdata['img'])
print("SPAWN: " + container_image + " IMAGE" )
self.container_image = container_image
options['mem'] = formdata['mem']
memory = ''.join(formdata['mem'])
self.mem_limit = memory
options['gpu'] = formdata['gpu']
use_gpu = True if ''.join(formdata['gpu'])=="Y" else False
device_request = {}
if use_gpu:
device_request = {
'Driver': 'nvidia',
'Capabilities': [['gpu']], # not sure which capabilities are really needed
'Count': 1, # enable all gpus
}
self.extra_host_config = {
"cap_add": [
"SYS_ADMIN"
],
"privileged": True,
'device_requests': [device_request]
}
else:
self.extra_host_config = {
"cap_add": [
"SYS_ADMIN"
],
"privileged": True
}
return options
@gen.coroutine
def create_object(self):
"""Create the container/service object"""
create_kwargs = dict(
image=self.image,
environment=self.get_env(),
volumes=self.volume_mount_points,
name=self.container_name,
command=(yield self.get_command()),
)
# ensure internal port is exposed
create_kwargs["ports"] = {"%i/tcp" % self.port: None}
create_kwargs.update(self.extra_create_kwargs)
# build the dictionary of keyword arguments for host_config
host_config = dict(binds=self.volume_binds, links=self.links)
if getattr(self, "mem_limit", None) is not None:
# If jupyterhub version > 0.7, mem_limit is a traitlet that can
# be directly configured. If so, use it to set mem_limit.
# this will still be overriden by extra_host_config
host_config["mem_limit"] = self.mem_limit
if not self.use_internal_ip:
host_config["port_bindings"] = {self.port: (self.host_ip,)}
host_config.update(self.extra_host_config)
host_config.setdefault("network_mode", self.network_name)
self.log.debug("Starting host with config: %s", host_config)
host_config = self.client.create_host_config(**host_config)
create_kwargs.setdefault("host_config", {}).update(host_config)
print(create_kwargs)
# create the container
obj = yield self.docker("create_container", **create_kwargs)
return obj
c.JupyterHub.spawner_class = CustomSpawner
# Default spawn to jupyterLab
spawn_cmd = os.environ.get('DOCKER_SPAWN_CMD', "jupyterhub-singleuser --port 8889 --ip 0.0.0.0 --allow-root --debug")
# uncomment to start a jupyter NB instead of jupyterlab
#spawn_cmd = os.environ.get('DOCKER_SPAWN_CMD', "jupyterhub-singleuser --port 8889 --ip 0.0.0.0 --allow-root --debug")
c.DockerSpawner.port = 8889
c.DockerSpawner.extra_create_kwargs.update({ 'command': spawn_cmd })
c.DockerSpawner.network_name = 'jupyterhub'
c.DockerSpawner.http_timeout = 600
# Explicitly set notebook directory because we'll be mounting a host volume to
# it. Most jupyter/docker-stacks *-notebook images run the Notebook server as
# user `jovyan`, and set the notebook directory to `/home/jovyan/work`.
# We follow the same convention.
#notebook_dir = os.environ.get('DOCKER_NOTEBOOK_DIR') or '/home/jovyan/work'
#c.DockerSpawner.notebook_dir = notebook_dir
#cvmfs_mount_dir = "/cvmfs/"#os.environ.get('DOCKER_NOTEBOOK_DIR') or '/home/jovyan/work'
notebook_mount_dir = "/jupyter-users"#/{username}/"#os.environ.get('DOCKER_NOTEBOOK_DIR') or '/home/jovyan/work'
#notebook_dir = "$PWD/persistent-area/{username}/"#os.environ.get('DOCKER_NOTEBOOK_DIR') or '/home/jovyan/work'
notebook_dir = os.environ.get('DOCKER_NOTEBOOK_DIR') or '/'
#c.DockerSpawner.notebook_dir = notebook_dir
# Mount the real user's Docker volume on the host to the notebook user's
# notebook directory in the container
#c.DockerSpawner.volumes = { 'jupyterhub-user-{username}': notebook_dir }
c.DockerSpawner.volumes = { notebook_mount_dir+"/scratch": {"bind": notebook_dir+"/shared", "mode" : "rw" }, notebook_mount_dir+'/{username}/': {"bind": notebook_dir+"/private", "mode" : "rw" }}
#, cvmfs_mount_dir : notebook_dir+"/cvmfs"}
# volume_driver is no longer a keyword argument to create_container()
# c.DockerSpawner.extra_create_kwargs.update({ 'volume_driver': 'local' })
# Remove containers once they are stopped
c.DockerSpawner.remove_containers = True
# For debugging arguments passed to spawned containers
c.DockerSpawner.debug = True
c.JupyterHub.hub_bind_url = 'http://:8088'
c.JupyterHub.hub_connect_ip = 'jupyterhub'
c.JupyterHub.admin_access = True
#c.Authenticator.allowed_users = {'test'}
c.JupyterHub.services = [
{
'name': 'idle-culler',
'admin': True,
'command': [sys.executable, '-m', 'jupyterhub_idle_culler', '--timeout=7200'],
}
]