Update disk docs in website for experimental feature banner
This commit is contained in:
Brian Cain
parent
734aad1ede
commit
3e177d380f
|
|
@ -8,6 +8,23 @@ description: |-
|
|||
|
||||
# Configuration
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported or functional.
|
||||
|
||||
This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to:
|
||||
|
||||
```
|
||||
VAGRANT_EXPERIMENTAL="disk_base_config"
|
||||
```
|
||||
|
||||
Please note that `VAGRANT_EXPERIMENTAL` is an environment variable. For more
|
||||
information about this flag visit the [Experimental docs page](/docs/experimental/)
|
||||
for more info. Without this flag enabled, triggers with the `:type` option
|
||||
will be ignored.
|
||||
</div>
|
||||
|
||||
Vagrant Disks has several options that allow users to define and attach disks to guests.
|
||||
|
||||
## Disk Options
|
||||
|
|
@ -29,12 +46,31 @@ Vagrant Disks has several options that allow users to define and attach disks to
|
|||
|
||||
## Disk Types
|
||||
|
||||
The disk config currently accepts three kinds of disk types:
|
||||
|
||||
* `disk` (symbol)
|
||||
* `dvd` (symbol)
|
||||
* `floppy` (symbol)
|
||||
|
||||
You can set a disk type with the first argument of a disk config in your Vagrantfile:
|
||||
|
||||
```ruby
|
||||
config.vm.disk :disk, name: "backup", size: "10GB"
|
||||
config.vm.disk :floppy, name: "cool_files"
|
||||
```
|
||||
|
||||
## Provider Author Guide
|
||||
|
||||
If you are a vagrant plugin author who maintains a provider for Vagrant, this short guide will hopefully give some information on how to use the internal disk config object.
|
||||
|
||||
TODO: Fill out these main points
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> This guide is still being written as we develop this
|
||||
new feature for Vagrant. Some points below are what we plan on covering once this
|
||||
feature is more fully developed in Vagrant.
|
||||
</div>
|
||||
|
||||
- Entry level builtin action `disk` and how to use it as a provider author
|
||||
- `id` is unique to each disk config object
|
||||
- `provider_config` and how to its structured and how to use/validate it
|
||||
|
||||
More information should be coming once the disk feature is more functional.
|
||||
|
|
|
|||
|
|
@ -8,9 +8,27 @@ description: |-
|
|||
|
||||
# Vagrant Disks
|
||||
|
||||
As of version 2.3.0, Vagrant is capable managing what disks are available for a given guest.
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported or functional.
|
||||
|
||||
TODO: GIVE A HIGH LEVEL OVERVIEW HERE
|
||||
This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to:
|
||||
|
||||
```
|
||||
VAGRANT_EXPERIMENTAL="disk_base_config"
|
||||
```
|
||||
|
||||
Please note that `VAGRANT_EXPERIMENTAL` is an environment variable. For more
|
||||
information about this flag visit the [Experimental docs page](/docs/experimental/)
|
||||
for more info. Without this flag enabled, triggers with the `:type` option
|
||||
will be ignored.
|
||||
|
||||
<strong>NOTE:</strong> Vagrant disks is currently a future feature for Vagrant that is not yet supported.
|
||||
Some documentation exists here for future reference, however the Disk feature is
|
||||
not yet functional. Please be patient for us to develop this new feature, and stay
|
||||
tuned for a future release of Vagrant with this new functionality!
|
||||
</div>
|
||||
|
||||
For more information about what options are available for configuring disks, see the
|
||||
[configuration section](/docs/disks/configuration.html).
|
||||
|
|
|
|||
|
|
@ -8,6 +8,23 @@ description: |-
|
|||
|
||||
# Basic Usage
|
||||
|
||||
<div class="alert alert-warning">
|
||||
<strong>Warning!</strong> This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported or functional.
|
||||
|
||||
This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to:
|
||||
|
||||
```
|
||||
VAGRANT_EXPERIMENTAL="disk_base_config"
|
||||
```
|
||||
|
||||
Please note that `VAGRANT_EXPERIMENTAL` is an environment variable. For more
|
||||
information about this flag visit the [Experimental docs page](/docs/experimental/)
|
||||
for more info. Without this flag enabled, triggers with the `:type` option
|
||||
will be ignored.
|
||||
</div>
|
||||
|
||||
Below are some very simple examples of how to use Vagrant Disks.
|
||||
|
||||
## Examples
|
||||
|
|
@ -15,4 +32,3 @@ Below are some very simple examples of how to use Vagrant Disks.
|
|||
- Resizing a disk (primary)
|
||||
- Attaching a new disk
|
||||
- Using provider specific options
|
||||
- ???
|
||||
|
|
|
|||
Loading…
Reference in New Issue