kubernetes-csi
/
csi-driver-smb
mirror of https://github.com/kubernetes-csi/csi-driver-smb.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update and rename design-goals.md to design.md

This commit is contained in:
Andy Zhang 2019-01-06 11:37:08 +08:00 committed by GitHub
parent 29bcec5d42
commit 967a3d177e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/design-goals.md → docs/design.md
View File

@ -1,8 +1,9 @@
# azurefile CSI driver design goals
### azurefile CSI driver should be implemented as compatitable as possible with built-in [azurefile](https://kubernetes.io/docs/concepts/storage/volumes/#azurefile) plugin, it has following goals:
> azurefile CSI driver is implemented as compatitable as possible with built-in [azurefile](https://kubernetes.io/docs/concepts/storage/volumes/#azurefile) plugin, it has following goals:
Goal | Status | Notes
--- | --- | --- |
Use same driver parameters with built-in [azurefile](https://kubernetes.io/docs/concepts/storage/volumes/#azurefile) plugin | Completed | [`file.csi.azure.com` driver parameters](./driver-parameters.md) |
Support service principal and msi authentication | Completed | |
Support both Linux & Windows | In Progress | Windows related work is in progress: [Enable CSI hostpath example on windows](https://github.com/kubernetes-csi/drivers/issues/79) |
Compatible with original storage class parameters and usage| Completed | There is a little difference in static provision, see [example](https://github.com/andyzhangx/azurefile-csi-driver/blob/master/README.md#example2-azurefile-static-provisioninguse-an-existing-azure-file-share) |
@ -10,5 +11,13 @@ Support sovereign cloud| Completed | |
Support volume size grow| to-do | |
Support snapshot | to-do | |
### Other work items
work item | Status | Notes
--- | --- | --- |
Complete all unit tests | In Progress | |
Set up E2E test | to-do | |
Implement NodeStage/NodeUnstage functions | to-do | two pods on same node could share same mount |
Implement azure file csi driver on Windows | to-do | |
### Implementation details
To prevent possible regression issues, azurefile CSI driver use [azure cloud provider](https://github.com/kubernetes/kubernetes/tree/v1.13.0/pkg/cloudprovider/providers/azure) library. Thus, all bug fixes in the built-in azure file plugin would be incorporated into this driver.