Skip to content

Umbrella Playbook

Cloud Codger edited this page Sep 4, 2026 · 1 revision

The umbrella.yml playbook

The umbrella.yml playbook will create a QEMU VM for any kind of testing you want. This can be very handy when following along with a tutorial for a new service being studied.

Like Study but primarily for Ubuntu VMs. Although it can also be used when you need two VMs for working on a tutorial or test setup.

Objective:

  • Use a static IP address and default route.
  • Use cloud_init_find_pm_host: true to dynamically select the PVE node on which to create the VM.
  • Optional: Enable the QEMU guest agent.
    • Set cloud_init_agent: true in lab-minimal/host_vars/local_umbrella.yml.
    • Set cloud_init_image to a cloud-init image with the QEMU Guest Agent pre-installed inside it. See the Builder Playbook page to create one.

Showcased roles

  • cloudcodger.proxmox_client.cloud_init

Prerequisites

Commands

Run the playbook.

ansible-playbook -i lab-minimal umbrella.yml

Once finished with the VM and no longer needing it, remove it.

ansible-playbook -i lab-minimal pve_remove_guests.yml -e remove_host_patterns=umbrella

The Process

  • Create a VM using a cloud-init image.
  • Perform an initial reboot if required and never done.

Playbook

The umbrella.yml playbook contains a single play.

Create umbrella VM play

The first play runs on local_umbrella (an alias for localhost in lab/local_aliases.yml) and has settings in lab/host_vars/local_umbrella.yml.

Role that is run:

  • cloudcodger.proxmox_client.cloud_init to:
    • Create the umbrella VM

Clone this wiki locally