mirror of
https://github.com/bpg/terraform-provider-proxmox.git
synced 2025-06-30 18:42:58 +00:00
63 lines
2.7 KiB
Cheetah
63 lines
2.7 KiB
Cheetah
---
|
|
layout: page
|
|
page_title: "Configure a VM with Cloud-Init"
|
|
subcategory: Guides
|
|
description: |-
|
|
This guide explains how to use the Proxmox provider to create and manage virtual machines using cloud-init.
|
|
---
|
|
|
|
# Configure a VM with Cloud-Init
|
|
|
|
## Native Proxmox Cloud-Init Support
|
|
|
|
Proxmox supports cloud-init natively, so you can use the `initialization` block to configure your VM:
|
|
|
|
{{ codefile "terraform" "examples/guides/cloud-init/native/main.tf" }}
|
|
|
|
Note that many cloud images do not have `qemu-guest-agent` installed by default, so you won't be able to retrieve the dynamic IP address of the VM from Proxmox, as this is agent's responsibility. You can use the `ip_config` block to configure a static IP address instead.
|
|
|
|
## Custom Cloud-Init Configuration
|
|
|
|
Due to several limitations of the native Proxmox cloud-init support, you may want to use a custom Cloud-Init configuration instead. This allows you to adjust the VM configuration to your needs and install the `qemu-guest-agent` and additional packages.
|
|
|
|
To use a custom cloud-init configuration, create a cloud-config snippet file and pass it to the VM as a `user_data_file_id` parameter. Use the `proxmox_virtual_environment_file` resource to create the file. Ensure the "Snippets" content type is enabled on the target datastore in Proxmox before applying the configuration below.
|
|
|
|
Note that you need to explicitly set the `hostname` in the provided cloud-init configuration, as the custom user data cloud-init config overwrites the config set by Proxmox, as shown in the example below.
|
|
|
|
{{ codefile "terraform" "examples/guides/cloud-init/custom/cloud-config.tf" }}
|
|
|
|
{{ codefile "terraform" "examples/guides/cloud-init/custom/main.tf" }}
|
|
|
|
If you wish to keep the user data cloud-init config generic, for example, when deploying multiple VMs for a Kubernetes cluster, you can use a separate snippet with the metadata cloud-init config to set the hostname. Note that it uses the `local-hostname` configuration parameter. See more details in the [cloud-init documentation](https://docs.cloud-init.io/en/latest/reference/yaml_examples/update_hostname.html).
|
|
|
|
```terraform
|
|
resource "proxmox_virtual_environment_file" "meta_data_cloud_config" {
|
|
content_type = "snippets"
|
|
datastore_id = "local"
|
|
node_name = "pve"
|
|
|
|
source_raw {
|
|
data = <<-EOF
|
|
#cloud-config
|
|
local-hostname: test-ubuntu
|
|
EOF
|
|
|
|
file_name = "meta-data-cloud-config.yaml"
|
|
}
|
|
}
|
|
```
|
|
|
|
```terraform
|
|
resource "proxmox_virtual_environment_vm" "ubuntu_vm" {
|
|
# ...
|
|
|
|
initialization {
|
|
# ...
|
|
user_data_file_id = proxmox_virtual_environment_file.user_data_cloud_config.id
|
|
meta_data_file_id = proxmox_virtual_environment_file.meta_data_cloud_config.id
|
|
}
|
|
|
|
# ...
|
|
}
|
|
```
|