haskal
/
vagrant
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add docs around various ways to define provider specific options for disk configs

This commit is contained in:
Brian Cain 2019-11-13 16:36:24 -08:00
parent 7feee7a87f
commit b0f4d43663
No known key found for this signature in database
GPG Key ID: 9FC4639B2E4510A0
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
website/source/docs/disks/configuration.html.md
View File

@ -18,7 +18,14 @@ Vagrant Disks has several options that allow users to define and attach disks to
* `primary` (boolean) - Optional argument that configures a given disk to be the "primary" disk to manage on the guest. There can only be one `primary` disk per guest.
* `provider_config` (hash) - Additional provider specific options for managing a given disk.
**Note:** The `provider_config` option will depend on the provider you are using. Please read the provider specific documentation for disk management to learn about what options are available to use.
Generally, the disk option accepts two kinds of ways to define a provider config:
+ `providername__diskoption = value`
- The provider name followed by a double underscore, and then the provider specific option for that disk
+ `{providername: {diskoption: value}, otherprovidername: {diskoption: value}`
- A hash where the top level key(s) are one or more providers, and each provider keys values are a hash of options and their values.
**Note:** More specific examples of these can be found under the provider specific disk page. The `provider_config` option will depend on the provider you are using. Please read the provider specific documentation for disk management to learn about what options are available to use.
## Disk Types