Skip to content

Latest commit

 

History

History
96 lines (59 loc) · 4.48 KB

README.md

File metadata and controls

96 lines (59 loc) · 4.48 KB
Raw

kaDalu

TravisCI Operator Docker Pulls Server Docker Pulls BuildX

What is Kadalu ?

Kadalu is a project to provide Persistent Storage in container ecosystem (like kubernetes, openshift, RKE, etc etc). Kadalu operator deploys CSI pods, and gluster storage pods as per the config. You would get your PVs served through APIs implemented in CSI.

Get Started

Getting started is made easy to copy paste the below commands.

curl -LO https://github.com/kadalu/kadalu/releases/latest/download/kubectl-kadalu
chmod +x ./kubectl-kadalu
sudo mv ./kubectl-kadalu /usr/local/bin/kubectl-kadalu
kubectl-kadalu version
kubectl kadalu install

The above will deploy the kadalu operator and CSI pods. Once done, you can provide storage to kadalu operator to manage.

$ kubectl kadalu storage-add storage-pool-1 --device kube1:/dev/sdc

Note that, in above command, kube1 is the node which is providing /dev/sdc as a storage to kadalu. In your setup, this may be different.

If you made some errors in setup, and want to start fresh, check this cleanup script, and run it to remove kadalu namespace completely.

curl -s https://raw.githubusercontent.com/kadalu/kadalu/devel/extras/scripts/cleanup | bash

Reach out

  1. Best is opening an issue in github.
  2. Reach to us on Slack (Note, there would be no history) - https://kadalu.slack.com

Contributing

We would like your contributions to come as feedbacks, testing, development etc. See CONTRIBUTING for more details.

If you are interested in financial donation to the project, or to the developers, you can do so at our opencollective page. (We like github sponsors too, but its still in waiting list for an org in India).

Helm support

helm install kadalu --namespace kadalu --create-namespace https://github.com/kadalu/kadalu/releases/latest/download/kadalu-helm-chart.tgz --set-string kubernetesDistro=$K8S_DIST

Where K8S_DIST can be one of below values:

  • kubernetes
  • openshift
  • rke
  • microk8s

If --set-string isn't supplied kubernetes will be used as default.

For Kadalu Versions >= 0.8.5 helm chart is broken into subcharts, refer below for installation:

# Takes values as mentioned above
K8S_DIST=kubernetes
curl -sL https://github.com/kadalu/kadalu/releases/latest/download/kadalu-helm-chart.tgz -o /tmp/kadalu-helm-chart.tgz

# First install operator
helm install operator --namespace kadalu --create-namespace /tmp/kadalu-helm-chart.tgz --set operator.enabled=true --set operator.kubernetesDistro=$K8S_DIST

# Incase of Kadalu upgrade verify pod eviction and no usage of Kadalu PVCs, for fresh installation just proceed after operator deployment
helm install csi-nodeplugin --namespace kadalu /tmp/kadalu-helm-chart.tgz --set csi-nodeplugin.enabled=true --set csi-nodeplugin.kubernetesDistro=$K8S_DIST

NOTE: We are still evolving with Helm chart based development, and happy to get contributions on the same.

Platform supports

We support x86_64 (amd64) by default (all releases, devel and latest tags), and in release 0.8.3 tag arm64 and arm/v7 is supported.

For any other platforms, we need users to confirm it works by building images locally. Once it works, we can include it in our automated scripts. You can confirm the build by command make release after checkout of the repository in the respective platform.

How to pronounce kadalu ?

One is free to pronounce 'kaDalu' as they wish. Below is a sample of how we pronounce it!

Request: If you like the project, give a github star :-)