Skip to content

Commit 93cab39

Browse files
committed
fix: naming and formatting
1 parent 0c5db1e commit 93cab39

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

.editorconfig

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@ root = true
22

33
[*]
44
indent_style = space
5-
indent_size = 4
5+
indent_size = 2
66
charset = utf-8
77
trim_trailing_whitespace = true
88
insert_final_newline = true
9+
10+
[*.go]
11+
indent_style = tab
12+
indent_size = 4

.github/workflows/build.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
name: Release
1+
name: Build
22

33
on:
44
push:
55
branches:
6-
- '*'
6+
- "*"
77
pull_request:
8+
workflow_dispatch:
89

910
jobs:
1011
build:

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,17 @@ This Docker volume plugin for utilizing OpenStack Cinder for persistent storage
44

55
The plugin attaches block storage volumes to the compute instance running the plugin. If the volume is already attached to another compute instance it will be detached first.
66

7-
87
## Requirements
98

109
* Block Storage API v3
1110
* Compute API v2
1211
* KVM w/ virtio
1312

14-
1513
## Setup
1614

1715
Provide configuration for the plugin:
1816

19-
```
17+
```json
2018
{
2119
"endpoint": "http://keystone.example.org/v3",
2220
"username": "username",
@@ -35,35 +33,33 @@ Provide configuration for the plugin:
3533

3634
Run the daemon before docker:
3735

38-
```
36+
```console
3937
$ /usr/local/bin/docker-plugin-cinder -config /path/to/config.json
4038
INFO Connecting... endpoint="http://api.os.xopic.de:5000/v3"
4139
INFO Machine ID detected id=e0f89b1b-ceeb-4ec5-b8f1-1b9c274f8e7b
4240
INFO Connected. endpoint="http://api.os.xopic.de:5000/v3"
4341
```
4442

45-
By default a `cinder.json` from the current working directory will be used.
43+
By default, a `cinder.json` from the current working directory will be used.
4644

4745
## Usage
4846

49-
The default volume size is 10GB but can be overridden:
47+
The default volume size is 10 GB but can be overridden:
5048

49+
```console
50+
docker volume create -d cinder -o size=20 volname
5151
```
52-
$ docker volume create -d cinder -o size=20 volname
53-
```
54-
5552

5653
## Notes
5754

5855
### Machine ID
5956

60-
This plugins expects `/etc/machine-id` to be the OpenStack compute instance UUID which seems to be the case when booting cloud images with KVM. Otherwise configure `machineID` in the configuration file.
57+
This plugin expects `/etc/machine-id` to be the OpenStack compute instance UUID which seems to be the case when booting cloud images with KVM. Otherwise, configure `machineID` in the configuration file.
6158

6259
### Attaching volumes
6360

6461
Requested volumes that are already attached will be forcefully detached and moved to the requesting machine.
6562

66-
6763
## License
6864

6965
MIT License

0 commit comments

Comments
 (0)