Update Docker build artifacts to new installer pattern by abernix · Pull Request #1629 · apollographql/router

abernix · 2022-08-26T10:29:49Z

Following up on #1433 which re-introduced target triplets and the installer to support it, this utilizes the installer in our Docker build steps.

This consists of:

Switching our direct downloading of releases to go through our unified installer endpoint.
Durably uses the installer script to download the right architecture for a particular release using the logic in the installer for that release.
There is now a default ROUTER_RELEASE value of latest on the images, though the argument still works (and is used by our releasing pipeline)
Simplifies some logic (e.g., transforming version numbers to remove v).
Switching from alpine to debian since our installer doesn't support alpine and fails. This is not a material change to the outcome because we were only using the alpine image to download a tarball, not for runtime. (Fwiw, it's worth, this change wouldn't have been necessary, but our installer runs router --version at the end which fails on Alpine.) Conceviably our Oribiter endpoint can just redirect to the tarballs with a small change which it already does for Rover, but this was quicker.

Following up on #1433 which re-introduced target triplets and the installer to support it, this utilizes the installer in our Docker build steps. This consists of: - Switching our direct downloading of releases to go through our unified installer endpoint. - Durably uses the installer script to download the right architecture for a particular release using the logic in the installer for that release. - There is now a default `ROUTER_RELEASE` value of `latest` on the images, though the argument still works (and is used by our releasing pipeline) - Simplifies some logic (e.g., transforming version numbers to remove `v`). - Switching from `alpine` to `debian` since our installer doesn't support `alpine` and fails. This is _not_ a material change to the outcome because we were only using the alpine image to download a tarball, not for runtime. (Fwiw, it's worth, this change wouldn't have been necessary, but our installer runs `router --version` at the end which fails on Alpine.) Conceviably our Oribiter endpoint can just redirect to the tarballs with a small change which it already does for Rover, but this was quicker.

github-actions · 2022-08-26T10:30:03Z

@abernix your pull request is missing a changelog!

abernix · 2022-08-26T10:32:29Z

.circleci/config.yml

      - run:
          name: Docker build
          command: |
-            ROUTER_RELEASE=${VERSION:1}


This was removing the letter v from the Git release tag (which is inclusive of the v) so that it could pass it to ROUTER_RELEASE below. The Docker image build now defaults to latest (and accepts --build-arg ROUTER_RELEASE=latest), so we can pass this value in opaquely now.

This does mean that users do pass --build-arg ROUTER_RELEASE=... they need to pass ROUTER_RELEASE=v0.16.0 or ROUTER_RELEASE=latest, but that actually seems intuitive to me in the context of the notion of "release".

It is a breaking change for current Router image builders, but this seems like a good time to make a breaking change of that sort!

abernix · 2022-08-26T10:34:54Z

dockerfiles/Dockerfile.router

 ARG DEBUG_IMAGE
 # Build is required to extract the release files
-FROM --platform=linux/amd64 alpine:latest AS build
+FROM --platform=linux/amd64 debian:bullseye-slim AS build


As noted in the PR body, this accounts for the fact that the installer necessitates an architecture that we can actually run the Router on and switches alpine:latest for a specific version of debian:*slim images.

There is no material change on the outcome of the image — we were using the Alpine image to download a tarball for the next build stage, not to create a small output image, nor on account of producing a Router image that runs on Alpine. Today, the Router does not support running on Alpine for reasons we will solve in the future.

abernix · 2022-08-26T10:35:35Z

dockerfiles/Dockerfile.router

+FROM --platform=linux/amd64 debian:bullseye-slim AS build

-ARG ROUTER_RELEASE
+ARG ROUTER_RELEASE=latest


I think this default makes a lot of sense and offers a nice user experience and pairs nicely with the capability of our router install endpoint.

abernix · 2022-08-26T10:36:39Z

dockerfiles/Dockerfile.router

-ADD https://github.com/apollographql/router/releases/download/v${ROUTER_RELEASE}/router-${ROUTER_RELEASE}-x86_64-unknown-linux-gnu.tar.gz /tmp/router.tar.gz
+WORKDIR /dist

