https://github.com/softwareunderground/jupyterhub-deployment

Software Underground's JupyterHub deployment
https://github.com/softwareunderground/jupyterhub-deployment

Last synced: 3 months ago
JSON representation

Software Underground's JupyterHub deployment

• Host: GitHub
• URL: https://github.com/softwareunderground/jupyterhub-deployment
• Owner: softwareunderground
• License: apache-2.0
• Created: 2021-03-27T13:25:17.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2022-01-09T17:04:49.000Z (over 4 years ago)
• Last Synced: 2024-05-01T09:36:55.795Z (about 2 years ago)
• Language: HCL
• Homepage: https://jupyter-dev.softwareunderground.org
• Size: 1020 KB
• Stars: 1
• Watchers: 15
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Software Underground's JupyterHub deployment

This repository contains Terraform files to deploy

a JupyterHub on Kubernetes using the official JupyterHub

[Helm chart](https://jupyterhub.github.io/helm-chart/).

This JupyterHub uses the Helm chart version `0.11.1`.

We are standing on the shoulders of giants such as:

* Quansight's [Qhub](https://github.com/Quansight/qhub-cloud) Terraform-based deployment

* [Zero to JupyterHub with Kubernetes](https://zero-to-jupyterhub.readthedocs.io)

## Login process

* Go to [https://jupyter-dev.softwareunderground.org/](https://jupyter-dev.softwareunderground.org/)

and click on `Sign in with Slack`:

![Step1](docs/images/step1.png)

* Fill out the Workspace's URL: `swung.slack.com`:

![Step2](docs/images/step2.png)

* Sign in into Slack:

![Step3](docs/images/step3.png)

* Allow the SwungHub Slack app to access your credentials:

![Step4](docs/images/step4.png)

* Enjoy!

## Roadmap

TBD

## Tools

* [Amazon EC2 Instance Selector](https://github.com/aws/amazon-ec2-instance-selector)

## How it works

* Infrastructure (IaaC)

* JupyterHub

## Deployment process

1. Deploy the Kubernetes cluster: execute `terraform apply` inside the `infrastructure` directory.

2. Update the `CNAME` of the JupyterHub endpoint with the new value shown after completion of the Terraform deployment.

3. Deploy the JupyterHub: execute `terraform apply` inside the `jupyterhub` directory.

## Questions

* [Discussion](https://github.com/softwareunderground/jupyterhub-deployment/discussions)

* [#swung-cloud](https://swung.slack.com/archives/C013Z9UQXGX) Slack channel

## How to contribute

TBD

## Code of Conduct

TBD

## License

[Apache License 2.0](https://github.com/softwareunderground/jupyterhub-deployment/blob/main/LICENSE)