• HashiCorp Developer

  • HashiCorp Cloud Platform
  • Terraform
  • Packer
  • Consul
  • Vault
  • Boundary
  • Nomad
  • Waypoint
  • Vagrant
Vagrant
  • Install
  • Intro
  • Tutorials
  • Documentation
  • Vagrant Cloud
  • Try Cloud(opens in new tab)
  • Sign up
Vagrant Home

Documentation

Skip to main content
  • Documentation
    • Overview
    • Configuration
    • Usage
  • Multi-Machine

  • Vagrant Cloud

  • Resources

  • Tutorial Library
  • Community Forum
    (opens in new tab)
  • Support
    (opens in new tab)
  • GitHub
    (opens in new tab)
  1. Developer
  2. Vagrant
  3. Documentation
  4. Cloud-Init
  5. Configuration
  • Vagrant
  • v2.3.3
  • v2.3.2
  • v2.3.1
  • v2.3.0
  • v2.2.19
  • v2.2.18
  • v2.2.17
  • v2.2.16
  • v2.2.15
  • v2.2.14
  • v2.2.13
  • v2.2.12
  • v2.2.11
  • v2.2.10

ยปConfiguration

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.

cloud_init Options

It should be noted that Vagrant will not validate the correctness of the cloud-init config provided, only that a cloud-init config has been provided through path or directly inline in a Vagrantfile.

  • content_type (string) - Required argument that defines the Content-Type of the given cloud_init config. Vagrant only supports the following options for content_type:

    • "text/cloud-boothook"
    • "text/cloud-config"
    • "text/cloud-config-archive"
    • "text/jinja2"
    • "text/part-handler"
    • "text/upstart-job"
    • "text/x-include-once-url"
    • "text/x-include-url"
    • "text/x-shellscript"
  • path (string) - Path to a file on the host machine that contains cloud-init user data. This will be added to the multipart user-data file along with its content_type. Incompatible with the inline option.

  • inline (string) - Inline cloud-init user data. This 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.

cloud_init Type

When defining a config for cloud_init, you can optionally define a type for the config:

config.vm.cloud_init :user_data, content_type: "text/cloud-config", path: "config.cfg"

config.vm.cloud_init :user_data do |cloud_init|
  cloud_init.content_type = "text/cloud-config"
  cloud_init.path = "config.cfg"
end

However, this is not a requirement. Leaving off type will default to :user_data.

  • type (Symbol) - This is an optional config that defines the type of cloud-init config. Currently, the only supported type is :user_data. If a type is not defined, it will default to :user_data.
Edit this page on GitHub

On this page

  1. Configuration
  2. cloud_init Options
Give Feedback(opens in new tab)
  • Certifications
  • System Status
  • Terms of Use
  • Security
  • Privacy
  • Trademark Policy
  • Trade Controls
  • Give Feedback(opens in new tab)