========================
Team and repository tags
========================

.. image:: https://governance.openstack.org/tc/badges/karbor.svg
    :target: https://governance.openstack.org/tc/reference/tags/index.html

.. Change things from this point on

======
Karbor
======

Application Data Protection as a Service for OpenStack

.. image:: https://raw.githubusercontent.com/openstack/karbor/master/doc/images/mascot/OpenStack_Project_Karbor_vertical.png
    :alt: Karbor
    :width: 300
    :height: 525
    :align: center


*****************
Mission Statement
*****************

To protect the Data and Metadata that comprises an OpenStack-deployed
Application against loss/damage (e.g. backup, replication) by providing a
standard framework of APIs and services that allows vendors to provide plugins
through a unified interface

Open Architecture
"""""""""""""""""

Design for multiple perspectives:

* User: Protect App Deployment

  * Configure and manage custom protection plans on the deployed resources
    (topology, VMs, volumes, images, ...)

* Admin: Define Protectable Resources

  * Decide what plugins protect which resources, what is available for the user
  * Decide where users can protect their resources

* Vendors: Standard API for protection products

  * Create plugins that implement Protection mechanisms for different OpenStack
    resources

*****
Links
*****

* Free software: Apache license
* Documentation: https://docs.openstack.org/karbor/latest/
* Source: https://git.openstack.org/cgit/openstack/karbor
* Bugs: https://bugs.launchpad.net/karbor
* Release notes: https://docs.openstack.org/karbor/latest/releasenotes.html

********
Features
********

Version 0.1
"""""""""""

* Resource API
* Plan API
* Bank API
* Ledger API
* Cross-resource dependencies

Limitations
***********

* Only 1 Bank plugin per Protection Plan
* Automatic object discovery not supported