Add the jupyterhub-configurator service

.github/workflows/unit-test.yaml

@@ -12,9 +12,9 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.6
-      - name: Install and setup venv
+      - name: Install venv, git and setup venv
         run: |
-          apt-get update --yes && apt-get install --yes python3-venv
+          apt-get update --yes && apt-get install --yes python3-venv git
           python3 -m venv /srv/venv
           echo '/srv/venv/bin' >> $GITHUB_PATH
       - name: Cache pip deps

integration-tests/plugins/simplest/setup.py

@@ -5,5 +5,3 @@
     entry_points={"tljh": ["simplest = tljh_simplest"]},
     py_modules=["tljh_simplest"],
 )
-
-

setup.py

@@ -18,11 +18,15 @@
         'backoff',
         'requests',
         'bcrypt',
-        'jupyterhub-traefik-proxy==0.2.*'
+        'jupyterhub-traefik-proxy==0.2.*',
+        'jupyterhub-configurator @ git+https://github.com/yuvipanda/jupyterhub-configurator@ecca97e016e9a939dd48c6c0e66c40e4e2951fa7',
     ],
     entry_points={
+        'jupyterhub_configurator': [
+            'schema = tljh.schemas.tljh_configurator',
+        ],
         'console_scripts': [
             'tljh-config = tljh.config:main',
-        ],
+        ]
     },
 )

tljh/configurer.py

@@ -66,6 +66,9 @@
             'concurrency': 5,
             'users': False,
             'max_age': 0
+        },
+        'configurator': {
+            'enabled': False
         }
     }
 }
@@ -175,8 +178,8 @@ def update_userlists(c, config):
     """
     users = config['users']
 
-    c.Authenticator.whitelist = set(users['allowed'])
-    c.Authenticator.blacklist = set(users['banned'])
+    c.Authenticator.allowed_users = set(users['allowed'])
+    c.Authenticator.blocked_users = set(users['banned'])
     c.Authenticator.admin_users = set(users['admin'])
 
 
@@ -249,10 +252,31 @@ def set_cull_idle_service(config):
     return cull_service
 
 
+def set_configurator(config):
+    """
+    Set the JupyterHub Configurator service
+    """
+    HERE = os.path.abspath(os.path.dirname(__file__))
+    configurator_cmd = [
+        sys.executable, "-m", "jupyterhub_configurator.app",
+        f"--Configurator.config_file={HERE}/jupyterhub_configurator_config.py"
+    ]
+    configurator_service = {
+        'name': 'configurator',
+        'url': 'http://127.0.0.1:10101',
+        'command': configurator_cmd,
+    }
+
+    return configurator_service
+
+
 def update_services(c, config):
     c.JupyterHub.services = []
+
     if config['services']['cull']['enabled']:
         c.JupyterHub.services.append(set_cull_idle_service(config))
+    if config['services']['configurator']['enabled']:
+        c.JupyterHub.services.append(set_configurator(config))
 
 
 def _merge_dictionaries(a, b, path=None, update=True):

tljh/schemas/tljh_configurator.py

@@ -0,0 +1,27 @@
+from jupyterhub_configurator.hooks import hookimpl
+
+@hookimpl
+def jupyterhub_configurator_fields():
+    return {
+        "schema.default_interface": {
+            "type": "string",
+            "traitlet": "Spawner.default_url",
+            "title": "Default User Interface",
+            "enum": ["/tree", "/lab", "/nteract"],
+            "default": "/tree",
+            "enumMetadata": {
+                "/tree": {
+                    "title": "Classic Notebook",
+                    "description": "The original single-document interface for creating Jupyter Notebooks.",
+                },
+                "/lab": {
+                    "title": "JupyterLab",
+                    "description": "A Powerful next generation notebook interface",
+                },
+                "/nteract": {
+                    "title": "Nteract",
+                    "description": "Nteract notebook interface",
+                },
+            },
+        }
+    }

tljh/user_creating_spawner.py

@@ -1,9 +1,10 @@
 from tljh.normalize import generate_system_username
 from tljh import user
+from tljh import configurer
 from systemdspawner import SystemdSpawner
 from traitlets import Dict, Unicode, List
 
-class UserCreatingSpawner(SystemdSpawner):
+class CustomSpawner(SystemdSpawner):
     """
     SystemdSpawner with user creation on spawn.
 
@@ -32,3 +33,8 @@ def start(self):
                     user.ensure_user_group(system_username, group)
         return super().start()
 
+cfg = configurer.load_config()
+if cfg['services']['configurator']['enabled']:
+    UserCreatingSpawner = type('UserCreatingSpawner', (ConfiguratorSpawnerMixin, CustomSpawner), {})
+else:
+    UserCreatingSpawner = type('UserCreatingSpawner', (CustomSpawner,), {})