Add beginning of disk management docs for vagrant website

This commit is contained in:
Brian Cain 2019-11-13 13:58:02 -08:00
parent 54c3e28a45
commit 1a02c52852
No known key found for this signature in database
GPG Key ID: 9FC4639B2E4510A0
4 changed files with 59 additions and 0 deletions

View File

@ -0,0 +1,24 @@
---
layout: "docs"
page_title: "Vagrant Disks Configuration"
sidebar_current: "disks-configuration"
description: |-
Documentation of various configuration options for Vagrant Disks
---
# Configuration
Vagrant Disks has several options that allow users to define and attach disks to guests.
## Disk Options
* `name` (string) - Optional argument to give the disk a name
* `type` (symbol) - The type of disk to manage. This option defaults to `:disk`. Please read the provider specific documentation for supported types.
* `file` (string) - Optional argument that defines a path on disk pointing to the location of a disk file.
* `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.
## Disk Types

View File

@ -0,0 +1,14 @@
---
layout: "docs"
page_title: "Vagrant Disks"
sidebar_current: "disks"
description: |-
Introduction to Vagrant Disks
---
# Vagrant Disks
As of version 2.3.0, Vagrant is capable managing what disks are available for a given guest.
For more information about what options are available for configuring disks, see the
[configuration section](/docs/disks/configuration.html).

View File

@ -0,0 +1,13 @@
---
layout: "docs"
page_title: "Vagrant Disk Usage"
sidebar_current: "disk-usage"
description: |-
Various Vagrant Disk examples
---
# Basic Usage
Below are some very simple examples of how to use Vagrant Disks.
## Examples

View File

@ -128,6 +128,14 @@
</ul>
</li>
<li<%= sidebar_current("disks") %>>
<a href="/docs/disks/">Disks</a>
<ul class="nav">
<li<%= sidebar_current("disks-configuration") %>><a href="/docs/disks/configuration.html">Configuration</a></li>
<li<%= sidebar_current("disks-usage") %>><a href="/docs/disks/usage.html">Usage</a></li>
</ul>
</li>
<li<%= sidebar_current("multimachine") %>>
<a href="/docs/multi-machine/">Multi-Machine</a>
</li>