Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 2.57 KB

index.rst

File metadata and controls

73 lines (53 loc) · 2.57 KB

Welcome to Kanister's documentation!

Kanister allows domain experts to capture application specific data management tasks in Blueprints which can be easily shared and extended. The framework takes care of the tedious details around execution on Kubernetes and presents a homogeneous operational experience across applications at scale.

The design of Kanister was driven by the following main goals:

  1. Application-Centric: Given the increasingly complex and distributed nature of cloud-native data services, there is a growing need for data management tasks to be at the application level. Experts who possess domain knowledge of a specific application's needs should be able to capture these needs when performing data operations on that application.
  2. API Driven: Data management tasks for each specific application may vary widely, and these tasks should be encapsulated by a well-defined API so as to provide a uniform data management experience. Each application expert can provide an application-specific pluggable implementation that satisifes this API, thus enabling a homogenous data management experience of diverse and evolving data services.
  3. Extensible: Any data management solution capable of managing a diverse set of applications must be flexible enough to capture the needs of custom data services running in a variety of environments. Such flexibility can only be provided if the solution itself can easily be extended.

Getting Started

Kanister is open source and more information can be found on github.

# clone the Kanister git repo
$ git clone git@github.com:kanisterio/kanister.git

# install Kanister operator controller
$ kubectl apply -f bundle.yaml

# install your application
$ kubectl apply -f examples/mongo-sidecar/mongo-cluster.yaml

# use an existing Blueprint, tweak one, or create one yourself
$ kubectl apply -f examples/mongo-sidecar/blueprint.yaml

# perform operations
$ kubectl apply -f examples/mongo-sidecar/backup-actionset.yaml

To get up an running using Kanister, we recommend :ref:`install` and working through the :ref:`tutorial`

Documentation

.. toctree::
   :maxdepth: 2

   self
   install
   tutorial
   operator
   functions
   templates