ridv/katbox

An ephemeral-inline volume manager with time delayed deletion for Kubernetes.

Katbox

Katbox is an inline ephemeral volume manager with delayed deletion for Kubernetes.

It is inspired by the "Sandbox" functionality provided by Apache Mesos.

Pre-requisite

• Kubernetes cluster
• Running version 1.18 or later
• Access to terminal with kubectl installed

Deployment

Deployment varies depending on the Kubernetes version your cluster is running:

• Deployment for Kubernetes 1.18 and later

Examples

Assuming katbox has been successfully deployed, the following example can be run using kubectl:

$ kubectl apply -f https://raw.githubusercontent.com/paypal/katbox/main/examples/csi-app-inline.yaml

Building the binaries

To build the driver, run the following command from the root of the repository:

make

Building a docker image

To build a docker image to be used on a kubernetes cluster, run the following command from the root of the repository:

docker build . -t <image name>

Documentation

A high level overview of how katbox works can be found here

A closer look at how the creation and deletion of volumes works can be found here

Credits

This project was initially a fork of CSI Hostpath driver.