msaraiva/alpine-erlang msaraiva/alpine-erlang

  • Stars
    star
    205
  • Rank 191,264 (Top 4 %)
  • Language
  • Created over 9 years ago
  • Updated almost 9 years ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
msaraiva/alpine-erlang
github

msaraiva

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Minimal Erlang/Elixir docker images with Alpine Linux

Erlang/Elixir on Alpine Linux

Alpine Linux is a lightweight Linux distribution built around musl libc and busybox. The main focus of this distribution is security, simplicity and resource efficiency. All that makes Alpine Linux perfect to work as base images for linux containers.

Minimal docker images

When creating a docker image, you probably want to minimize its size as much as possible. At the same time, you might want to have access to a full-featured package system with a large range of packages available. As far as I can see, Alpine Linux is the best choice for that.

How minimal?

REPOSITORY                     TAG      IMAGE ID       CREATED           VIRTUAL SIZE
hello                          latest   dfee0002c943   12 minutes ago    20.75 MB
hello_phoenix                  latest   0ea00b410d90   24 minutes ago    25.09 MB
msaraiva/elixir                1.2.0    df35f2590cd3   38 minutes ago    23.23 MB
msaraiva/erlang                18.1     55ac7fb64a42   56 minutes ago    18.3 MB

Getting started (WIP)

Packages

In order to keep packages as compact as possible, Erlang libraries for Alpine Linux are split into many different packages. The full list of Erlang packages available can be found here.

What is apk?

The apk command is the official tool for package management on Alpine Linux. Something like apt-get on Ubuntu. More information about apk can be found here.

Installing packages with apk

Create a Dockerfile

FROM alpine:3.3

