Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Source binaries for linux artifacts from docker images #4491

Merged
merged 5 commits into from
Sep 13, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions .github/workflows/pr_build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ jobs:
artifacts:
name: artifacts (linux)
runs-on: ubuntu-20.04
needs: [cache-deps]
needs: [cache-deps, images]
timeout-minutes: 30

permissions:
Expand All @@ -132,16 +132,16 @@ jobs:
uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # v4.1.0
with:
go-version: ${{ env.GO_VERSION }}
- name: Load cached deps
uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
- name: Load cached build tools
uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
- name: Install regctl
uses: regclient/actions/regctl-installer@b6614f5f56245066b533343a85f4109bdc38c8cc # main
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we pin to a versioned commit? Looks like the latest version is v1.2.8. I see we are pinning to main in other places too, so not something we would need to handle in this PR.

I suspect we will also run into problems with dependabot with this dependency because it isn't generating GitHub releases. Perhaps we can create an issue in that project similar to msys2/setup-msys2#327.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We tried to move the regctl stuff forward at some point but ran into some breaking changes. I think this is worth exploring at another time.

- name: Download archived images
uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3.0.2
with:
path: .build
key: ${{ runner.os }}-tools-${{ hashFiles('.go-version','Makefile') }}
name: images
path: .
- name: Expand archived images
run: |
tar xvf images.tar.gz
- name: Build artifacts
run: ./.github/workflows/scripts/build_artifacts.sh ${{ runner.os }}
- name: Archive artifacts
Expand Down Expand Up @@ -543,6 +543,8 @@ jobs:
update: true
install: >-
git base-devel mingw-w64-x86_64-toolchain zip unzip
- name: Build binaries
run: make build
- name: Build artifacts
run: ./.github/workflows/scripts/build_artifacts.sh ${{ runner.os }}
- name: Archive binaries
Expand Down
23 changes: 13 additions & 10 deletions .github/workflows/release_build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,8 @@ jobs:
artifacts:
name: artifacts (linux)
runs-on: ubuntu-20.04
needs: [cache-deps]
needs: [cache-deps, images]
timeout-minutes: 30

permissions:
contents: read
Expand All @@ -125,16 +126,16 @@ jobs:
uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # v4.1.0
with:
go-version: ${{ env.GO_VERSION }}
- name: Load cached deps
uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
- name: Load cached build tools
uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
- name: Install regctl
uses: regclient/actions/regctl-installer@b6614f5f56245066b533343a85f4109bdc38c8cc # main
- name: Download archived images
uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3.0.2
with:
path: .build
key: ${{ runner.os }}-tools-${{ hashFiles('.go-version','Makefile') }}
name: images
path: .
- name: Expand archived images
run: |
tar xvf images.tar.gz
- name: Build artifacts
run: ./.github/workflows/scripts/build_artifacts.sh ${{ runner.os }}
- name: Archive artifacts
Expand Down Expand Up @@ -531,6 +532,8 @@ jobs:
update: true
install: >-
git base-devel mingw-w64-x86_64-toolchain zip unzip
- name: Build binaries
run: make build
- name: Build artifacts
run: ./.github/workflows/scripts/build_artifacts.sh ${{ runner.os }}
- name: Archive binaries
Expand Down
42 changes: 21 additions & 21 deletions .github/workflows/scripts/build_artifacts.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,32 @@
set -e

usage() {
echo "usage: ${BASH_SOURCE[0]} <Linux|Windows|macOS>"
echo "usage: ${BASH_SOURCE[0]} <Linux|Windows>"
exit 1
}

