Skip to content

kubedb/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 

Repository files navigation

Go Report Card

KubeDB

Running production quality database in Kubernetes can be tricky to say the least. In the early days of Kubernetes, replication controllers were used to run a single pod for a database. With the introduction of StatefulSet, it became easy to run a docker container for any database. But what about monitoring, taking periodic backups, restoring from backups or cloning from an existing database? KubeDB is a framework for writing operators for any database that support the following operational requirements:

  • Create a database declaratively using TPR.
  • Take one-off backups or period backups to various cloud stores, eg,, S3, GCS, etc.
  • Restore from backup or clone any database.
  • Native integration with Prometheus for monitoring via CoreOS Prometheus Operator.
  • Apply deletion lock to avoid accidental deletion of database.
  • Keep track of deleted databases, cleanup prior snapshots with a single command.
  • Use cli to manage databases like kubectl for Kubernetes.

KubeDB is developed at AppsCode to run their SAAS platform on Kubernetes. Currently we include complete implementations for Postgres and ElasticSearch database.

Supported Versions

Kubernetes 1.5+

Installation

To install KubeDB, please follow the guide here.

Using KubeDB

Want to learn how to use KubeDB? Please start here.

Contribution guidelines

Want to help improve KubeDB? Please start here.

Project Status

Wondering what features are coming next? Please visit here.


The KubeDB operator collects anonymous usage statistics to help us learn how the software is being used and how we can improve it. To disable stats collection, run the operator with the flag --analytics=false.


Support

If you have any questions, you can reach out to us.