Skip to content

Commit

Permalink
Document enabling backups for hubs running jupyterhub-home-nfs
Browse files Browse the repository at this point in the history
  • Loading branch information
sgibson91 committed Jan 27, 2025
1 parent bcf2513 commit 82a1b5c
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
4 changes: 4 additions & 0 deletions docs/howto/features/storage-quota.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ terraform plan -var-file=projects/$CLUSTER_NAME.tfvars
terraform apply -var-file=projects/$CLUSTER_NAME.tfvars
```

```{important}
At this point, it is also a good idea to enable [automatic backups of the the NFS server](howto:filesystem-backups:enable:aws) as well.
```

## Enabling `jupyterhub-home-nfs`

To be able to configure per-user storage quotas, we need to run an in-cluster NFS server using [`jupyterhub-home-nfs`](https://github.com/sunu/jupyterhub-home-nfs). This can be enabled by setting `jupyterhub-home-nfs.enabled = true` in the hub's values file (or the common values files if all hubs on this cluster will be using this).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,33 @@
This document covers how to enable automatic filesystem backups across the cloud
providers we use.

(howto:filesystem-backups:enable:gcp)=
## GCP

```bash
export CLUSTER_NAME=<cluster-name>
```

(howto:filesystem-backups:enable:aws)=
## AWS

```{attention}
For AWS hubs running `jupyterhub-home-nfs` only
```

To enable backups of home directories running on AWS EBS volumes, add the following line to the cluster's terraform values file.

```
enable_nfs_backup = true
```

Then apply the changes with:

```bash
terraform plan -var-file=projects/$CLUSTER_NAME.tfvars
terraform apply -var-file=projects/$CLUSTER_NAME.tfvars
```

(howto:filesystem-backups:enable:gcp)=
## GCP

1. **Create relevant resources via terraform.**

Our terraform configuration supports creating the relevant resources to support
Expand Down

0 comments on commit 82a1b5c

Please sign in to comment.