Skip to content

Commit

Permalink
Emphasize the client container requirement in Readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
casusbelli committed Jan 29, 2018
1 parent 17f009f commit 94af583
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Quobyte volume plug-in for Docker

This plugin allows you to use [Quobyte](https://www.quobyte.com) with Docker. The plugin is intended to run without installing the Quobyte client on the host system (e.g. for Rancher/CoreOS) but by using a Quobyte client run in a Docker container. For more information on how to set up a Quobyte Client Docker container look at [docs/coreos.md](docs/coreos.md) or the Quobyte manual (Integration -> Quobyte and Container Infrastructures -> Quobyte Containers - Deep Dive -> Running a Quobyte Client inside a Container).
This plugin allows you to use [Quobyte](https://www.quobyte.com) with Docker. The plugin is intended to run without installing the Quobyte client on the host system (e.g. for Rancher/CoreOS) but by using a Quobyte client run in a Docker container.

## Tested

Expand All @@ -15,6 +15,12 @@ CoreOS 1097.0.0 | 1.11.2

## Setup

### Prerequisite: Quobyte client mount

As described previously a Quobyte multi volume mount has to be available on the host the plugin is intended to run upon. For this setup we recommend running a dockerized Quobyte client. For more information on how to set up a Quobyte Client Docker container look at the example in [docs/coreos.md](docs/coreos.md) or the Quobyte manual (Integration -> Quobyte and Container Infrastructures -> Quobyte Containers - Deep Dive -> Running a Quobyte Client inside a Container).

Using a locally installed client works fine, too, if this type of installation is preferred.

### Binary

Download the binary and the systemd files from the [releases](https://github.com/quobyte/docker-volume/releases) page. To download version `1.1` of this plugin run the following step:
Expand Down

0 comments on commit 94af583

Please sign in to comment.