cars/packer-vsphere

Rainpole Machine Images Using HashiCorp Packer and VMware vSphere

Rainpole Machine Images

Using HashiCorp Packer and VMware vSphere to Build Private Cloud Machine Images

This repository provides examples to automate the creation of virtual machine images and their guest operating systems on VMware vSphere using HashiCorp Packer and the vsphere-iso builder. All examples are authored in the HashiCorp Configuration Language ("HCL2") instead of JSON.

The resulting machine image artifacts are, by default, converted to a virtual machine template and then transferred to a vSphere Content Library as an OVF template.

If an item of the same name exists in the target content library, Packer will update the existing item with the new OVF template. This method is extremely useful for vRealize Automation / vRealize Automation Cloud as image mappings do not need to be updated when a virtual machine image update is executed and finalized.

The following builds are automated:

Linux Distributions

• VMware Photon OS 4.0 Beta
• VMware Photon OS 3.0
• Ubuntu Server 20.04 LTS
• Ubuntu Server 18.04 LTS
• Red Hat Enterprise Linux Server 8
• Red Hat Enterprise Linux Server 7
• CentOS Server 8
• CentOS Server 7

Microsoft Windows - Core and Desktop Experience

• Microsoft Windows Server 2019 - Standard and Datacenter
• Microsoft Windows Server 2016 - Standard and Datacenter

Requirements

• macOS

• vCenter Server 7.0 U1 or higher.

• Packer 1.6.5 or higher.

  rainpole@macos> brew install hashicorp/tap/packer
  

• Windows Update Provisioner - a community provisioner for Packer.

  rainpole@macos> git clone https://github.com/rgl/packer-provisioner-windows-update.git
  

NOTE: You must place the provisioner executable in the same directory as your Packer executable /usr/local/bin or $HOME/.packer.d/plugins.

Structure

The directory structure of the repository.

packer-vsphere/ 
├── build.sh
├── redhat.pkrvars.hcl
├── vsphere.pkrvars.hcl
├── CHANGELOG.md
├── README.md
├── builds
│   └── linux
│       └── distribution version
|           (e.g. ubuntu-server-20-04-lts)
│           └── build files
|               (e.g. variables.auto.pkrvars.hcl and *.pkr.hcl)
│   └── windows
│       └── version 
|           (e.g. windows-server-2019)
│           └── build files 
│               └── build.sh
|               (e.g. variables.auto.pkrvars.hcl and *.pkr.hcl)
├── certificates
│   └── root-ca.crt
│   └── root-ca.p7b
├── configs
│   └── linux
│       └── distribution
|           (e.g. ubuntu-server)
│           └── kickstart files 
|               (e.g. ks*.cfg or ks.json)
│   └── windows
│       └── version
|           (e.g. windows-server-2019)
│           └── edition 
|               (e.g. standard-core)
│               └── bios 
│                   └── unattended files 
|                   (e.g. autounattend.xml)
│               └── efi-secure 
│                   └── unattended files 
|                   (e.g. autounattend.xml)
├── drivers
│   └── pvsci
├── keys
│   └── id_ecdsa.pub
└── scripts
│   └── linux
│       (e.g. ubuntu-server-cleanup.sh)
│   └── windows
│       (e.g. windows-server-cleanup.ps1)

Getting Started

Step 1 - Clone

Clone the GitHub repository:

Example:

rainpole@macos> git clone https://github.com/rainpole/packer-vsphere.git

Step 2 - Guest Operating Systems

1. Download the x64 guest operating system .iso images.

   Linux Distributions

   • VMware Photon OS 4.0 Beta
     • Download the latest beta release.
   • VMware Photon OS 3.0
     • Download the latest release.
   • Ubuntu Server 20.04 LTS
     • Download the latest live release.
   • Ubuntu Server 18.04 LTS
     • Download the latest legacy non-live release.
   • CentOS Server 8
     • Download the latest release.
   • CentOS Server 7
     • Download the latest release.
   • Red Hat Enterprise Linux Server 8
     • Download the latest release.
   • Red Hat Enterprise Linux Server 7
     • Download the latest release.

   Microsoft Windows

   • Microsoft Windows Server 2019
   • Microsoft Windows Server 2016

2. Rename your guest operating system .iso images. The examples in this repository generally use the format of iso-family-vendor-type-version.iso.

   For example:

   • iso-linux-photon-server-4.iso
   • iso-linux-photon-server-3.iso
   • iso-linux-ubuntu-server-20-04-lts.iso
   • iso-linux-ubuntu-server-18-04-lts.iso
   • iso-linux-redhat-server-8
   • iso-linux-redhat-server-7
   • iso-linux-centos-server-8
   • iso-linux-centos-server-7
   • iso-windows-server-2019.iso
   • iso-windows-server-2016.iso

