🛅 Backup your Kubernetes Stateful Applications
go get github.com/stashed/stash
Stash
Stash by AppsCode is a cloud-native data backup and recovery solution for Kubernetes workloads. If you are running production workloads in Kubernetes, you might want to take backup of your disks, databases, etc. Traditional tools are too complex to set up and maintain in a dynamic compute environment like Kubernetes. Stash is a Kubernetes operator that uses restic or Kubernetes CSI Driver VolumeSnapshotter functionality to address these issues. Using Stash, you can backup Kubernetes volumes mounted in workloads, stand-alone volumes, and databases. Users may even extend Stash via addons for any custom workload.
Features
| Features | Community Edition | Enterprise Edition | Scope |
|---|---|---|---|
| Open source Stash Free for everyone | Open Core Stash for production Enterprise workloads | ||
| Backup & Restore Workload Data | ✓ | ✓ | Deployment, DaemonSet, StatefulSet, ReplicaSet, ReplicationController, OpenShift DeploymentConfig |
| Backup & Restore Stand-alone Volume (PVC) | ✓ | ✓ | PersistentVolumeClaim, PersistentVolume |
| Schedule Backup, Instant Backup | ✓ | ✓ | Schedule through cron expression or trigger instant backup using Stash Kubernetes plugin |
| Pause Backup | ✓ | ✓ | No new backup when paused. |
| Backup & Restore subset of files | ✓ | ✓ | Only backup/restore the files that matches the provided patterns |
| Cleanup old snapshots automatically | ✓ | ✓ | Cleanup old snapshots according to different retention policies |
| Encryption, Deduplication (send only diff) | ✓ | ✓ | Encrypt backed up data with AES-256. Stash only sends the changes since last backup. |
| CSI Driver Integration | ✓ | ✓ | VolumeSnapshot for Kubernetes workloads. Supported for Kubernetes v1.17.0+. |
| Prometheus Metrics | ✓ | ✓ | Rich backup metrics, restore metrics and Stash operator metrics. |
| Security | ✓ | ✓ | Built-in support for RBAC, PSP and Network Policy |
| CLI | ✓ | ✓ | kubectl plugin (for Kubernetes 1.12+) |
| Extensibility and Customizability | ✓ | ✓ | Write addons for bespoke applications and customize currently supported workloads |
| Hooks | ✓ | ✓ | Execute httpGet, httpPost, tcpSocket and exec hooks before and after of backup or restore process. |
| Cloud Storage as Backend | ✓ | ✓ | Stores backup data in AWS S3, Minio, Rook, GCS, Azure, OpenStack Swift, Backblaze B2 and Rest Server |
| On-prem Storage as Backend | ✗ | ✓ | Stores backup data in any locally mounted Kubernetes Volumes such as NFS, etc. |
| Backup & Restore databases | ✗ | ✓ | PostgreSQL, MySQL, MongoDB, Elasticsearch, Redis, MariaDB, Percona XtraDB |
| Auto Backup | ✗ | ✓ | Share backup configuration across workloads using templates. Enable backup for a target application via annotation. |
| Batch Backup & Batch Restore | ✗ | ✓ | Backup and restore co-related applications (eg, WordPress server and its database) together |
| Point-In-Time Recovery (PITR) | ✗ | Planned | Restore a set of files from a time in the past. |
Installation
To install Stash, please follow the guide here.
Using Stash
Want to learn how to use Stash? Please start here.
Contribution guidelines
Want to help improve Stash? Please start here.
Acknowledgement
- Many thanks to Alexander Neumann for Restic project.
Support
To speak with us, please leave a message on our website.
To join public discussions with the Stash community, join us in the AppsCode Slack team channel #stash. To sign up, use our Slack inviter.
To receive product announcements, follow us on Twitter.
If you have found a bug with Stash or want to request new features, please file an issue.
License
