Merge pull request #12032 from soapy1/vmware-disk-docs
Add vmware disks docs
This commit is contained in:
commit
5d936330c6
@ -117,6 +117,7 @@ export default [
|
||||
'usage',
|
||||
{ category: 'virtualbox', content: ['usage', 'common-issues'] },
|
||||
{ category: 'hyperv', content: ['usage', 'common-issues'] },
|
||||
{ category: 'vmware', content: ['usage', 'common-issues'] },
|
||||
],
|
||||
},
|
||||
'multi-machine',
|
||||
|
||||
@ -28,6 +28,6 @@ off for any changes to be applied to a guest. If you make a configuration change
|
||||
with a guests disk, you will need to `vagrant reload` the guest for any changes
|
||||
to be applied.
|
||||
|
||||
For more information on how to use VirtualBox to configure disks for a guest, refer
|
||||
For more information on how to use Hyper-V to configure disks for a guest, refer
|
||||
to the [general usage](/docs/disks/usage) and [configuration](/docs/disks/configuration)
|
||||
guide for more information.
|
||||
|
||||
42
website/pages/docs/disks/vmware/common-issues.mdx
Normal file
42
website/pages/docs/disks/vmware/common-issues.mdx
Normal file
@ -0,0 +1,42 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Common Issues - Disks VMWare Provider
|
||||
sidebar_title: Common Issues
|
||||
description: |-
|
||||
HashiCorp develops an official VMware Fusion and VMware Workstation provider
|
||||
for Vagrant. This provider allows Vagrant to power VMware based machines and
|
||||
take advantage of the improved stability and performance that VMware software
|
||||
offers.
|
||||
---
|
||||
|
||||
# Common Issues and Troubleshooting
|
||||
|
||||
This page lists some common issues people run into with Vagrant and VMWare
|
||||
as well as solutions for those issues.
|
||||
|
||||
## Are my disks attached?
|
||||
|
||||
A handy way to figure out what disks are attached (or not attached) to your guest
|
||||
is to open up the VMWare GUI and open up the guest settings and selecting the
|
||||
disks options.
|
||||
|
||||
## How many disks can I attach?
|
||||
|
||||
Vagrant will attempt to attach all disks specified in the Vagrantfile. If more than
|
||||
four `ide` type disks are specified, only the first four will be attached.
|
||||
|
||||
## Applying Vagrant disk configuration changes to guests
|
||||
|
||||
Due to how VMware works, you must reload your guest for any disk config changes
|
||||
to be applied. So if you update your Vagrantfile to update or even remove disks, make
|
||||
sure to `vagrant reload` your guests for these changes to be applied. Also note, that
|
||||
Vagrant will not decrease the size of a disk.
|
||||
|
||||
## Disk functionality with snapshots
|
||||
|
||||
If snapshots exist for a VM, disk functionality will be limited. Vagrant will return
|
||||
an error for any actions that are limited due to the existence of snapshots. In order
|
||||
to restore functionality the snapshots must be removed. This can be done using the
|
||||
[`vagrant snapshot delete`](/docs/cli/snapshot) command. To delete all snapshots
|
||||
for a VMWare backed VM try `vagrant cap provider delete_all_snapshots --target <target vm name>`.
|
||||
Note once a snapshot is deleted, it can not be restored.
|
||||
35
website/pages/docs/disks/vmware/index.mdx
Normal file
35
website/pages/docs/disks/vmware/index.mdx
Normal file
@ -0,0 +1,35 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Disks for VMWare Provider
|
||||
sidebar_title: VMWare
|
||||
description: |-
|
||||
HashiCorp develops an official VMware Fusion and VMware Workstation provider
|
||||
for Vagrant. This provider allows Vagrant to power VMware based machines and
|
||||
take advantage of the improved stability and performance that VMware software
|
||||
offers.
|
||||
---
|
||||
|
||||
# VMWare
|
||||
|
||||
~> **Warning!** This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported.
|
||||
|
||||
This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to:
|
||||
|
||||
```
|
||||
VAGRANT_EXPERIMENTAL="disks"
|
||||
```
|
||||
|
||||
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, any disks defined will not be configured.
|
||||
|
||||
Because of how VMWare handles disk management, a Vagrant guest _must_ be powered
|
||||
off for any changes to be applied to a guest. If you make a configuration change
|
||||
with a guests disk, you will need to `vagrant reload` the guest for any changes
|
||||
to be applied.
|
||||
|
||||
For more information on how to use VMWare to configure disks for a guest, refer
|
||||
to the [general usage](/docs/disks/usage) and [configuration](/docs/disks/configuration)
|
||||
guide for more information.
|
||||
44
website/pages/docs/disks/vmware/usage.mdx
Normal file
44
website/pages/docs/disks/vmware/usage.mdx
Normal file
@ -0,0 +1,44 @@
|
||||
---
|
||||
layout: docs
|
||||
page_title: Usage - Disks VMWare Provider
|
||||
sidebar_title: Usage
|
||||
description: |-
|
||||
HashiCorp develops an official VMware Fusion and VMware Workstation provider
|
||||
for Vagrant. This provider allows Vagrant to power VMware based machines and
|
||||
take advantage of the improved stability and performance that VMware software
|
||||
offers.
|
||||
---
|
||||
|
||||
# Usage
|
||||
|
||||
~> **Warning!** This feature is experimental and may break or
|
||||
change in between releases. Use at your own risk. It currently is not officially
|
||||
supported.
|
||||
|
||||
This feature currently reqiures the experimental flag to be used. To explicitly enable this feature, you can set the experimental flag to:
|
||||
|
||||
```
|
||||
VAGRANT_EXPERIMENTAL="disks"
|
||||
```
|
||||
|
||||
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, any disks defined will not be configured.
|
||||
|
||||
For examples of how to use the disk feature with VMWware, please refer to the
|
||||
[general disk usage guide](/docs/disks/usage) for more examples.
|
||||
|
||||
## provider_config options
|
||||
|
||||
Vagrant supports some additional VMWware specific options for specifying disk.
|
||||
|
||||
To define a provider specific option, please refer to the [Disk Options documentation page](/docs/disks/configuration) for more info.
|
||||
|
||||
### Note about options defined below
|
||||
|
||||
It is possible these options could be out of date or stale. If you happen to see
|
||||
an option that has changed or is missing from this page, please open an issue
|
||||
or pull request on Vagrants GitHub page to correct this.
|
||||
|
||||
- `bus_type` (string) - Sets the bus type when attaching the disk. Possible options are `sata`, `ide`, and `scsi`. Defaults to `scsi`
|
||||
- `adapter_type` (string) - Sets the adapter type when creating the disk. Possible options are `ide`, `buslogic` and `lsilogic`. Defaults to `lsilogic`
|
||||
Loading…
x
Reference in New Issue
Block a user