Add cloud-init user docs to usage and configuration pages

This commit is contained in:
Brian Cain 2020-06-09 08:51:03 -07:00
parent 8d77c5634c
commit 44f1365b96
No known key found for this signature in database
GPG Key ID: 9FC4639B2E4510A0
7 changed files with 30 additions and 17 deletions

View File

@ -7,7 +7,11 @@ description: Documentation of various configuration options for Vagrant cloud-in
# Configuration
Vagrant cloud-init has several options that allow users to define and attach disks to guests.
Vagrant cloud-init has several options that allow users to define a config to be
used with cloud-init.
For more detailed information about these config values and how to use cloud-init,
please read the [official documentation for cloud-init](https://cloudinit.readthedocs.io/en/latest/index.html).
## cloud_init Options
@ -24,8 +28,12 @@ given cloud_init config. Vagrant only supports the following options for `conten
+ `"text/x-include-url"`
+ `"text/x-shellscript"`
- `path` (string) - Optional argument that defines what kind of file
extension a disk should have. Defaults to `"vdi"` if unspecified. For a list of
supported disk extensions, please check the specific provider being used.
- `inline` (string) - Optional argument that defines a path on disk pointing to
the location of a disk file that already exists.
- `path` (string) - Path to a file on the host machine that containing
cloud-init user data. Incompatible with the `inline` option. This will be added
to the multipart user-data file along with its `content_type`.
- `inline` (string) - Inline cloud-init user data. Will be added to the
multipart user-data file along with its content_type. Incompatible with `path`
option.
Examples of how to define these options can be found in the
[usage documentation](/docs/cloud-init/configuration).

View File

@ -9,11 +9,10 @@ description: Introduction to using cloud-init with Vagrant
~> **Warning!** 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. Please refer to the providier specific disk documentation
for more information on how to use and enable this feature.
supported or functional.
For examples on how to achieve this, among other use cases, please refer to the [usage](/docs/cloud-init/usage)
guide for more information!
For more information about what options are available for configuring disks, see the
For more information about what options are available for configuring cloud-init, see the
[configuration section](/docs/cloud-init/configuration).

View File

@ -19,12 +19,16 @@ VAGRANT_EXPERIMENTAL="cloud_init"
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 more info. Without this flag enabled, any cloud-init configs defined will
not be configured.
Also note that the examples below use the VirtualBox provider, which is the current
supported providier for this feature.
supported provider for this feature.
Below are some very simple examples of how to use Vagrant Disks with the VirtualBox provider.
Below are some very simple examples of how to use Vagrant Cloud-Init with the VirtualBox provider.
For more detailed information about these config values and how to use cloud-init,
please read the [official documentation for cloud-init](https://cloudinit.readthedocs.io/en/latest/index.html).
## Basic Examples

View File

@ -9,7 +9,7 @@ description: Introduction to Vagrant Disks
~> **Warning!** 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. Please refer to the providier specific disk documentation
supported or functional. Please refer to the provider specific disk documentation
for more information on how to use and enable this feature.
Vagrant Disks is a feature that allows users to define what mediums should be attached

View File

@ -22,7 +22,7 @@ information about this flag visit the [Experimental docs page](/docs/experimenta
for more info. Without this flag enabled, any disks defined will not be configured.
Also note that the examples below use the VirtualBox provider, which is the current
supported providier for this feature.
supported provider for this feature.
Below are some very simple examples of how to use Vagrant Disks with the VirtualBox provider.

View File

@ -43,7 +43,7 @@ This is a list of all the valid experimental features that Vagrant recognizes:
### `cloud_init`
Enabling this feature allows Vagrant to use the `cloud-init` feature. More
information about these options can be found on the [cloud-init documentation page](/docs/cloud-init/basic_usage)
information about these options can be found on the [cloud-init documentation page](/docs/cloud-init/usage)
### `dependency_provisioners`

View File

@ -93,14 +93,16 @@ machine that Vagrant manages.
constraints.
- `config.vm.cloud_init` - Stores various [cloud_init](/docs/cloud-init) configurations
on the machine.
on the machine. __Currently experimental!__ Read the documentation for more
information on how to enable this feature.
- `config.vm.communicator` (string) - The communicator type to use to connect to the
guest box. By default this is `"ssh"`, but should be changed to `"winrm"` for
Windows guests.
- `config.vm.disk` - Stores various virtual [disk](/docs/disks) configurations
on the machine.
on the machine. __Currently experimental!__ Read the documentation for more
information on how to enable this feature.
- `config.vm.graceful_halt_timeout` (integer) - The time in seconds that Vagrant will
wait for the machine to gracefully halt when `vagrant halt` is called.