Skip to content

Commit e5421cc

Browse files
committed
Update README
1 parent 93e64e3 commit e5421cc

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,15 @@ The plugin attaches block storage volumes to the compute instance running the pl
88

99
* Block Storage API v3
1010
* Compute API v2
11-
* KVM w/ virtio
11+
* KVM w/ virtio or SCSI disks
1212

13-
## Setup
13+
## Install
1414

15-
Provide configuration for the plugin:
15+
Download binary or package from the latest release. The packages include a systemd service and socket file, as well as sample config file.
16+
17+
### Configuration
18+
19+
Provide configuration at `/etc/docker/cinder.json` for the plugin:
1620

1721
```json
1822
{
@@ -31,10 +35,19 @@ Provide configuration for the plugin:
3135
}
3236
```
3337

34-
Run the daemon before docker:
38+
Enable and start the `docker-plugin-cinder.socket` unit and start/restart docker:
39+
40+
```console
41+
systemctl enable docker-plugin-cinder.socket
42+
systemctl start docker-plugin-cinder.socket
43+
44+
systemctl restart docker.service
45+
```
46+
47+
Or manually run the plugin before docker:
3548

3649
```console
37-
$ /usr/local/bin/docker-plugin-cinder -config /path/to/config.json
50+
$ /usr/bin/docker-plugin-cinder -config /etc/docker/cinder.json
3851
INFO Connecting... endpoint="http://api.os.xopic.de:5000/v3"
3952
INFO Machine ID detected id=e0f89b1b-ceeb-4ec5-b8f1-1b9c274f8e7b
4053
INFO Connected. endpoint="http://api.os.xopic.de:5000/v3"

0 commit comments

Comments
 (0)