Merge pull request #176 from AmedeeBulle/uefi-serial

UEFI boot,  Serial Console and Vagrant aarch64 support

Author: AmedeeBulle

oracle-linux-image-tools/.markdownlint.json

@@ -0,0 +1,6 @@
+{
+  "MD013": false,
+  "MD024": {
+    "siblings_only": true
+  }
+}

oracle-linux-image-tools/CHANGELOG.md

@@ -1,5 +1,57 @@
 # Release Notes
 
+## March 2025
+
+Note: OL7 Premier Support ended on 31 December 2024, scripts will only be maintained for the OL8 and newer images.
+
+### New Features
+
+- aarch64 support for vagrant-virtualbox (on Apple silicon)
+- UEFI support for x86_64.  
+  `BOOT_MODE` can be set to `bios`, `uefi` or `hybrid`. In hybrid mode the image is compatible with both Legacy BIOS and UEFI
+- new `SERIAL_CONSOLE_RUNTIME` build parameter to configure serial console in the generated image
+
+### Changes
+
+- The partition layout is now [GPT](https://en.wikipedia.org/wiki/GUID_Partition_Table) for all images
+- Install the audit package (allow SELinux auditing)
+
+### Bug fixes
+
+- OL9: update BLS files when grub config is updated
+- OLVM OL9 templates have now the correct OS id (was set to OL8 for compatibility reason)
+
+### Refactor
+
+- The partitioning in the _kickstart_ files is generated dynamically in the `%pre` section
+
+## November 2024
+
+### New Features
+
+- Update for OL9.5
+
+### Bug fixes
+
+- Fix regression for Vagrant Virtualbox boxes (set default NIC type to `virtio`)
+
+## September 2024
+
+### Bug fixes
+
+- Use a version-based sort on the output of osinfo-query to ensure we always use the latest available variant on the build host when creating the initial VM
+
+## May 2024
+
+### New Features
+
+- OL 8.10 & OL9.4 update
+
+### Bug fixes
+
+- Truncate `/etc/resolv.conf` in cleanup
+- Pin `kernel-uek-core` to prevent accidental removal
+
 ## March 30, 2024
 
 ### Bug fixes
@@ -33,7 +85,7 @@ As of this release, we have:
 
 Notable code changes:
 
-- Drop support for [VirtualBox](https://www.virtualbox.org/) as **builder** (you can still create Vagrant VirtualBox **images**)
+- Drop support for [VirtualBox](https://www.virtualbox.org/) as __builder__ (you can still create Vagrant VirtualBox __images__)
 - `image-scripts.sh` `::seal()` functions obsolete; code moved to `provision.sh` `::cleanup()` functions.
   We don't need anymore a separate _offline_ cleanup as `virt-customize` doesn't actually run the built VM.
 - Simplify `provision.sh` `::cleanup()` functions as most parts are now handled by `virt-sysprep` operations.

oracle-linux-image-tools/README.md

@@ -10,9 +10,9 @@ The tools are architected around _distribution flavours_ and _target clouds_.
 They currently support:
 
 - Distributions:
-  - Oracle Linux 7 update 9 -- Slim (x86_64 only)
+  - Oracle Linux 7 update 9 -- Slim (x86_64 only; deprecated)
   - Oracle Linux 8 update 10 -- Slim (x86_64 and aarch64)
-  - Oracle Linux 9 update 4 -- Slim (x86_64 and aarch64)
+  - Oracle Linux 9 update 5 -- Slim (x86_64 and aarch64)
 - Clouds:
   - Microsoft Azure cloud (x86_64)  
     Target packages: WALinuxAgent  
@@ -27,7 +27,7 @@ They currently support:
   - Oracle VM Server (OVM) (x86_64)  
     Target packages: oracle-template-config + vmapi  
     Image format: OVM OVA
-  - Vagrant (VirtualBox provider) (x86_64)  
+  - Vagrant (VirtualBox provider) (x86_64 and aarch64)  
     Target packages: VirtualBox guest additions  
     Image format: box
   - Vagrant (libvirt provider) (x86_64)  
@@ -110,7 +110,7 @@ In that case, you will have to provide an URL to an installation tree and option
 Example for an Oracle Linux 9 using the UEK boot ISO:
 
 ```Shell
-ISO_URL="https://yum.oracle.com/ISOS/OracleLinux/OL9/u4/x86_64/OracleLinux-R9-U4-x86_64-boot-uek.iso"
+ISO_URL="https://yum.oracle.com/ISOS/OracleLinux/OL9/u5/x86_64/OracleLinux-R9-U5-x86_64-boot-uek.iso"
 REPO_URL="https://yum.oracle.com/repo/OracleLinux/OL9/baseos/latest/x86_64"
 REPO[AppStream]="https://yum.oracle.com/repo/OracleLinux/OL9/appstream/x86_64"
 REPO[ol9_UEKR7]="https://yum.oracle.com/repo/OracleLinux/OL9/UEKR7/x86_64"

oracle-linux-image-tools/bin/build-image.sh

@@ -3,7 +3,7 @@
 #
 # Create minimal Oracle Linux images
 #
-# Copyright (c) 2019, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2019, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # https://oss.oracle.com/licenses/upl.
 #
@@ -189,8 +189,11 @@ load_env() {
 
   [[ "${SERIAL_CONSOLE,,}" =~ ^((yes)|(no))$ ]] || common::error "SERIAL_CONSOLE must be yes or no"
   readonly SERIAL_CONSOLE
+  [[ "${SERIAL_CONSOLE_RUNTIME,,}" =~ ^((yes)|(no))$ ]] || common::error "SERIAL_CONSOLE_RUNTIME must be yes or no"
+  readonly SERIAL_CONSOLE_RUNTIME
 
-  [[ "${BOOT_MODE,,}" =~ ^((bios)|(uefi))$ ]] || common::error "BOOT_MODE must be bios or uefi"
+
+  [[ "${BOOT_MODE,,}" =~ ^((bios)|(uefi)|(hybrid))$ ]] || common::error "BOOT_MODE must be bios, uefi or hybrid"
   readonly BOOT_MODE
 
   if [[ -z ${OS_VARIANT} ]]; then
@@ -263,7 +266,7 @@ stage_files() {
     [[ -r "${env_file}" ]] && cat "${env_file}" >> "${GLOBAL_ENV_FILE}"
   done
 
-  # Main provisionning script
+  # Main provisioning script
   cp "${BIN_DIR}/provision.sh" "${provision_path}/"
   cp "${BIN_DIR}/provision-common.sh" "${provision_path}/"
 
@@ -317,6 +320,8 @@ stage_kickstart() {
 
   cp "${DISTR_DIR}/${DISTR}/"*-ks.cfg "${ks_path}"
 
+  # This shouldn't be necessary with the current partitioning method, but we
+  # leave it for backward compatibility (OL7)
   if [[ "${SETUP_SWAP,,}" = "no" ]]; then
     sed -i -e '/^part swap /d' "${ks_path}"
   fi
@@ -368,14 +373,14 @@ image_create() {
   ISO_LABEL=$(file "${ISO_PATH}" | sed -e "s/.* '\(.*\)' .*/\1/"  -e 's/ /\\x20/g')
 
   declare -ga virt_install_args
-  # Set Serial conole
+  # Set Serial console
   if [[ "${SERIAL_CONSOLE,,}" = "yes" ]]; then
     BOOT_COMMAND+=( "${BOOT_COMMAND_SERIAL_CONSOLE[@]}" )
   else
     virt_install_args+=(--wait "${INSTALL_WAIT_TIME}" --noautoconsole)
   fi
 
-  if [[ ${BOOT_MODE,,} == uefi ]]; then
+  if [[ ${BOOT_MODE,,} != bios ]]; then
     virt_install_args+=(--boot uefi)
   fi
 
@@ -403,7 +408,7 @@ image_create() {
 }
 
 #######################################
-# Customize Oracle Linux: run provisionning scripts
+# Customize Oracle Linux: run provisioning scripts
 # Uses libguestfs to update the ${WORKSPACE}/${VM_NAME}/${VM_NAME}.qcow2
 # Globals:
 #   BUILD_INFO, MEM_SIZE, PROVISION_DIR, PROVISION_SCRIPT, SELINUX, VM_NAME, WORKSPACE

oracle-linux-image-tools/bin/provision-common.sh

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 #
-# Common functions for provisionning the VM
+# Common functions for provisioning the VM
 #
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # https://oss.oracle.com/licenses/upl.
 #
@@ -114,7 +114,7 @@ common::remove_kernels() {
 #   None
 #######################################
 common::distr_cleanup() {
-  common::echo_message "Stoppping services"
+  common::echo_message "Stopping services"
   systemctl stop rsyslog || true
   systemctl stop auditd || true
 

oracle-linux-image-tools/cloud/azure/image-scripts.sh

@@ -2,13 +2,13 @@
 #
 # Cleanup and package image for Azure
 #
-# Copyright (c) 2019, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2019, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # https://oss.oracle.com/licenses/upl
 #
 # Description: this module provides the following functions which are run on
 # the host:
-#   cloud::validate: called at the very begining to validate project parameters
+#   cloud::validate: called at the very beginning to validate project parameters
 #     (optional)
 #   cloud::customize_args: arguments to pass to virt-customize (optional)
 #   cloud::sysprep_args: arguments to pass to virt-sysprep (optional)

oracle-linux-image-tools/cloud/none/image-scripts.sh

@@ -2,13 +2,13 @@
 #
 # Cleanup and package image for the "None" image
 #
-# Copyright (c) 2019, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2019, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # https://oss.oracle.com/licenses/upl
 #
 # Description: this module provides the following functions which are run on
 # the host:
-#   cloud::validate: called at the very begining to validate project parameters
+#   cloud::validate: called at the very beginning to validate project parameters
 #     (optional)
 #   cloud::customize_args: arguments to pass to virt-customize (optional)
 #   cloud::sysprep_args: arguments to pass to virt-sysprep (optional)
@@ -20,7 +20,7 @@
 
 #######################################
 # Image packaging: do nothing
-# (Provide stub as we need a packaging fnction)
+# (Provide stub as we need a packaging function)
 # Globals:
 #   None
 # Arguments:

oracle-linux-image-tools/cloud/oci/image-scripts.sh

@@ -2,13 +2,13 @@
 #
 # Cleanup and package image for OCI
 #
-# Copyright (c) 2020, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2020, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # https://oss.oracle.com/licenses/upl
 #
 # Description: this module provides the following functions which are run on
 # the host:
-#   cloud::validate: called at the very begining to validate project parameters
+#   cloud::validate: called at the very beginning to validate project parameters
 #     (optional)
 #   cloud::customize_args: arguments to pass to virt-customize (optional)
 #   cloud::sysprep_args: arguments to pass to virt-sysprep (optional)

oracle-linux-image-tools/cloud/olvm/image-scripts.sh

@@ -2,13 +2,13 @@
 #
 # Cleanup and package image for OLVM
 #
-# Copyright (c) 2020, 2022 Oracle and/or its affiliates.
+# Copyright (c) 2020, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # https://oss.oracle.com/licenses/upl
 #
 # Description: this module provides the following functions which are run on
 # the host:
-#   cloud::validate: called at the very begining to validate project paramters
+#   cloud::validate: called at the very beginning to validate project parameters
 #     (optional)
 #   cloud::customize_args: arguments to pass to virt-customize (optional)
 #   cloud::sysprep_args: arguments to pass to virt-sysprep (optional)

oracle-linux-image-tools/cloud/olvm/mk-envelope.py

@@ -26,7 +26,7 @@
     'OL6': 5002,
     'OL7': 5003,
     'OL8': 5006,
-    'OL9': 5006,  # Use OL8 ID for now, to support older OLVM versions
+    'OL9': 5007,
 }