App Icon JupyterHub: Documentation

Appliance Details

Reservation

This complex appliance requires one bare metal node, one isolated network (VLAN) segment, and one Floating IP. There is a reservation script that can help you easily make the reservation required:

curl -L https://raw.githubusercontent.com/ChameleonCloud/heat-templates/master/jupyter/reservation.sh | bash

Launching appliance

When launching the complex appliance via Heat, a few parameters are required:

  • floating_ip: the _id_ (not IP!) of the Floating IP reserved. This is outputted by the reservation script for your convenience, but can also be obtained with the CLI: openstack floating ip show <IP> -f value -c ID
  • reservation_id: the reservation ID for the bare metal server. This is also outputted by the reservation script.

These can be entered in the GUI when launching the appliance, or can be entered as parameters via the CLI:

openstack stack create jupyterhub
  --template https://www.chameleoncloud.org/appliances/api/appliances/72/template \
  --parameter floating_ip=<floating_ip> \
  --parameter reservation_id=<reservation_id>

Logging in

When the appliance has finished launching, there will still be a few moments until the application is available to access via the Floating IP. However, you should soon be able to visit the Floating IP in your web browser and be redirected to a secure login page. Because a self-signed certificate is being utilized, you will have to instruct your browser to proceed despite the security warning. You should see a login prompt; you can enter your Chameleon credentials to log in, similar to the Jupyter environment at jupyter.chameleoncloud.org. Upon login, your server will be created for you as a Docker container. You should see the containers if you are logged in to the server:

docker container ls --format '{{.ID}}\t{{.Status}}\t{{.Names}}'
a6f1dcf9ae2f    Up 4 minutes    jupyter-<username>
37444f531825    Up 17 minutes   jupyterhub
dadf1af7907c    Up 17 minutes   nginx