[[ $# -eq 1 ]] || usage

os="$1"
declare -a supported_archs
if [[ "${os}" == "Linux" ]] || [[ "${os}" == "macOS" ]]; then
supported_archs=(amd64 arm64)
elif [[ "${os}" == "Windows" ]]; then
supported_archs=(amd64)
else
echo "unrecognized OS: ${os}"
usage
fi
SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"

export TAG=
if [[ "$GITHUB_REF" =~ ^refs/tags/v[0-9.]+$ ]]; then
# Strip off the leading "v" from the release tag. Release artifacts are
# named just with the version number (e.g. v0.9.3 tag produces
# spire-0.9.3-linux-x64.tar.gz).
TAG="${GITHUB_REF##refs/tags/v}"
# Strip off the leading "v" from the release tag. Release artifacts are
# named just with the version number (e.g. v0.9.3 tag produces
# spire-0.9.3-linux-x64.tar.gz).
TAG="${GITHUB_REF##refs/tags/v}"
fi

# Make references the $TAG environment variable set above
for arch in "${supported_archs[@]}"; do
GOARCH=$arch make artifact
done
[[ $# -eq 1 ]] || usage

os="$1"
case "${os}" in
Linux)
"${SCRIPTDIR}"/build_linux_artifacts.sh
;;
Windows)
"${SCRIPTDIR}"/build_windows_artifacts.sh
;;
*)
echo "Only artifacts for Linux and Windows are supported" 1>&2
usage
;;
esac
93 changes: 93 additions & 0 deletions .github/workflows/scripts/build_linux_artifacts.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
#!/bin/bash

set -e

REPODIR=$(git rev-parse --show-toplevel)

TAG=${TAG:-$(git log -n1 --pretty=%h)}
OUTDIR=${OUTDIR:-"${REPODIR}/artifacts"}

TARCMD=tar
if [[ $(uname -s) == "Darwin" ]]; then
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Since this script is only invoked for Linux artifact builds, I think this can be removed. Otherwise if this is meant to handle macOS builds too, we should rename this file and fix the invocation in build_artifacts.sh to handle both macOS and Linux.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was mostly for test convenience. As a developer it was convenient to build the linux artifacts from my box instead of spinning up yet-another-container. I'm ok removing it 🤷

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm inclined to keep it as is to make the developer experience easier.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case, it makes sense to keep, but since it's just for dev purposes, I would suggest adding a comment to clarify that.

# When building linux artifacts from darwin, gtar is required.
TARCMD="gtar"
fi

TAROPTS=("--owner=root" "--group=root")

TMPDIR=$(mktemp -d)
cleanup() {
rm -rf "${TMPDIR}"
}
trap cleanup EXIT

azdagron marked this conversation as resolved.
Show resolved Hide resolved

copy_binary_from_multiarch_tar() {
local arch=$1
local binary=$2
local destdir=$3

local srcpath="/opt/spire/bin/${binary}"
local destpath="${destdir}/${binary}"
local ocidir="ocidir://${TMPDIR}/${arch}/oci/${binary}"
local imagetar="${REPODIR}/${binary}-image.tar"
local platform="linux/${arch}"

echo "Importing multiarch image ${imagetar}..."
regctl image import "${ocidir}" "${imagetar}"

echo "Copying ${srcpath} for platform ${platform}..."
regctl image get-file "${ocidir}" "${srcpath}" "${destpath}" -p "${platform}"

# file does not retain permission bits, so fix up the executable bit.
chmod +x "${destpath}"
}

build_artifact() {
ARCH="$1"
rturner3 marked this conversation as resolved.
Show resolved Hide resolved

ARTIFACT="${OUTDIR}/spire-${TAG}-linux-${ARCH}-musl.tar.gz"
CHECKSUM="${OUTDIR}/spire-${TAG}-linux-${ARCH}-musl_sha256sum.txt"

EXTRAS_ARTIFACT="${OUTDIR}/spire-extras-${TAG}-linux-${ARCH}-musl.tar.gz"
EXTRAS_CHECKSUM="${OUTDIR}/spire-extras-${TAG}-linux-${ARCH}-musl_sha256sum.txt"

TARDIR="${TMPDIR}/${ARCH}/tar"
mkdir -p "${TARDIR}"
rturner3 marked this conversation as resolved.
Show resolved Hide resolved

STAGING="${TARDIR}"/spire/spire-${TAG}
EXTRAS_STAGING="${TARDIR}"/spire-extras/spire-extras-${TAG}
mkdir -p "${STAGING}" "${EXTRAS_STAGING}"

echo "Creating \"${ARTIFACT}\" and \"${EXTRAS_ARTIFACT}\""

# Copy in the contents under release/
cp -r "${REPODIR}"/release/posix/spire/* "${STAGING}"
cp -r "${REPODIR}"/release/posix/spire-extras/* "${EXTRAS_STAGING}"

# Copy in the LICENSE
cp "${REPODIR}"/LICENSE "${STAGING}"
cp "${REPODIR}"/LICENSE "${EXTRAS_STAGING}"

# Copy in the SPIRE binaries from the docker images:
# 1. import the image from the multiarch tarball into the OCI directory
mkdir -p "${STAGING}"/bin "${EXTRAS_STAGING}"/bin
copy_binary_from_multiarch_tar "$ARCH" "spire-server" "${STAGING}/bin"
copy_binary_from_multiarch_tar "$ARCH" "spire-agent" "${STAGING}/bin"
copy_binary_from_multiarch_tar "$ARCH" "oidc-discovery-provider" "${EXTRAS_STAGING}/bin"

mkdir -p "${OUTDIR}"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can we consolidate some of these mkdir -p commands into a single command?


# Create the tarballs and checksums
(cd "${TARDIR}/spire"; ${TARCMD} -cvzf "${ARTIFACT}" "${TAROPTS[@]}" -- *)
(cd "${TARDIR}/spire-extras"; ${TARCMD} -cvzf "${EXTRAS_ARTIFACT}" "${TAROPTS[@]}" -- *)

(cd "$(dirname "${ARTIFACT}")"; shasum -a 256 "$(basename "${ARTIFACT}")" > "${CHECKSUM}" )
(cd "$(dirname "${EXTRAS_ARTIFACT}")"; shasum -a 256 "$(basename "${EXTRAS_ARTIFACT}")" > "${EXTRAS_CHECKSUM}" )
}

command -v regctl >/dev/null 2>&1 || { echo -e "The regctl cli is required to run this script." >&2 ; exit 1; }
command -v "${TARCMD}" >/dev/null 2>&1 || { echo -e "The ${TARCMD} command is required to run this script." >&2 ; exit 1; }

build_artifact amd64
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: just for readability, could define a supported_archs array at the top of the script and loop through it here

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's what the old code did and i found it less readable putting in all the looping stuff and array declaration to handle two elements :)

build_artifact arm64
51 changes: 51 additions & 0 deletions .github/workflows/scripts/build_windows_artifacts.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
#!/bin/bash

set -e

REPODIR=$(git rev-parse --show-toplevel)
BINDIR="${REPODIR}/bin"

TAG=${TAG:-$(git log -n1 --pretty=%h)}
OUTDIR=${OUTDIR:-"${REPODIR}/artifacts"}

ARCH=amd64

ARTIFACT="${OUTDIR}/spire-${TAG}-windows-${ARCH}.zip"
CHECKSUM="${OUTDIR}/spire-${TAG}-windows-${ARCH}_sha256sum.txt"

EXTRAS_ARTIFACT="${OUTDIR}/spire-extras-${TAG}-windows-${ARCH}.zip"
EXTRAS_CHECKSUM="${OUTDIR}/spire-extras-${TAG}-windows-${ARCH}_sha256sum.txt"

TMPDIR=$(mktemp -d)
cleanup() {
rm -rf "${TMPDIR}"
}
trap cleanup EXIT

STAGING="${TMPDIR}"/spire/spire-${TAG}
EXTRAS_STAGING="${TMPDIR}"/spire-extras/spire-extras-${TAG}
mkdir -p "${STAGING}" "${EXTRAS_STAGING}"

echo "Creating \"${ARTIFACT}\" and \"${EXTRAS_ARTIFACT}\""

# Copy in the contents under release/
cp -r "${REPODIR}"/release/windows/spire/* "${STAGING}"
cp -r "${REPODIR}"/release/windows/spire-extras/* "${EXTRAS_STAGING}"

# Copy in the LICENSE
cp "${REPODIR}"/LICENSE "${STAGING}"
cp "${REPODIR}"/LICENSE "${EXTRAS_STAGING}"

# Copy in the SPIRE binaries
mkdir -p "${STAGING}"/bin "${EXTRAS_STAGING}"/bin
cp "${BINDIR}"/spire-server.exe "${STAGING}"/bin
cp "${BINDIR}"/spire-agent.exe "${STAGING}"/bin
cp "${BINDIR}"/oidc-discovery-provider.exe "${EXTRAS_STAGING}"/bin

mkdir -p "${OUTDIR}"

(cd "${TMPDIR}/spire"; zip -rv "${ARTIFACT}" -- *)
(cd "${TMPDIR}/spire-extras"; zip -rv "${EXTRAS_ARTIFACT}" -- *)

(cd "$(dirname "${ARTIFACT}")"; CertUtil -hashfile "$(basename "${ARTIFACT}")" SHA256 > "${CHECKSUM}")
(cd "$(dirname "${EXTRAS_ARTIFACT}")"; CertUtil -hashfile "$(basename "${EXTRAS_ARTIFACT}")" SHA256 > "${EXTRAS_CHECKSUM}")
10 changes: 0 additions & 10 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ help:
@echo
@echo "$(bold)Build:$(reset)"
@echo " $(cyan)build$(reset) - build all SPIRE binaries (default)"
@echo " $(cyan)artifact$(reset) - build SPIRE tarball artifact"
@echo
@echo "$(bold)Test:$(reset)"
@echo " $(cyan)test$(reset) - run unit tests"
Expand Down Expand Up @@ -318,15 +317,6 @@ endif
integration-windows:
$(E)./test/integration/test-windows.sh $(SUITES)

#############################################################################
# Build Artifact
#############################################################################

.PHONY: artifact

artifact: build
$(E)OUTDIR="$(OUTDIR)" TAG="$(TAG)" ./script/build-artifact.sh

#############################################################################
# Docker Images
#############################################################################
Expand Down
Loading
Loading