RUN apk --update add erlang && rm -rf /var/cache/apk/*

CMD ["/bin/sh"]

Build the image:

$ docker build -t erlang .

Run docker images. You should see something like:

REPOSITORY           TAG           IMAGE ID           CREATED             VIRTUAL SIZE
erlang               latest        d76965a1f753       4 seconds ago       18.3 MB

Building packages

You can see how packages are built by looking at the APKBUILD scripts:

For more info, see http://wiki.alpinelinux.org/wiki/APKBUILD_Reference

Patches

If you take a look at the APKBUILD scripts, you'll notice that some patches are applied in order to successfully build the packages. Some of those patches are related to musl, some to Busybox and some just split or remove stuff to make packages smaller.

Docker Images

Note: All base images listed here are automated builds and their Dockerfiles can be found in the dockerfiles folder.

Examples

I'll describe here some examples on how to create minimal docker images for Erlang/Elixir projects using Alpine Linux.

Hello world (compilation on host machine)

A simple command line executable

  • Source: https://github.com/msaraiva/docker-alpine-examples/
  • Built with mix escript.build
  • Compilation on host machine
  • Requires Erlang 18.1 and Elixir >= 1.1.1 on the host machine
  • You need to compile your application on the host machine before building this image

Dockerfile:

FROM msaraiva/erlang:18.1

ADD hello /usr/local/bin/hello

ENTRYPOINT ["/usr/local/bin/hello"]

Building:

$ git clone https://github.com/msaraiva/docker-alpine-examples
$ cd docker-alpine-examples/hello
$ MIX_ENV=prod mix escript.build
$ docker build -t hello .

Run docker images. You should see something like:

REPOSITORY           TAG           IMAGE ID           CREATED             VIRTUAL SIZE
hello                latest        ab3d45ddf551       18 seconds ago      20.75 MB

Running:

$ docker run --rm hello Docker
Hello, Docker!

Hello world (compilation inside the container)

The same simple command line executable. But:

  • Compilation inside the container
  • No need to install Erlang/Elixir on the host machine

Building:

$ docker run --rm -v $PWD:$PWD -w $PWD -e "MIX_ENV=prod" msaraiva/elixir sh -c "mix escript.build"

Running:

$ docker run --rm hello Docker
Hello, Docker!

Phoenix + Elixir Release Manager (exrm)

In order to generate releases for phoenix applications, you need to make some minimal changes in a couple of files. See this page from the Phoenix documentation for details. If you just want to see the changes, take a look at this commit.

Another thing to pay attention to, is the architecture of the build environment. From the same Phoenix documentation:

We need to be sure that the architectures for both our build and hosting environments are the same, e.g. 64-bit Linux -> 64-bit Linux. If the architectures don't match, our application might not run when deployed.

By default, exrm pulls the Erlang runtime system from the build environment. That means, if you generate a release, for instance, on Windows or OSX, your application will not run on Alpine Linux. There are two ways to deal with this:

  1. Instruct exrm to exclude the Erlang runtime from the release
  2. Gererate the release inside Alpine Linux

Note: To instruct exrm to exclude the Erlang runtime from the release, we need to create a file called rel/relx.config with this content: {include_erts, false}..

Let's see how we can do this.

Hello Phoenix

This is the hello phoenix application created when you run mix phoenix.new hello_phoenix --no-brunch --no-ecto

Dockerfile:

FROM msaraiva/erlang:18.1

RUN apk --update add erlang-crypto erlang-sasl && rm -rf /var/cache/apk/*

ENV APP_NAME hello_phoenix
ENV APP_VERSION "0.0.1"
ENV PORT 4000

RUN mkdir -p /$APP_NAME
ADD rel/$APP_NAME/bin /$APP_NAME/bin
ADD rel/$APP_NAME/lib /$APP_NAME/lib
ADD rel/$APP_NAME/releases/start_erl.data                 /$APP_NAME/releases/start_erl.data
ADD rel/$APP_NAME/releases/$APP_VERSION/$APP_NAME.sh      /$APP_NAME/releases/$APP_VERSION/$APP_NAME.sh
ADD rel/$APP_NAME/releases/$APP_VERSION/$APP_NAME.boot    /$APP_NAME/releases/$APP_VERSION/$APP_NAME.boot
ADD rel/$APP_NAME/releases/$APP_VERSION/$APP_NAME.rel     /$APP_NAME/releases/$APP_VERSION/$APP_NAME.rel
ADD rel/$APP_NAME/releases/$APP_VERSION/$APP_NAME.script  /$APP_NAME/releases/$APP_VERSION/$APP_NAME.script
ADD rel/$APP_NAME/releases/$APP_VERSION/start.boot        /$APP_NAME/releases/$APP_VERSION/start.boot
ADD rel/$APP_NAME/releases/$APP_VERSION/sys.config        /$APP_NAME/releases/$APP_VERSION/sys.config
ADD rel/$APP_NAME/releases/$APP_VERSION/vm.args           /$APP_NAME/releases/$APP_VERSION/vm.args

EXPOSE $PORT

CMD trap exit TERM; /$APP_NAME/bin/$APP_NAME foreground & wait

Building:

$ cd hello_phoenix
$ mix deps.get
$ MIX_ENV=prod mix compile
$ MIX_ENV=prod mix release
$ docker build -t hello_phoenix .

Running:

$ docker run --rm -p 4000:4000 hello_phoenix

Hello NIF

A simple command line executable that calculates a dot product of two lists on a NIF

Compiling:

$ cd hello_nif
$ docker run --rm -v $PWD:$PWD -w $PWD -e "MIX_ENV=prod" msaraiva/elixir-gcc sh -c "mix deps.get && mix escript.build"

Building the docker image:

$ docker build -t hello_nif .

Running:

$ docker run --rm hello_nif
Hello! This dot product was calculated by a NIF:
[1.0, 2.0, 3.0] x [5.0, 10.0, 20.0] = 85.0

Contributing

Contributions are more than welcome. There're a lot of ways to contribute:

  • Compiling and testing other projects based on Erlang
  • Maintaining packages or creating new ones
  • Patching existing packages
  • Creating or improving docker images
  • Creating new examples
  • Improving this page

Feedback is also very important. If you have something to share, fell free to open an issue.

Credits

Related Projects

Other Resources and News

More Repositories

1

atom-elixir

An Atom package for Elixir
Elixir
408
star
2

elixir_sense

Provides context-aware information for code completion, documentation, go/jump to definition, signature info and more
Elixir
189
star
3

exsamples

Initializes lists of maps, structs or keyword lists using tabular data in Elixir
Elixir
121
star
4

docker-alpine

25
star
5

vscode-surface

A VS Code extension to add syntax highlighting support for Surface/Elixir
16
star
6

surface_app

A bare bones Surface boilerplate without any node/npm dependencies
Elixir
12
star
7

docker-alpine-examples

Examples of Erlang/Elixir docker images with Alpine Linux
JavaScript
5
star
8

docker-busybox

A busybox image for Erlang/Elixir apps
1
star
9

func_call_parser

Elixir
1
star
10

change_track

Elixir
1
star