diff --git a/ci-automation/ci-config.env b/ci-automation/ci-config.env index 4b44ddd547..6c177bb4c5 100644 --- a/ci-automation/ci-config.env +++ b/ci-automation/ci-config.env @@ -14,6 +14,7 @@ BUILDCACHE_USER="bincache" RELEASES_SERVER="mirror.release.flatcar-linux.net" CONTAINER_REGISTRY="ghcr.io/flatcar" +RELEASES_JSON_FEED="https://www.flatcar.org/releases-json/releases.json" GC_BUCKET="flatcar-linux" diff --git a/ci-automation/garbage_collect.sh b/ci-automation/garbage_collect.sh index 4ad8f4d3c4..a84e24c201 100644 --- a/ci-automation/garbage_collect.sh +++ b/ci-automation/garbage_collect.sh @@ -272,5 +272,13 @@ function _garbage_collect_impl() { source ci-automation/garbage_collect_github_ci_sdk.sh garbage_collect_github_ci 1 "${min_age_days}" + + echo + echo "########################################" + echo + echo Running Release Artifacts cache garbage collector + echo + source ci-automation/garbage_collect_releases.sh + garbage_collect_releases } # -- diff --git a/ci-automation/garbage_collect_github_ci_sdk.sh b/ci-automation/garbage_collect_github_ci_sdk.sh index 58ace907bc..6a05ca3174 100644 --- a/ci-automation/garbage_collect_github_ci_sdk.sh +++ b/ci-automation/garbage_collect_github_ci_sdk.sh @@ -41,10 +41,14 @@ function _garbage_collect_github_ci_impl() { local dry_run="${DRY_RUN:-}" local min_age_date="$(date -d "${min_age_days} days ago" +'%Y_%m_%d')" + + source ci-automation/ci_automation_common.sh + local sshcmd="$(gen_sshcmd)" + # Example version string # # - local versions_detected="$(curl -s https://bincache.flatcar-linux.net/containers/ \ + local versions_detected="$(curl -s https://${BUILDCACHE_SERVER}/containers/ \ | grep -E '\' \ | sed 's:.*\"./\([^/]\+\)/".*:\1:' )" @@ -80,9 +84,6 @@ function _garbage_collect_github_ci_impl() { print $1 }') - source ci-automation/ci_automation_common.sh - local sshcmd="$(gen_sshcmd)" - echo echo "######## The following version(s) will be purged ########" if [ "$dry_run" = "y" ] ; then diff --git a/ci-automation/garbage_collect_releases.sh b/ci-automation/garbage_collect_releases.sh new file mode 100644 index 0000000000..907dfb0673 --- /dev/null +++ b/ci-automation/garbage_collect_releases.sh @@ -0,0 +1,180 @@ +#!/bin/bash +# +# Copyright (c) 2021 The Flatcar Maintainers. +# Use of this source code is governed by a BSD-style license that can be +# found in the LICENSE file. + +# >>> This file is supposed to be SOURCED from the repository ROOT. <<< +# +# garbage_collect_releases() should be called after sourcing. +# +# OPTIONAL INPUT +# - Number releases to keep per channel. Defaults to 10. +# - Number of LTS channels to keep. Defaults to 3 (i.e. the current and the previous (deprecated) LTS). +# - DRY_RUN (Env variable). Set to "y" to just list what would be done but not +# actually purge anything. + +# Flatcar build cache releases artifacts garbage collector. +# This script removes release artifacts of past releases from the build cache. +# Note that release artifacts are copied to official mirrors upon release, so there's +# no need to keep a copy on the build cache server. + +function garbage_collect_releases() { + # Run a subshell, so the traps, environment changes and global + # variables are not spilled into the caller. + ( + set -euo pipefail + + _garbage_collect_releases_impl "${@}" + ) +} +# -- + +function _garbage_collect_releases_impl() { + local keep_per_chan="${1:-10}" + local keep_lts_releases="${2:-2}" + local dry_run="${DRY_RUN:-}" + + echo + echo "Number of versions to keep per channel: '${keep_per_chan}'" + echo "Number of LTS major releases to keep: '${keep_lts_releases}'" + echo + + source ci-automation/ci_automation_common.sh + local sshcmd="$(gen_sshcmd)" + + local keep_versions + mapfile -t keep_versions < <(unset POSIXLY_CORRECT; \ + curl -s "${RELEASES_JSON_FEED}" \ + | jq '[keys]' \ + | sed -n 's/.*"\([0-9]\+\.[0-9]\+\.[0-9]\+\)".*/\1/p' \ + | sort -Vr \ + | awk -v keep="${keep_per_chan}" -v lts="${keep_lts_releases}" ' + { + version = $1 + chan_num = gensub("[0-9]+\\.([0-9]+)\\.[0-9]+","\\1","g", version) + 0 + major = gensub("([0-9]+)\\.[0-9]+\\.[0-9]+","\\1","g", version) + 0 + + if (chan_num <= 2) { + if (chan_count[chan_num] < keep) + print version + chan_count[chan_num] = chan_count[chan_num] + 1 + } else { + if ( (chan_count["lts"][major] < keep) \ + && (length(chan_count["lts"]) <= lts) ) + print version + chan_count["lts"][major] = chan_count["lts"][major] + 1 + } + } ') + + echo + echo "######## The following version(s) will be kept ########" + if [ "$dry_run" = "y" ] ; then + echo + echo "(NOTE this is just a dry run since DRY_RUN=y)" + echo + fi + printf "%s\n" "${keep_versions[@]}" + + local dir="" + for dir in "sdk/amd64" \ + "containers" \ + "boards/amd64-usr" \ + "boards/arm64-usr" \ + "images/amd64" \ + "images/arm64" \ + "testing" \ + ; do + + local fullpath="${BUILDCACHE_PATH_PREFIX}/${dir}" + echo + echo "## Processing '${fullpath}'" + echo "---------------------------" + for version in $($sshcmd "${BUILDCACHE_USER}@${BUILDCACHE_SERVER}" \ + "ls -1 ${BUILDCACHE_PATH_PREFIX}/${dir} | grep -E '^[0-9]+\.[0-9]+\.[0-9]+$'"); do + local o_fullpath="${fullpath}/${version}" + + # skip if version is marked for keeping OR if it's a new release about to be published + if printf "%s\n" "${keep_versions[@]}" \ + | { unset POSIXLY_CORRECT ; awk -v version="${version}" -v path="${dir}" ' + BEGIN { + vmajor = gensub("([0-9]+)\\.[0-9]+\\.[0-9]+","\\1","g", version) + 0 + vminor = gensub("[0-9]+\\.([0-9]+)\\.[0-9]+","\\1","g", version) + 0 + vpatch = gensub("[0-9]+\\.[0-9]+\\.([0-9]+)","\\1","g", version) + 0 + ret = 1 + } + + { + if ($0 == version) { + print "" + print "## Skipping " version " because it is in the keep list." + ret = 0 + exit + } + + major = gensub("([0-9]+)\\.[0-9]+\\.[0-9]+","\\1","g") + 0 + minor = gensub("[0-9]+\\.([0-9]+)\\.[0-9]+","\\1","g") + 0 + patch = gensub("[0-9]+\\.[0-9]+\\.([0-9]+)","\\1","g") + 0 + + if ( ((path == "sdk/amd64") || (path == "containers")) \ + && (vmajor == major) && (vminor == 0) && (vpatch == 0) ) { + print "" + print "## Skipping " version " in " path " because it contains the SDK for release " $0 " in keep list." + ret = 0 + exit + } + + if (major_alpha == "") + major_alpha = major + + if (vmajor > major_alpha) { + print "" + print "## Skipping " version " because major version is higher than the latest Alpha (" major_alpha ") in keep list." + print "(I.e. this is an unpublished new Alpha release)" + ret = 0 + exit + } + + if ((vmajor == major) && (vminor > minor)) { + print "" + print "## Skipping " version " because major version is in keep list and minor version is higher than the latest release." + print "(I.e. this is an unpublished channel progression " $0 " -> " version ")" + ret = 0 + exit + } + + if ((vmajor == major) && (vminor == minor) && (vpatch > patch)) { + print "" + print "## Skipping " version " because major and minor versions are in keep list and patch version is higher than the latest release." + print "(I.e. this is an unpublished new patch release " $0 " -> " version ")" + ret = 0 + exit + } + } + + END { + exit ret + }' ; } then + continue + fi + + echo + echo "## Removing version '${version}' in '${o_fullpath}'" + echo + + echo "## The following files will be removed ##" + $sshcmd "${BUILDCACHE_USER}@${BUILDCACHE_SERVER}" \ + "ls -la ${o_fullpath} || true" + + if [ "$dry_run" != "y" ] ; then + set -x + $sshcmd "${BUILDCACHE_USER}@${BUILDCACHE_SERVER}" \ + "rm -rf ${o_fullpath} || true" + set +x + else + echo "## (DRY_RUN=y so not doing anything) ##" + fi + done + done +} +# --