Makefile

#
# The following variables can be overriden from the command line
# using NAME=value make arguments
#
ARCH := $(shell uname -m)

# Options used in the 'rpm' target
USHIFT_GIT_URL ?= https://github.com/openshift/microshift.git
USHIFT_GITREF ?= main
ifeq ($(ARCH),aarch64)
OKD_VERSION_TAG ?= $$(./src/okd/get_version.sh latest-arm64)
else
OKD_VERSION_TAG ?= $$(./src/okd/get_version.sh latest-amd64)
endif
RPM_OUTDIR ?=
SRPM_WORKDIR ?=

# Options used in the 'image' target
BOOTC_IMAGE_URL ?= quay.io/centos-bootc/centos-bootc
BOOTC_IMAGE_TAG ?= stream9
WITH_KINDNET ?= 1
WITH_TOPOLVM ?= 1
WITH_OLM ?= 0
WITH_MULTUS ?= 0
EMBED_CONTAINER_IMAGES ?= 0

# Options used in the 'run' target
LVM_VOLSIZE ?= 1G
ISOLATED_NETWORK ?= 0
EXPOSE_KUBEAPI_PORT ?= 1

# Internal variables
SHELL := /bin/bash
# OKD release image URLs for different architectures
OKD_RELEASE_IMAGE_X86_64 ?= quay.io/okd/scos-release
OKD_RELEASE_IMAGE_AARCH64 ?= ghcr.io/microshift-io/okd/okd-release-arm64

RPM_IMAGE := microshift-okd-rpm
USHIFT_IMAGE := microshift-okd
SRPM_IMAGE := microshift-okd-srpm
LVM_DISK := /var/lib/microshift-okd/lvmdisk.image
VG_NAME := myvg1

PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
include $(PROJECT_DIR)/src/copr/copr.mk

#
# Define the main targets
#
.PHONY: all
all:
	@echo "make <rpm | srpm | image | run | add-node | start | stop | clean | check | env [CMD=command]>"
	@echo "   rpm:       	build the MicroShift RPMs"
	@echo "   srpm:      	build the MicroShift SRPM"
	@echo "   image:     	build the MicroShift bootc container image"
	@echo "   run:       	create and run a MicroShift cluster (1 node) in a bootc container"
	@echo "   add-node:  	add a new node to the MicroShift cluster in a bootc container"
	@echo "   start:     	start the MicroShift cluster that was already created"
	@echo "   stop:      	stop the MicroShift cluster"
	@echo "   clean:     	clean up the MicroShift cluster and the LVM backend"
	@echo "   check:     	run the presubmit checks"
	@echo "   env:       	start a shell with MicroShift kubeconfig environment"
	@echo "   env CMD=...:  run a command in MicroShift kubeconfig environment"
	@echo ""
	@echo "Sub-targets:"
	@echo "   rpm-to-deb:	convert the MicroShift RPMs to Debian packages"
	@echo "   run-ready: 	wait until the MicroShift service is ready across the cluster"
	@echo "   run-healthy:	wait until the MicroShift service is healthy across the cluster"
	@echo "   run-status:	show the status of the MicroShift cluster"
	@echo "   clean-all:	perform a full cleanup, including the container images"
	@echo ""

.PHONY: rpm
rpm: srpm
	@echo "Building the MicroShift RPMs image"
	sudo podman build \
        -t "${RPM_IMAGE}" \
        --ulimit nofile=524288:524288 \
        -f packaging/rpm.Containerfile .

	@outdir="$${RPM_OUTDIR:-$$(mktemp -d /tmp/microshift-rpms-XXXXXX)}" && \
	mntdir="$$(sudo podman image mount "${RPM_IMAGE}")" && \
	trap "sudo podman image umount '${RPM_IMAGE}' >/dev/null" EXIT && \
	sudo cp -r "$${mntdir}/home/microshift/microshift/_output/rpmbuild/RPMS/." "$${outdir}" && \
	echo -e "\nBuild completed successfully\nRPMs are available in '$${outdir}'"

