Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stashed/stash
🛅 Backup your Kubernetes Stateful Applications
https://github.com/stashed/stash
appscode backup cloud-native kubernetes restic
Last synced: 8 days ago
JSON representation
🛅 Backup your Kubernetes Stateful Applications
- Host: GitHub
- URL: https://github.com/stashed/stash
- Owner: stashed
- License: other
- Created: 2017-02-28T00:37:01.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T22:06:22.000Z (8 months ago)
- Last Synced: 2024-05-14T14:31:57.996Z (7 months ago)
- Topics: appscode, backup, cloud-native, kubernetes, restic
- Language: Go
- Homepage: https://stash.run
- Size: 67.4 MB
- Stars: 1,275
- Watchers: 22
- Forks: 87
- Open Issues: 109
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- stars - stashed/stash
- awesome-restic - Stash - Backup your Kubernetes Stateful Applications (Other)
- awesome-repositories - stashed/stash - 🛅 Backup your Kubernetes Stateful Applications (Go)
- awesome-cloud-native - Stash - Backup your Kubernetes Stateful Applications. (OPS)
- awesome-technostructure - stashed/stash
- awesome-technostructure - stashed/stash
- awesome-starts - stashed/stash - 🛅 Backup your Kubernetes Stateful Applications (Go)
README
[](https://goreportcard.com/report/stash.appscode.dev/stash)
[](https://github.com/stashed/stash/actions?workflow=CI)
[](https://hub.docker.com/r/appscode/stash/)
[](https://slack.appscode.com)
[](https://twitter.com/intent/follow?screen_name=KubeStash)
# Stash
[Stash](https://stash.run) 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](https://github.com/restic/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](https://stash.run/docs/latest/guides/latest/addons/overview/) 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](https://en.wikipedia.org/wiki/Cron) 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](https://restic.readthedocs.io/en/stable/060_forget.html#removing-snapshots-according-to-a-policy) |
| Encryption, Deduplication (send only diff) | ✓ | ✓ | Encrypt backed up data with AES-256. Stash only sends the changes since last backup. |
| [CSI Driver Integration](https://kubernetes.io/docs/concepts/storage/volume-snapshots/) | ✓ | ✓ | 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](https://stash.run/docs/latest/setup/).
## Using Stash
Want to learn how to use Stash? Please start [here](https://stash.run/docs/latest/).
## Contribution guidelines
Want to help improve Stash? Please start [here](https://stash.run/docs/latest/welcome/contributing).
## Acknowledgement
- Many thanks to [Alexander Neumann](https://github.com/fd0) for [Restic](https://restic.net) project.
## Support
To speak with us, please leave a message on [our website](https://appscode.com/contact/).
To join public discussions with the Stash community, join us in the [AppsCode Slack team](https://appscode.slack.com/messages/C8NCX6N23/details/) channel `#stash`. To sign up, use our [Slack inviter](https://slack.appscode.com/).
To receive product announcements, follow us on [Twitter](https://twitter.com/KubeStash).
If you have found a bug with Stash or want to request new features, please [file an issue](https://github.com/stashed/project/issues/new).
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fstashed%2Fstash?ref=badge_large)