An open API service indexing awesome lists of open source software.

https://github.com/marcinbojko/proxmox-kvm-packer

Proxmox and KVM Templates - Virtual Machines using packer
https://github.com/marcinbojko/proxmox-kvm-packer

almalinux kvm linux oraclelinux packer proxmox rockylinux ubuntu

Last synced: 6 months ago
JSON representation

Proxmox and KVM Templates - Virtual Machines using packer

Awesome Lists containing this project

README

        

# Proxmox and KVM related Virtual Machines using Hashicorp's Packer

![RockyLinux](https://img.shields.io/badge/Linux-Rocky-brightgreen)
![OracleLinux](https://img.shields.io/badge/Linux-Oracle-brightgreen)
![AlmaLinux](https://img.shields.io/badge/Linux-Alma-brightgreen)
![UbuntuLinux](https://img.shields.io/badge/Linux-Ubuntu-orange)
![OpenSuse](https://img.shields.io/badge/Linux-OpenSuse-darkorange)
![Windows2019](https://img.shields.io/badge/Windows-2019-blue)
![Windows2022](https://img.shields.io/badge/Windows-2022-blue)

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/marcinbojko)

- [Proxmox and KVM related Virtual Machines using Hashicorp's Packer](#proxmox-and-kvm-related-virtual-machines-using-hashicorps-packer)
- [Proxmox](#proxmox)
- [Proxmox requirements](#proxmox-requirements)
- [Usage](#usage)
- [Provisioning](#provisioning)
- [Updates](#updates)
- [KVM](#kvm)
- [KVM Requirements](#kvm-requirements)
- [Cloud-init support](#cloud-init-support)
- [RHEL](#rhel)
- [Ubuntu](#ubuntu)
- [KVM scripts usage](#kvm-scripts-usage)
- [Parameters](#parameters)
- [KVM building scripts, by OS with cloud parameters](#kvm-building-scripts-by-os-with-cloud-parameters)
- [Default credentials](#default-credentials)
- [Known Issues](#known-issues)
- [Windows UEFI boot and 'Press any key to boot from CD or DVD' issue](#windows-uefi-boot-and-press-any-key-to-boot-from-cd-or-dvd-issue)
- [OpenSuse Leap stage 2 sshd fix](#opensuse-leap-stage-2-sshd-fix)
- [To DO](#to-do)
- [Q & A](#q--a)

Consider buying me a coffee if you like my work. All donations are appreciated. All donations will be used to pay for pipeline running costs

## Proxmox

### Proxmox requirements

- [Packer](https://www.packer.io/downloads) in version >= 1.10.0
- [Proxmox](https://www.proxmox.com/en/downloads) in version >= 8.0 with any storage (tested with CEPH and ZFS)
- [Ansible] in version >= 2.10.0
- tested with `AMD Ryzen 9 5950X`, `Intel(R) Core(TM) i3-7100T`
- at least 2GB of free RAM for virtual machines (4GB recommended)
- at least 100GB of free disk space for virtual machines (200GB recommended) on fast storage (SSD/NVME with LVM thinpool, Ceph or ZFS)

### Usage

- Init packer by running `packer init config.pkr.hcl` or `packer init -upgrade config.pkr.hcl`
- Init your ansible by running `ansible-galaxy collection install --upgrade -r ./extra/playbooks/requirements.yml`
- Generate new user or token for existing user in Proxmox - `Datacenter/Pemissions/API Tokens`

Do not mark `Privilege separation` checkbox, unless you have dedicated role prepared.

Example token:

![images/token.png](images/token.png)

- create and use env variables for secrets `/secrets/proxmox.sh` with content similar to:

```bash
export PROXMOX_URL="https://someproxmoxserver:8006/api2/json"
export PROXMOX_USERNAME="root@pam!packer"
export PROXMOX_TOKEN="xxxxxxxxxxxxxxxxx"
```

- adjust required variables in `proxmox/variables*.pkvars.hcl` files especially datastore names (`storage_pool`, `iso_file`, `iso_storage_pool`) in:

```hcl
disks = {
cache_mode = "writeback"
disk_size = "50G"
format = "raw"
type = "sata"
storage_pool = "zfs"
}
```

Replace `storage_pool` variable with your storage pool name.

```ini
iso_file = "images:iso/20348.169.210806-2348.fe_release_svc_refresh_SERVER_EVAL_x64FRE_en-us.iso"
iso_storage_pool = "local"
proxmox_node = "proxmox5"
virtio_iso_file = "images:iso/virtio-win.iso"
```

Replace `iso_file` and `virtio_iso_file` with your ISO files and `iso_storage_pool` with your storage pool name. If you are using CEPH storage, you can use `ceph` as storage pool name. If you are using ZFS storage, you can use `zfs` as storage pool name. If you are using LVM storage, you can use `local` as storage pool name.

```hcl
network_adapters = {
bridge = "vmbr0"
model = "virtio"
firewall = false
mac_address = ""
}
```

Replace `bridge` with your bridge name.

- run `proxmox_generic` script with proper parameters for dedicated OS

| Command | OS FullName and Version | Boot Type |
|----------------------------------------------------------------|--------------------------------|-----------|
| ./proxmox_generic.sh -V almalinux88 -F rhel -U true | AlmaLinux 8.8 | UEFI |
| ./proxmox_generic.sh -V almalinux88 -F rhel -U false | AlmaLinux 8.8 | BIOS |
| ./proxmox_generic.sh -V almalinux89 -F rhel -U true | AlmaLinux 8.9 | UEFI |
| ./proxmox_generic.sh -V almalinux89 -F rhel -U false | AlmaLinux 8.9 | BIOS |
| ./proxmox_generic.sh -V almalinux810 -F rhel -U true | AlmaLinux 8.10 | UEFI |
| ./proxmox_generic.sh -V almalinux810 -F rhel -U false | AlmaLinux 8.10 | BIOS |
| ./proxmox_generic.sh -V almalinux92 -F rhel -U true | AlmaLinux 9.2 | UEFI |
| ./proxmox_generic.sh -V almalinux92 -F rhel -U false | AlmaLinux 9.2 | BIOS |
| ./proxmox_generic.sh -V almalinux93 -F rhel -U true | AlmaLinux 9.3 | UEFI |
| ./proxmox_generic.sh -V almalinux93 -F rhel -U false | AlmaLinux 9.3 | BIOS |
| ./proxmox_generic.sh -V almalinux94 -F rhel -U true | AlmaLinux 9.4 | UEFI |
| ./proxmox_generic.sh -V almalinux94 -F rhel -U false | AlmaLinux 9.4 | BIOS |
| ./proxmox_generic.sh -V opensuse_leap_15_5 -F sles -U true | openSUSE Leap 15.5 | UEFI |
| ./proxmox_generic.sh -V opensuse_leap_15_5 -F sles -U false | openSUSE Leap 15.5 | BIOS |
| ./proxmox_generic.sh -V opensuse_leap_15_6 -F sles -U true | openSUSE Leap 15.6 | UEFI |
| ./proxmox_generic.sh -V opensuse_leap_15_6 -F sles -U false | openSUSE Leap 15.6 | BIOS |
| ./proxmox_generic.sh -V oraclelinux810 -F rhel -U true | Oracle Linux 8.10 | UEFI |
| ./proxmox_generic.sh -V oraclelinux810 -F rhel -U false | Oracle Linux 8.10 | BIOS |
| ./proxmox_generic.sh -V oraclelinux88 -F rhel -U true | Oracle Linux 8.8 | UEFI |
| ./proxmox_generic.sh -V oraclelinux88 -F rhel -U false | Oracle Linux 8.8 | BIOS |
| ./proxmox_generic.sh -V oraclelinux89 -F rhel -U true | Oracle Linux 8.9 | UEFI |
| ./proxmox_generic.sh -V oraclelinux89 -F rhel -U false | Oracle Linux 8.9 | BIOS |
| ./proxmox_generic.sh -V oraclelinux92 -F rhel -U true | Oracle Linux 9.2 | UEFI |
| ./proxmox_generic.sh -V oraclelinux92 -F rhel -U false | Oracle Linux 9.2 | BIOS |
| ./proxmox_generic.sh -V oraclelinux93 -F rhel -U true | Oracle Linux 9.3 | UEFI |
| ./proxmox_generic.sh -V oraclelinux93 -F rhel -U false | Oracle Linux 9.3 | BIOS |
| ./proxmox_generic.sh -V oraclelinux94 -F rhel -U true | Oracle Linux 9.4 | UEFI |
| ./proxmox_generic.sh -V oraclelinux94 -F rhel -U false | Oracle Linux 9.4 | BIOS |
| ./proxmox_generic.sh -V rockylinux810 -F rhel -U true | Rocky Linux 8.10 | UEFI |
| ./proxmox_generic.sh -V rockylinux810 -F rhel -U false | Rocky Linux 8.10 | BIOS |
| ./proxmox_generic.sh -V rockylinux88 -F rhel -U true | Rocky Linux 8.8 | UEFI |
| ./proxmox_generic.sh -V rockylinux88 -F rhel -U false | Rocky Linux 8.8 | BIOS |
| ./proxmox_generic.sh -V rockylinux89 -F rhel -U true | Rocky Linux 8.9 | UEFI |
| ./proxmox_generic.sh -V rockylinux89 -F rhel -U false | Rocky Linux 8.9 | BIOS |
| ./proxmox_generic.sh -V rockylinux92 -F rhel -U true | Rocky Linux 9.2 | UEFI |
| ./proxmox_generic.sh -V rockylinux92 -F rhel -U false | Rocky Linux 9.2 | BIOS |
| ./proxmox_generic.sh -V rockylinux93 -F rhel -U true | Rocky Linux 9.3 | UEFI |
| ./proxmox_generic.sh -V rockylinux93 -F rhel -U false | Rocky Linux 9.3 | BIOS |
| ./proxmox_generic.sh -V rockylinux94 -F rhel -U true | Rocky Linux 9.4 | UEFI |
| ./proxmox_generic.sh -V rockylinux94 -F rhel -U false | Rocky Linux 9.4 | BIOS |
| ./proxmox_generic.sh -V ubuntu2204 -F ubuntu -U true | Ubuntu 22.04 | UEFI |
| ./proxmox_generic.sh -V ubuntu2204 -F ubuntu -U false | Ubuntu 22.04 | BIOS |
| ./proxmox_generic.sh -V ubuntu2304 -F ubuntu -U true | Ubuntu 23.04 | UEFI |
| ./proxmox_generic.sh -V ubuntu2304 -F ubuntu -U false | Ubuntu 23.04 | BIOS |
| ./proxmox_generic.sh -V ubuntu2404 -F ubuntu -U true | Ubuntu 24.04 | UEFI |
| ./proxmox_generic.sh -V ubuntu2404 -F ubuntu -U false | Ubuntu 24.04 | BIOS |
| ./proxmox_generic.sh -V windows2019-dc -F windows -U true | Windows Server 2019 Datacenter | UEFI |
| ./proxmox_generic.sh -V windows2019-dc -F windows -U false | Windows Server 2019 Datacenter | BIOS |
| ./proxmox_generic.sh -V windows2019-std -F windows -U true | Windows Server 2019 Standard | UEFI |
| ./proxmox_generic.sh -V windows2019-std -F windows -U false | Windows Server 2019 Standard | BIOS |
| ./proxmox_generic.sh -V windows2022-dc -F windows -U true | Windows Server 2022 Datacenter | UEFI |
| ./proxmox_generic.sh -V windows2022-dc -F windows -U false | Windows Server 2022 Datacenter | BIOS |
| ./proxmox_generic.sh -V windows2022-std -F windows -U true | Windows Server 2022 Standard | UEFI |
| ./proxmox_generic.sh -V windows2022-std -F windows -U false | Windows Server 2022 Standard | BIOS |

| OS | script | Comments|
|----|--------|---------|
| Alma Linux 8.8 | `./proxmox_almalinux_88.sh` | |
| Alma Linux 8.9 | `./proxmox_almalinux_89.sh` | |
| Alma Linux 8.10 | `./proxmox_almalinux_810.sh` | |
| Alma Linux 9.2 | `./proxmox_almalinux_92.sh` | |
| Alma Linux 9.3 | `./proxmox_almalinux_93.sh` | |
| Alma Linux 9.4 | `./proxmox_almalinux_94.sh` | |
| OpenSuse Leap 15.5 | `./proxmox_opensuse_leap_15_5.sh` | |
| Oracle Linux 8.8 | `./proxmox_oraclelinux_88.sh` | |
| Oracle Linux 8.9 | `./proxmox_oraclelinux_89.sh` | |
| Oracle Linux 8.10 | `./proxmox_oraclelinux_810.sh` | |
| Oracle Linux 9.2 | `./proxmox_oraclelinux_92.sh` | |
| Oracle Linux 9.3 | `./proxmox_oraclelinux_93.sh` | |
| Oracle Linux 9.4 | `./proxmox_oraclelinux_94.sh` | |
| Rocky Linux 8.8 | `./proxmox_rockylinux_88.sh` | |
| Rocky Linux 8.9 | `./proxmox_rockylinux_89.sh` | |
| Rocky Linux 9.2 | `./proxmox_rockylinux_92.sh` | |
| Rocky Linux 9.3 | `./proxmox_rockylinux_93.sh` | |
| Rocky Linux 9.4 | `./proxmox_rockylinux_94.sh` | |
| Ubuntu 22.04 HWE LTS | `./proxmox_ubuntu_2204_hwe.sh` | HWE Kernel|
| Ubuntu 22.04 LTS | `./proxmox_ubuntu_2204.sh` | |
| Ubuntu 23.04 | `./proxmox_ubuntu_2304.sh` | |
| Ubuntu 24.04 | `./proxmox_ubuntu_2404.sh` | |
| Microsoft Windows 2022 Datacenter | `./proxmox_windows_2022-dc.sh` |Datacenter Edition |
| Microsoft Windows 2022 Standard | `./proxmox_windows_2022-std.sh` |Standard Edition |
| Microsoft Windows 2019 Standard | `./proxmox_windows_2019-std.sh` |Standard Edition |
| Microsoft Windows 2019 Datacenter | `./proxmox_windows_2019-dc.sh` |Datacenter Edition |

### Provisioning

- For RHEl-based machines, provisioning is done by Ansible Playbooks `extra/playbooks` using variables from `variables/` folder

example:

```yaml
install_epel: true
install_webmin: false
install_hyperv: false
install_cockpit: true
install_neofetch: true
install_updates: true
install_extra_groups: true
docker_prepare: false
extra_device: ""
install_motd: true
```

- For Ubuntu-based machines provisioning is done by scripts from `extra/files/ubuntu*` folders

- For Windows-based machines provisioning is done by Powershell scripts located in `extra/scripts/windows/*`

### Updates

In case of RHEL clones, only current release is allowed to do updates, as updating for example Alma Linux 8.8 will always end in current release (8.10). This is due to the way how RHEL clones are built. To avoid that, all updates in NON current releases are disabled by setting extra variable for ansible playbook `install_updates: false`

```ini
ansible_extra_args = ["-e", "@extra/playbooks/provision_rocky8_variables.yml", "-e", "@variables/rockylinux8.yml", "-e", "{\"install_updates\": false}","--scp-extra-args", "'-O'"]
```

if you really want to start from historical release and update it to current release, remove `"-e","{\"install_updates\": false}"` from `ansible_extra_args` variable

## KVM

### KVM Requirements

- [Packer](https://www.packer.io/downloads) in version >= 1.10
- [Ansible] in version >= 2.10.0
- tested with `AMD Ryzen 9 5950X`, `Intel(R) Core(TM) i3-7100T`
- at least 2GB of free RAM for virtual machines (4GB recommended)
- KVM hypervisor

### Cloud-init support

KVM builds are separated by cloud-init groups. Currently supported groups are:

#### RHEL

- generic - generic cloud-init configuration
- oci - Oracle Cloud Infrastructure cloud-init configuration
- alicloud - Alibaba Cloud cloud-init configuration

#### Ubuntu

### KVM scripts usage

- Init packer by running `packer init config.pkr.hcl`
- Scripts have `kvm_` prefix

#### Parameters

KVM building scripts will take 2 runtime parameters:

- $1 - PACKER_LOG settings, can be 0 or 1 (can be skipped)
- $2 - cloud-init group, can be: `generic`, `oci` or `alicloud` (can be skipped)

Example:

```bash
./kvm_rockylinux92.sh 1 generic #This will build Rocky Linux 9.2 with generic cloud-init configuration and PACKER_LOG set to verbose output
```

Example 2

```bash
./kvm_rockylinux92.sh oci #This will build Rocky Linux 9.2 with oci cloud-init configuration and PACKER_LOG set to 0 (default)
```

#### KVM building scripts, by OS with cloud parameters

| OS | script | Comments|Generic|OCI|AliCloud|
|----|--------|---------|-------|---|--------|
| Alma Linux 8.7 | `./kvm_almalinux87.sh` | | generic/empty | oci | alicloud |
| Alma Linux 8.8 | `./kvm_almalinux88.sh` | | generic/empty | oci | alicloud |
| Alma Linux 8.9 | `./kvm_almalinux89.sh` | | generic/empty | oci | alicloud |
| Alma Linux 8.10 | `./kvm_almalinux810.sh` | | generic/empty | oci | alicloud |
| Alma Linux 9.0 | `./kvm_almalinux90.sh` | | generic/empty | oci | alicloud |
| Alma Linux 9.1 | `./kvm_almalinux91.sh` | | generic/empty | oci | alicloud |
| Alma Linux 9.2 | `./kvm_almalinux92.sh` | | generic/empty | oci | alicloud |
| Alma Linux 9.3 | `./kvm_almalinux93.sh` | | generic/empty | oci | alicloud |
| Alma Linux 9.4 | `./kvm_almalinux94.sh` | | generic/empty | oci | alicloud |
| Oracle Linux 8.6 | `./kvm_oraclelinux86.sh` | | generic/empty | oci | alicloud |
| Oracle Linux 8.7 | `./kvm_oraclelinux87.sh` | | generic/empty | oci | alicloud |
| Oracle Linux 8.8 | `./kvm_oraclelinux88.sh` | | generic/empty | oci | alicloud |
| Oracle Linux 8.9 | `./kvm_oraclelinux89.sh` | | generic/empty | oci | alicloud |
| Oracle Linux 8.10 | `./kvm_oraclelinux810.sh` | | generic/empty | oci | alicloud |
| Oracle Linux 9.0 | `./kvm_oraclelinux90.sh` | | generic/empty | oci | alicloud |
| Oracle Linux 9.1 | `./kvm_oraclelinux91.sh` | | generic/empty | oci | alicloud |
| Oracle Linux 9.2 | `./kvm_oraclelinux92.sh` | | generic/empty | oci | alicloud |
| Oracle Linux 9.3 | `./kvm_oraclelinux93.sh` | | generic/empty | oci | alicloud |
| Oracle Linux 9.4 | `./kvm_oraclelinux94.sh` | | generic/empty | oci | alicloud |
| Rocky Linux 8.7 | `./kvm_rockylinux87.sh` | | generic/empty | oci | alicloud |
| Rocky Linux 8.8 | `./kvm_rockylinux88.sh` | | generic/empty | oci | alicloud |
| Rocky Linux 8.9 | `./kvm_rockylinux89.sh` | | generic/empty | oci | alicloud |
| Rocky Linux 9.0 | `./kvm_rockylinux90.sh` | | generic/empty | oci | alicloud |
| Rocky Linux 9.1 | `./kvm_rockylinux91.sh` | | generic/empty | oci | alicloud |
| Rocky Linux 9.2 | `./kvm_rockylinux92.sh` | | generic/empty | oci | alicloud |
| Rocky Linux 9.3 | `./kvm_rockylinux93.sh` | | generic/empty | oci | alicloud |
| Rocky Linux 9.4 | `./kvm_rockylinux94.sh` | | generic/empty | oci | alicloud |

## Default credentials

|OS|username|password|
|--|--------|--------|
|Windows|Administrator|password|
|Alma/Rocky/Oracle|root|password|
|OpenSuse|root|password|
|Ubuntu|ubuntu|password|

## Known Issues

### Windows UEFI boot and 'Press any key to boot from CD or DVD' issue

When using the `proxmox` builder with `efi` firmware, the Windows installer will not boot automatically. Instead, it will display the message `Press any key to boot from CD or DVD` and wait for user input. User needs to properly adjust `boot_wait` and `boot_command` wait times to find the right balance between waiting for the installer to boot and waiting for the user to press a key.

### OpenSuse Leap stage 2 sshd fix

When building OpenSuse Leap 15.x sshd service starts in stage 2 which breaks packer scripts. There is an artificial delay added to builder (6 minutes) to wait for sshd to start. This is not ideal solution, but it works.

## To DO

- ansible playbooks for Windows and Ubuntu machines
- OpenSuse Leap 15.x
- OpenSuse Leap stage 2 sshd fix
- Debian 12

## Q & A

Q: Will you add support for other OSes?
A: Yes, I will add support for other OSes as I need them. If you need support for a specific OS, please open an issue and I will try to add it.

Q: Will you add support for other hypervisors?
A: No, this repository is dedicated to Proxmox and KVM. If you need support for other hypervisors, please look at my other repositories

Q: Will you add support for other cloud providers?
A: Since some of cloud providers are using KVM based hypervisors, building custom image with KVM and importing them will solve the case

Q: Will you add support RHEL and RedHat based OSes?
A: No, I will not add support for RHEL and RedHat directly, due to their licensing. However, I will add support for RHEL based OSes like AlmaLinux, Oracle Linux and Rocky Linux.

Q: Can I help?
A: Yes, please open an issue or a pull request and I will try to help you. Please split PRs into separate commits for block of changes.

Q: Can I use this repository for my own projects?
A: Yes, this repository is licensed under the Apache 2 license, so you can use it for your own projects. Please note that some of the files are licensed under different licenses, so please check the licenses of the individual files before using them