chore: add scripts for building a docker image

coder · deansheather · Jun 18, 2022 · Jun 7, 2022 · Jun 8, 2022 · Jun 8, 2022
commit 64f9648f5de2dc110c156bb301b35cb8abc1df09
diff --git a/Dockerfile b/Dockerfile
@@ -1,6 +1,6 @@
 FROM alpine
 
-# Generated by goreleaser on `goreleaser release`
+# The coder binary is injected by scripts/build_docker.sh.
 ADD coder /opt/coder
 
 ENTRYPOINT [ "/opt/coder", "server" ]
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -1,7 +1,7 @@
 version: "3.9"
 services:
   coder:
-    image: ghcr.io/coder/coder:v${CODER_VERSION:-0.5.10}-${ARCH:-amd64}
+    image: ghcr.io/coder/coder:v${CODER_VERSION:-0.5.10}
     ports:
       - "7080:7080"
     environment:

diff --git a/scripts/build_docker.sh b/scripts/build_docker.sh
@@ -0,0 +1,131 @@
+#!/usr/bin/env bash
+
+# This script builds a Docker image of Coder containing the given binary, for
+# the given architecture. Only linux binaries are supported at this time.
+#
+# Usage: ./build_docker.sh --arch amd64 --tags v1.2.4-rc.1-arm64,v1.2.3+devel.abcdef [--version 1.2.3] [--push]
+#
+# The --arch parameter is required and accepts a Golang arch specification. It
+# will be automatically mapped to a suitable architecture that Docker accepts.
+#
+# The image will be built and tagged against all supplied tags. At least one tag
+# must be supplied. All tags will be sanitized to remove invalid characters like
+# plus signs.
+#
+# If no version is specified, defaults to the version from ./version.sh.
+#
+# If the --push parameter is supplied, all supplied tags will be pushed.
+
+set -euo pipefail
+# shellcheck source=lib.sh
+source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
+
+image="ghcr.io/coder/coder"
+arch=""
+tags_str=""
+version=""
+push=0
+
+args="$(getopt -o "" -l arch:,tags:,version:,push -- "$@")"
+eval set -- "$args"
+while true; do
+    case "$1" in
+    --arch)
+        arch="$2"
+        shift 2
+        ;;
+    --tags)
+        tags_str="$2"
+        shift 2
+        ;;
+    --version)
+        version="$2"
+        shift 2
+        ;;
+    --push)
+        push=1
+        shift
+        ;;
+    --)
+        shift
+        break
+        ;;
+    *)
+        error "Unrecognized option: $1"
+        ;;
+    esac
+done
+
+if [[ "$arch" == "" ]]; then
+    error "The --arch parameter is required"
+fi
+
+tags=()
+for tag in $(echo "$tags_str" | tr "," "\n"); do
+    # Docker images don't support plus signs, which devel versions may contain.
+    tag="${tag//+/-}"
+    tags+=("$tag")
+done
+if [[ "${#tags[@]}" == 0 ]]; then
+    error "At least one tag must be supplied through --tags"
+fi
+
+if [[ "$#" != 1 ]]; then
+    error "Exactly one argument must be provided to this script, $# were supplied"
+fi
+if [[ ! -f "$1" ]]; then
+    error "File '$1' does not exist or is not a regular file"
+fi
+input_file="$(realpath "$1")"
+
+# Remove the "v" prefix.
+version="${version#v}"
+if [[ "$version" == "" ]]; then
+    version="$(execrelative ./version.sh)"
+fi
+
+# Remap the arch from Golang to Docker.
+declare -A arch_map=(
+    [amd64]="linux/amd64"
+    [arm64]="linux/arm64"
+    [arm]="linux/arm/v7"
+)
+if [[ "${arch_map[$arch]+exists}" != "" ]]; then
+    arch="${arch_map[$arch]}"
+fi
+
+# Make temporary dir where all source files intended to be in the image will be
+# hardlinked from.
+cdroot
+temp_dir="$(TMPDIR="$(dirname "$input_file")" mktemp -d)"
+ln -P "$input_file" "$temp_dir/coder"
+ln -P Dockerfile "$temp_dir/"
+
+cd "$temp_dir"
+
+build_args=(
+    "--platform=$arch"
+    "--label=org.opencontainers.image.title=Coder"
+    "--label=org.opencontainers.image.description=A tool for provisioning self-hosted development environments with Terraform."
+    "--label=org.opencontainers.image.url=https://github.com/coder/coder"
+    "--label=org.opencontainers.image.source=https://github.com/coder/coder"
+    "--label=org.opencontainers.image.version=$version"
+    "--label=org.opencontainers.image.licenses=AGPL-3.0"
+)
+for tag in "${tags[@]}"; do
+    build_args+=(--tag "$image:$tag")
+done
+
+echo "--- Building Docker image for $arch"
+docker buildx build "${build_args[@]}" .
+
+cdroot
+rm -rf "$temp_dir"
+
+if [[ "$push" == 1 ]]; then
+    echo "--- Pushing Docker images for $arch"
+    for tag in "${tags[@]}"; do
+        echo "Pushing $image:$tag"
+        docker push "$image:$tag"
+    done
+fi
diff --git a/scripts/build_go.sh b/scripts/build_go.sh
@@ -95,6 +95,7 @@ if [[ "$output_path" == "" ]]; then
 fi
 build_args+=(-o "$output_path")
 
+# TODO: GOARM
 CGO_ENABLED=0 GOOS="$os" GOARCH="$arch" go build \
     "${build_args[@]}" \
     ./cmd/coder 1>&2

diff --git a/scripts/lib.sh b/scripts/lib.sh
@@ -59,6 +59,7 @@ realpath() {
     )"/"$base"
 }
 
+# error prints an error message and returns an error exit code.
 error() {
     echo "ERROR: $*" 1>&2
     exit 1

diff --git a/scripts/package.sh b/scripts/package.sh
@@ -77,4 +77,5 @@ for format in "${formats[@]}"; do
         -t "$output_path"
 done
 
+cdroot
 rm -rf "$temp_dir"
-Original file line number
+Diff line change
@@ Expand Up / @@ -77,4 +77,5 @@ for format in "${formats[@]}"; do @@
             -t "$output_path"
     done
+    cdroot
     rm -rf "$temp_dir"