Skip to main content

Kubernetes 使用 JuiceFS 持久化数据

JuiceFS 非常适合用作 Kubernetes 集群的存储层，目前有两种常见的用法。

JuiceFS CSI 驱动​

提示

推荐在 Kubernetes 中使用 JuiceFS CSI 驱动的部署方式，了解更多关于 JuiceFS CSI 驱动的信息请访问项目主页。

JuiceFS CSI 驱动遵循 CSI 规范，实现了容器编排系统与 JuiceFS 文件系统之间的接口，支持动态配置 JuiceFS 卷提供给 Pod 使用。

版本要求​

  • Kubernetes 1.14+

安装​

以下提供了两种安装 JuiceFS CSI 驱动的方式。

方法一：通过 Helm 安装​

版本要求​
  • Helm 3.1.0+
安装 Helm​

Helm 是 Kubernetes 的包管理器，Chart 是 Helm 管理的包。你可以把它看作是 Homebrew formula，APT dpkg，或 YUM RPM 在 Kubernetes 中的等价物。

请参照 Helm 文档 进行安装，并确保 helm 二进制能在 PATH 环境变量中找到。

安装 JuiceFS CSI 驱动​

  1. 准备配置文件

    创建一个配置文件，例如：values.yaml，复制并完善下列配置信息。其中，backend 部分是 JuiceFS 文件系统相关的信息，你可以参照「JuiceFS 快速上手指南」了解相关内容。如果使用的是已经提前创建好的 JuiceFS 卷，则只需填写 name 和 metaurl 这两项即可。mountPod 部分可以对使用此驱动的 Pod 设置 CPU 和内存的资源配置。不需要的项可以删除，或者将它的值留空。

    说明

    请参考文档了解 JuiceFS CSI 驱动的 Helm chart 支持的所有配置项

    values.yaml
    storageClasses:
    - name: juicefs-sc
      enabled: true
      reclaimPolicy: Retain
      backend:
        name: "<name>"
        metaurl: "<meta-url>"
        storage: "<storage-type>"
        accessKey: "<access-key>"
        secretKey: "<secret-key>"
        bucket: "<bucket>"
        # 如果需要设置 JuiceFS Mount Pod 的时区请将下一行的注释符号删除，默认为 UTC 时间。
        # envs: "{TZ: Asia/Shanghai}"
      mountPod:
        resources:
          limits:
            cpu: "<cpu-limit>"
            memory: "<memory-limit>"
          requests:
            cpu: "<cpu-request>"
            memory: "<memory-request>"

  2. 检查 kubelet 根目录

    执行以下命令

    ps -ef | grep kubelet | grep root-dir

    如果结果不为空，则代表 kubelet 的根目录（--root-dir）不是默认值（/var/lib/kubelet），需要在第一步准备的配置文件 values.yaml 中将 kubeletDir 设置为 kubelet 当前的根目录路径：

    kubeletDir: <kubelet-dir>

  3. 部署

    依次执行以下三条命令，通过 Helm 部署 JuiceFS CSI 驱动。

    helm repo add juicefs-csi-driver https://juicedata.github.io/charts/
    helm repo update
    helm install juicefs-csi-driver juicefs-csi-driver/juicefs-csi-driver -n kube-system -f ./values.yaml

  4. 检查部署状态

    • 检查 Pods：部署过程会启动一个名为 juicefs-csi-controller 的 StatefulSet 及一个 replica，以及一个名为 juicefs-csi-node 的 DaemonSet。执行命令 kubectl -n kube-system get pods -l app.kubernetes.io/name=juicefs-csi-driver 会看到有 n+1 个（n 指 Kubernetes 的 Node 数量）pod 在运行，例如：

      kubectl -n kube-system get pods -l app.kubernetes.io/name=juicefs-csi-driver
      NAME                       READY   STATUS    RESTARTS   AGE
      juicefs-csi-controller-0   3/3     Running   0          22m
      juicefs-csi-node-v9tzb     3/3     Running   0          14m

    • 检查 Secret：通过命令 kubectl -n kube-system describe secret juicefs-sc-secret 可以看到前面 values.yaml 配置文件中 backend 部分的 secret 信息。

      Name:         juicefs-sc-secret
      Namespace:    kube-system
      Labels:       app.kubernetes.io/instance=juicefs-csi-driver
                    app.kubernetes.io/managed-by=Helm
                    app.kubernetes.io/name=juicefs-csi-driver
                    app.kubernetes.io/version=0.7.0
                    helm.sh/chart=juicefs-csi-driver-0.1.0
      Annotations:  meta.helm.sh/release-name: juicefs-csi-driver
                    meta.helm.sh/release-namespace: default

      Type:  Opaque

      Data
      ====
      access-key:  0 bytes
      bucket:      47 bytes
      metaurl:     54 bytes
      name:        4 bytes
      secret-key:  0 bytes
      storage:     2 bytes

    • 检查存储类（Storage Class）：通过命令 kubectl get sc juicefs-sc 会看到类似下面的存储类信息。

      NAME         PROVISIONER       RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
      juicefs-sc   csi.juicefs.com   Retain          Immediate           false                  69m

