JuiceFS CSI Driver

The JuiceFS Container Storage Interface (CSI) Driver implements the CSI specification for container orchestrators to manage the lifecycle of JuiceFS file system.

Installation

Deploy the driver:

kubectl apply -f https://raw.githubusercontent.com/juicedata/juicefs-csi-driver/master/deploy/k8s.yaml

If the CSI driver couldn't be discovered by Kubernetes and the error like this: driver name csi.juicefs.com not found in the list of registered CSI drivers , check the kubelet path for kubernetes deployment from the kubelet process running with --root-dir . Run the following command:

ps -ef | grep kubelet | grep root-dir

on any non-master node of you Kubernetes cluster. If the result isn't empty, modify the CSI driver deployment k8s.yaml file with the new path and redeploy the CSI Storage Plugin again.

curl -sSL https://raw.githubusercontent.com/juicedata/juicefs-csi-driver/master/deploy/k8s.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -

Replace {{KUBELET_DIR}} with your own --root-dir value in above command.

Installation with Helm

Prerequisites

Kubernetes 1.14+
Helm 3.1.0

Install Helm

Helm is a tool for managing Kubernetes charts. Charts are packages of pre-configured Kubernetes resources.

To install Helm, refer to the Helm install guide and ensure that the helm binary is in the PATH of your shell.

Using Helm To Deploy

Prepare a values.yaml file with access infomation about redis and object storage

storageClasses:
- name: juicefs-sc
  enabled: true
  reclaimPolicy: Delete
  backend:
    name: "<name>"
    metaurl: "<redis-url>"
    storage: "<storage-type>"
    accessKey: "<access-key>"
    secretKey: "<secret-key>"
    bucket: "<bucket>"

Install

helm repo add juicefs-csi-driver https://juicedata.github.io/juicefs-csi-driver/
helm repo update
helm upgrade juicefs-csi-driver juicefs-csi-driver/juicefs-csi-driver --install -f ./values.yaml

After above steps, juicefs-sc storage class is created

Upgrade CSI Driver

Stop all pods using this driver.
Upgrade driver:
- If you're using latest tag, simple run kubectl rollout restart -f k8s.yaml and make sure juicefs-csi-controller and juicefs-csi-node pods are restarted.
- If you have pinned to a specific version, modify your k8s.yaml to a newer version, then run kubectl apply -f k8s.yaml. Alternatively, if juicefs-csi-driver is installed using helm, we can also use helm to upgrade it.

Visit here for more versions.

Examples

Before the example, you need to:

Get yourself familiar with how to setup Kubernetes and how to use JuiceFS file system.
Make sure JuiceFS is accessible from Kuberenetes cluster. It is recommended to create the file system inside the same region as Kubernetes cluster.
Install JuiceFS CSI driver following the Installation steps.

Example links

Notes:

Since JuiceFS is an elastic file system it doesn't really enforce any file system capacity. The actual storage capacity value in persistence volume and persistence volume claim is not used when creating the file system. However, since the storage capacity is a required field by Kubernetes, you must specify the value and you can use any valid value e.g. 10Pi for the capacity.
kustomize 3.x is required to build some examples.

CSI Specification Compatibility

JuiceFS CSI Driver \ CSI Version	v0.3	v1.0
master branch	no	yes

Interfaces

The following CSI interfaces are implemented:

Node Service: NodePublishVolume, NodeUnpublishVolume, NodeGetCapabilities, NodeGetInfo, NodeGetId
Identity Service: GetPluginInfo, GetPluginCapabilities, Probe