.PHONY: srpm
srpm:
	@echo "Building the MicroShift SRPM image"
	sudo podman build \
        -t "${SRPM_IMAGE}" \
        --build-arg USHIFT_GIT_URL="${USHIFT_GIT_URL}" \
        --build-arg USHIFT_GITREF="${USHIFT_GITREF}" \
        --build-arg OKD_VERSION_TAG="${OKD_VERSION_TAG}" \
        --build-arg OKD_RELEASE_IMAGE_X86_64="${OKD_RELEASE_IMAGE_X86_64}" \
        --build-arg OKD_RELEASE_IMAGE_AARCH64="${OKD_RELEASE_IMAGE_AARCH64}" \
        -f packaging/srpm.Containerfile .

	@outdir="$${SRPM_WORKDIR:-$$(mktemp -d /tmp/microshift-srpms-XXXXXX)}" && \
	mntdir="$$(sudo podman image mount "${SRPM_IMAGE}")" && \
	trap "sudo podman image umount '${SRPM_IMAGE}' >/dev/null" EXIT && \
	sudo cp -r "$${mntdir}/home/microshift/microshift/_output/rpmbuild/SRPMS/." "$${outdir}" && \
	echo -e "\nBuild completed successfully\nSRPM is available in '$${outdir}'"

.PHONY: rpm-to-deb
rpm-to-deb:
	if [ -z "${RPM_OUTDIR}" ] ; then \
		echo "ERROR: RPM_OUTDIR is not set" ; \
		exit 1 ; \
	fi && \
	sudo ./src/deb/convert.sh "${RPM_OUTDIR}" && \
	echo "" && \
	echo "Conversion completed successfully" && \
	echo "Debian packages are available in '${RPM_OUTDIR}/deb'"

.PHONY: image
image:
	@if ! sudo podman image exists "${RPM_IMAGE}" ; then \
		echo "ERROR: Run 'make rpm' or 'make rpm-copr' to build the MicroShift RPMs" ; \
		exit 1 ; \
	fi

	@echo "Building the MicroShift bootc container image"
	sudo podman build \
		-t "${USHIFT_IMAGE}" \
        --ulimit nofile=524288:524288 \
        --label microshift.ref="${USHIFT_GITREF}" \
        --label okd.version="${OKD_VERSION_TAG}" \
        --build-arg BOOTC_IMAGE_URL="${BOOTC_IMAGE_URL}" \
        --build-arg BOOTC_IMAGE_TAG="${BOOTC_IMAGE_TAG}" \
    	--env WITH_KINDNET="${WITH_KINDNET}" \
    	--env WITH_TOPOLVM="${WITH_TOPOLVM}" \
    	--env WITH_OLM="${WITH_OLM}" \
    	--env WITH_MULTUS="${WITH_MULTUS}" \
    	--env EMBED_CONTAINER_IMAGES="${EMBED_CONTAINER_IMAGES}" \
        -f packaging/bootc.Containerfile .

.PHONY: run
run:
	@USHIFT_IMAGE=${USHIFT_IMAGE} ISOLATED_NETWORK=${ISOLATED_NETWORK} LVM_DISK=${LVM_DISK} LVM_VOLSIZE=${LVM_VOLSIZE} VG_NAME=${VG_NAME} EXPOSE_KUBEAPI_PORT=${EXPOSE_KUBEAPI_PORT} ./src/cluster_manager.sh create

.PHONY: add-node
add-node:
	@USHIFT_IMAGE=${USHIFT_IMAGE} ISOLATED_NETWORK=${ISOLATED_NETWORK} LVM_DISK=${LVM_DISK} LVM_VOLSIZE=${LVM_VOLSIZE} VG_NAME=${VG_NAME} EXPOSE_KUBEAPI_PORT=0 ./src/cluster_manager.sh add-node

.PHONY: start
start:
	@USHIFT_IMAGE=${USHIFT_IMAGE} ISOLATED_NETWORK=${ISOLATED_NETWORK} LVM_DISK=${LVM_DISK} LVM_VOLSIZE=${LVM_VOLSIZE} VG_NAME=${VG_NAME} EXPOSE_KUBEAPI_PORT=0 ./src/cluster_manager.sh start