方法二：通过 kubectl 安装​

由于 Kubernetes 在版本变更过程中会废弃部分旧的 API，因此需要根据你使用 Kubernetes 版本选择适用的部署文件。

  1. 检查 kubelet 根目录

    在 Kubernetes 集群中任意一个非 Master 节点上执行以下命令：

    ps -ef | grep kubelet | grep root-dir

  2. 部署

    • 如果上一步检查命令返回的结果不为空，则代表 kubelet 的根目录（--root-dir）不是默认值（/var/lib/kubelet），因此需要在 CSI 驱动的部署文件中更新 kubeletDir 路径并部署：

      注意

      请将下述命令中的 {{KUBELET_DIR}} 替换成 kubelet 当前的根目录路径。

      # Kubernetes 版本 >= v1.18
      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 -
      # Kubernetes 版本 < v1.18
      curl -sSL https://raw.githubusercontent.com/juicedata/juicefs-csi-driver/master/deploy/k8s_before_v1_18.yaml | sed 's@/var/lib/kubelet@{{KUBELET_DIR}}@g' | kubectl apply -f -

    • 如果前面检查命令返回的结果为空，无需修改配置，可直接部署：

      # Kubernetes 版本 >= v1.18
      kubectl apply -f https://raw.githubusercontent.com/juicedata/juicefs-csi-driver/master/deploy/k8s.yaml
      # Kubernetes 版本 < v1.18
      kubectl apply -f https://raw.githubusercontent.com/juicedata/juicefs-csi-driver/master/deploy/k8s_before_v1_18.yaml

  3. 创建存储类

    参考以下内容创建一个配置文件，例如：juicefs-sc.yaml，在 stringData 部分填写 JuiceFS 文件系统的配置信息：

    juicefs-sc.yaml
    apiVersion: v1
    kind: Secret
    metadata:
      name: juicefs-sc-secret
      namespace: kube-system
    type: Opaque
    stringData:
      name: "test"
      metaurl: "redis://juicefs.afyq4z.0001.use1.cache.amazonaws.com/3"
      storage: "s3"
      bucket: "https://juicefs-test.s3.us-east-1.amazonaws.com"
      access-key: ""
      secret-key: ""
      # 如果需要设置 JuiceFS Mount Pod 的时区请将下一行的注释符号删除，默认为 UTC 时间。
      # envs: "{TZ: Asia/Shanghai}"
    ---
    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: juicefs-sc
    provisioner: csi.juicefs.com
    reclaimPolicy: Retain
    volumeBindingMode: Immediate
    parameters:
      csi.storage.k8s.io/node-publish-secret-name: juicefs-sc-secret
      csi.storage.k8s.io/node-publish-secret-namespace: kube-system
      csi.storage.k8s.io/provisioner-secret-name: juicefs-sc-secret
      csi.storage.k8s.io/provisioner-secret-namespace: kube-system

    执行命令，部署存储类：

    kubectl apply -f ./juicefs-sc.yaml

    另外，你也可以将上述配置文件中 Secret 部分抽离出来，通过 kubectl 在命令行上创建：

    kubectl -n kube-system create secret generic juicefs-sc-secret \
      --from-literal=name=test \
      --from-literal=metaurl=redis://juicefs.afyq4z.0001.use1.cache.amazonaws.com/3 \
      --from-literal=storage=s3 \
      --from-literal=bucket=https://juicefs-test.s3.us-east-1.amazonaws.com \
      --from-literal=access-key="" \
      --from-literal=secret-key=""

    这样一来，存储类的配置文件 juicefs-sc.yaml 应该像下面这样：

    juicefs-sc.yaml
    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: juicefs-sc
    provisioner: csi.juicefs.com
    reclaimPolicy: Retain
    parameters:
      csi.storage.k8s.io/node-publish-secret-name: juicefs-sc-secret
      csi.storage.k8s.io/node-publish-secret-namespace: kube-system
      csi.storage.k8s.io/provisioner-secret-name: juicefs-sc-secret
      csi.storage.k8s.io/provisioner-secret-namespace: kube-system

    然后通过 kubectl apply 部署存储类：

    kubectl apply -f ./juicefs-sc.yaml

使用 JuiceFS 为 Pod 提供存储​

JuiceFS CSI 驱动同时支持静态和动态 PersistentVolume（PV），你既可以将提前创建的 PV 手动分配给 Pods，也可以在部署 Pods 时通过 PersistentVolumeClaim（PVC）动态地创建卷。

例如，可以使用下面的配置创建一个名为 development.yaml 的配置文件，它通过 PVC 为 Nginx 容器创建持久化卷，并挂载到了容器的 /config 目录：

