jparklab/synology-csi

synology-csi

一个用于Synology NAS的https://github.com/container-storage-interface%EF%BC%88CSI%EF%BC%89%E9%A9%B1%E5%8A%A8%E3%80%82

支持的平台

该驱动仅支持Linux，因为需要主机上运行iscsid服务。目前已在Ubuntu 16.04、Ubuntu 18.04和Alpine上测试通过。

提供预构建的Docker镜像，支持amd64、arm64、armv7架构。

安装

确保在所有要运行该驱动的节点上安装iscsiadm。

构建

构建软件包

bash
make

构建Docker镜像

bash
# 示例：docker build -t jparklab/synology-csi .
docker build [-f Dockerfile] -t <仓库名>[:<标签>] .

构建多架构Docker镜像

要构建多架构镜像，需使用Docker 19.03或更高版本，该版本支持buildx。

bash
# 示例：./build.sh -t jparklab/synology-csi
./build.sh -t <仓库名>[:<标签>] .

测试

使用https://github.com/re***/gocsi%E6%B5%8B%E8%AF%95%E9%A9%B1%E5%8A%A8%E3%80%82

创建测试配置文件

需创建包含连接Synology NAS API信息的配置文件。详见下文创建配置文件。

启动插件驱动

bash
# 可指定任意nodeid
$ go run cmd/syno-csi-plugin/main.go \
    --nodeid CSINode \
    --endpoint tcp://127.0.0.1:10000 \
    --synology-config syno-config.yml 

获取插件信息

bash
$ csc identity plugin-info -e tcp://127.0.0.1:10000

创建卷

bash
$ csc controller create-volume \
    --req-bytes 2147483648 \
    -e tcp://127.0.0.1:10000 \
    test-volume 
"8.1" 2147483648 "iqn"="iqn.2000-01.com.synology:kube-csi-test-volume" "mappingIndex"="1" "targetID"="8"

列出卷

输出的第一列是卷ID。

bash
$ csc controller list-volumes -e tcp://127.0.0.1:10000 
"8.1" 2147483648 "iqn"="iqn.2000-01.com.synology:kube-csi-test-volume" "mappingIndex"="1" "targetID"="8"

删除卷

bash
# 示例：
# csc controller delete-volume  -e tcp://127.0.0.1:10000 8.1
$ csc controller delete-volume  -e tcp://127.0.0.1:10000 <卷ID>

部署

确保Kubernetes集群已配置CSI驱动

对于Kubernetes v1.12和v1.13，需启用特性门控以使用CSI驱动。按照https://kubernetes-csi.github.io/docs/csi-driver-object.html%E5%92%8Chttps://kubernetes-csi.github.io/docs/csi-node-object.html%E4%B8%8A%E7%9A%84%E8%AF%B4%E6%98%8E%E8%AE%BE%E7%BD%AEKubernetes%E9%9B%86%E7%BE%A4%E3%80%82

创建配置文件

yaml
---
# syno-config.yml 文件
host: <主机名>           # Synology NAS的IP地址或主机名
port: 5000               # 如使用非默认端口，修改此值
sslVerify: false         # 设置为true以使用https
username: <登录名>        # 用户名
password: <密码>          # 密码
loginApiVersion: 2       # 可选。登录版本，2到6之间，默认为"2"
loginHttpMethod: <方法>  # 可选。方法，"GET"、"POST"或"auto"（默认）。"auto"在版本>=6时使用POST
sessionName: Core        # 无需修改此值
enableSynoToken: no      # 可选。设置为'true'启用syno token，仅适用于版本3及以上
enableDeviceToken: yes   # 可选。设置为'true'启用设备token，仅适用于版本6及以上
deviceId: <设备ID>        # 可选。仅适用于版本6及以上，如未设置，读取DEVICE_ID环境变量
deviceName: <名称>        # 可选。仅适用于版本6及以上

从配置文件创建Kubernetes Secret

bash
kubectl create secret generic synology-config --from-file=syno-config.yml

（可选）使用自签名CA的HTTPS

若使用自签名CA颁发的证书，CSI驱动需访问CA证书。可通过ConfigMap添加证书。

创建包含证书的ConfigMap：

bash
# 示例：
# kubectl create configmap synology-csi-ca-cert --from-file=self-ca.crt
kubectl create configmap synology-csi-ca-cert --from-file=<CA文件>

将证书添加到部署中：

yaml
# 添加到attacher.yml、node.yml和provisioner.yml
..
spec:
...
- name: csi-plugin
  ...
    volumeMounts:
    ...
    - mountPath: /etc/ssl/certs/self-ca.crt
      name: cert
      subPath: self-ca.crt      # 需与创建ConfigMap时使用的文件名相同
  ...
  volumes:
  - configMap:
      defaultMode: 0444
      name: synology-csi-ca-cert

部署到Kubernetes

bash
kubectl apply -f deploy/kubernetes/v1.15

（v1.12已测试，v1.13未测试）

注意：

synology-csi-attacher和synology-csi-provisioner需要运行在同一节点上（可能）。

卷参数

默认情况下，iSCSI LUN将在Volume 1（/volume1）位置创建，采用精简置备。可在storage_class.yml中设置参数选择不同位置或卷类型。

示例：

yaml
apiVersion: storage.k8s.io/v1
kind: StorageClass
name: synology-iscsi-storage
...
provisioner: csi.synology.com
parameters:
  location: '/volume2'
  type: 'FILE'          # 若位置使用ext4文件系统，FILE表示厚置备，THIN表示精简置备；
                        # 若使用btrfs文件系统，BLUN_THICK表示厚置备，BLUN表示精简置备
reclaimPolicy: Delete

注意：若已创建存储类，需删除后重新创建以应用新参数。

Synology配置

由于该服务几乎同时执行多次登录请求，Synology可能会阻止请求，日志中会出现407错误（版本6）或400错误。建议禁用自动阻止和IP检查以确保正常工作。

确保执行以下操作：

• 进入控制面板/安全性/常规：启用“通过跳过IP检查增强浏览器兼容性”
• 进入控制面板/安全性/账户：禁用“自动阻止”