Enable Automatic Filesystem Backups

This document covers how to enable automatic filesystem backups across the cloud providers we use.

export CLUSTER_NAME=<cluster-name>

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

Ensure you are in the correct terraform workspace to apply the changes:

terraform workspace select $CLUSTER_NAME

Then apply the changes with:

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

GCP

Backup persistent disks

Backups of persistent disks are automatically enabled when defining a disk in .tfvars file, such as:

persistent_disks = {
  "staging" = {
    size        = 1
    name_suffix = "staging"
  }
}

Backups must be explicitly disabled by adding disable_nfs_backups = true, like so:

persistent_disks = {
  "staging" = {
    size                = 1
    name_suffix         = "staging"
    disable_nfs_backups = true
  }
}

By default, snapshots of the disk will be scheduled to be taken at 00:00 UTC every day, and a maximum of 5 snapshots will be retained.

Warning

It is not currently possible to define a backup cadence other than daily

Jetstream2

Currently, Jetstream2 does not provide any backup service for data and are recommending to keep any backups of the data offsite.

We recommend that users take regular backups of their data to a separate location as we cannot currently ensure a disaster recovery service for Jetstream2 data.