Skip to content

Latest commit

 

History

History
129 lines (106 loc) · 4.17 KB

csi-dev.md

File metadata and controls

129 lines (106 loc) · 4.17 KB
Raw

Azure file CSI driver development guide

How to build this project

  • Clone repo
$ mkdir -p $GOPATH/src/sigs.k8s.io/
$ git clone https://github.com/kubernetes-sigs/azurefile-csi-driver $GOPATH/src/sigs.k8s.io/azurefile-csi-driver
  • Build CSI driver
$ cd $GOPATH/src/sigs.k8s.io/azurefile-csi-driver
$ make azurefile
  • Run verification test before submitting code
$ make verify
  • If there is config file changed under charts directory, run following command to update chart file
helm package charts/latest/azurefile-csi-driver -d charts/latest/

How to test CSI driver in local environment

Install csc tool according to https://github.com/rexray/gocsi/tree/master/csc

$ mkdir -p $GOPATH/src/github.com
$ cd $GOPATH/src/github.com
$ git clone https://github.com/rexray/gocsi.git
$ cd rexray/gocsi/csc
$ make build

Start CSI driver locally

$ cd $GOPATH/src/sigs.k8s.io/azurefile-csi-driver
$ ./_output/amd64/azurefileplugin --endpoint tcp://127.0.0.1:10000 --nodeid CSINode -v=5 &

Before running CSI driver, create "/etc/kubernetes/azure.json" file under testing server(it's better copy azure.json file from a k8s cluster with service principle configured correctly) and set AZURE_CREDENTIAL_FILE as following:

export set AZURE_CREDENTIAL_FILE=/etc/kubernetes/azure.json

1. Get plugin info

$ csc identity plugin-info --endpoint tcp://127.0.0.1:10000
"file.csi.azure.com"    "v0.4.0"

2. Create an azure file volume

$ csc controller new --endpoint tcp://127.0.0.1:10000 --cap 1,block CSIVolumeName  --req-bytes 2147483648 --params skuname=Standard_LRS
CSIVolumeID       2147483648      "accountname"="f5713de20cde511e8ba4900" "skuname"="Standard_LRS"

3. Mount an azure file volume to a user specified directory

$ mkdir ~/testmount
$ csc node publish --endpoint tcp://127.0.0.1:10000 --cap 1,block --target-path ~/testmount CSIVolumeID
#f5713de20cde511e8ba4900#pvc-file-dynamic-8ff5d05a-f47c-11e8-9c3a-000d3a00df41

4. Unmount azure file volume

$ csc node unpublish --endpoint tcp://127.0.0.1:10000 --target-path ~/testmount CSIVolumeID
CSIVolumeID

5. Delete azure file volume

$ csc controller del --endpoint tcp://127.0.0.1:10000 CSIVolumeID
CSIVolumeID

6. Validate volume capabilities

$ csc controller validate-volume-capabilities --endpoint tcp://127.0.0.1:10000 --cap 1,block CSIVolumeID
CSIVolumeID  true

7. Get NodeID

$ csc node get-info --endpoint tcp://127.0.0.1:10000
CSINode

8. Create snapshot

$  csc controller create-snapshot

9. Delete snapshot

$  csc controller delete-snapshot

How to test CSI driver in a Kubernetes cluster

  • Build container image and push image to dockerhub
# run `docker login` first
export REGISTRY=<dockerhub-alias>
export IMAGE_VERSION=latest
# build linux, windows images
make container-all
# create a manifest list for the images above
make push-manifest
wget -O csi-azurefile-controller.yaml https://raw.githubusercontent.com/kubernetes-sigs/azurefile-csi-driver/master/deploy/csi-azurefile-controller.yaml
# edit csi-azurefile-controller.yaml
kubectl apply -f csi-azurefile-controller.yaml

wget -O csi-azurefile-node.yaml https://raw.githubusercontent.com/kubernetes-sigs/azurefile-csi-driver/master/deploy/csi-azurefile-node.yaml
# edit csi-azurefile-node.yaml
kubectl apply -f csi-azurefile-node.yaml

How to update chart index

helm repo index charts --url=https://raw.githubusercontent.com/kubernetes-sigs/azurefile-csi-driver/master/charts