development.yaml
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: web-pvc
spec:
  accessModes:
    - ReadWriteMany
  resources:
    requests:
      storage: 10Pi
  storageClassName: juicefs-sc
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-run
spec:
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
        - name: nginx
          image: linuxserver/nginx
          ports:
            - containerPort: 80
          volumeMounts:
            - mountPath: /config
              name: web-data
      volumes:
        - name: web-data
          persistentVolumeClaim:
            claimName: web-pvc

通过 kubectl apply 部署 Pods：

kubectl apply -f ./development.yaml

部署成功以后，查看 pods 状态：

kubectl get pods
NAME                         READY   STATUS    RESTARTS   AGE
nginx-run-7d6fb7d6df-cfsvp   1/1     Running   0          21m

可以简单地通过 kubectl exec 命令查看容器中的文件系统挂载情况：

kubectl exec nginx-run-7d6fb7d6df-cfsvp -- df -Th
Filesystem     Type          Size  Used Avail Use% Mounted on
overlay        overlay        40G  7.0G   34G  18% /
tmpfs          tmpfs          64M     0   64M   0% /dev
tmpfs          tmpfs         3.8G     0  3.8G   0% /sys/fs/cgroup
JuiceFS:jfs    fuse.juicefs  1.0P  180M  1.0P   1% /config
...

从容器中返回的结果可以看到，完全符合预期，JuiceFS 卷已经挂载到了指定的 /config 目录。

像上面这样通过 PVC 动态创建 PV 时，JuiceFS 会在文件系统根目录创建与 PV 同名的目录并挂载到容器中。执行下列命令，可以查看集群中所有 PV：

kubectl get pv -A
NAME                                       CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS   CLAIM             STORAGECLASS   REASON   AGE
pvc-b670c8a1-2962-497c-afa2-33bc8b8bb05d   10Pi       RWX            Retain           Bound    default/web-pvc   juicefs-sc              34m

通过外部主机挂载同一个 JuiceFS 存储，可以看到当前正在使用的 PV 以及曾经创建的 PV。

创建更多 JuiceFS 存储类​

你可以根据实际需要重复前面的步骤，通过 JuiceFS CSI 驱动创建任意数量的存储类。但要注意修改存储类的名称以及 JuiceFS 文件系统的配置信息，避免与已创建的存储类冲突。例如，使用 Helm 时可以创建一个名为 juicefs-sc2.yaml 的配置文件：

juicefs-sc2.yaml
storageClasses:
- name: juicefs-sc2
  enabled: true
  reclaimPolicy: Retain
  backend:
    name: "jfs-2"
    metaurl: "redis://example.abc.0001.use1.cache.amazonaws.com/3"
    storage: "s3"
    accessKey: ""
    secretKey: ""
    bucket: "https://jfs2.s3.us-east-1.amazonaws.com"

执行 Helm 命令进行部署：

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

查看集群中存储类的情况：

kubectl get sc
NAME                 PROVISIONER                RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
juicefs-sc           csi.juicefs.com            Retain          Immediate           false                  88m
juicefs-sc2          csi.juicefs.com            Retain          Immediate           false                  13m
standard (default)   k8s.io/minikube-hostpath   Delete          Immediate           false                  128m

监控​

请查看「监控」文档了解如何收集及展示 JuiceFS 监控指标

了解更多​

了解更多关于 JuiceFS CSI 驱动的信息，请访问项目主页。

在容器中挂载 JuiceFS​

某些情况下，你可能需要在容器中直接挂载 JuiceFS 存储，这需要在容器中使用 JuiceFS 客户端，你可以参考以下 Dockerfile 样本将 JuiceFS 客户端集成到应用镜像：

Dockerfile
FROM alpine:latest
LABEL maintainer="Juicedata <https://juicefs.com>"

# Install JuiceFS client
RUN apk add --no-cache curl && \
  JFS_LATEST_TAG=$(curl -s https://api.github.com/repos/juicedata/juicefs/releases/latest | grep 'tag_name' | cut -d '"' -f 4 | tr -d 'v') && \
  wget "https://github.com/juicedata/juicefs/releases/download/v${JFS_LATEST_TAG}/juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz" && \
  tar -zxf "juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz" && \
  install juicefs /usr/bin && \
  rm juicefs "juicefs-${JFS_LATEST_TAG}-linux-amd64.tar.gz" && \
  rm -rf /var/cache/apk/* && \
  apk del curl

ENTRYPOINT ["/usr/bin/juicefs", "mount"]

由于 JuiceFS 需要使用 FUSE 设备挂载文件系统，因此在创建 Pod 时需要允许容器在特权模式下运行：

apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-run
spec:
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
        - name: nginx
          image: linuxserver/nginx
          ports:
            - containerPort: 80
          securityContext:
            privileged: true
注意

容器启用 privileged: true 特权模式以后，就具备了访问宿主机所有设备的权限，即拥有了对宿主机内核的完全控制权限。使用不当会带来严重的安全隐患，请您在使用此方式之前进行充分的安全评估。