3. Obtain the SHA-512 checksum for each guest operating system .iso image. This will be use in the build's input variables.

   • macOS terminal: shasum -a 512 [filename.iso]
   • Linux shell: sha512sum [filename.iso]
   • Windows command: certutil -hashfile [filename.iso] sha512

4. Upload your guest operating system .iso images to the iso_datastore/iso_path datastore location that will be defined in your variables. For example, [sfo-w01-ds-nfs01] /iso.

Step 3 - Input Variables

All Packer input variables are defined in HCL2 as .pkvars.hcl files.

vSphere Variables

Edit the vsphere.pkvars.hcl file to configure the following:

• Credentials
  • For the vCenter Server endpoint instance.
  • For the local build account on an image.
• vSphere Objects
• ISO Objects

Example: : vsphere.pkvars.hcl

```
# Credentials

vcenter_username = "svc-packer-vsphere@rainpole.io"
vcenter_password = "R@in!$aG00dThing."
build_username   = "rainpole"
build_password   = "R@in!$aG00dThing."

# vSphere Objects

vcenter_insecure_connection = true
vcenter_server              = "sfo-w01-vc01.sfo.rainpole.io"
vcenter_datacenter          = "sfo-w01-dc01"
vcenter_cluster             = "sfo-w01-cl01"
vcenter_datastore           = "sfo-w01-cl01-ds-vsan01"
vcenter_network             = "sfo-w01-seg-dhcp"
vcenter_folder              = "sfo-w01-fd-templates"
vcenter_content_library     = "sfo-w01-clib01"

# ISO Objects

iso_datastore = "[sfo-w01-cl01-ds-nfs01] " # The [SPACE] is required.
iso_path      = "iso"
```

Red Hat Subscription Manager Variables

Edit the redhat.pkvars.hcl file to configure the following:

• Credentials for your Red Hat Subscription Manager account.

Example: : redhat.pkvars.hcl

rhsm_username = "rainpole"
rhsm_password = "R@in!$aG00dThing."

These input variables are only used if you are performing a Red Hat Enterprise Linux Server build to register the image with Red Hat Subscription Manager and run a sudo yum update -y within the shell provisioner. Before the build completes, the image is unregistered.

Build Variables

Edit the variables.auto.pkvars.hcl file in each builds/<type>/<build> folder to configure the following, as required:

• CPU Sockets (init)

• CPU Cores (init)

• Memory in MB (init)

• Primary Disk in MB (init)

• .iso Image File (string)

