Skip to content

Commit

Permalink
Update README.md with Usage and References to external docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cdkharris authored Jul 17, 2024
1 parent f1a7a24 commit 18e1576
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@

## Usage

1. Populate the `public_key_openssh` and `KUBECONFIG` variables
2. Deploy the Terraform module
3. Wait for `cloud-init` to finish configuring k3s on the VM
4. Log into the VM and become root
5. Fill out the `jupyterhub_config.yaml` file with data from a suitable AzureAD app registration
6. Run the `install_jupyterhub.sh` script

## References

- [K3s](https://docs.k3s.io/installation)
- [Zero to JupyterHub](https://z2jh.jupyter.org/en/stable/)

<!-- BEGIN_TF_DOCS -->
## Requirements

Expand Down

0 comments on commit 18e1576

Please sign in to comment.