Skip to content

Commit

Permalink
fix: naming and formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
jgraichen committed Nov 7, 2024
1 parent 0c5db1e commit 93cab39
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 14 deletions.
6 changes: 5 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@ root = true

[*]
indent_style = space
indent_size = 4
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.go]
indent_style = tab
indent_size = 4
5 changes: 3 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
name: Release
name: Build

on:
push:
branches:
- '*'
- "*"
pull_request:
workflow_dispatch:

jobs:
build:
Expand Down
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,17 @@ This Docker volume plugin for utilizing OpenStack Cinder for persistent storage

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.


## Requirements

* Block Storage API v3
* Compute API v2
* KVM w/ virtio


## Setup

Provide configuration for the plugin:

```
```json
{
"endpoint": "http://keystone.example.org/v3",
"username": "username",
Expand All @@ -35,35 +33,33 @@ Provide configuration for the plugin:

Run the daemon before docker:

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

By default a `cinder.json` from the current working directory will be used.
By default, a `cinder.json` from the current working directory will be used.

## Usage

The default volume size is 10GB but can be overridden:
The default volume size is 10 GB but can be overridden:

```console
docker volume create -d cinder -o size=20 volname
```
$ docker volume create -d cinder -o size=20 volname
```


## Notes

### Machine ID

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.
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.

### Attaching volumes

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


## License

MIT License

0 comments on commit 93cab39

Please sign in to comment.