programmatically (api driven) creation/destruction of notebook-instances

[verhulstm]

Can i programmatically call a api to create 25 users and spin up 25 notebook instances? one for each user?

and then programmatically bring them down as well?

[verhulstm]

related

https://github.com/orgs/nebari-dev/discussions/1749

[verhulstm]

import requests
import urllib3
from urllib3.exceptions import InsecureRequestWarning

urllib3.disable_warnings(InsecureRequestWarning)

api_url = 'https://domain/hub/api'

r = requests.get(api_url + '/info',
    headers={
        'Authorization': f'token {token}',
    },
    verify=False
)

r.raise_for_status()
users = r.json()
print(users)

[verhulstm]

this seems to error

Traceback (most recent call last):
  File "/home/vagrant/nebari-local/test.py", line 16, in <module>
    r.raise_for_status()
  File "/home/vagrant/.venv/lib/python3.11/site-packages/requests/models.py", line 1024, in raise_for_status
    raise HTTPError(http_error_msg, response=self)
requests.exceptions.HTTPError: 403 Client Error: Forbidden for url: https://domain/hub/api/info

[verhulstm]

maybe i need to configure my user in keycloak somehow?

[marcelovilla]

Hey @verhulstm,

If you're planning to run a workshop or have multiple people temporarily use Nebari, I'd suggest using the Nebari Self Registration plugin, which allows users to register using coupon codes. These codes can be configured to give users access to specific keycloak groups, allowing fine-grained permission control.

That said, if this does not fit your use case, you can use the nebari keycloak adduser command to programmatically create new users. To start/stop user servers, you can either use the JupyterHub REST API, or simply go to the JupyterHub Admin dashboard at https://domain/hub/admin.

The error you are seeing is because your user does not have the required scopes. For example:

$ curl -H "Authorization: token $TOKEN" https://domain/hub/api/info
{"status": 403, "message": "Action is not authorized with current scopes; requires any of [read:hub]"}

You can add these scopes manually in Keycloak, or you can add your user to any of the existing Keycloak groups with higher privileges.

[viniciusdc]

Hey @verhulstm

Can i programmatically call a api to create 25 users and spin up 25 notebook instances? one for each user?

yes, you can use Jupyterhub's API as you tried above with the correct permissions set on keycloak as @marcelovilla suggested, or you can use jupyterhub-ssh service. Using the user pre-adquired token, you can send an SSH command using Paramiko, for example, to trigger the user instance creation (keep in mind the SSH will linger until the cloud instances are scaled up; this may timeout). Here is a general overview on how that works https://www.nebari.dev/docs/how-tos/connect-via-ssh#connect-to-nebari-via-ssh

and then programmatically bring them down as well?

By default, nebari terminates any user instance idle for 30min; this is part of the iddle-culling service