• .iso Image SHA-512 Checksum (string)

  Note: All variables.auto.pkvars.hcl default to using the VMware Paravirtual SCSI controller and the VMXNET 3 network card device types.

  IMPORTANT: EFI Secure Boot is not yet used as there is a reported bug (2639957) for the vSphere Content Library. OVF Template virtual machines images with EFI set to BIOS when cloned from a vSphere Content Library. This will be resolved in a future vSphere update, and the plumbing is ready to support it.

  Example 1: Ubuntu Server 20.04 LTS

  # HTTP Settings for Kickstart
  
  http_directory = "../../../configs/linux/ubuntu-server"
  
  # Virtual Machine Settings
  
  vm_guest_os_family          = "linux" 
  vm_guest_os_vendor          = "ubuntu"
  vm_guest_os_member          = "server" 
  vm_guest_os_version         = "20-04-lts" 
  vm_guest_os_type            = "ubuntu64Guest" 
  vm_version                  = 18
  vm_firmware                 = "bios"
  vm_cpu_sockets              = 2
  vm_cpu_cores                = 1
  vm_mem_size                 = 2048
  vm_disk_size                = 40960
  vm_disk_controller_type     = ["pvscsi"]
  vm_network_card             = "vmxnet3"
  vm_boot_wait                = "2s"
  
  # ISO Objects
  
  iso_file     = "iso-linux-ubuntu-server-20-04-lts.iso"
  iso_checksum = ".........."
  
  # Scripts
  
  shell_scripts = ["../../../scripts/linux/ubuntu-server-cleanup.sh"]
  

  Example 2: Microsoft Windows Server 2019

  # Virtual Machine Settings
  
  vm_guest_os_family          = "windows"
  vm_guest_os_member          = "server" 
  vm_guest_os_version         = "2019"
  vm_guest_os_edition_std     = "standard"
  vm_guest_os_edition_dc      = "datacenter"
  vm_guest_os_type            = "windows2019srv_64Guest" 
  vm_version                  = 18
  vm_firmware                 = "bios"
  vm_boot_command             = ["<spacebar>"]
  vm_boot_wait                = "2s"
  vm_cdrom_type               = "sata"
  vm_cpu_sockets              = 2
  vm_cpu_cores                = 1
  vm_mem_size                 = 2048
  vm_disk_size                = 102400
  vm_disk_controller_type     = ["pvscsi"]
  vm_network_card             = "vmxnet3"
  vm_floppy_files_server_std_dexp = [
      "../../../configs/windows/windows-server-2019/standard/bios/autounattend.xml",
      "../../../scripts/windows/",
      "../../../drivers/windows",
      "../../../certificates/",
  ]
  vm_floppy_files_server_std_core = [
      "../../../configs/windows/windows-server-2019/standard-core/bios/autounattend.xml",
      "../../../scripts/windows/",
      "../../../drivers/windows",
      "../../../certificates/",
  ]
  vm_floppy_files_server_dc_dexp = [
      "../../../configs/windows/windows-server-2019/datacenter/bios/autounattend.xml",
      "../../../scripts/windows/",
      "../../../drivers/windows",
      "../../../certificates/",
  ]
  vm_floppy_files_server_dc_core = [
      "../../../configs/windows/windows-server-2019/datacenter-core/bios/autounattend.xml",
      "../../../scripts/windows/",
      "../../../drivers/windows",
      "../../../certificates/",
  ]
  vm_shutdown_command = "a:/windows-server-shutdown.bat"
  
  # ISO Objects
  
  iso_file      = "iso-windows-server-2019.iso"
  iso_checksum  = ".........."
  
  # Provisioner Objects
  
  powershell_scripts = [
      "../../../scripts/windows/windows-server-cleanup.ps1"
  ]
  powershell_inline = [
      "Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))",
      "choco feature enable -n allowGlobalConfirmation",
      "choco install googlechrome",
      "choco install firefox",
      "choco install postman",
      "choco install winscp",
      "choco install putty",
      "choco install vscode"
  ]
  

  Hint: You can discover the VirtualMachineGuestOsIdentifier using the vSphere 7.0 API Reference documentation.

Step 4 - Configurations and Scripts

Update the configuration and scripts files, as needed, for the Linux distributions and Microsoft Windows.

Linux Distribution Kickstart and Scripts

packer-vsphere/ 
├── configs
│   └── linux
│       └── distribution
|           (e.g. ubuntu-server)
│           └── kickstart files 
|               (e.g. ks.cfg or ks.json)
└── scripts
│   └── linux
│       (e.g. ubuntu-server-cleanup.sh)

The kickstart files for each linux distribution includes a SHA-512 encrypted password for the root account and the name and SHA-512 encrypted password for the the build user rainpole. It also adds the build user to the sudoers. Update these lines as necessary.

You can generate a SHA-512 password using various other tools like OpenSSL, mkpasswd, etc.

Example: : OpenSSL on macOS

rainpole@macos>  openssl passwd -6 
Password: ***************
Verifying - Password: ***************
[password hash]

Example: : mkpasswd on Linux

rainpole@linux>  mkpasswd --method=SHA-512 --rounds=4096
Password: ***************
[password hash]

Example 1: VMware Photon OS ks.json file.

"password":
    {
        "crypted": true,
        "text": "[password hash]"
    },
    ...
    "postinstall": [
        ...
        "useradd -m -p '[password hash]' -s /bin/bash rainpole",
        "usermod -aG sudo rainpole"
    ],

NOTE: Update the public_key with the desired public key for the root user. This will be added to the .ssh/authorized_keys file for the root account.

Example 2:

Older Ubuntu Server ks.cfg file.

# User Configuration

d-i passwd/user-fullname string rainpole

d-i passwd/username string rainpole

d-i passwd/user-password-crypted password [password hash]

# Root Configuration
d-i passwd/root-password-crypted password [password hash]

# Add User to Sudoers
d-i preseed/late_command string \
    echo 'rainpole ALL=(ALL) NOPASSWD: ALL' > /target/etc/sudoers.d/rainpole ; \
    in-target chmod 440 /etc/sudoers.d/rainpole ;

Newer Ubuntu Server user-data and meta-data files.

The user-data and meta-data files are cloud-init configuration files used to build the Ubuntu Server 20.04 LTS and later machine images. You must update the user-data file, but the contents of the meta-data file should remain empty.