-WORKDIR /tmp


We no longer need to work in a /tmp directory and then moving it to a /dist since the installer actually just takes care of the extraction itself.

abernix · 2022-08-26T10:37:16Z

dockerfiles/Dockerfile.router

-RUN mkdir /dist/config && mkdir /dist/schema
+RUN mkdir config schema

 # Copy configuration for docker image
-COPY dockerfiles/router.yaml /dist/config
+COPY dockerfiles/router.yaml config


Effectively using WORKDIR like a variable here to DRY up the repetition of /dist/

abernix · 2022-08-26T10:38:14Z

dockerfiles/diy/build_docker_image.sh

 else
    # Let the user know what we are going to do
    echo "Building image: ${ROUTER_VERSION}" from released tarballs""
-    ROUTER_RELEASE="$(echo "${ROUTER_VERSION}" | cut -c2-)"


In the same spirit as the change in the .circleci/config.yml above, this transformation of the ROUTER_VERSION to remove the v character is no longer necessary and we can treat this like an opaque value.

abernix · 2022-08-26T10:41:05Z

dockerfiles/diy/dockerfiles/Dockerfile.release

@@ -3,40 +3,44 @@
 # builds to work on platforms such as Mac OS X/M1 (with some help from


This file is almost fully identical to the Dockerfile.router above, now more than ever. The only notable difference is that the other file above supports the debug build argument. We should align these in the future?

garypen

Looks good. Just one question about ca-certificates.

garypen · 2022-08-26T10:43:58Z

.circleci/config.yml

      - run:
          name: Docker build
          command: |
-            ROUTER_RELEASE=${VERSION:1}


Nice to see all this dancing around to add/remove the "v" prefix is gone...

garypen · 2022-08-26T10:47:15Z

dockerfiles/Dockerfile.router

-# router.tar.gz extracts to "dist"
-RUN tar xvzf router.tar.gz -C /
+# Run the Router downloader which puts Router into current working directory
+RUN curl -sSL https://router.apollo.dev/download/nix/${ROUTER_RELEASE}/ | sh


I'm assuming no certificate issues with debian:bullseye-slim. i.e.: no need to install ca-certificates.

I think curl just actually brings in ca-certificates now.

abernix added this to the v1.0.0-alpha.0 milestone Aug 26, 2022

abernix requested a review from garypen August 26, 2022 10:29

abernix commented Aug 26, 2022

View reviewed changes

abernix requested a review from Geal August 26, 2022 10:41

garypen approved these changes Aug 26, 2022

View reviewed changes

Geal approved these changes Aug 26, 2022

View reviewed changes

Geal mentioned this pull request Aug 26, 2022

update the released package name in Docker image construction #1397

Closed

abernix merged commit b3e503b into main Aug 26, 2022

abernix deleted the abernix/dockerfile-after-installer branch August 26, 2022 11:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Docker build artifacts to new installer pattern#1629

Update Docker build artifacts to new installer pattern#1629
abernix merged 1 commit intomainfrom
abernix/dockerfile-after-installer

abernix commented Aug 26, 2022

Uh oh!

github-actions bot commented Aug 26, 2022

Uh oh!

abernix Aug 26, 2022

Uh oh!

abernix Aug 26, 2022

Uh oh!

abernix Aug 26, 2022

Uh oh!

abernix Aug 26, 2022

Uh oh!

abernix Aug 26, 2022

Uh oh!

abernix Aug 26, 2022

Uh oh!

abernix Aug 26, 2022

Uh oh!

garypen left a comment

Uh oh!

garypen Aug 26, 2022

Uh oh!

garypen Aug 26, 2022

Uh oh!

abernix Aug 26, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -3,40 +3,44 @@
		# builds to work on platforms such as Mac OS X/M1 (with some help from

Conversation

abernix commented Aug 26, 2022

Uh oh!

github-actions bot commented Aug 26, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

garypen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants