Skip to content

Commit 7a8da23

Browse files
authored
Update README.md
1 parent 36601e7 commit 7a8da23

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

pkg/blobfuse-proxy/README.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,32 @@
11
# Use blobfuse-proxy
22

3-
By default, restart csi-blobfuse-node daemonsetwould make current blobfuse mounts unavailable. When fuse nodeserver restarts on the node, the fuse daemon also restarts, this results in breaking all connections FUSE daemon is maintaining. You could find more details here: [No easy way how to update CSI driver that uses fuse](https://github.com/kubernetes/kubernetes/issues/70013).
3+
By default, restart csi-blobfuse-node daemonset would make current blobfuse mounts unavailable. When fuse nodeserver restarts on the node, the fuse daemon also restarts, this results in breaking all connections FUSE daemon is maintaining. You could find more details here: [No easy way how to update CSI driver that uses fuse](https://github.com/kubernetes/kubernetes/issues/70013).
44

5-
This page shows how to run a blobfuse proxy on all agent nodes and this proxy mounts volumes and maintains FUSE connections. Blobfuse proxy receives mount request in a GRPC call and then uses this data to mount and returns the output of the blobfuse command.
5+
This page shows how to run a blobfuse proxy on all agent nodes and this proxy mounts volumes, maintains FUSE connections.
6+
> Blobfuse proxy receives mount request in a GRPC call and then uses this data to mount and returns the output of the blobfuse command.
67
7-
### Prerequisite
8-
- make sure [blobfuse](https://github.com/Azure/azure-storage-fuse) is already installed on agent node
8+
### Step#1. Install blobfuse-proxy on debian based agent node
9+
> below daemonset would also install latest [blobfuse](https://github.com/Azure/azure-storage-fuse) version on the node
10+
```console
11+
kubectl apply -f https://raw.githubusercontent.com/kubernetes-sigs/blob-csi-driver/master/deploy/blobfuse-proxy/blobfuse-proxy.yaml
12+
```
913

10-
### Install blobfuse-proxy on debian-based agent node
14+
### Step#2. Install Blob CSI driver with `node.enableBlobfuseProxy=true` setting
15+
```console
16+
helm repo add blob-csi-driver https://raw.githubusercontent.com/kubernetes-sigs/blob-csi-driver/master/charts
17+
helm install blob-csi-driver blob-csi-driver/blob-csi-driver --namespace kube-system --version v1.1.0 --set node.enableBlobfuseProxy=true
18+
```
19+
20+
#### Troubleshooting
21+
- Get `blobfuse-proxy` logs on the node
22+
```console
23+
kubectl get po -n kube-system -o wide | grep blobfuse-proxy
24+
csi-blobfuse-proxy-47kpp 1/1 Running 0 37m
25+
kubectl logs -n kube-system csi-blobfuse-proxy-47kpp
26+
```
1127

12-
- Download blobfuse-proxy package, run as a service
28+
#### Development
29+
- install blobfuse-proxy package, run as a service manually
1330
```console
1431
wget https://github.com/kubernetes-sigs/blob-csi-driver/raw/master/deploy/blobfuse-proxy/v0.1.0/blobfuse-proxy-v0.1.0.deb -O /tmp/blobfuse-proxy-v0.1.0.deb
1532
dpkg -i /tmp/blobfuse-proxy-v0.1.0.deb
@@ -19,13 +36,6 @@ systemctl start blobfuse-proxy
1936
```
2037
> blobfuse-proxy start unix socket under `/var/lib/kubelet/blobfuse-proxy.sock` by default
2138
22-
#### Troubleshooting
23-
- Get `blobfuse-proxy` logs
24-
```console
25-
sudo journalctl -u blobfuse-proxy -l > blobfuse-proxy.log
26-
```
27-
28-
#### Development
2939
- make sure all required [Protocol Buffers](https://github.com/protocolbuffers/protobuf) binaries are installed
3040
```console
3141
./hack/install-protoc.sh
@@ -55,7 +65,7 @@ rpmbuild --target noarch -bb utils.spec
5565

5666
- Installing blobfuse-proxy package
5767
```console
58-
# On debian based systems:
68+
# On debian based systems
5969
wget https://github.com/kubernetes-sigs/blob-csi-driver/raw/master/deploy/blobfuse-proxy/v0.1.0/blobfuse-proxy-v0.1.0.deb
6070
dpkg -i blobfuse-proxy-v0.1.0.deb
6171

0 commit comments

Comments
 (0)