Example: Ubuntu Server user-data file.

identity:
    hostname: ubuntu-server
    username: rainpole
    password: '[password hash]'

late-commands:
- echo 'rainpole ALL=(ALL) NOPASSWD:ALL' > /target/etc/sudoers.d/rainpole
- curtin in-target --target=/target -- chmod 440 /etc/sudoers.d/rainpole

Example 3: Red Hat Enterprise Linux Server and CentOS Server ks.cfg file:

rootpw [password hash] --iscrypted

user --name=rainpole --groups=wheel --iscrypted --password=[password hash]
...
echo "rainpole ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers.d/rainpole

Microsoft Windows Unattended amd Scripts

packer-vsphere/ 
├── configs
│   └── windows
│       └── version
|           (e.g. windows-server-2019)
│           └── edition 
|               (e.g. standard-core)
│               └── unattended files 
|                   (e.g. autounattend.xml)
└── scripts
│   └── windows
│       (e.g. windows-server-cleanup.sh)

The Microsoft Windows autounattend.xml files include configurations to:

• Add the Registration Name and Organization
• Set the Product Key
• Add a local account for the build user.
• Set the password for the Administrator and the build user.

If the Registration Name and Organization must be changed, update this code block in each autounattend.xml.

By default, each unattended file set the Product Key to use the KMS client setup keys.

If the password for the <UserAccounts> - which includes the administrator and build user, rainpole - and the <AutoLogon> must be changed, update these code blocks in each autounattend.xml file.

Example: Administrator and Local Accounts

<UserAccounts>
<AdministratorPassword>
    <Value>R@in!$aG00dThing.</Value>
    <PlainText>true</PlainText>
</AdministratorPassword>
<LocalAccounts>
    <LocalAccount wcm:action="add">
        <Password>
            <Value>R@in!$aG00dThing.</Value>
            <PlainText>true</PlainText>
        </Password>
        <Group>administrators</Group>
        <DisplayName>Rainpole</DisplayName>
        <Name>rainpole</Name>
        <Description>Build Account by Rainpole</Description>
    </LocalAccount>
</LocalAccounts>
</UserAccounts>

Example: Auto Logon.

<AutoLogon>
<Password>
    <Value>R@in!$aG00dThing.</Value>
    <PlainText>true</PlainText>
</Password>
<Enabled>true</Enabled>
<Username>rainpole</Username>
</AutoLogon>

If you would like to encrypt the passwords in the autounattend.xml, you can do so using the following. But please note that the can be easily decrypted.

Example: Encode a password with PowerShell on macOS.

PS /Users/rainpole> $UnEncodedText = 'R@in!$aG00dThing.'
PS /Users/rainpole> $EncodedText =[Convert]::ToBase64String([System.Text.Encoding]::Unicode.GetBytes($UnEncodedText))
PS /Users/rainpole> write-host "Encoded Password:" $EncodedText             

Encoded Password: [encoded password]

Example: Decode a password with PowerShell on macOS.

PS /Users/rainpole $DecodedText = [System.Text.Encoding]::Unicode.GetString([System.Convert]::FromBase64String($EncodedText))
PS /Users/rainpole> write-host "Decoded Password:" $DecodedText              

Decoded Password: [decoded password]

Example: Use the encoded password in a autounattend.xml file.

<Password>
    <Value>[encoded password]</Value>
    <PlainText>false</PlainText>
</Password>

Need help customizing the configuration files further?

• VMware PhotonOS - Read the PhotonOS Kickstart Documentation.

• Red Hat Enterprise Linux (and CentOS) - Use the Red Hat Kickstart Generator.

• Ubuntu Server - Install and run system-config-kickstart on a Ubuntu desktop.

  sudo apt-get install system-config-kickstart
  ssh -X rainpole@ubuntu-desktop
  sudo system-config-kickstart
  

• Microsoft Windows - Use the Microsoft Windows Answer File Generator if you need to customize the provided examples further.

NOTE: BIOS-based autounattend.xml files for Microsoft Windows included in this repository are configured to use KMS licenses, and configure Windows Remote Management and VMware Tools. UEFI-based autounattend.xml files are included for future consumption and include the addition of the GPT disk structure requirements.

Step 5 - Certificates and Keys

