NAPALM/napalm-proxmox
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases Wiki Activity
Files
feat/guest-os
napalm-proxmox/CHANGELOG.md
T
Christian Manivong ecff2b430d
CI / test (3.10) (push) Successful in 34s
Details
CI / test (3.11) (push) Successful in 32s
Details
CI / test (3.12) (push) Successful in 36s
Details
CI / test (3.10) (pull_request) Successful in 34s
Details
CI / test (3.11) (pull_request) Successful in 32s
Details
CI / test (3.12) (pull_request) Successful in 35s
Details
feat(vm-provision): provision FreeBSD and OpenBSD guests 
create_vm_from_cloud_init(guest_os=...) with GUEST_AGENTS from
napalm-device-types 3.0 (QEMU_GUEST_AGENTS: Linux, FreeBSD, OpenBSD). An
unknown guest_os is refused before anything is created. Found on FreeBSD
15.1 and OpenBSD 7.9 cloud images (NetOrk/netork#793):

- OS type `other` for the BSDs. OpenBSD's qemu-ga only works over ISA
  serial, and only as the second port: the image keeps its console on
  com0, so the VM gets `serial0: socket` next to `agent: 1,type=isa`.
- A BSD guest gets a network-config v2 snippet of its own
  (`cicustom: user=...,network=...`, MAC read back from net0). FreeBSD's
  nuageinit fails on the v1 Proxmox generates and then skips runcmd,
  which starts the guest agent. Linux keeps Proxmox's own.
- Packed images (FreeBSD's .qcow2.xz) are unpacked on the node after the
  packed file's checksum is verified; only the unpacked file is cached.
  download-url unpacks ISOs only, so they always take the SSH path.

Fixed on the way:
- get_vm_status skipped loopback only when it was called `lo`; OpenBSD's
  agent lists `lo0` first, so 127.0.0.1 would have been the VM's IP.
  Loopback is now recognised by its address.
- destroy_vm read cicustom after deleting the VM, when its config was gone,
  so snippets stayed on the node; it now reads them first and removes all
  of them (#15).
2026-10-08 07:53:58 +02:00

3.7 KiB
Raw Permalink Blame History

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

  • FreeBSD and OpenBSD guests: create_vm_from_cloud_init(guest_os=...) with GUEST_AGENTS from napalm-device-types 3.0. A BSD guest gets OS type other and a network-config v2 snippet of its own (cicustom network=), because FreeBSD's nuageinit skips runcmd on the v1 Proxmox generates. OpenBSD's agent runs over ISA serial behind serial0, as the image keeps its console on com0. An unknown guest_os is refused before anything is created.
  • Packed cloud images (FreeBSD's .qcow2.xz) are unpacked on the node after the packed file's checksum is verified; only the unpacked file is cached. Proxmox's download-url unpacks ISOs only, so they always go over SSH.

Fixed

  • get_vm_status no longer reports a loopback address as the VM's IP when the agent lists loopback under another name than lo (lo0 on the BSDs, listed first by OpenBSD).
  • destroy_vm reads the VM's cloud-init snippets before deleting the VM, and removes all of them; it read them afterwards, when the config was gone (#15).
  • Cloud images for create_vm_from_cloud_init are downloaded by Proxmox itself when the node has an active storage with content type import (Proxmox 8.2+): download-url with checksum verification, then import-from as the root disk. The image no longer passes through the node's root filesystem. Files are named netork-<url hash>-<name>.<qcow2|raw|vmdk> and reused; Ubuntu's .img is stored as .qcow2. Without such a storage, or for an image type Proxmox cannot import, the SSH download into /var/lib/vz/template/netork-images is used as before.
  • HypervisorDriver contract methods start_vm, stop_vm, reboot_vm, suspend_vm and get_vm_config. They accept a VM's name or vmid, raise ValueError/RuntimeError instead of returning a result dict, and wait for the Proxmox task to finish. power_vm is unchanged.
  • Snapshot methods get_vm_snapshots, create_vm_snapshot, delete_vm_snapshot, rollback_vm_snapshot for VMs and containers (containers never save RAM state).
  • reboot_host() restarts the node through the API instead of SSH.

Changed

  • get_vms() reports vmid as a string ("100"), following napalm-device-types 2.0. Ordering stays numeric.

[0.1.0] - 2024-01-01

Added

  • Initial release of the Proxmox VE NAPALM driver
  • Support for classic Linux networking (/etc/network/interfaces, Linux bridges)
  • Support for Proxmox SDN (zones: VLAN, QinQ, VXLAN, EVPN; VNets and subnets)
  • Support for Open vSwitch (OVS) bridges, bonds, and internal ports
  • Password and API token authentication via proxmoxer
  • Implemented NAPALM methods:
    • open, close, is_alive
    • get_facts
    • get_interfaces, get_interfaces_ip, get_interfaces_counters
    • get_environment (CPU, memory, temperature sensors)
    • get_arp_table (via /proc/net/arp)
    • get_mac_address_table (Linux bridge fdb + OVS appctl)
    • get_vlans (SDN VNet tags + bridge vlan show)
    • get_network_instances (SDN zones as NAPALM network instances)
    • get_ntp_servers, get_ntp_stats
    • get_snmp_information
    • get_users
    • get_config, load_merge_candidate, load_replace_candidate
    • compare_config, commit_config, discard_config, rollback
    • get_lldp_neighbors, get_lldp_neighbors_detail
    • get_ipv6_neighbors_table
    • ping, traceroute, cli
    • get_route_to
  • 149 unit tests with ~79% code coverage
  • Full type annotations
Reference in New Issue View Git Blame Copy Permalink