Skip to content

Commit

Permalink
Merge pull request #208 from andyzhangx/doc-rename
Browse files Browse the repository at this point in the history
doc: renaming in doc
  • Loading branch information
andyzhangx committed Aug 9, 2020
2 parents 9bc1b4f + f6057df commit fce8466
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions deploy/example/deployment.yaml
Expand Up @@ -36,11 +36,11 @@ spec:
- "-c"
- while true; do echo $(date) >> /mnt/blob/outfile; sleep 1; done
volumeMounts:
- name: blobfuse
- name: blob
mountPath: "/mnt/blob"
readOnly: false
volumes:
- name: blobfuse
- name: blob
persistentVolumeClaim:
claimName: pvc-blob
strategy:
Expand Down
16 changes: 8 additions & 8 deletions deploy/example/e2e_usage.md
@@ -1,20 +1,20 @@
## CSI driver E2E usage example
create a pod with blobfuse mount on linux
create a pod with blob mount on linux
### Dynamic Provisioning (create storage account and container by Blob Storage CSI driver)
- Create a blobfuse CSI storage class
- Create a blob storage CSI storage class
```console
kubectl create -f https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/deploy/example/storageclass-blobfuse-csi.yaml
```

- Create a blobfuse CSI PVC
- Create a blob storage CSI PVC
```console
kubectl create -f https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/deploy/example/pvc-blob-csi.yaml
```

### Static Provisioning(use an existing storage account)
#### Option#1: use existing credentials in k8s cluster
> make sure the existing credentials in k8s cluster(e.g. service principal, msi) could access the specified storage account
- Download [blobfuse CSI storage class](https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/deploy/example/storageclass-blobfuse-csi-existing-container.yaml), edit `resourceGroup`, `storageAccount`, `containerName` in storage class
- Download [blob storage CSI storage class](https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/deploy/example/storageclass-blobfuse-csi-existing-container.yaml), edit `resourceGroup`, `storageAccount`, `containerName` in storage class
```yaml
apiVersion: storage.k8s.io/v1
kind: StorageClass
Expand All @@ -33,7 +33,7 @@ volumeBindingMode: Immediate
kubectl create -f storageclass-blobfuse-csi-existing-container.yaml
```

- Create a blobfuse CSI PVC
- Create a blob storage CSI PVC
```console
kubectl create -f https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/deploy/example/pvc-blob-csi.yaml
```
Expand All @@ -48,7 +48,7 @@ kubectl create secret generic azure-secret --from-literal azurestorageaccountnam

> storage account key(or sastoken) could also be stored in Azure Key Vault, check example here: [read-from-keyvault](../../docs/read-from-keyvault.md)
- Create a blobfuse CSI PV: download [`pv-blobfuse-csi.yaml` file](https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/deploy/example/pv-blobfuse-csi.yaml) and edit `containerName` in `volumeAttributes`
- Create a blob storage CSI PV: download [`pv-blobfuse-csi.yaml` file](https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/deploy/example/pv-blobfuse-csi.yaml) and edit `containerName` in `volumeAttributes`
```yaml
apiVersion: v1
kind: PersistentVolume
Expand All @@ -74,7 +74,7 @@ spec:
kubectl create -f pv-blobfuse-csi.yaml
```

- Create a blobfuse CSI PVC which would be bound to the above PV
- Create a blob storage CSI PVC which would be bound to the above PV
```console
kubectl create -f https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/deploy/example/pvc-blob-csi-static.yaml
```
Expand All @@ -85,7 +85,7 @@ kubectl create -f https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi
watch kubectl describe pvc pvc-blob
```

- create a pod with blobfuse CSI PVC
- create a pod with blob storage CSI PVC
```console
kubectl create -f https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/deploy/example/nginx-pod-blob.yaml
```
Expand Down
2 changes: 1 addition & 1 deletion docs/design.md
Expand Up @@ -18,7 +18,7 @@ Enable CI on Windows | Completed | |
Complete all unit tests | Completed | |
Set up E2E test | to-do | |
Implement NodeStage/NodeUnstage functions | to-do | two pods on same node could share same mount |
Implement azure blobfuse.csi driver on Windows | to-do | |
Implement Blob Storage CSI driver on Windows | to-do | |

### Implementation details
To prevent possible regression issues, Azure Blob Storage 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 blobfuse plugin would be incorporated into this driver.

0 comments on commit fce8466

Please sign in to comment.