Kanister
Kanister is a data protection workflow management tool. It provides a set of cohesive APIs for defining and curating data operations by abstracting away tedious details around executing data operations on Kubernetes. It's extensible and easy to install, operate and scale.
Highlights
ExecStream
framework.
Quickstart
Follow the instructions in the installation documentation, to install Kanister on your Kubernetes cluster.
Walk through the tutorial to define, curate and run your first data protection workflow using Kanister blueprints, actionsets and profiles.
The examples
directory contains many sample blueprints that you
can use to define data operations for:
- AWS RDS
- Cassandra
- Couchbase
- Elasticsearch
- etcd
- FoundationDB
- K8ssandra
- MongoDB
- MongoDB on OpenShift using DeploymentConfig
- MySQL
- MySQL on OpenShift using DeploymentConfig
- PostgreSQL
- PostgreSQL on OpenShift using DeploymentConfig
- Redis
The Kanister architecture is documented here.
Getting Help
If you have any questions or run into issues, feel free to reach out to us on Slack.
GitHub issues or pull requests that have been inactive for more than 60 days
will be labeled as stale. If they remained inactive for another 30 days, they
will be automatically closed. To be exempted from the issue lifecycle, discuss
with a maintainer the reasons behind the exemption, and add the frozen
label
to the issue or pull request.
If you discovered any security issues, refer to our SECURITY.md
documentation for our security policy, including steps on how to report
vulnerabilities.
Community
The Kanister community meetings happen once every two weeks on Thursday, 16:00
UTC, where we discuss ongoing interesting features, issues, and pull requests.
Come join us! Everyone is welcome!
If you are currently using Kanister, we would love to hear about it! Feel free
to add your organization to the ADOPTERS.md
by submitting a
pull request.
Code of Conduct
Kanister is for everyone. We ask that our users and contributors take a few minutes to review our Code of Conduct.
Resources
- CNCF - Enhancing data protection workflows with Kanister and Argo workflows
- CNCF - Kanister: Application-Level Data Protection on Kubneretes
- CNCF - Integrating Backup Into Your GitOps CI/CD Pipeline
- DoK - Kanister & Kopia: An Open-Source Data Protection Match Made in Heaven
- DoK - Kanister: Application-Level Data Operations on Kubernetes
- Kanister Overview 2021
- SIG Apps Demo
- Percona Live 2018
License
Apache License 2.0, see LICENSE.