env.properties

# Custom parameter for the builder
# You can set / override any parameter in this file.
# Alternatively you can use it as a template and pass the actual file as
# parameter to the builder.
# You need at least provide the mandatory parameters

#
# Mandatory parameters
#

# Workspace for the builder and location of the artifacts
WORKSPACE=
# Distribution
DISTR=
# ISO_URL -- location of the ISO file for the distribution
# Can be local (file://) or remote (https://) but it must be an URL format
# If you use a "boot" ISO instead of a "full" ISO, you must also specify the
# location of the repositories (see REPO_URL and REPO[] below)
ISO_URL=
# ISO_CHECKSUM -- checksum for the ISO file
ISO_CHECKSUM=

#
# Optional parameters
#

# Cloud provider (Default is none)
# CLOUD=

# Waiting time in minutes for the OS install to complete ("virt-install" part)
# (default is 30 minutes)
# Increase for slow systems or with limited internet connection bandwidth
# Note: this is only used when SERIAL_CONSOLE=no. There is no timeout when the
# serial console is enabled.
# INSTALL_WAIT_TIME=

# ISO label of the distribution image (Default: read from image)
# Specify only if label is not retrieved properly
# ISO_LABEL=

# Location of the kernel and initrd on the distribution image.
# Typically set at distr level. When unset, let virt-install guess the Location
# (which might fail when building for a recent distr)
# BOOT_LOCATION=

# OS Variant (Default: retrieved using `osinfo-query`)
# Should only be specified if it cannot be retrieved automatically
# (e.g. host not fully up-to-date or new distribution)
# OS_VARIANT=

# Build BUILD_NUMBER (Default is 0)
# BUILD_NUMBER=

# Root access to the VM
# This is *not* needed for the build, use this only if you need root access
# to the generated image.
# (Parameters have been renamed to ensure safe defaults when using an older
# property file)
#
# Root password (Default: locked)
# The format of the ROOT_PASSWORD property is described in
# https://libguestfs.org/virt-builder.1.html#users-and-passwords
# E.g.:
# ROOT_PASSWORD="file:PASSWORD_FILE_NAME"
# ROOT_PASSWORD="password:PASSWORD_STRING"
# ROOT_PASSWORD=
#
# SSH Public key for the root user (default: no public key)
# The format of the ROOT_SSH_KEY property is described in
# https://libguestfs.org/virt-builder.1.html#ssh-keys
# E.g.:
# ROOT_SSH_KEY="file:PUBLIC_KEY_FILE_NAME"
# ROOT_SSH_KEY="string:PUBLIC_KEY_STRING"
# ROOT_SSH_KEY=
#
# Control root login over SSH (Default: prohibit-password)
# Possible values: yes, prohibit-password, forced-commands-only, or no.
# see sshd_config(5) for more details
# PERMIT_ROOT_LOGIN=

#
# Override examples
#

# Setup swap? (Yes/No, default is distribution / cloud specific)
# SETUP_SWAP=

# SELinux state (enforcing, permissive, disabled)
# SELINUX=

# Root filesystem: btrfs, xfs or lvm (Default: xfs)
# ROOT_FS=

# Set /tmp to tmpfs
# TMP_IN_TMPFS="no"

# Which kernel? (uek, rhck, modrhck, default is distribution / cloud specific)
# KERNEL=

# UEK release (distribution / cloud specific)
# UEK_RELEASE=

# Keep linux-firmware package? (Yes/No, default Yes)
# Linux firmware is not needed on VM instances, unless hardware like GPU is
# directly passed to the VM.
# Removing this package will drastically reduce the size of the image.
# Note that kernel packages have an install dependency on linux-firmware; if
# removed it will be re-installed when a new kernel is installed.
# LINUX_FIRMWARE=

# Strip locales and only keep en_US? (Yes/No, default No)
# (ol7-slim distribution only)
# STRIP_LOCALES=

