From b0c2ac1d64f4b4b8b20d697804479dd7f27b45e0 Mon Sep 17 00:00:00 2001 From: Simon Cornet Date: Mon, 15 Jul 2024 15:06:01 +0200 Subject: [PATCH] [readme] feat: added script documentation --- readme.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/readme.md b/readme.md index a7dd210..cbdad68 100644 --- a/readme.md +++ b/readme.md @@ -1,25 +1,24 @@ # What does this stuff do? -Packer is a tool that can create Virtual Machine templates from code. This repository hosts the code for a customized templates used in Siempie's home environment using the Proxmox Hypervisor. +Packer is a tool that can create Virtual Machine templates from code. +This repository hosts the code for a customized templates used in Siempie's home environment using the Proxmox Hypervisor. # Template Inside the template packer does: - Install updates - Install tools; curl, qemu-guest agent, sudo and wget. - Install Ansible user with private key - - Clean guest (machine-id, logs, apt cache, etc) + - Clean guest (machine-id, logs, package cache, etc) Other information to know: - Template hostname: `localhost` - - packer username: `packer` - packer password: `packer` - - Ubuntu 24 Template: VM ID 999 More info: https://developer.hashicorp.com/packer/docs/intro -| OS | VM Name | VM ID | -|----|---------|-------| -| Ubuntu 24 | ubuntu.template.siempie.internal | 999 | +| OS | VM Name | VM ID | Script | +|----|---------|-------|--------| +| Ubuntu 24 | ubuntu.template.siempie.internal | 999 | scripts/ubuntu24.sh | # Install packer Install packer on your system: @@ -29,12 +28,17 @@ https://developer.hashicorp.com/packer/tutorials/docker-get-started/get-started- Copy the `variables.pkrvars.hcl.example` file to `variables.pkrvars.hcl` and change the variables. # Initialize the project and install the proxmox provider +This will initialize packer and install the required proxmox plugin. ``` packer init -var-file variables.pkrvars.hcl ubuntu24/packer.pkr.hcl ``` +# Customization +Since packer allows either an inline or a script execution there is a script per template. +See the table above for the specific location per template. + # Usage -Ubuntu 24 +Ubuntu 24 Template: ``` packer build -force -var-file variables.pkrvars.hcl ubuntu24/packer.pkr.hcl ```