Skip to content

Commit ed0bce4

Browse files
committed
Add documentation on the "managed" volume parameter
1 parent 7f47c5e commit ed0bce4

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -632,6 +632,10 @@ Each volume in map is defined a key corresponding to its and a map of attributes
632632
- GCP: `pd-ssd`
633633
- OpenStack: `null`
634634
- OVH: `null`
635+
- `managed` (optional, def: `true`): set to `false` to indicate that the volume already
636+
exists and should not be created by Terraform only mounted. When a volume is configured with `managed = false`,
637+
its name needs to match the following pattern `{tag}-{name}-{mounting_hostname}`,
638+
for example `nfs-home-mgmt1`.
635639
636640
Volumes with a tag that have no corresponding instance will not be created.
637641

0 commit comments

Comments
 (0)