From ac1abfd72b5c8232ff91d25e0121d68bf58d0591 Mon Sep 17 00:00:00 2001 From: Lam Tran Date: Sun, 21 Apr 2024 10:20:34 +0700 Subject: [PATCH] feat: add otelcol-contrib (#3) --- .github/workflows/test.yaml | 30 +-- README.md | 9 +- src/otelcol-contrib/README.md | 17 ++ src/otelcol-contrib/devcontainer-feature.json | 20 ++ src/otelcol-contrib/install.sh | 18 ++ src/otelcol-contrib/library_scripts.sh | 172 ++++++++++++++++++ .../test.sh} | 2 +- test/otelcol/scenarios.json | 8 - 8 files changed, 235 insertions(+), 41 deletions(-) create mode 100644 src/otelcol-contrib/README.md create mode 100644 src/otelcol-contrib/devcontainer-feature.json create mode 100755 src/otelcol-contrib/install.sh create mode 100644 src/otelcol-contrib/library_scripts.sh rename test/{otelcol/test_defaults_debian.sh => otelcol-contrib/test.sh} (56%) delete mode 100644 test/otelcol/scenarios.json diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 9ccfeb0..b5b4b2d 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -14,8 +14,10 @@ jobs: matrix: features: - otelcol + - otelcol-contrib baseImage: - mcr.microsoft.com/devcontainers/base:ubuntu + - mcr.microsoft.com/devcontainers/base:debian steps: - uses: actions/checkout@v3 @@ -24,31 +26,3 @@ jobs: - name: "Generating tests for '${{ matrix.features }}' against '${{ matrix.baseImage }}'" run: devcontainer features test --skip-scenarios -f ${{ matrix.features }} -i ${{ matrix.baseImage }} . - - test-scenarios: - runs-on: ubuntu-latest - continue-on-error: true - strategy: - matrix: - features: - - otelcol - steps: - - uses: actions/checkout@v3 - - - name: "Install latest devcontainer CLI" - run: npm install -g @devcontainers/cli - - - name: "Generating tests for '${{ matrix.features }}' scenarios" - run: devcontainer features test -f ${{ matrix.features }} --skip-autogenerated --skip-duplicated . - - test-global: - runs-on: ubuntu-latest - continue-on-error: true - steps: - - uses: actions/checkout@v3 - - - name: "Install latest devcontainer CLI" - run: npm install -g @devcontainers/cli - - - name: "Testing global scenarios" - run: devcontainer features test --global-scenarios-only . diff --git a/README.md b/README.md index 9299767..774099b 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,16 @@ ## Contents -This repository contains features: `otelcol` +This repository contains features: otelcol, otelcol-contrib -### `otelcol` +## Usage ```jsonc { - "image": "mcr.microsoft.com/devcontainers/base:ubuntu", + "image": "mcr.microsoft.com/devcontainers/base:debian", "features": { - "ghcr.io/tranngoclam/otel-devcontainer-features/otelcol:1": {} + "ghcr.io/tranngoclam/otel-devcontainer-features/otelcol:1": {}, + "ghcr.io/tranngoclam/otel-devcontainer-features/otelcol-contrib:1": {}, } } ``` diff --git a/src/otelcol-contrib/README.md b/src/otelcol-contrib/README.md new file mode 100644 index 0000000..dc8fc96 --- /dev/null +++ b/src/otelcol-contrib/README.md @@ -0,0 +1,17 @@ +# otelcol-contrib (via Github Releases) (otelcol-contrib) + +OpenTelemetry Collector Contrib Distro. + +## Example DevContainer Usage + +```json +"features": { + "ghcr.io/tranngoclam/otel-devcontainer-features/otelcol-contrib:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| version | Select the version to install. | string | latest | diff --git a/src/otelcol-contrib/devcontainer-feature.json b/src/otelcol-contrib/devcontainer-feature.json new file mode 100644 index 0000000..4ae7d23 --- /dev/null +++ b/src/otelcol-contrib/devcontainer-feature.json @@ -0,0 +1,20 @@ +{ + "id": "otelcol", + "version": "1.0.0", + "name": "otelcol (via Github Releases)", + "documentationURL": "http://github.com/tranngoclam/otel-devcontainer-features/tree/main/src/otelcol-contrib", + "description": "OpenTelemetry Collector Contrib Distro.", + "options": { + "version": { + "default": "latest", + "description": "Select the version to install.", + "proposals": [ + "latest" + ], + "type": "string" + } + }, + "installsAfter": [ + "ghcr.io/devcontainers-contrib/features/gh-release" + ] +} diff --git a/src/otelcol-contrib/install.sh b/src/otelcol-contrib/install.sh new file mode 100755 index 0000000..b758490 --- /dev/null +++ b/src/otelcol-contrib/install.sh @@ -0,0 +1,18 @@ +set -e + +. ./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" + +$nanolayer_location \ + install \ + devcontainer-feature \ + "ghcr.io/devcontainers-contrib/features/gh-release:1.0.24" \ + --option repo='open-telemetry/opentelemetry-collector-releases' --option binaryNames='otelcol-contrib' --option version="$VERSION" + +echo 'Done!' diff --git a/src/otelcol-contrib/library_scripts.sh b/src/otelcol-contrib/library_scripts.sh new file mode 100644 index 0000000..0d7f34d --- /dev/null +++ b/src/otelcol-contrib/library_scripts.sh @@ -0,0 +1,172 @@ + + +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="" + + _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 + } + + _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 + } + + _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 + } + + _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 + + 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 == $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 + export ${variable_name}=$__nanolayer_location + +} + + diff --git a/test/otelcol/test_defaults_debian.sh b/test/otelcol-contrib/test.sh similarity index 56% rename from test/otelcol/test_defaults_debian.sh rename to test/otelcol-contrib/test.sh index 240c566..9a1a329 100755 --- a/test/otelcol/test_defaults_debian.sh +++ b/test/otelcol-contrib/test.sh @@ -4,6 +4,6 @@ set -e source dev-container-features-test-lib -check "otelcol --version" otelcol --version +check "otelcol-contrib --version" otelcol-contrib --version reportResults diff --git a/test/otelcol/scenarios.json b/test/otelcol/scenarios.json deleted file mode 100644 index 998c816..0000000 --- a/test/otelcol/scenarios.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "test_defaults_debian": { - "image": "mcr.microsoft.com/devcontainers/base:debian", - "features": { - "otelcol": {} - } - } -}