Skip to content

Commit

Permalink
Update documentation for docker volume and set options as parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Carabas committed Apr 16, 2020
1 parent c1e2ef9 commit 544350f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 9 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -552,12 +552,9 @@ You can pass additional mount options to the `local` driver. For mounting an NFS
docker_volume { 'nfs-volume':
ensure => present,
driver => 'local',
options => {
type => 'nfs4',
o => 'addr=10.10.10.10,rw',
device => ':/exports/data'
},
options => ['type=nfs','o=addr=%{custom_manager},rw','device=:/srv/blueocean']
}
```

The name value and the `ensure` parameter are required. If you do not include the `driver` value, the default `local` is used.
Expand All @@ -574,9 +571,7 @@ docker::volumes:
ensure: present
driver: local
options:
type: "nfs"
o: "addr=%{custom_manager},rw",
device: ":/srv/blueocean"
- ['type=nfs','o=addr=%{custom_manager},rw','device=:/srv/blueocean']
```

Available parameters for `options` depend on the used volume driver. For details, see
Expand Down
2 changes: 1 addition & 1 deletion lib/puppet/type/docker_volume.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
desc 'The volume driver used by the volume'
end

newproperty(:options) do
newparam(:options) do
desc 'Additional options for the volume driver'
end

Expand Down

0 comments on commit 544350f

Please sign in to comment.