diff --git a/website/pages/docs/cloud-init/configuration.mdx b/website/pages/docs/cloud-init/configuration.mdx index f9f93afc3..49bfecfb1 100644 --- a/website/pages/docs/cloud-init/configuration.mdx +++ b/website/pages/docs/cloud-init/configuration.mdx @@ -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). diff --git a/website/pages/docs/cloud-init/index.mdx b/website/pages/docs/cloud-init/index.mdx index cec5dbfd8..ee6760e8f 100644 --- a/website/pages/docs/cloud-init/index.mdx +++ b/website/pages/docs/cloud-init/index.mdx @@ -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). diff --git a/website/pages/docs/cloud-init/usage.mdx b/website/pages/docs/cloud-init/usage.mdx index 86c7d44cd..7874cad03 100644 --- a/website/pages/docs/cloud-init/usage.mdx +++ b/website/pages/docs/cloud-init/usage.mdx @@ -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 diff --git a/website/pages/docs/disks/index.mdx b/website/pages/docs/disks/index.mdx index bda25aeae..08c45b8e4 100644 --- a/website/pages/docs/disks/index.mdx +++ b/website/pages/docs/disks/index.mdx @@ -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 diff --git a/website/pages/docs/disks/usage.mdx b/website/pages/docs/disks/usage.mdx index 3af107510..3ab962a92 100644 --- a/website/pages/docs/disks/usage.mdx +++ b/website/pages/docs/disks/usage.mdx @@ -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. diff --git a/website/pages/docs/experimental.mdx b/website/pages/docs/experimental.mdx index 3ce0641dc..56ba11eeb 100644 --- a/website/pages/docs/experimental.mdx +++ b/website/pages/docs/experimental.mdx @@ -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` diff --git a/website/pages/docs/vagrantfile/machine_settings.mdx b/website/pages/docs/vagrantfile/machine_settings.mdx index b1d4b4c12..aa04f6f5e 100644 --- a/website/pages/docs/vagrantfile/machine_settings.mdx +++ b/website/pages/docs/vagrantfile/machine_settings.mdx @@ -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.