1. Save a copy of your Root Certificate Authority certificate to /certificates in .crt and .p7b formats.

   packer-vsphere/ 
   ├── certificates
   │   └── root-ca.crt
   │   └── root-ca.p7b
   

   These files are copied to the guest operating systems with a Packer file provisioner; after which, the a shell provisioner adds the certificate to the Trusted Certificate Authority of the guest operating system.

   NOTE: If you do not with to install the certificates on the guest operating systems, comment out the portion of the shell provisioner scripts in /scripts/ and remove the file provisioner from the prk.hcl file for each build. If you need to add an intermediate certificate, add the certificate to /certificates/ and update the shell provisioner scripts in /scripts/ with your requirements.

2. Generate a Public Key

   Generate a Public Key on macOS and Linux.

   Example: id_ecdsa.pub/

   rainpole@macos> cd .ssh/
   rainpole@macos ~/.ssh> ssh-keygen -t ecdsa -b 521 -C "code@rainpole.io"
   Generating public/private ecdsa key pair.
   Enter file in which to save the key (/Users/rainpole/.ssh/id_ecdsa): 
   Enter passphrase (empty for no passphrase): **************
   Enter same passphrase again: **************
   Your identification has been saved in /Users/rainpole/.ssh/id_ecdsa.
   Your public key has been saved in /Users/rainpole/.ssh/id_ecdsa.pub.
   The key fingerprint is:
   SHA256:O4S+1jZ3IEnBsBt8mpxv2xeRd15d2RDkdY/Q/jyuZZs code@rainpole.io
   The key's randomart image is:
   +---[ECDSA 521]---+
   |      .o    .o+o=|
   |     . .o    o.+=|
   |      + ..   oo +|
   |     . O.   o o +|
   |      B.S.   o =.|
   |     . oo.. .  .+|
   |      ..=. . ..o.|
   |      .o++. o o.o|
   |     ....o.o ..E |
   +----[SHA256]-----+
   rainpole@macos ~/.ssh> mv id_ecdsa id_ecdsa.pem
   rainpole@macos ~/.ssh> ssh-add
   Enter passphrase for /Users/rainpole/.ssh/id_ecdsa:
   Identity added: /Users/rainpole/.ssh/id_ecdsa (code@rainpole.io)
   

   Example: Copy the id_ecdsa.pub file to the keys directory.

   packer-vsphere/ 
   ├── keys
   │   └── id_ecdsa.pub
   

   This file is temporarily copied to the guest operating systems of the Linux distributions with a Packer file provisioner; after which, the a shell provisioner adds the key to the .ssh/authorized_keys file of the build_username on the guest operating system.

   IMPORTANT: You definitely must to replace this public key.

   NOTE: This release uses the newer ECDSA versus the older RSA public key algorithm.

   See Generate a New SSH Key on SSH.com.

Step 6 - Run a Build!

Start a pre-defined build by running the build script (./build.sh). The script presents a menu the which simply calls Packer and the respective build(s).

Example: Launch./build.sh.

rainpole@macos packer-examples> ./build.sh

The menu will allow you to execute and confirm a build using Packer and the vsphere-iso provisioner.

Example: Menu for ./build.sh.

  Select a HashiCorp Packer build for VMware vSphere:

      Linux Distribution:

         1  -  VMware Photon OS 4 (Beta)
         2  -  VMware Photon OS 3
         3  -  Ubuntu Server 20.04 LTS
         4  -  Ubuntu Server 18.04 LTS
         5  -  Red Hat Enterprise Linux Server 8
         6  -  Red Hat Enterprise Linux Server 7
         7  -  CentOS Server 8
         8  -  CentOS Server 7


      Microsoft Windows:

         9  -  Windows Server 2019 - All
        10  -  Windows Server 2019 - Standard Only
        11  -  Windows Server 2019 - Datacenter Only
        12  -  Windows Server 2016 - All
        13  -  Windows Server 2016 - Standard Only
        14  -  Windows Server 2016 - Datacenter Only


      Other:

        I   -  Information
        Q   -  Quit

You can also start a build based on a specific source for some of the virtual machine images.

For example, if you simply want to build a Microsoft Windows Server 2019 Standard Core, run the following:

Example: Build a specific machine image.

rainpole@macos packer-examples> cd builds/windows/windows-server-2019/
rainpole@macos windows-server-2019> packer build -force \
      --only vsphere-iso.windows-server-standard-core \
      -var-file="../../../vsphere.pkrvars.hcl" .

Happy building!!!

-- Your friends at rainpole.io.

Troubleshooting

• Read Debugging Packer Builds.

Credits:

• Maher AlAsfar @vmwarelab

  Linux Bash scripting code.

• Owen Reynolds @OVDamn

  VMware Tools for Windows installation PowerShell script.