Backup and Restore

Last modified on October 06, 2023

To back up and restore your SwaggerHub On-Premise installation, we recommend using Velero (currently recommended version 1.9.5), which is an open-source tool for backing up and restoring Kubernetes clusters. Refer to https://docs.replicated.com/vendor/snapshots-overview#velero-version-compatibility for up-to-date versions supported.

Velero supports both manual and scheduled backups and also comes with a CLI. Velero backups can be stored to a variety of locations, including AWS, Azure, GCP, and NFS servers.

VM (embedded cluster) installations come with Velero pre-installed. If you deployed SwaggerHub On-Premise to an existing Kubernetes cluster, you can install Velero manually.

To learn more about using Velero, refer to:

Snapshots guide in KOTS documentation

Velero documentation

Important notes

VM-level snapshots created in the hypervisor are not supported as the backup and restore method for VM-based installations of SwaggerHub On-Premise 2.x.

Highlight search results