CI: Build/publish multi-architecture Docker images via ko

.github/workflows/test-build-deploy.yml

@@ -20,7 +20,7 @@ jobs:
   lint:
     runs-on: ubuntu-20.04
     container:
-      image: grafana/mimir-build-image:update-go-1.17.8-8a996bb57
+      image: grafana/mimir-build-image:chore-build-multiplatform-images-3b8a0c120
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v2
@@ -50,7 +50,7 @@ jobs:
   lint-jsonnet:
     runs-on: ubuntu-20.04
     container:
-      image: grafana/mimir-build-image:update-go-1.17.8-8a996bb57
+      image: grafana/mimir-build-image:chore-build-multiplatform-images-3b8a0c120
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v2
@@ -81,7 +81,7 @@ jobs:
         test_group_id:    [0, 1, 2, 3]
         test_group_total: [4]
     container:
-      image: grafana/mimir-build-image:update-go-1.17.8-8a996bb57
+      image: grafana/mimir-build-image:chore-build-multiplatform-images-3b8a0c120
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v2
@@ -107,7 +107,7 @@ jobs:
   build-mimir:
     runs-on: ubuntu-20.04
     container:
-      image: grafana/mimir-build-image:update-go-1.17.8-8a996bb57
+      image: grafana/mimir-build-image:chore-build-multiplatform-images-3b8a0c120
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v2
@@ -117,26 +117,27 @@ jobs:
         run: |
           mkdir -p /go/src/github.com/grafana/mimir
           ln -s $GITHUB_WORKSPACE/* /go/src/github.com/grafana/mimir
-      - name: Build Image
-        run: |
-          make BUILD_IN_CONTAINER=false ./cmd/mimir/.uptodate
-      - name: Save Images
+      - name: Build Images
         run: |
-          mkdir /tmp/images
-          ln -s /tmp/images ./docker-images
-          make BUILD_IN_CONTAINER=false save-images
-      - name: Create Docker Images Archive
-        run: tar -cvf mimir-images.tar /tmp/images
-      - name: Upload Docker Images Artifact
+          export GIT_REVISION=$(git rev-parse --short HEAD)
+          export VERSION=$(cat "./VERSION" 2> /dev/null)
+          export GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
+          # Configure ko's image creation timestamp to correspond to the commit timestamp
+          export SOURCE_DATE_EPOCH=$(git show -s --format=%ct)
+          export KO_DOCKER_REPO=grafana
+          ko build -B --image-label org.opencontainers.image.title=mimir,org.opencontainers.image.source=https://github.com/grafana/mimir/tree/main/cmd/mimir,org.opencontainers.image.revision=${GIT_REVISION} --oci-layout-path mimir-oci-layout --platform=linux/amd64,linux/arm64 --push=false ./cmd/mimir
+      - name: Create Mimir OCI Image Layout Archive
+        run: tar -cvf mimir-oci-layout.tar mimir-oci-layout
+      - name: Upload Mimir OCI Image Layout
         uses: actions/upload-artifact@v2
         with:
-          name: Docker Images Mimir
-          path: ./mimir-images.tar
+          name: Mimir OCI Image Layout
+          path: ./mimir-oci-layout.tar
 
   build-tools:
     runs-on: ubuntu-20.04
     container:
-      image: grafana/mimir-build-image:update-go-1.17.8-8a996bb57
+      image: grafana/mimir-build-image:chore-build-multiplatform-images-3b8a0c120
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v2
@@ -149,19 +150,23 @@ jobs:
       - name: Build Images
         # Build everything except mimir (run by build-mimir job) and build image (not managed by CI).
         run: |
-          make list-image-targets | grep -v -E '/mimir-build-image/|/cmd/mimir/|/mimir-mixin-tools/' | xargs -I {} make BUILD_IN_CONTAINER=false {}
-      - name: Save Images
-        run: |
-          mkdir /tmp/images
-          ln -s /tmp/images ./docker-images
-          make BUILD_IN_CONTAINER=false save-images
-      - name: Create Docker Images Archive
-        run: tar -cvf tools-images.tar /tmp/images
-      - name: Upload Docker Image Artifact
+          IMAGES="mimirtool metaconvert query-tee"
+          export GIT_REVISION=$(git rev-parse --short HEAD)
+          export VERSION=$(cat "./VERSION" 2> /dev/null)
+          export GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
+          # Configure ko's image creation timestamp to correspond to the commit timestamp
+          export SOURCE_DATE_EPOCH=$(git show -s --format=%ct)
+          export KO_DOCKER_REPO=grafana
+          for name in ${IMAGES}; do
+            ko build -B --image-label org.opencontainers.image.title=${name},org.opencontainers.image.source=https://github.com/grafana/mimir/tree/main/cmd/${name},org.opencontainers.image.revision=${GIT_REVISION} --oci-layout-path ${name}-oci-layout --platform=linux/amd64,linux/arm64 --push=false ./cmd/${name}
+          done
+      - name: Create Tool OCI Image Layouts Archive
+        run: tar -cvf tool-oci-layouts.tar *-oci-layout
+      - name: Upload Tool OCI Image Layouts
         uses: actions/upload-artifact@v2
         with:
-          name: Docker Images Tools
-          path: ./tools-images.tar
+          name: Tool OCI Image Layouts
+          path: ./tool-oci-layouts.tar
 
   integration:
     needs: build-mimir
@@ -182,20 +187,24 @@ jobs:
         uses: actions/checkout@v2
       - name: Install Docker Client
         run: sudo ./.github/workflows/scripts/install-docker.sh
+      # TODO: Work into image, since this job doesn't use the Mimir build image (which has ko installed)
+      # Keep revision in sync with that in Mimir build image
+      - name: Install ko
+        run: |
+          go install github.com/grafana/ko@37f6651b50ba1ecdfb691be4602472d4df8424e4
       - name: Symlink Expected Path to Workspace
         run: |
           sudo mkdir -p /go/src/github.com/grafana/mimir
           sudo ln -s $GITHUB_WORKSPACE/* /go/src/github.com/grafana/mimir
-      - name: Download Docker Images Mimir Artifacts
+      - name: Download Mimir OCI Image Layout
         uses: actions/download-artifact@v2
         with:
-          name: Docker Images Mimir
-      - name: Extract Docker Image Archive
-        run: tar -xvf mimir-images.tar -C /
-      - name: Load Docker Images
+          name: Mimir OCI Image Layout
+      - name: Load Mimir Docker Image
         run: |
-          ln -s /tmp/images ./docker-images
-          make BUILD_IN_CONTAINER=false load-images
+          tar -xvf mimir-oci-layout.tar
+          IMAGE_TAG=$(make image-tag)
+          KO_DOCKER_REPO=grafana ko publish-layout -B --tags ${IMAGE_TAG} --local mimir mimir-oci-layout
       - name: Preload Images
         # We download docker images used by integration tests so that all images are available
         # locally and the download time doesn't account in the test execution time, which is subject
@@ -216,7 +225,7 @@ jobs:
     if: (startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads/r') ) && github.event_name == 'push' && github.repository == 'grafana/mimir'
     runs-on: ubuntu-20.04
     container:
-      image: grafana/mimir-build-image:update-go-1.17.8-8a996bb57
+      image: grafana/mimir-build-image:chore-build-multiplatform-images-3b8a0c120
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v2
@@ -226,29 +235,25 @@ jobs:
         run: |
           mkdir -p /go/src/github.com/grafana/mimir
           ln -s $GITHUB_WORKSPACE/* /go/src/github.com/grafana/mimir
-      - name: Download Docker Tool Images Artifacts
+      - name: Download Tool OCI Image Layouts
         uses: actions/download-artifact@v2
         with:
-          name: Docker Images Tools
-      - name: Download Docker Mimir Image Artifacts
+          name: Tool OCI Image Layouts
+      - name: Download Mimir OCI Image Layout
         uses: actions/download-artifact@v2
         with:
-          name: Docker Images Mimir
-      - name: Extract Docker Images
-        run: |
-          tar -xvf mimir-images.tar -C /
-          tar -xvf tools-images.tar -C /
-      - name: Load Images
+          name: Mimir OCI Image Layout
+      - name: Extract OCI Image Layouts
         run: |
-          ln -s /tmp/images ./docker-images
-          make BUILD_IN_CONTAINER=false load-images
+          tar -xvf mimir-oci-layout.tar
+          tar -xvf tool-oci-layouts.tar
       - name: Deploy
         run: |
           if [ -n "$DOCKER_PASSWORD" ]; then
-            printenv DOCKER_PASSWORD | docker login -u "$DOCKER_USERNAME" --password-stdin
+            printenv DOCKER_PASSWORD | ko login -u "$DOCKER_USERNAME" --password-stdin
           fi
-          export IMAGE_TAG=$(make image-tag)
-          ./push-images
+          export IMAGE_TAG=$(./tools/image-tag)
+          make ci-push-images
         env:
           DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
           DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}

.gitignore

@@ -1,19 +1,9 @@
 cmd/mimirtool/mimirtool
-cmd/mimirtool/mimirtool_linux_amd64
-cmd/mimirtool/mimirtool_linux_arm64
 cmd/test-exporter/test-exporter
 cmd/mimir/mimir
-cmd/mimir/mimir_linux_amd64
-cmd/mimir/mimir_linux_arm64
 cmd/query-tee/query-tee
-cmd/query-tee/query-tee_linux_amd64
-cmd/query-tee/query-tee_linux_arm64
 cmd/metaconvert/metaconvert
-cmd/metaconvert/metaconvert_linux_amd64
-cmd/metaconvert/metaconvert_linux_arm64
 cmd/mimir-continuous-test/mimir-continuous-test
-cmd/mimir-continuous-test/mimir-continuous-test_linux_amd64
-cmd/mimir-continuous-test/mimir-continuous-test_linux_arm64
 .uptodate
 .pkg
 .cache

.ko.yaml

@@ -0,0 +1,49 @@
+# ko's standard base image causes our integration tests to fail, due to lack of permission to read
+# TLS CA certificates installed in the filesystem it looks like.
+defaultBaseImage: grafana/alpine:3.15.4
+
+builds:
+  - id: mimir
+    main: ./cmd/mimir
+    env:
+      - CGO_ENABLED=0
+    ldflags:
+      - -X github.com/grafana/mimir/pkg/util/version.Branch={{.Env.GIT_BRANCH}}
+      - -X github.com/grafana/mimir/pkg/util/version.Revision={{.Env.GIT_REVISION}}
+      - -X github.com/grafana/mimir/pkg/util/version.Version={{.Env.VERSION}}
+      - -extldflags "-static"
+      - -s
+      - -w
+  - id: mimirtool
+    main: ./cmd/mimirtool
+    env:
+      - CGO_ENABLED=0
+    ldflags:
+      - -X github.com/grafana/mimir/pkg/util/version.Branch={{.Env.GIT_BRANCH}}
+      - -X github.com/grafana/mimir/pkg/util/version.Revision={{.Env.GIT_REVISION}}
+      - -X github.com/grafana/mimir/pkg/util/version.Version={{.Env.VERSION}}
+      - -extldflags "-static"
+      - -s
+      - -w
+  - id: metaconvert
+    main: ./cmd/metaconvert
+    env:
+      - CGO_ENABLED=0
+    ldflags:
+      - -X github.com/grafana/mimir/pkg/util/version.Branch={{.Env.GIT_BRANCH}}
+      - -X github.com/grafana/mimir/pkg/util/version.Revision={{.Env.GIT_REVISION}}
+      - -X github.com/grafana/mimir/pkg/util/version.Version={{.Env.VERSION}}
+      - -extldflags "-static"
+      - -s
+      - -w
+  - id: query-tee
+    main: ./cmd/query-tee
+    env:
+      - CGO_ENABLED=0
+    ldflags:
+      - -X github.com/grafana/mimir/pkg/util/version.Branch={{.Env.GIT_BRANCH}}
+      - -X github.com/grafana/mimir/pkg/util/version.Revision={{.Env.GIT_REVISION}}
+      - -X github.com/grafana/mimir/pkg/util/version.Version={{.Env.VERSION}}
+      - -extldflags "-static"
+      - -s
+      - -w

CHANGELOG.md

@@ -41,6 +41,7 @@
 * [ENHANCEMENT] Alertmanager: added `insight=true` field to alertmanager dispatch logs. #1379
 * [ENHANCEMENT] Store-gateway: Add the experimental ability to run index header operations in a dedicated thread pool. This feature can be configured using `-blocks-storage.bucket-store.index-header-thread-pool-size` and is disabled by default. #1660
 * [ENHANCEMENT] Querier: wait until inflight queries are completed when shutting down queriers and running Mimir with query-scheduler. #1756
+* [ENHANCEMENT] Docker images are now published as multi-architecture (AMD64/ARM64). #1124
 * [BUGFIX] Query-frontend: do not shard queries with a subquery unless the subquery is inside a shardable aggregation function call. #1542
 * [BUGFIX] Query-frontend: added `component=query-frontend` label to results cache memcached metrics to fix a panic when Mimir is running in single binary mode and results cache is enabled. #1704
 * [BUGFIX] Mimir: services' status content-type is now correctly set to `text/html`. #1575