
- #Synology drive configuration how to#
- #Synology drive configuration install#
- #Synology drive configuration driver#
- #Synology drive configuration full#
#Synology drive configuration driver#
If you are no longer using the CSI driver, make sure that no other resources in your Kubernetes cluster are using storage managed by Synology CSI driver before uninstalling it. scripts/deploy.sh -help to see more information on the usage of the commands.
#Synology drive configuration install#
To install pods of the CSI driver without the snapshotter, run.To install all pods of the CSI driver, run.scripts/deploy.sh build.Īfterwards, run docker images to check the newly created image. The output binary will be at bin/synocli. To build the synocli dev tool, execute make synocli.If you want to use images you built locally for installation, edit all files under deploy/kubernetes// and make sure imagePullPolicy: IfNotPresent is included in every csi-plugin container. This will allow you to take snapshots of them.Īpply the YAML files to the Kubernetes cluster.īy default, the CSI driver will pull the latest image from Docker Hub. All volumes created by the CSI driver are Thin Provisioned LUNs on DSM.If you leave the parameter location blank, the CSI driver will choose a volume on DSM with available storage to create the volumes.The formatting file system of the PersistentVolumes when you mount them on the pods The location (/volume1, /volume2, …) on DSM where the LUN for PersistentVolume will be created The IPv4 address of your DSM, which must be included in the client-info.yml for the CSI driver to log in to DSM You can also leave blank if you don’t have a preference: Name is-default-class: "false"Ĭonfigure the StorageClass properties by assigning the parameters in the table. Usually the config file sets up the secret as well, but if you still want to create the secret or recreate it, follow the instructions below:Įdit the config file config/client-info.yml or create a new one like the example shown here: Create the storage system secret (This is not mandatory because deploy.sh will complete all the configurations when you configure the config file mentioned previously.)Ĭreate a secret to specify the storage system address and credentials (username and password).
#Synology drive configuration how to#
This section explains how to do the following things: Storage classes and the secret are required for the CSI driver to function properly.
#Synology drive configuration full#
( Full deployment only)Ĭheck if the status of all pods of the CSI driver is Running. Create a volume snapshot class named “ synology-snapshotclass” that uses the “ Delete” policy.Create a default storage class named “ synology-iscsi-storage” that uses the “ Retain” policy.Build a local image and deploy the CSI driver.Create a secret named “ client-info-secret” using the credentials from the client-info.yml you configured in the previous step.This is where the driver will be installed. Create a namespace named “ synology-csi“.If you don’t need to build the driver locally and want to pull the image from Docker instead, run the command as instructed below. If you want a basic deployment, which doesn’t include installing a snapshotter, change the command as instructed below. This will be a full deployment, which means you’ll be building and running all CSI services as well as the snapshotter. scripts/deploy.sh run to install the driver. username, password: The credentials for connecting to DSM.Make sure the port is properly configured as well. https: Set “true” to use HTTPS for secure connections.Only change this if you use a different port. Change the following parameters as needed: You can specify one or more storage systems on which the CSI volumes will be created. cp config/client-info-template.yml config/client-info.ymlĮdit config/client-info.yml to configure the connection information for DSM. If you don’t need the Snapshot feature, you can install the basic deployment of the CSI driver instead.Ĭopy the client-info-template.yml file. After you complete the steps below, the full deployment of the CSI driver, including the snapshotter, will be installed.Make sure that all the worker nodes in your Kubernetes cluster can connect to your DSM.Before installing the CSI driver, make sure you have created and initialized at least one storage pool and one volume on your DSM.(Optional) Both Volume Snapshot CRDs and the common snapshot controller must be installed in your Kubernetes cluster if you want to use the Snapshot feature.Go version 1.16 or above is recommended.Container Images & Kubernetes Compatibilityĭriver Name: Driver Version The official Container Storage Interface driver for Synology NAS.
