Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documents #7

Merged
merged 1 commit into from
Dec 6, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions doc/en/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,11 +206,13 @@ No resources found

### Data Engine: SPDK LVS

The csi-node depends on `nvme` command-line tool to connect remote targets. Run following commands to install nvme client.
~~The csi-node depends on `nvme` command-line tool to connect remote targets. Run following commands to install nvme client.~~
`nvme` client is installed in CSI base image. If you want to override the `nvme` command in container, you could run the following commands.
CSI-node checks file `/home/admin/nvmeof/bin/nvme` at first priority, then looks for `nvme` in PATH.

```
# prepare your own nvme client and copy to /home/admin/nvmeof/bin/nvme
sudo yum install -y nvme-cli

# csi-node uses file /home/admin/nvmeof/bin/nvme
sudo cp /usr/sbin/nvme /home/admin/nvmeof/bin/
```

Expand All @@ -219,7 +221,7 @@ sudo cp /usr/sbin/nvme /home/admin/nvmeof/bin/
kubectl create -f hack/deploy/base/

# create nvmf_tgt daemonset and configmap
kubectl create -f hack/deploy/base/aio-lvs
kubectl create -f hack/deploy/aio-lvs
```

The disk-agent config will create a normal file `/local-storage/aio-lvs` of 1GiB and create an AIOBdev, which is used to create a LVS.
Expand Down Expand Up @@ -265,7 +267,7 @@ status:
#### Deploy Pod and PVC

```
$ kubectl create -f pod.yaml
$ kubectl create -f hack/deploy/example/pod.yaml
pod/test-pod created
persistentvolumeclaim/pvc-obnvmf-test created

Expand Down