-
Notifications
You must be signed in to change notification settings - Fork 597
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add
update-template-centos-stream.sh
```console
$ hack/update-template-centos-stream.sh
update-template-centos-stream.sh: Update the CentOS Stream image location in the specified templates
Usage:
update-template-centos-stream.sh [--version <version>] <template.yaml>...
Description:
This script updates the CentOS Stream image location in the specified templates.
If the image location in the template contains a release date in the URL, the script replaces it with the latest available date.
Image location basename format: CentOS[Stream-GenericCloud-<version>-[latest|<date>.0].<arch>.qcow2
Published CentOS Stream image information is fetched from the following URLs:
https://cloud.centos.org/centos/<major version>-stream/<arch>/images/
To parsing html, this script requires 'htmlq' or 'pup' command.
The downloaded files will be cached in the Lima cache directory.
Examples:
Update the CentOS Stream image location in templates/**.yaml:
$ update-template-centos-stream.sh templates/**.yaml
Update the CentOS Stream image location in ~/.lima/centos/lima.yaml:
$ update-template-centos-stream.sh ~/.lima/centos/lima.yaml
$ limactl factory-reset centos
Update the CentOS Stream image location to 9-Stream in ~/.lima/centos/lima.yaml:
$ update-template-centos-stream.sh --version 9-stream ~/.lima/centos/lima.yaml
$ limactl factory-reset centos
Flags:
--version <version> Use the specified version. The version must be 8 or later.
-h, --help Print this help message
```
Signed-off-by: Norio Nomura <norio.nomura@gmail.com>- Loading branch information
1 parent
c3578ed
commit 68b8d42
Showing
2 changed files
with
273 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,271 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -eu -o pipefail | ||
|
|
||
| # Functions in this script assume error handling with 'set -e'. | ||
| # To ensure 'set -e' works correctly: | ||
| # - Use 'set +e' before assignments and '$(set -e; <function>)' to capture output without exiting on errors. | ||
| # - Avoid calling functions directly in conditions to prevent disabling 'set -e'. | ||
| # - Use 'shopt -s inherit_errexit' (Bash 4.4+) to avoid repeated 'set -e' in all '$(...)'. | ||
| shopt -s inherit_errexit || error_exit "inherit_errexit not supported. Please use bash 4.4 or later." | ||
|
|
||
| function centos_print_help() { | ||
| cat <<HELP | ||
| $(basename "${BASH_SOURCE[0]}"): Update the CentOS Stream image location in the specified templates | ||
| Usage: | ||
| $(basename "${BASH_SOURCE[0]}") [--version <version>] <template.yaml>... | ||
| Description: | ||
| This script updates the CentOS Stream image location in the specified templates. | ||
| If the image location in the template contains a release date in the URL, the script replaces it with the latest available date. | ||
| Image location basename format: CentOS[Stream-GenericCloud-<version>-[latest|<date>.0].<arch>.qcow2 | ||
| Published CentOS Stream image information is fetched from the following URLs: | ||
| https://cloud.centos.org/centos/<major version>-stream/<arch>/images/ | ||
| To parsing html, this script requires 'htmlq' or 'pup' command. | ||
| The downloaded files will be cached in the Lima cache directory. | ||
| Examples: | ||
| Update the CentOS Stream image location in templates/**.yaml: | ||
| $ $(basename "${BASH_SOURCE[0]}") templates/**.yaml | ||
| Update the CentOS Stream image location in ~/.lima/centos/lima.yaml: | ||
| $ $(basename "${BASH_SOURCE[0]}") ~/.lima/centos/lima.yaml | ||
| $ limactl factory-reset centos | ||
| Update the CentOS Stream image location to 9-Stream in ~/.lima/centos/lima.yaml: | ||
| $ $(basename "${BASH_SOURCE[0]}") --version 9-stream ~/.lima/centos/lima.yaml | ||
| $ limactl factory-reset centos | ||
| Flags: | ||
| --version <version> Use the specified version. The version must be 8 or later. | ||
| -h, --help Print this help message | ||
| HELP | ||
| } | ||
|
|
||
| # print the URL spec for the given location | ||
| function centos_url_spec_from_location() { | ||
| local location=$1 jq_filter url_spec | ||
| jq_filter='capture( | ||
| "^https://cloud\\.centos\\.org/centos/(?<path_version>\\d+)-stream/(?<path_arch>[^/]+)/images/" + | ||
| "CentOS-Stream-(?<target_vendor>.*)-(?<version>\\d+(\\.[.\\d]+)?)-" + | ||
| "(latest|(?<date_and_ci_job_id>\\d{8}\\.\\d+))\\.(?<arch>[^.]+).(?<file_extension>.*)$" | ||
| ;"x")' | ||
| url_spec=$(jq -e -r "${jq_filter}" <<<"\"${location}\"") | ||
| jq -e '.path_version == .version' <<<"${url_spec}" >/dev/null || | ||
| error_exit "Validation failed: .path_version != .version: ${location}" | ||
| jq -e '.path_arch == .arch' <<<"${url_spec}" >/dev/null || | ||
| error_exit "Validation failed: .path_arch != .arch: ${location}" | ||
| echo "${url_spec}" | ||
| } | ||
| readonly centos_jq_filter_directory='"https://cloud.centos.org/centos/\(.version)-stream/\(.path_arch)/images/"' | ||
| readonly centos_jq_filter_filename='"CentOS-Stream-\(.target_vendor)-\(.version)-\(.date_and_ci_job_id // "latest").\(.arch).\(.file_extension)"' | ||
| # print the location for the given URL spec | ||
| function centos_location_from_url_spec() { | ||
| local -r url_spec=$1 | ||
| jq -e -r "${centos_jq_filter_directory} + ${centos_jq_filter_filename}" <<<"${url_spec}" || | ||
| error_exit "Failed to get the location for ${url_spec}" | ||
| } | ||
| function centos_image_directory_from_url_spec() { | ||
| local -r url_spec=$1 | ||
| jq -e -r "${centos_jq_filter_directory}" <<<"${url_spec}" || | ||
| error_exit "Failed to get the image directory for ${url_spec}" | ||
| } | ||
| function centos_image_filename_from_url_spec() { | ||
| local -r url_spec=$1 | ||
| jq -e -r "${centos_jq_filter_filename}" <<<"${url_spec}" || | ||
| error_exit "Failed to get the image filename for ${url_spec}" | ||
| } | ||
| # | ||
| function centos_latest_image_entry_for_url_spec() { | ||
| local url_spec=$1 version arch image_directory downloaded_page links_in_page latest_info | ||
| version=$(jq -r '.version' <<<"${url_spec}") | ||
| arch=$(jq -r '.arch' <<<"${url_spec}") | ||
| image_directory=$(centos_image_directory_from_url_spec "${url_spec}") | ||
| downloaded_page=$(download_to_cache "${image_directory}") | ||
| if command -v htmlq >/dev/null; then | ||
| links_in_page=$(htmlq 'td.indexcolname a' --attribute href <"${downloaded_page}") | ||
| elif command -v pup >/dev/null; then | ||
| links_in_page=$(pup 'td[class=indexcolname] a attr{href}' <"${downloaded_page}") | ||
| else | ||
| error_exit "Please install 'htmlq' or 'pup' to list images from https://cloud.centos.org/centos/${version}/${arch}/images/" | ||
| fi | ||
| latest_info=$(jq -e -Rrs --argjson spec "${url_spec}" ' | ||
| [ | ||
| split("\n").[] | | ||
| capture( | ||
| "^CentOS-Stream-\($spec.target_vendor)-\($spec.version)-(?<date_and_ci_job_id>\\d{8}\\.\\d+)\\.\($spec.arch)\\.\($spec.file_extension)$" | ||
| ;"x" | ||
| ) | ||
| ] | sort_by(.date_and_ci_job_id) | last | ||
| ' <<<"${links_in_page}") | ||
| [[ -n ${latest_info} ]] || return | ||
| local newer_url_spec location sha256sum_location downloaded_sha256sum filename digest | ||
| newer_url_spec=$(jq -e -r ". + ${latest_info}" <<<"${url_spec}") | ||
| location=$(centos_location_from_url_spec "${newer_url_spec}") | ||
| sha256sum_location="${location}.SHA256SUM" | ||
| downloaded_sha256sum=$(download_to_cache "${sha256sum_location}") | ||
| filename=$(centos_image_filename_from_url_spec "${newer_url_spec}") | ||
| digest="sha256:$(awk "/SHA256 \(${filename}\) =/{print \$4}" "${downloaded_sha256sum}")" | ||
| [[ -n ${digest} ]] || error_exit "Failed to get the SHA256 digest for ${filename}" | ||
| json_vars location arch digest | ||
| } | ||
| function centos_cache_key_for_image_kernel() { | ||
| local location=$1 overriding=${3:-"{}"} url_spec | ||
| url_spec=$(centos_url_spec_from_location "${location}" | jq -r ". + ${overriding}") | ||
| jq -r '["centos", .version, .target_vendor, | ||
| if .date_and_ci_job_id then "timestamped" else "latest" end, | ||
| .arch, .file_extension] | join(":")' <<<"${url_spec}" | ||
| } | ||
| function centos_image_entry_for_image_kernel() { | ||
| local location=$1 kernel_is_not_supported=$2 overriding=${3:-"{}"} url_spec image_entry='' | ||
| [[ ${kernel_is_not_supported} == "null" ]] || echo "Updating kernel information is not supported on CentOS Stream" >&2 | ||
| url_spec=$(centos_url_spec_from_location "${location}" | jq -r ". + ${overriding}") | ||
| if jq -e '.date_and_ci_job_id' <<<"${url_spec}" >/dev/null; then | ||
| image_entry=$(centos_latest_image_entry_for_url_spec "${url_spec}") | ||
| else | ||
| image_entry=$( | ||
| # shellcheck disable=SC2030 | ||
| location=$(centos_location_from_url_spec "${url_spec}") | ||
| location=$(validate_url_without_redirect "${location}") | ||
| arch=$(jq -r '.path_arch' <<<"${url_spec}") | ||
| json_vars location arch | ||
| ) | ||
| fi | ||
| # shellcheck disable=SC2031 | ||
| if [[ -z ${image_entry} ]]; then | ||
| error_exit "Failed to get the ${url_spec} image location for ${location}" | ||
| elif jq -e ".location == \"${location}\"" <<<"${image_entry}" >/dev/null; then | ||
| echo "Image location is up-to-date: ${location}" >&2 | ||
| else | ||
| echo "${image_entry}" | ||
| fi | ||
| } | ||
| # check if the script is executed or sourced | ||
| # shellcheck disable=SC1091 | ||
| if [[ ${BASH_SOURCE[0]} == "${0}" ]]; then | ||
| scriptdir=$(dirname "${BASH_SOURCE[0]}") | ||
| # shellcheck source=./cache-common-inc.sh | ||
| . "${scriptdir}/cache-common-inc.sh" | ||
| if ! command -v htmlq >/dev/null && ! command -v pup >/dev/null; then | ||
| error_exit "Please install 'htmlq' or 'pup' to list images from https://cloud.centos.org/centos/<version>/<arch>/images/" | ||
| fi | ||
| # shellcheck source=/dev/null # avoid shellcheck hangs on source looping | ||
| . "${scriptdir}/update-template.sh" | ||
| else | ||
| # this script is sourced | ||
| if ! command -v htmlq >/dev/null && ! command -v pup >/dev/null; then | ||
| echo "Please install 'htmlq' or 'pup' to list images from https://cloud.centos.org/centos/<version>/<arch>/images/" >&2 | ||
| elif [[ -v SUPPORTED_DISTRIBUTIONS ]]; then | ||
| SUPPORTED_DISTRIBUTIONS+=("centos") | ||
| else | ||
| declare -a SUPPORTED_DISTRIBUTIONS=("centos") | ||
| fi | ||
| return 0 | ||
| fi | ||
| declare -a templates=() | ||
| declare overriding="{}" | ||
| while [[ $# -gt 0 ]]; do | ||
| case "$1" in | ||
| -h | --help) | ||
| centos_print_help | ||
| exit 0 | ||
| ;; | ||
| -d | --debug) set -x ;; | ||
| --version) | ||
| if [[ -n $2 && $2 != -* ]]; then | ||
| overriding=$( | ||
| version="${2%%-*}" | ||
| [[ ${version} -ge 8 ]] || error_exit "CentOS Stream version must be 8 or later" | ||
| json_vars version <<<"${overriding}" | ||
| ) | ||
| shift | ||
| else | ||
| error_exit "--version requires a value" | ||
| fi | ||
| ;; | ||
| --version=*) | ||
| overriding=$( | ||
| version="${1#*=}" | ||
| version="${version%%-*}" | ||
| [[ ${version} -ge 8 ]] || error_exit "CentOS Stream version must be 8 or later" | ||
| json_vars version <<<"${overriding}" | ||
| ) | ||
| ;; | ||
| *.yaml) templates+=("$1") ;; | ||
| *) | ||
| error_exit "Unknown argument: $1" | ||
| ;; | ||
| esac | ||
| shift | ||
| [[ -z ${overriding} ]] && overriding="{}" | ||
| done | ||
| if [[ ${#templates[@]} -eq 0 ]]; then | ||
| centos_print_help | ||
| exit 0 | ||
| fi | ||
| declare -A image_entry_cache=() | ||
| for template in "${templates[@]}"; do | ||
| echo "Processing ${template}" | ||
| # 1. extract location by parsing template using arch | ||
| yq_filter=" | ||
| .images[] | [.location, .kernel.location, .kernel.cmdline] | @tsv | ||
| " | ||
| parsed=$(yq eval "${yq_filter}" "${template}") | ||
| # 3. get the image location | ||
| arr=() | ||
| while IFS= read -r line; do arr+=("${line}"); done <<<"${parsed}" | ||
| locations=("${arr[@]}") | ||
| for ((index = 0; index < ${#locations[@]}; index++)); do | ||
| [[ ${locations[index]} != "null" ]] || continue | ||
| set -e | ||
| IFS=$'\t' read -r location kernel_location kernel_cmdline <<<"${locations[index]}" | ||
| set +e # Disable 'set -e' to avoid exiting on error for the next assignment. | ||
| cache_key=$( | ||
| set -e # Enable 'set -e' for the next command. | ||
| centos_cache_key_for_image_kernel "${location}" "${kernel_location}" "${overriding}" | ||
| ) # Check exit status separately to prevent disabling 'set -e' by using the function call in the condition. | ||
| # shellcheck disable=2181 | ||
| [[ $? -eq 0 ]] || continue | ||
| image_entry=$( | ||
| set -e # Enable 'set -e' for the next command. | ||
| if [[ -v image_entry_cache[${cache_key}] ]]; then | ||
| echo "${image_entry_cache[${cache_key}]}" | ||
| else | ||
| centos_image_entry_for_image_kernel "${location}" "${kernel_location}" "${overriding}" | ||
| fi | ||
| ) # Check exit status separately to prevent disabling 'set -e' by using the function call in the condition. | ||
| # shellcheck disable=2181 | ||
| [[ $? -eq 0 ]] || continue | ||
| set -e | ||
| image_entry_cache[${cache_key}]="${image_entry}" | ||
| if [[ -n ${image_entry} ]]; then | ||
| [[ ${kernel_cmdline} != "null" ]] && | ||
| jq -e 'has("kernel")' <<<"${image_entry}" >/dev/null && | ||
| image_entry=$(jq ".kernel.cmdline = \"${kernel_cmdline}\"" <<<"${image_entry}") | ||
| echo "${image_entry}" | jq | ||
| limactl edit --log-level error --set " | ||
| .images[${index}] = ${image_entry}| | ||
| (.images[${index}] | ..) style = \"double\" | ||
| " "${template}" | ||
| fi | ||
| done | ||
| done |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters