From 793a94798f5ff0397a49848ec204f6da351dcec8 Mon Sep 17 00:00:00 2001 From: Tom Plant Date: Tue, 15 Oct 2024 08:36:23 +0000 Subject: [PATCH 1/2] feat: add talosctl via Github Releases Signed-off-by: Tom Plant --- src/talosctl/README.md | 17 +++ src/talosctl/devcontainer-feature.json | 20 +++ src/talosctl/install.sh | 21 +++ src/talosctl/library_scripts.sh | 173 +++++++++++++++++++++++++ test/talosctl/scenarios.json | 8 ++ test/talosctl/test.sh | 9 ++ 6 files changed, 248 insertions(+) create mode 100644 src/talosctl/README.md create mode 100644 src/talosctl/devcontainer-feature.json create mode 100644 src/talosctl/install.sh create mode 100644 src/talosctl/library_scripts.sh create mode 100644 test/talosctl/scenarios.json create mode 100644 test/talosctl/test.sh diff --git a/src/talosctl/README.md b/src/talosctl/README.md new file mode 100644 index 000000000..9d04e0297 --- /dev/null +++ b/src/talosctl/README.md @@ -0,0 +1,17 @@ +# talosctl (via Github Releases) + +A CLI tool that interfaces with the [Talos Linux](https://www.talos.dev) API. + +## Example DevContainer Usage + +```json +"features": { + "ghcr.io/devcontainers-extra/features/talosctl:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| version | Select the version to install. | string | latest | diff --git a/src/talosctl/devcontainer-feature.json b/src/talosctl/devcontainer-feature.json new file mode 100644 index 000000000..25d9c6134 --- /dev/null +++ b/src/talosctl/devcontainer-feature.json @@ -0,0 +1,20 @@ +{ + "id": "talosctl", + "version": "1.0.0", + "name": "talosctl (via Github Releases)", + "documentationURL": "http://github.com/devcontainers-extra/features/tree/main/src/talosctl", + "description": "A CLI tool that interfaces with the Talos Linux API.", + "options": { + "version": { + "default": "latest", + "description": "Select the version to install.", + "proposals": [ + "latest" + ], + "type": "string" + } + }, + "installsAfter": [ + "ghcr.io/devcontainers-extra/features/gh-release" + ] +} \ No newline at end of file diff --git a/src/talosctl/install.sh b/src/talosctl/install.sh new file mode 100644 index 000000000..43e4a96fb --- /dev/null +++ b/src/talosctl/install.sh @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +set -e + +source ./library_scripts.sh + +# nanolayer is a cli utility which keeps container layers as small as possible +# source code: https://github.com/devcontainers-contrib/nanolayer +# `ensure_nanolayer` is a bash function that will find any existing nanolayer installations, +# and if missing - will download a temporary copy that automatically get deleted at the end +# of the script +ensure_nanolayer nanolayer_location "v0.5.6" + +# Example nanolayer installation via devcontainer-feature +$nanolayer_location \ + install \ + devcontainer-feature \ + "ghcr.io/devcontainers-extra/features/gh-release:1" \ + --option repo='siderolabs/talos' --option binaryNames='talosctl' --option version="$VERSION" + +echo 'Done!' diff --git a/src/talosctl/library_scripts.sh b/src/talosctl/library_scripts.sh new file mode 100644 index 000000000..496144c47 --- /dev/null +++ b/src/talosctl/library_scripts.sh @@ -0,0 +1,173 @@ +#!/usr/bin/env bash + +clean_download() { + # The purpose of this function is to download a file with minimal impact on container layer size + # this means if no valid downloader is found (curl or wget) then we install a downloader (currently wget) in a + # temporary manner, and making sure to + # 1. uninstall the downloader at the return of the function + # 2. revert back any changes to the package installer database/cache (for example apt-get lists) + # The above steps will minimize the leftovers being created while installing the downloader + # Supported distros: + # debian/ubuntu/alpine + + url=$1 + output_location=$2 + tempdir=$(mktemp -d) + downloader_installed="" + + function _apt_get_install() { + tempdir=$1 + + # copy current state of apt list - in order to revert back later (minimize contianer layer size) + cp -p -R /var/lib/apt/lists $tempdir + apt-get update -y + apt-get -y install --no-install-recommends wget ca-certificates + } + + function _apt_get_cleanup() { + tempdir=$1 + + echo "removing wget" + apt-get -y purge wget --auto-remove + + echo "revert back apt lists" + rm -rf /var/lib/apt/lists/* + rm -r /var/lib/apt/lists && mv $tempdir/lists /var/lib/apt/lists + } + + function _apk_install() { + tempdir=$1 + # copy current state of apk cache - in order to revert back later (minimize contianer layer size) + cp -p -R /var/cache/apk $tempdir + + apk add --no-cache wget + } + + function _apk_cleanup() { + tempdir=$1 + + echo "removing wget" + apk del wget + } + # try to use either wget or curl if one of them already installer + if type curl >/dev/null 2>&1; then + downloader=curl + elif type wget >/dev/null 2>&1; then + downloader=wget + else + downloader="" + fi + + # in case none of them is installed, install wget temporarly + if [ -z $downloader ]; then + if [ -x "/usr/bin/apt-get" ]; then + _apt_get_install $tempdir + elif [ -x "/sbin/apk" ]; then + _apk_install $tempdir + else + echo "distro not supported" + exit 1 + fi + downloader="wget" + downloader_installed="true" + fi + + if [ $downloader = "wget" ]; then + wget -q $url -O $output_location + else + curl -sfL $url -o $output_location + fi + + # NOTE: the cleanup procedure was not implemented using `trap X RETURN` only because + # alpine lack bash, and RETURN is not a valid signal under sh shell + if ! [ -z $downloader_installed ]; then + if [ -x "/usr/bin/apt-get" ]; then + _apt_get_cleanup $tempdir + elif [ -x "/sbin/apk" ]; then + _apk_cleanup $tempdir + else + echo "distro not supported" + exit 1 + fi + fi + +} + +ensure_nanolayer() { + # Ensure existance of the nanolayer cli program + local variable_name=$1 + + local required_version=$2 + # normalize version + if ! [[ $required_version == v* ]]; then + required_version=v$required_version + fi + + local nanolayer_location="" + + # If possible - try to use an already installed nanolayer + if [[ -z "${NANOLAYER_FORCE_CLI_INSTALLATION}" ]]; then + if [[ -z "${NANOLAYER_CLI_LOCATION}" ]]; then + if type nanolayer >/dev/null 2>&1; then + echo "Found a pre-existing nanolayer in PATH" + nanolayer_location=nanolayer + fi + elif [ -f "${NANOLAYER_CLI_LOCATION}" ] && [ -x "${NANOLAYER_CLI_LOCATION}" ]; then + nanolayer_location=${NANOLAYER_CLI_LOCATION} + echo "Found a pre-existing nanolayer which were given in env variable: $nanolayer_location" + fi + + # make sure its of the required version + if ! [[ -z "${nanolayer_location}" ]]; then + local current_version + current_version=$($nanolayer_location --version) + if ! [[ $current_version == v* ]]; then + current_version=v$current_version + fi + + if ! [ $current_version == $required_version ]; then + echo "skipping usage of pre-existing nanolayer. (required version $required_version does not match existing version $current_version)" + nanolayer_location="" + fi + fi + + fi + + # If not previuse installation found, download it temporarly and delete at the end of the script + if [[ -z "${nanolayer_location}" ]]; then + + if [ "$(uname -sm)" == "Linux x86_64" ] || [ "$(uname -sm)" == "Linux aarch64" ]; then + tmp_dir=$(mktemp -d -t nanolayer-XXXXXXXXXX) + + clean_up() { + ARG=$? + rm -rf $tmp_dir + exit $ARG + } + trap clean_up EXIT + + if [ -x "/sbin/apk" ]; then + clib_type=musl + else + clib_type=gnu + fi + + tar_filename=nanolayer-"$(uname -m)"-unknown-linux-$clib_type.tgz + + # clean download will minimize leftover in case a downloaderlike wget or curl need to be installed + clean_download https://github.com/devcontainers-contrib/cli/releases/download/$required_version/$tar_filename $tmp_dir/$tar_filename + + tar xfzv $tmp_dir/$tar_filename -C "$tmp_dir" + chmod a+x $tmp_dir/nanolayer + nanolayer_location=$tmp_dir/nanolayer + + else + echo "No binaries compiled for non-x86-linux architectures yet: $(uname -m)" + exit 1 + fi + fi + + # Expose outside the resolved location + declare -g ${variable_name}=$nanolayer_location + +} diff --git a/test/talosctl/scenarios.json b/test/talosctl/scenarios.json new file mode 100644 index 000000000..e5fd55cf2 --- /dev/null +++ b/test/talosctl/scenarios.json @@ -0,0 +1,8 @@ +{ + "test": { + "image": "mcr.microsoft.com/devcontainers/base:debian", + "features": { + "talosctl": {} + } + } +} \ No newline at end of file diff --git a/test/talosctl/test.sh b/test/talosctl/test.sh new file mode 100644 index 000000000..40bc30bc1 --- /dev/null +++ b/test/talosctl/test.sh @@ -0,0 +1,9 @@ +#!/usr/bin/env bash + +set -e + +source dev-container-features-test-lib + +check "talosctl version --client" talosctl version --client + +reportResults From 5fac77dccd0bc47b075fd414bec44478c07438a7 Mon Sep 17 00:00:00 2001 From: Tom Plant Date: Sat, 19 Oct 2024 01:58:14 +0000 Subject: [PATCH 2/2] fix: talosctl exclude prereleases and add version test Signed-off-by: Tom Plant --- src/talosctl/install.sh | 2 +- test/talosctl/scenarios.json | 8 ++++++++ test/talosctl/test.sh | 2 +- test/talosctl/test_specific_version.sh | 9 +++++++++ 4 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 test/talosctl/test_specific_version.sh diff --git a/src/talosctl/install.sh b/src/talosctl/install.sh index 43e4a96fb..53a093a80 100644 --- a/src/talosctl/install.sh +++ b/src/talosctl/install.sh @@ -16,6 +16,6 @@ $nanolayer_location \ install \ devcontainer-feature \ "ghcr.io/devcontainers-extra/features/gh-release:1" \ - --option repo='siderolabs/talos' --option binaryNames='talosctl' --option version="$VERSION" + --option repo='siderolabs/talos' --option binaryNames='talosctl' --option version="$VERSION" --option releaseTagRegex='^(?!.*(alpha|beta)).*$' echo 'Done!' diff --git a/test/talosctl/scenarios.json b/test/talosctl/scenarios.json index e5fd55cf2..f49126646 100644 --- a/test/talosctl/scenarios.json +++ b/test/talosctl/scenarios.json @@ -4,5 +4,13 @@ "features": { "talosctl": {} } + }, + "test_specific_version": { + "image": "mcr.microsoft.com/devcontainers/base:debian", + "features": { + "talosctl": { + "version": "v1.8.0" + } + } } } \ No newline at end of file diff --git a/test/talosctl/test.sh b/test/talosctl/test.sh index 40bc30bc1..f61a3bdbf 100644 --- a/test/talosctl/test.sh +++ b/test/talosctl/test.sh @@ -4,6 +4,6 @@ set -e source dev-container-features-test-lib -check "talosctl version --client" talosctl version --client +check "talosctl is installed" talosctl version --client reportResults diff --git a/test/talosctl/test_specific_version.sh b/test/talosctl/test_specific_version.sh new file mode 100644 index 000000000..af227ba9e --- /dev/null +++ b/test/talosctl/test_specific_version.sh @@ -0,0 +1,9 @@ +#!/usr/bin/env bash + +set -e + +source dev-container-features-test-lib + +check "talosctl version is equal to v1.8.0" sh -c "talosctl version --client | grep 'v1.8.0'" + +reportResults \ No newline at end of file