# docker-volume-beegfs

## Preconditions

- BeeGFS cluster has to be setup and running
- `beegfs` kernel module loaded on the host running Docker

## Installation

### RedHat/CentOS 7

An rpm can be built with:

    make rpm

Then install and start the service:

    rpm -i docker-volume-beegfs-$VERSION.rpm
    systemctl start docker-volume-beegfs

### Others

Build the plugin:

    go build

## Usage

First create a volume (no additional options are supported yet):

  docker volume create -d beegfs --name postgres-portroach

Then use the volume by passing the name (`postgres-1`):

  docker run -ti -v postgres-portroach:/var/lib/postgresql/data --volume-driver=beegfs -p 5432:5432 -e POSTGRES_PASSWORD=postgres postgres

Inspect the volume:

  docker volume inspect postgres-portroach

Remove the volume (note that this will _not_ remove the actual data):

  docker volume rm postgres-portroach

## Roadmap

- Support options passed at `docker volume create`

## License

MIT, please see the LICENSE file.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

# docker-volume-beegfs

Docker Volume plugin to create persistent volumes in a BeeGFS cluster.

## Preconditions

- BeeGFS cluster has to be setup and running
- `beegfs-client` service needs to be running on the Docker host

## Installation

### RedHat/CentOS 7

An rpm can be built with:

    make rpm

Then install and start the service:

    rpm -i docker-volume-beegfs-$VERSION.rpm
    systemctl start docker-volume-beegfs

### Others

Build the plugin:

    go build

## Usage

First create a volume (no additional options are supported yet):

  docker volume create -d beegfs --name postgres-portroach

Then use the volume by passing the name (`postgres-1`):

  docker run -ti -v postgres-portroach:/var/lib/postgresql/data --volume-driver=beegfs -p 5432:5432 -e POSTGRES_PASSWORD=postgres postgres

Inspect the volume:

  docker volume inspect postgres-portroach

Remove the volume (note that this will _not_ remove the actual data):

  docker volume rm postgres-portroach

## Caveats

- Currently the plugin assumes the BeeGFS share is mounted on `/mnt/beegfs`

## Roadmap

- Support options passed at `docker volume create`

## License

MIT, please see the LICENSE file.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Add caveat and short description
Add caveat and short description