Skip to content

Commit

Permalink
[#59] Update compose file reference for volumes
Browse files Browse the repository at this point in the history
  • Loading branch information
Evgeny committed Aug 2, 2022
1 parent 00f8808 commit e16c13e
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/references/compose-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -582,16 +582,19 @@ volumes:

!!! Note

Uffizzi currently only supports mounting empty volumes, i.e. you cannot preload data into your volumes. Support for non-empty volumes is on the [roadmap](https://github.com/orgs/UffizziCloud/projects/2/views/1).
Uffizzi currently only supports mounting empty volumes (i.e. 'anonymous' and 'named' volumes). Therefore you cannot preload data into your volumes. Support for non-empty volumes is on the [roadmap](https://github.com/orgs/UffizziCloud/projects/2/views/1).

#### Short syntax

The short syntax uses the generic `[SOURCE:]TARGET[:MODE]` format, where `SOURCE` can be either a host path or volume name. `TARGET` is the container path where the volume is mounted. Standard modes are `ro` for read-only and `rw` for read-write (default).

``` yaml
volumes:
# Just specify a path and let Uffizzi create a volume
# Anonymous volume. Just specify a path and let Uffizzi create a volume
- /var/lib/mysql
# Anonymous volume with read-only access
- /var/lib/mysql:ro
# Named volume
- datavolume:/var/lib/mysql
Expand Down Expand Up @@ -623,7 +626,7 @@ volumes:

!!! Warning

If more than one service mounts a shared volume, only one service can have read-write access to it. All other services must be designated read-only, e.g. using the sh~ort syntax ` - shared_db:/var/lib/mysql:ro` or long syntax `read-only: true`.
The options 'source' and 'target' are required for a long syntax. Therefore anonymous volume can't be define for a long syntax.

### **x-uffizzi-continuous-previews**

Expand Down Expand Up @@ -950,4 +953,4 @@ services:
volumes:
data-volume:
```
```

0 comments on commit e16c13e

Please sign in to comment.