Add docker image for example MorpheusVM #1915
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,13 @@ | ||
| .ci | ||
| .github | ||
| .gitignore | ||
| .golangci.yml | ||
|
|
||
| .idea | ||
| .vscode | ||
|
|
||
| LICENSE | ||
| *.md | ||
|
|
||
| # Ignore all dockerfiles not just the main one | ||
| Dockerfile* |
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 |
|---|---|---|
|
|
@@ -26,6 +26,19 @@ jobs: | |
| - shell: bash | ||
| run: scripts/tests.clean.sh | ||
|
|
||
| build_image: | ||
| name: Image build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Install qemu (required for cross-platform builds) | ||
| run: | | ||
| sudo apt update | ||
| sudo apt -y install qemu-system qemu-user-static | ||
| - name: Build MorpheusVM Docker Image | ||
| shell: bash | ||
| run: bash -x scripts/build_docker_image.sh | ||
|
There was a problem hiding this comment. I recommend validating image build since, by itself, executing this script without error provides no guarantee of the viability of the images produced. Example from avalanchego: https://github.com/ava-labs/avalanchego/blob/master/scripts/tests.build_image.sh |
||
|
|
||
| hypersdk-lint: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
|
|
||
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,32 @@ | ||
| # syntax=docker/dockerfile:experimental | ||
|
|
||
| # ============= Setting up base Stage ================ | ||
| # AVALANCHEGO_NODE_IMAGE needs to identify an existing node image and should include the tag | ||
| ARG AVALANCHEGO_NODE_IMAGE | ||
| ARG VM_ID | ||
| ARG VM_COMMIT | ||
| ARG CURRENT_BRANCH | ||
|
|
||
| # ============= Compilation Stage ================ | ||
| FROM --platform=$BUILDPLATFORM golang:1.22.8-bullseye AS builder | ||
|
There was a problem hiding this comment. Specifying Note also that there are two steps in enabling cross compilation: |
||
|
|
||
| WORKDIR /build | ||
|
|
||
| # Copy the code into the container | ||
| COPY . . | ||
|
|
||
| ARG VM_NAME | ||
|
|
||
| WORKDIR /build/examples/$VM_NAME/ | ||
|
|
||
| # Ensure pre-existing builds are not available for inclusion in the final image | ||
| RUN [ -d ./build ] && rm -rf ./build/* || true | ||
|
|
||
| RUN export VM_COMMIT=$VM_COMMIT && export CURRENT_BRANCH=$CURRENT_BRANCH && ./scripts/build.sh /build/build/vm | ||
|
|
||
| # ============= Cleanup Stage ================ | ||
| FROM $AVALANCHEGO_NODE_IMAGE AS builtImage | ||
|
|
||
| # Copy the evm binary into the correct location in the container | ||
| ARG VM_ID | ||
| COPY --from=builder /build/build/vm /avalanchego/build/plugins/$VM_ID | ||
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
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,79 @@ | ||
| #!/usr/bin/env bash | ||
| # Copyright (C) 2023, Ava Labs, Inc. All rights reserved. | ||
| # See the file LICENSE for licensing terms. | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| # If set to non-empty, prompts the building of a multi-arch image when the image | ||
| # name indicates use of a registry. | ||
| # | ||
| # A registry is required to build a multi-arch image since a multi-arch image is | ||
| # not really an image at all. A multi-arch image (also called a manifest) is | ||
| # basically a list of arch-specific images available from the same registry that | ||
| # hosts the manifest. Manifests are not supported for local images. | ||
| # | ||
| # Reference: https://docs.docker.com/build/building/multi-platform/ | ||
| PLATFORMS="${PLATFORMS:-}" | ||
|
|
||
| # If set to non-empty, the image will be published to the registry. | ||
| PUBLISH="${PUBLISH:-}" | ||
|
|
||
| # The name of the VM to build. Defaults to build morpheusvm in examples/morpheusvm/ | ||
| VM_NAME=${VM_NAME:-"morpheusvm"} | ||
|
|
||
| # Directory above this script | ||
| HYPERSDK_PATH=$( | ||
| cd "$(dirname "${BASH_SOURCE[0]}")" | ||
| cd .. && pwd | ||
| ) | ||
| VM_PATH=${VM_PATH:-"${HYPERSDK_PATH}/examples/${VM_NAME}"} | ||
|
|
||
| # Load the constants | ||
| source "$HYPERSDK_PATH"/scripts/constants.sh | ||
|
|
||
| # WARNING: this will use the most recent commit even if there are un-committed changes present | ||
| BUILD_IMAGE_ID=${BUILD_IMAGE_ID:-"${CURRENT_BRANCH}"} | ||
|
|
||
| # buildx (BuildKit) improves the speed and UI of builds over the legacy builder and | ||
| # simplifies creation of multi-arch images. | ||
| # | ||
| # Reference: https://docs.docker.com/build/buildkit/ | ||
| DOCKER_CMD="docker buildx build" | ||
|
|
||
| if [[ -n "${PUBLISH}" ]]; then | ||
| DOCKER_CMD="${DOCKER_CMD} --push" | ||
|
|
||
| echo "Pushing $DOCKERHUB_REPO:$BUILD_IMAGE_ID" | ||
|
|
||
| # A populated DOCKER_USERNAME env var triggers login | ||
| if [[ -n "${DOCKER_USERNAME:-}" ]]; then | ||
| echo "$DOCKER_PASS" | docker login --username "$DOCKER_USERNAME" --password-stdin | ||
| fi | ||
| fi | ||
|
|
||
| # Build a multi-arch image if requested | ||
| if [[ -n "${PLATFORMS}" ]]; then | ||
| DOCKER_CMD="${DOCKER_CMD} --platform=${PLATFORMS}" | ||
| fi | ||
|
|
||
| VM_ID=${VM_ID:-"${DEFAULT_VM_ID}"} | ||
| if [[ "${VM_ID}" != "${DEFAULT_VM_ID}" ]]; then | ||
| DOCKERHUB_TAG="${VM_ID}-${DOCKERHUB_TAG}" | ||
| fi | ||
|
|
||
| # Default to the release image. Will need to be overridden when testing against unreleased versions. | ||
| AVALANCHEGO_NODE_IMAGE="${AVALANCHEGO_NODE_IMAGE:-${AVALANCHEGO_IMAGE_NAME}:${AVALANCHE_DOCKER_VERSION}}" | ||
|
There was a problem hiding this comment. (No action required) Maybe support building the avalanchego image for an as-yet unmerged hash as per the example of https://github.com/ava-labs/subnet-evm/blob/master/scripts/build_antithesis_images.sh#L24? |
||
|
|
||
| echo "Building Docker Image: $DOCKERHUB_REPO:$BUILD_IMAGE_ID based off AvalancheGo@$AVALANCHE_DOCKER_VERSION" | ||
| ${DOCKER_CMD} -t "$DOCKERHUB_REPO:$BUILD_IMAGE_ID" \ | ||
| "$HYPERSDK_PATH" -f "$HYPERSDK_PATH/Dockerfile" \ | ||
| --build-arg AVALANCHEGO_NODE_IMAGE="$AVALANCHEGO_NODE_IMAGE" \ | ||
| --build-arg VM_COMMIT="$VM_COMMIT" \ | ||
| --build-arg CURRENT_BRANCH="$CURRENT_BRANCH" \ | ||
| --build-arg VM_ID="$VM_ID" \ | ||
| --build-arg VM_NAME="$VM_NAME" | ||
|
|
||
| if [[ -n "${PUBLISH}" && $CURRENT_BRANCH == "master" ]]; then | ||
| echo "Tagging current image as $DOCKERHUB_REPO:latest" | ||
| docker buildx imagetools create -t "$DOCKERHUB_REPO:latest" "$DOCKERHUB_REPO:$BUILD_IMAGE_ID" | ||
| fi | ||
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 |
|---|---|---|
| @@ -1,10 +1,50 @@ | ||
| #!/usr/bin/env bash | ||
| # Copyright (C) 2023, Ava Labs, Inc. All rights reserved. | ||
| # See the file LICENSE for licensing terms. | ||
| # Ignore warnings about variables appearing unused since this file is not the consumer of the variables it defines. | ||
| # shellcheck disable=SC2034 | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| AVALANCHE_VERSION=${AVALANCHE_VERSION:-'13c08681c17d0790a94ed8c8ef8a3c88f8bb196d'} | ||
| # Optionally specify a separate version of AvalancheGo for building docker images | ||
| # Added to support the case there's no such docker image for the specified commit of AvalancheGo | ||
| AVALANCHE_DOCKER_VERSION=${AVALANCHE_DOCKER_VERSION:-'v1.12.2'} | ||
|
|
||
| # Set the PATHS | ||
| GOPATH="$(go env GOPATH)" | ||
| DEFAULT_VM_ID="pkEmJQuTUic3dxzg8EYnktwn4W7uCHofNcwiYo458vodAUbY7" | ||
|
|
||
| # Avalabs docker hub | ||
| # avaplatform/avalanchego - defaults to local as to avoid unintentional pushes | ||
| # You should probably set it - export DOCKER_REPO='avaplatform/subnet-evm' | ||
| DOCKERHUB_REPO=${DOCKER_REPO:-"morpheusvm"} | ||
|
|
||
| # Shared between ./scripts/build_docker_image.sh | ||
| AVALANCHEGO_IMAGE_NAME="${AVALANCHEGO_IMAGE_NAME:-avaplatform/avalanchego}" | ||
|
|
||
| # set git constants if available, otherwise set to empty string (say building from a release) | ||
| if git rev-parse --is-inside-work-tree > /dev/null 2>&1; then | ||
|
There was a problem hiding this comment. (No action required) Maybe follow the example of ava-labs/avalanchego#3660 to enable building the images in a non-primary worktree? |
||
| # Current branch | ||
| CURRENT_BRANCH=${CURRENT_BRANCH:-$(git describe --tags --exact-match 2>/dev/null || git symbolic-ref -q --short HEAD || git rev-parse --short HEAD || :)} | ||
|
|
||
| # Image build id | ||
| # | ||
| # Use an abbreviated version of the full commit to tag the image. | ||
| # WARNING: this will use the most recent commit even if there are un-committed changes present | ||
| VM_COMMIT="$(git rev-parse HEAD || :)" | ||
| else | ||
| CURRENT_BRANCH="" | ||
| VM_COMMIT="" | ||
| fi | ||
|
|
||
| # Shared between ./scripts/build_docker_image.sh | ||
| DOCKERHUB_TAG=${VM_COMMIT::8} | ||
|
|
||
| echo "Using branch: ${CURRENT_BRANCH}" | ||
|
|
||
| # Set the CGO flags to use the portable version of BLST | ||
| # | ||
| # We use "export" here instead of just setting a bash variable because we need | ||
| # to pass this flag to all child processes spawned by the shell. | ||
| export CGO_CFLAGS="-O2 -D__BLST_PORTABLE__" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(No action required) Did you mean to add a publish script in addition to this CI test? That would be a likely precondition for performing kube-based scale testing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not yet, I didn't have permission to create a new DockerHub repo, so was blocked on this and just wanted to add some check to make sure this didn't break.