# Exclude documentation (man pages, info files, doc files)? (Yes/No/Minimal,
# default: No)
# When "Yes" is selected, yum/dnf wil be configured to exclude all documentation
# ("tsflags=nodocs" parameter).
# If you plan to re-distribute the image, you might need to keep the
# "/usr/share/doc" directory which contains the packages license terms.
# The "Minimal" option will remove man pages and info files, but will keep the
# "/usr/share/doc" directory.
# EXCLUDE_DOCS=

# Number of CPUs for the build VM (Default: 4)
# CPU_NUM=
# Memory allocated to the build VM (Default: 8192)
# MEM_SIZE=

# Allocated disk size for the image, default is distribution / cloud specific
# DISK_SIZE_GB=

# Capture serial console in serial-console.txt during Kickstart. (Yes, No,
# default: no) -- Useful for debugging Kickstart issues.
# SERIAL_CONSOLE=

# Enable serial console for the generated image. (Yes, No, default: No).
# Ignore for aarch64 images which always have serial console enabled
# SERIAL_CONSOLE_RUNTIME=

# If defined, override generated VM_NAME
# VM_NAME=

# Path to a cache directory for downloaded images (absolute or relative to WORKSPACE)
# Directory will be created it if does not exists, but the parent directory must exists.
# (Default: .cache)
# CACHE_DIR=

# If your ISO_URL points to a boot iso, you need to provide:
#   - an URL to an installation tree on a remote server
#   - optionally an associative array of additional yum repositories that may
#     be used as sources for package installation.
# Example for an OL9 install:
# 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"

# OVM Image version (Default: 1.0)
# IMAGE_VERSION=

# OCI / OLVM:
# Install cloud-init? (Yes/No, default is Yes for OCI and No for OLVM)
# CLOUD_INIT=
# cloud-init user (Default is "opc" for OCI and "cloud-user" for OLVM)
# CLOUD_USER=
# OCI: Install OCI repo mapper script to use the OCI yum mirror in the region
# (Default: Yes; when set to No, the vm will use the public yum)
# OCI_REPO_MAPPER=
# OLVM: Custom script passed to Cloud-init (user data) -- Example:
# CUSTOM_SCRIPT="#cloud-config
# disable_root: true"
# CUSTOM_SCRIPT=

# OLVM:
# Generates a template instead of an image? (Yes, No, default: No)
# OLVM_TEMPLATE=

# Vagrant virtualbox
# Memory and CPU to allocate to the box by default at runtime (default: same
# as build VM values)
# VAGRANT_VIRTUALBOX_MEM_SIZE=
# VAGRANT_VIRTUALBOX_CPU_NUM=
# Additional disk to attach to the VM.
# Empty means no disk, otherwise it is the size in GB of the extra disk
# VAGRANT_VIRTUALBOX_EXTRA_DISK_GB=
# Install different Guest Additions than the ones provided by the build host.
# URL can be a local file (file:// URI)
# VAGRANT_GUEST_ADDITIONS_URL=""
# VAGRANT_GUEST_ADDITIONS_SHA256=""

# Vagrant libvirt
# Location of the vagrant libvirt create_box.sh script.
# Install the vagrant-libvirt plugin on your build machine or download the
# script from:
# https://github.com/vagrant-libvirt/vagrant-libvirt/blob/master/tools/create_box.sh
# VAGRANT_LIBVIRT_BOX_SCRIPT="${HOME}/.vagrant.d/gems/<vagrant version>/gems/vagrant-libvirt-<version>/tools/create_box.sh"
# Memory and CPU to allocate to the box by default at runtime (default: same
# as build VM values)
# VAGRANT_LIBVIRT_MEM_SIZE=
# VAGRANT_LIBVIRT_CPU_NUM=

# Vagrant all providers
# Install developer release packages (Yes/No, default: no)
# VAGRANT_DEVELOPER_REPOS=

# UTM
# Password for the OPC user
# OPC_PASSWORD=