The purpose of this project is to provide a one-click deployment of a JupyterHub server that is immediately ready for many people to use. The JupyterHub runs on a Kubernetes cluster in AWS. It persists user data on an NFS server in AWS, autoscales automatically, and can easily be configured further for your needs (see below in "Extra Configuration"). This project deploys the JupyterHub in two steps. First it deploys a new VPC and control node, then the control node deploys and configures the K8s cluster and necessary AWS resources.
These instructions assume that you are familiar with AWS and that your CLI is configured properly for your AWS account.
Install PyYaml and Boto3 python packages:
pip install pyyaml boto3
make deploy
Deploying the package will kick off two CloudFormation Stacks in AWS. You can check the status of this build by going to the Cloudformation service in the AWS console. It takes about 20 minutes for everything to build. Once it's finished building, go to the EC2 service and find the loadbalancer for your JupyterHub. Copy the domain of the loadbalancer in your browser and you should see a working JupyterHub!
Your JupyterHub cluster is managed by a control node. You can access this node with the SSH key you entered in the config.yaml file. You can find the ip address / domain of the control node in the EC2 service console and then ssh using the following command:
ssh -i "umsi-easy-hub-test.pem" [email protected]
Below are a few commands you can run on your control node once you have opened up an ssh connection:
TBD...
Below is a list of custom configurations you can add to your JupyterHub.
In AWS, it is very easy to create a custom domain and point it at your JupyterHub load balancer. Simply create a Route53 domain and point it at your load balancer as an "A" record set.
Once you have a custom domain pointing to your JupyterHub, you can implement secure access to your JupyterHub by adding a HTTPS listener on port 443 of the load balancer. When adding an HTTPS listener through the AWS console, you will be required to use an SSL certificate. If you don't have one already for your custom domain, you will need to generate one through Amazon's Certificate Manager (ACM). For the listener's default action, choose the https target group that was generated when you deployed your cluster.
The final step in enabling HTTPS requires you to ssh into the control node and change the helm chart configuration. Once you ssh into the control node:
ssh -i "umsi-easy-hub-test.pem" [email protected]
There is a file called config.yaml. Uncomment the https section under the proxy settings.
Then re-apply the configuration by running the following command:
helm upgrade --install jhub jupyterhub/jupyterhub --namespace jhub --version 0.8.2 --values helm_config.yaml
You should now be able to access your cluster via https.
The helm chart we're using is already set up to accept GitHub authentication, all you need to do is set up a GitHub app and configure some more details in the helm config. First let's set up the GitHub app.
Log into GitHub with your own GitHub account and create a new OAuth app under settings > OAuth Apps. Give it any name you want, enter your domain in the "Homepage URL" and then enter https://<yourdomain>/hub/oauth_callback into the Authorization callback URL (replace "yourdomain" with your actual domain). Once you create the app, save the app's client ID and Client Secret somewhere.
Once your GitHub app is set up, ssh into the control node and open up the config.yaml like you did in the above section. Uncomment the auth section, and change clientId, clientSecret, and callbackUrl to align with what's in your GitHub app. Add in any GitHub users under admin and whitelist that you want to use the JupyterHub. Re-apply the configuration to get the updates.
Next time you log into the hub, it should ask you to login with your GitHub credentials.
To add in custom notebook profiles beyond the scipy notebook, you have to edit the helm config once again. In the singleuser section, see the profile list section and notice an example custom profile. You can add as many of these as you'd like. Just make sure to re-apply the configuration to get the updates.
There are two manual steps you need to complete in order to attach an old EFS to your new JupyterHub cluster. First, log into the AWS console and find the EFS that you would like to use. Remove all of the old mountpoints of the EFS and then add new mountpoints in the same Vpc/Subnets that your new JupyterHub is in. Once the EFS has mountpoints in the proper subnets, it can be discoverable by the nodes in your cluster. The second step is to edit the node startup script. First take note of the File System ID of your EFS. Then go to the S3 bucket that holds all of the source files of your hub (for example s3://1234567890-umsi-easy-hub-test) and change the value in node_startup_script.sh that assigns the EFSID. Then terminate all your nodes (not the control node) and when they reboot, they will mount the new EFS.
For further questions and configurations, please contact myself ([email protected]) or the MADS Tech team ([email protected])