From b0f4d43663253ab4ae1d7908403ccf2ec4259946 Mon Sep 17 00:00:00 2001 From: Brian Cain Date: Wed, 13 Nov 2019 16:36:24 -0800 Subject: [PATCH] Add docs around various ways to define provider specific options for disk configs --- website/source/docs/disks/configuration.html.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/website/source/docs/disks/configuration.html.md b/website/source/docs/disks/configuration.html.md index 33b9c8d69..e249719de 100644 --- a/website/source/docs/disks/configuration.html.md +++ b/website/source/docs/disks/configuration.html.md @@ -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