earthlywill not install these for you, please ensure they are present before proceeding. These tools are very common, so many environments will already have them installed. If you choose to use our prebuilt containers, these dep
dockeris used to glean information about the containerization environment, and manage our
earthly-buildkitddaemon. It is also used to do things like save images locally on your machine after they have been built by Earthly. To install
docker, use the most recent versions directly from Docker. The versions packaged for many distributions tend to fall behind.
gitis used to help fetch remote targets, and also provides metadata for Earthly during your build. To install
git, you can typically use your distributions package manager.
earthlyto your CI. It will work best on dedicated computers, or in scripted/auto-provisioned build environments. You can pin it to a specific version like so:
earthlyas part of the new host's configuration, and not as part of your build. This will speed up your builds, since you do not need to download
earthlyeach time; and it will also provide stability in case a future version of
earthlychanges the behavior of a command.
earthly bootstrapwhen you are done to finish configuration!
earthly/earthly, which is a 1-stop shop. It includes a built-in
earthly-buildkitddaemon, and accepts a target to be built as a parameter. It requires a mount for your source code, and an accessible
earthlyis fairly configurable by itself, it also depends on the configuration of its dependencies. In a CI environment, you will need to ensure all of them are configured correctly.
gitwill need to be configured to have access to these repositories. Please see our documentation for how to configure access.
dockeralso needs to be configured to have access to any private repositories referenced in the
Earthfilesyou want to build. Please our documentation for how to log in, and our examples for pushing to many popular repositories.
earthly-buildkitddaemon requires running in
--privilegedmode, which means that the
dockerdaemon needs to be configured to allow this as well. Rootless configurations are currently unsupported.
earthlyhas quite a few configuration options that can either be set through a configuration file or environment variables. See our configuration reference for a complete list of options.
earthlyby using the
earthly configcommand from within a script. This can be useful for some dynamic configuration.
--pushoption that can be used when invoking a target. In a CI, you may want to ensure this flag is present to push images or run commands that are not typically done as part of a normal development workflow.
binfmt_miscentries. This can be done by running:
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes. This installs the needed entries and
qemue-user-staticbinaries on your system. This will need to be repeated on each physical box (only once, since its a kernel level change, and the kernel is shared across containers).
earthlydepends on the availability of an
earthly-buildkitdaemon to perform its build. This daemon has some networking and security considerations.
dockerpull requests for certain images. You can set up and use a pull through cache to circumvent this.
earthlyis running on a dedicated host, the only consideration to take is the ability to run the container in a
--privilegedmode. Typical installations should support this out of the box. We also support running under user namespaces, when
earthlyis configured to start the
earthly-buildkitcontainer with the
--userns hostoption. Rootless configurations are currently unsupported.
earthlyis connecting to a remote
earthly-buildkitd, then you will need to take additional steps. See this article for running a remote BuildKit instance.