Skip to content

Commit e94c806

Browse files
authored
Update README.md
1 parent 6e36cf4 commit e94c806

File tree

1 file changed

+2
-73
lines changed

1 file changed

+2
-73
lines changed

README.md

Lines changed: 2 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -34,79 +34,8 @@ Please refer to `blobfuse.csi.azure.com` [driver parameters](./docs/driver-param
3434
### Install blobfuse CSI driver on a kubernetes cluster
3535
Please refer to [install blobfuse csi driver](https://github.com/csi-driver/blobfuse-csi-driver/blob/master/docs/install-blobfuse-csi-driver.md)
3636

37-
## E2E Usage example
38-
create a pod with blobfuse mount on linux
39-
### Dynamic Provisioning (create storage account and container automatically by blobfuse driver)
40-
- Create a blobfuse CSI storage class
41-
```sh
42-
kubectl create -f https://raw.githubusercontent.com/csi-driver/blobfuse-csi-driver/master/deploy/example/storageclass-blobfuse-csi-mountoptions.yaml
43-
```
44-
45-
- Create a blobfuse CSI PVC
46-
```sh
47-
kubectl create -f https://raw.githubusercontent.com/csi-driver/blobfuse-csi-driver/master/deploy/example/pvc-blobfuse-csi.yaml
48-
```
49-
50-
### Static Provisioning(use an existing storage account)
51-
#### Option#1: use existing credentials in k8s cluster
52-
> make sure the existing credentials in k8s cluster(e.g. service principal, msi) could access the specified storage account
53-
- Download a blobfuse CSI storage class, edit `resourceGroup`, `storageAccount`, `containerName` in storage class
54-
```sh
55-
wget https://raw.githubusercontent.com/csi-driver/blobfuse-csi-driver/master/deploy/example/storageclass-blobfuse-csi-existing-container.yaml
56-
vi storageclass-blobfuse-csi-existing-container.yaml
57-
kubectl create -f storageclass-blobfuse-csi-existing-container.yaml
58-
```
59-
60-
- Create a blobfuse CSI PVC
61-
```sh
62-
kubectl create -f https://raw.githubusercontent.com/csi-driver/blobfuse-csi-driver/master/deploy/example/pvc-blobfuse-csi.yaml
63-
```
64-
65-
#### Option#2: provide storage account name and key(or sastoken)
66-
- Use `kubectl create secret` to create `azure-secret` with existing storage account name and key(or sastoken)
67-
```
68-
kubectl create secret generic azure-secret --from-literal azurestorageaccountname=NAME --from-literal azurestorageaccountkey="KEY" --type=Opaque
69-
#kubectl create secret generic azure-secret --from-literal azurestorageaccountname=NAME --from-literal azurestorageaccountsastoken
70-
="sastoken" --type=Opaque
71-
```
72-
73-
> storage account key(or sastoken) could also be stored in Azure Key Vault, check example here: [read-from-keyvault](./docs/read-from-keyvault.md)
74-
75-
- Create a blobfuse CSI PV, download `pv-blobfuse-csi.yaml` file and edit `containerName` in `volumeAttributes`
76-
```sh
77-
wget https://raw.githubusercontent.com/csi-driver/blobfuse-csi-driver/master/deploy/example/pv-blobfuse-csi.yaml
78-
vi pv-blobfuse-csi.yaml
79-
kubectl create -f pv-blobfuse-csi.yaml
80-
```
81-
82-
- Create a blobfuse CSI PVC which would be bound to the above PV
83-
```
84-
kubectl create -f https://raw.githubusercontent.com/csi-driver/blobfuse-csi-driver/master/deploy/example/pvc-blobfuse-csi-static.yaml
85-
```
86-
87-
#### 2. Validate PVC status and create an nginx pod
88-
> make sure pvc is created and in `Bound` status
89-
```
90-
watch kubectl describe pvc pvc-blobfuse
91-
```
92-
93-
- create a pod with blobfuse CSI PVC
94-
```
95-
kubectl create -f https://raw.githubusercontent.com/csi-driver/blobfuse-csi-driver/master/deploy/example/nginx-pod-blobfuse.yaml
96-
```
97-
98-
#### 3. enter the pod container to do validation
99-
- watch the status of pod until its Status changed from `Pending` to `Running` and then enter the pod container
100-
```sh
101-
$ watch kubectl describe po nginx-blobfuse
102-
$ kubectl exec -it nginx-blobfuse -- bash
103-
Filesystem Size Used Avail Use% Mounted on
104-
...
105-
blobfuse 30G 8.9G 21G 31% /mnt/blobfuse
106-
/dev/sda1 30G 8.9G 21G 31% /etc/hosts
107-
...
108-
```
109-
In the above example, there is a `/mnt/blobfuse` directory mounted as `blobfuse` filesystem.
37+
### Examples
38+
- [Basic usage](./deploy/example/e2e_usage.md)
11039

11140
## Kubernetes Development
11241
Please refer to [development guide](./docs/csi-dev.md)

0 commit comments

Comments
 (0)