.PHONY: stop
stop:
	@USHIFT_IMAGE=${USHIFT_IMAGE} ISOLATED_NETWORK=${ISOLATED_NETWORK} LVM_DISK=${LVM_DISK} LVM_VOLSIZE=${LVM_VOLSIZE} VG_NAME=${VG_NAME} ./src/cluster_manager.sh stop

.PHONY: run-ready
run-ready:
	@echo "Waiting 5m for the MicroShift service to be ready"
	@for _ in $$(seq 60); do \
		if USHIFT_IMAGE=${USHIFT_IMAGE} ISOLATED_NETWORK=${ISOLATED_NETWORK} LVM_DISK=${LVM_DISK} LVM_VOLSIZE=${LVM_VOLSIZE} VG_NAME=${VG_NAME} ./src/cluster_manager.sh ready ; then \
			printf "\nOK\n" && exit 0; \
		fi ; \
		sleep 5 ; \
	done ; \
	printf "\nFAILED\n" && exit 1

.PHONY: run-healthy
run-healthy:
	@echo "Waiting 15m for the MicroShift service to be healthy"
	@for _ in $$(seq 60); do \
		if USHIFT_IMAGE=${USHIFT_IMAGE} ISOLATED_NETWORK=${ISOLATED_NETWORK} LVM_DISK=${LVM_DISK} LVM_VOLSIZE=${LVM_VOLSIZE} VG_NAME=${VG_NAME} ./src/cluster_manager.sh healthy ; then \
			printf "\nOK\n" && exit 0; \
		fi ; \
		sleep 5 ; \
	done ; \
	printf "\nFAILED\n" && exit 1

.PHONY: run-status
run-status:
	@USHIFT_IMAGE=${USHIFT_IMAGE} ISOLATED_NETWORK=${ISOLATED_NETWORK} LVM_DISK=${LVM_DISK} LVM_VOLSIZE=${LVM_VOLSIZE} VG_NAME=${VG_NAME} ./src/cluster_manager.sh status

.PHONY: env
env: run-ready
	@USHIFT_IMAGE=${USHIFT_IMAGE} ISOLATED_NETWORK=${ISOLATED_NETWORK} LVM_DISK=${LVM_DISK} LVM_VOLSIZE=${LVM_VOLSIZE} VG_NAME=${VG_NAME} EXPOSE_KUBEAPI_PORT=1 ./src/cluster_manager.sh env "${CMD}"

.PHONY: clean
clean:
	@USHIFT_IMAGE=${USHIFT_IMAGE} ISOLATED_NETWORK=${ISOLATED_NETWORK} LVM_DISK=${LVM_DISK} LVM_VOLSIZE=${LVM_VOLSIZE} VG_NAME=${VG_NAME} ./src/cluster_manager.sh delete

.PHONY: clean-all
clean-all:
	@echo "Performing a full cleanup"
	$(MAKE) clean
	sudo podman rmi -f "${USHIFT_IMAGE}" || true
	sudo podman rmi -f "${RPM_IMAGE}" || true
	sudo podman rmi -f "${SRPM_IMAGE}" || true

.PHONY: check
check: _hadolint _shellcheck

#
# Define the private targets
#

# When run inside a container, the file contents are redirected via stdin and
# the output of errors does not contain the file path. Work around this issue
# by replacing the '^-:' token in the output by the actual file name.
.PHONY: _hadolint
_hadolint:
	set -euo pipefail && \
	RET=0 && \
	FILES=$$(find . -iname '*containerfile*' -o -iname '*dockerfile*' | grep -v "vendor\|_output\|origin\|.git") && \
	for f in $${FILES} ; do \
    	echo "$${f}" ; \
    	if ! podman run --rm -i \
        		-v "$(CURDIR)/.hadolint.yaml:/.hadolint.yaml:Z" \
        		ghcr.io/hadolint/hadolint:2.12.0 < "$${f}" | sed "s|^-:|$${f}:|" ; then \
			RET=1 ; \
		fi ; \
	done ; \
	exit $${RET}

.PHONY: _shellcheck
_shellcheck:
	shopt -s globstar nullglob && \
	podman run --rm -i \
		-v "$(CURDIR):/mnt:Z" \
		docker.io/koalaman/shellcheck:v0.11.0 --format=gcc --external-sources \
		**/*.sh