Skip to main content
Enterprise

Backups

NetBox Enterprise integrates with Velero for Kubernetes-native backup and restore.

info

Velero backup integration requires an Enterprise license tier.

Prerequisites​

  • Velero installed in your cluster
  • A backup storage location configured in Velero
  • Enterprise license

Enable Backups​

netboxEnterprise:
  spec:
    backups: true

When enabled, the operator creates a Velero Backup resource that captures:

  • PersistentVolumeClaim snapshots (database data, media files)
  • Secrets and ConfigMaps
  • All NetBox and Diode resources in the namespace

Backup Workflow​

Create a Backup​

With backups: true, Velero will include the NetBox namespace in scheduled backups. You can also trigger an on-demand backup:

velero backup create netbox-backup \
  --include-namespaces netbox \
  --wait

Check Backup Status​

velero backup get
velero backup describe netbox-backup --details

Restore from Backup​

To restore NetBox from a Velero backup:

  1. Enable maintenance mode to stop the application:
kubectl -n netbox patch netboxenterprise netbox \
  --type merge \
  -p '{"spec":{"maintenanceMode":true}}'
  1. Restore the backup:
velero restore create --from-backup netbox-backup --wait
  1. Disable maintenance mode to resume:
kubectl -n netbox patch netboxenterprise netbox \
  --type merge \
  -p '{"spec":{"maintenanceMode":false}}'

Data Preservation​

When a NetBoxEnterprise resource is deleted, PersistentVolumeClaims are preserved (not deleted) to prevent accidental data loss. This allows re-creating the cluster and reattaching existing data volumes.

Next Steps​