Awesome

Anchor

A tool for anchoring dependencies in dockerfiles

</div>

Installation
What is Anchor, and How Does it Work?
- By Example
Supported Operating Systems Package Managers
Recommended Workflow
Usage
License

Installation

Via Homebrew

brew tap songstitch/anchor
brew install anchor

Via Go Install

go install github.com/songstitch/anchor@latest

Via GitHub Releases

Download the latest binary from the releases page

What is Anchor, and How Does it Work?

Anchor is a tool for anchoring Dockerfiles (not unlike pinning in lock files). It allows for reproducible builds by ensuring that the versions of dependencies are fixed. This is done in two ways

Replacing docker image tags referenced in a Dockerfile with the digest of the image
Replacing package versions in a Dockerfile with the version of the package. The parent digest image is used resolve the package versions to ensure that the package versions are consistent with the parent image.

Anchor has been designed such that with the generated Dockerfile, no changes are needed on one's CI or build process.

Note that docker must be installed and running on the system for anchor to work.

By Example

Given this Dockerfile

# Comments are preserved
FROM golang:1.23-bookworm as builder

RUN apt-get update \
    && apt-get install --no-install-recommends -y curl wget \
    && rm -rf /var/lib/apt/lists/* \
    && apt-get clean

Running anchor will generate the following Dockerfile

# Comments are preserved
FROM golang:1.23-bookworm@sha256:31dc846dd1bcca84d2fa231bcd16c09ff271bcc1a5ae2c48ff10f13b039688f3 as builder

RUN apt-get update \
    && dpkg --add-architecture arm64 && apt-get update && \
    apt-get install --no-install-recommends -y curl:arm64=7.88.1-10+deb12u5 wget:arm64=1.21.3-1+b1 \
    && rm -rf /var/lib/apt/lists/* \
    && apt-get clean

Supported Operating Systems Package Managers

Currently, Anchor only supports the apt package manager. Support for other OS package managers is planned.

Recommended Workflow

The recommended workflow for using anchor is as follows:

Name your Dockerfile Dockerfile.template
Run anchor in the same directory as the Dockerfile.template
Commit the generated Dockerfile to your repository
Use the generated Dockerfile in your CI/CD pipeline to ensure repoducible builds
Do not modify the generated Dockerfile manually
If you need to make changes to the Dockerfile, make them in the Dockerfile.template and run anchor again
If you need to update the dependencies, run anchor again

Usage

Default Usage

Running anchor without any flags will use the default input and output files. It looks for a file named Dockerfile.template in the current directory and outputs the result to Dockerfile.

anchor

Specifying Input and Output Files

You can specify the input and output files using the -i and -o flags respectively.

anchor -i Dockerfile.template -o Dockerfile

Non-Interactive Mode (CI/CD Pipelines)

You can use the --yes flag to automatically accept the changes made by anchor. This is useful for CI/CD pipelines.

anchor -i Dockerfile.template -o Dockerfile --yes

Without the --yes flag, anchor will prompt you to accept any overwrites.

Printing the Output Instead of Writing to a File

You can print the output to stdout by using the -p flag.

anchor -i Dockerfile.template --dry-run

Ignoring Images and Packages

It is possible to tell anchor to ignore images and packages in the Dockerfile statement by adding a # anchor ignore comment above the statement in the Dockerfile template. For example:

# ignore this statement
# anchor ignore
FROM golang:1.23-bookworm as builder

# ignore this statement
# anchor ignore
RUN apt-get update \
    && apt-get install --no-install-recommends -y curl wget \
    && rm -rf /var/lib/apt/lists/* \
    && apt-get clean

# explicitly tell anchor to ignore this image
# anchor ignore=golang:1.23-bookworm
FROM golang:1.23-bookworm

# explicitly tell anchor to ignore the curl package
# anchor ignore=curl
RUN apt-get update \
    && apt-get install --no-install-recommends -y curl wget \
    && rm -rf /var/lib/apt/lists/* \
    && apt-get clean

License

This project is licensed under the GPL-2.0 License - see the LICENSE file for details.