ks2rootfs/scripts/ks2rootfs

#!/bin/bash -e
# description: CI/CD Utility helper. Builds linux rootfs file from kickstart input file in docker/podman enviroment
#       param: 1. kickstart file and 2. rootfs file name to be generated
# license: MIT.

usage() {
    cat 1>&2 <<EOF
Script to create roofs file from a kickstart file using livemedia-creator

ENVIRONMENT VARIABLES:
======================

BUILD_KICKSTART  : Reuired - Input kickstart source file (.ks)
BUILD_ROOTFS     : Required - Rootfs output file name 

BUILD_WORK_DIR   : Optional - Working dir for kickstart source and image destination. Defaults to current directory.
BUILD_OUTDIR     : Optional - Output directory name in working dir (default - 'result') - Optional
BUILD_FLAG_OUTOUT_IN_PWD : Optional - Set this flag to true to write output files in current working directory. Default value is false. When value is set to `true`, any value passed to `BUILD_OUTDIR` will be ignored.
BUILD_FLAG_WRITE_META    : Optional - Generate meta data about the kickstart build system. Default value is true.
BUILD_FLAG_RETAIN_LOG    : Optional - Retain generated output log files under 'logs' output directory. Default value is false.
BUILD_COMPTYPE   : Optional - Build compression type default 'xz', gzip and lzma.
USAGE:
    ks2rootfs KICKSTART_FILE_NAME ROOTFS_FILE_NAME

EXAMPLES:
    ks2rootfs os-minimal.ks os-minimal.tar.xz
EOF
}

run-summary() {
    cat 1>&2 <<EOF

ks2rootfs - Script input summary:

FLAGS
-----
FLAG_OUTOUT_PWD : ${BUILD_FLAG_OUTOUT_IN_PWD}
FLAG_WRITE_META : ${BUILD_FLAG_WRITE_META}
FLAG_RETAIN_LOG : ${BUILD_FLAG_RETAIN_LOG}

VARIABLES
---------
BUILD_WORK_DIR  : ${BUILD_WORK_DIR}
BUILD_OUTDIR    : ${BUILD_OUTDIR}
BUILD_LOGDIR    : ${BUILD_LOGDIR}
INPUT_KICKSTART : ${BUILD_WORK_DIR}${BUILD_KICKSTART}
OUTPUT_ROOTFS   : ${BUILD_OUTDIR}/${BUILD_ROOTFS}
BUILD_COMPTYPE  : ${BUILD_COMPTYPE}

EOF
}

BUILD_WORK_DIR=${BUILD_WORK_DIR:-./}
BUILD_KICKSTART=${BUILD_KICKSTART:-$1}
BUILD_ROOTFS=${BUILD_ROOTFS:-$2}
BUILD_FLAG_WRITE_META=${BUILD_FLAG_WRITE_META:-true}
BUILD_FLAG_RETAIN_LOG=${BUILD_FLAG_RETAIN_LOG:-false}
BUILD_FLAG_OUTOUT_IN_PWD=${BUILD_FLAG_OUTOUT_IN_PWD:-false}
BUILD_COMPTYPE=${BUILD_COMPTYPE:-xz}

USE_PWD_OUTPUT=${USE_PWD_OUTPUT:-false}

BUILD_OUTDIR=${BUILD_OUTDIR:-result}
BUILD_LOGDIR=${BUILD_OUTDIR}/logs

if [ ${BUILD_FLAG_OUTOUT_IN_PWD} == 'true' ]; then
    echo 'Build output files will be in current working folder ... ' 
    BUILD_OUTDIR=${BUILD_WORK_DIR}
else
    BUILD_OUTDIR=${BUILD_WORK_DIR}${BUILD_OUTDIR:-result}
    echo "Build output files will be in '${BUILD_OUTDIR}' folder ... " 
    if [[ -d "${BUILD_OUTDIR}" ]]; then
        echo "Output directory ${BUILD_OUTDIR} already exists, please remove it"
        exit 1
    fi
    mkdir -p ${BUILD_OUTDIR}
    if [[ -d "${BUILD_OUTDIR}" ]]; then
        echo "Output directory ${BUILD_OUTDIR} created successfully"
    else    
        echo "Error in creating output directory: ${BUILD_OUTDIR}"
        exit 1
    fi
fi


BUILD_LOGDIR=${BUILD_OUTDIR}/logs

if [ -z ${BUILD_KICKSTART} ] || [ -z ${BUILD_ROOTFS} ]
then
  echo "Please provide two parameters, kickstart source file and rootfs output file name"
  usage
  exit 1
fi

# Write run summary to console
run-summary

# set anaconda base product
cat << _EOF > /etc/anaconda/product.d/ks2rootfs.conf
# Anaconda configuration file for Kickstart to Rootfs.

[Product]
product_name = Kickstart to RootFS

[Base Product]
product_name = AlmaLinux

[Storage]
file_system_type =

[License]
eula =
_EOF

# create rootfs
livemedia-creator --logfile="/tmp/ks2rootfs.log" \
    --make-tar --ks="${BUILD_WORK_DIR}/${BUILD_KICKSTART}" --no-virt \
    --image-only --image-name="${BUILD_ROOTFS}" \
    --anaconda-arg "--product Kickstart to RootFS" \
    --compression ${BUILD_COMPTYPE}

# copy rootfs to working dir
cp -rp /var/tmp/${BUILD_ROOTFS} ${BUILD_OUTDIR}/${BUILD_ROOTFS}
echo "Copied disk image from /var/tmp/${BUILD_ROOTFS} to ${BUILD_OUTDIR}/${BUILD_ROOTFS}"

if [ ${BUILD_FLAG_WRITE_META} == 'true' ]; then
    # extract os-release info
    tar -xvf /var/tmp/${BUILD_ROOTFS} -C /tmp/ --strip-components=3 ./usr/lib/os-release
    os_release_id=$(awk -F= '$1=="ID" { print $2 ;}' /tmp/os-release | tr -d '"')
    distro_release=$(grep "${os_release_id}.*-release-" /tmp/anaconda/packaging.log | grep -o "Verifying:.*" | sed -n 's/Verifying: //p')
    if [ -z ${distro_release+x} ]; then
        exit 1
    else
        echo 'Writting meta data ... ' 
        # save distro release info
        echo "$distro_release" > ${BUILD_OUTDIR}/distro-release
    fi
    # save list of packages installed
    jq .[] -r /tmp/dnf.cache/tempfiles.json | awk -F '/' '{print $5}' | sort > ${BUILD_OUTDIR}/pkgs-list
    echo 'Writting meta data completed.'
else
    echo 'Skip writing meta data based on configuration.' 
fi

if [ ${BUILD_FLAG_RETAIN_LOG} == 'true' ]; then
    rm -rf ${BUILD_LOGDIR}
    mkdir -p ${BUILD_LOGDIR} ${BUILD_LOGDIR}/anaconda
    echo "Copying logs to '${BUILD_LOGDIR}' ..." 
    cp /tmp/ks2rootfs.log rm -rf ${BUILD_LOGDIR}/ks2rootfs.log 
    cp -rp /tmp/anaconda/* ${BUILD_LOGDIR}/anaconda
    echo 'Copying logs completed.'
else
    echo 'Skip copying logs data based on configuration (default). '
fi

cat << _EOF > "${BUILD_OUTDIR}/Dockerfile"
# This file auto generated from 'ks2rootfs' script, any changes will be over-written
FROM scratch
ADD ${BUILD_ROOTFS} /

CMD ["/bin/bash"]
_EOF
echo "Generating '${BUILD_OUTDIR}/Dockerfile' completed."