| commit | d548cf3a2412afc1f6db4c19613abcd7af1fc6ce | [log] [tgz] |
|---|---|---|
| author | Adam Kocoloski <kocolosk@apache.org> | Tue Feb 08 12:39:54 2022 -0500 |
| committer | Nick Vatamaniuc <nickva@users.noreply.github.com> | Tue Apr 26 11:06:19 2022 -0400 |
| tree | 2f3e511517e45b8b4d5b90570db5b4ddbac8fa2d | |
| parent | 1ef076da9252d334ff6b7fa9ffc8123e6800d0ee [diff] |
Choose package repo dynamically
The main purpose of this repository is to provide scripts that:
It intends to cover a range of both operating systems (Linux, macOS, BSD, Windows) and Erlang versions (17.x, 18.x, 19.x, etc.)
These images are used by Apache Jenkins CI to build CouchDB with every checkin to main, 3.x, a release branch (e.g., 2.3.0), or an open Pull Request. CouchDB's CI build philosophy is to validate CouchDB against different Erlang versions with each commit to a Pull Request, and to validate CouchDB against different OSes and architectures on merged commits to main, 3.x, and release branches. Where possible, Jenkins also auto-builds convenience binaries or packages. The eventual goal is that these auto-built binaries/packages/Docker images will be auto-pushed to our distribution repos for downstream consumption.
| OS / distro | Version | Erlang Versions | Architectures | Docker? |
|---|---|---|---|---|
| debian | stretch | 19.3.6, 20.3.8.25 | x86_64, arm64v8 | :heavy_check_mark: |
| debian | buster | 20.3.8.25 | x86_64, arm64v8 | :heavy_check_mark: |
| ubuntu | bionic | 20.3.8.25 | x86_64 | :heavy_check_mark: |
| centos | 6 | 20.3.8.25 | x86_64 | :heavy_check_mark: |
| centos | 7 | 20.3.8.25 | x86_64 | :heavy_check_mark: |
| centos | 8 | 20.3.8.25 | x86_64 | :heavy_check_mark: |
| freebsd | 11.x | default | x86_64 | :x: |
| freebsd | 12.0 | default | x86_64 | :x: |
...with support now for any arbitrary Erlang version!
For those OSes that support Docker, we run builds inside of Docker containers. These containers are built using the build.sh command at the root level.
apache organization to upload new images. Ask the CouchDB PMC for assistance with this.export DOCKER_ID_USER="username"docker login -u "username" and enter your password.The platform images include all of the build dependencies necessary to build and full test CouchDB on a given OS/version/architecture combination.
Build a platform image with:
./build.sh platform <distro>-<version>
We want to generate a rebar binary compatible with all versions of Erlang we support. If we do this on too new a version, older Erlangs won't recognize it. So we always keep an image around with that version.
On the other hand, some OSes won't run older Erlangs because of library changes, so you need to override that environment variable.
Just specify on the command line any of the ERLANGVERSION, NODEVERSION, or ELIXIRVERSION environment variables:
NODEVERSION=8 ELIXIRVERSION=v1.6.1 ERLANGVERSION=17.5.3 ./build.sh platform debian-jessie
The tool also recognizes a special ERLANGVERSION=all value for the debian-buster platform. This builds the lowest, default, and highest versions of Erlang using the kerl build system, and installs them to /usr/local/kerl for activation before builds. This version is intended for use in standard CI runs, such as for pull requests.
We can use Docker‘s Buildx plugin to generate multi-architecture container images with a single command invocation. Docker Desktop ships with buildx support, but you’ll need to create a new builder to use it:
docker buildx create --use
Then, add the --platform flag to spin up parallel builders for each desired architecture. For example:
buildargs="--platform linux/amd64,linux/arm64,linux/ppc64le --push" ./build.sh platform debian-bullseye
will build and upload a new multi-arch container image to the registory. Currently docker images can only accept single-platform images, so this is one downside of the simplified build approach. Omitting the --push option will just leave the build result in the build cache, which isn't terribly useful.
If you built a single-architecture container image and did not supply --push as a build arg to upload it automatically you can upload the image using
./build.sh platform-upload <distro>-<version>
build.sh options./build.sh <command> [OPTIONS] Recognized commands: clean <plat> Removes all images for <plat>. clean-all Removes all images for all platforms. platform <plat> Builds the image for <plat> with Erlang & JS support. platform-all Builds all images with Erlang and JS support. *platform-upload Uploads the couchdbdev/*-erlang-* images to Docker Hub. *platform-upload-all Uploads all the couchdbdev/*-erlang-* images to Docker. couch <plat> Builds and tests CouchDB for <plat>. couch-all Builds and tests CouchDB on all platforms. Commands marked with * require appropriate Docker Hub credentials.
After building the image as above:
docker run -it couchdbdev/<tag>
where <tag> is of the format <distro>-<version>-<type>, such as debian-stretch-erlang-19.3.6.
./build.sh couch <distro>-<version>
This is only needed if a platform does not have a supported SpiderMonkey library. As of April 2021, this is no currently supported platform.
First, build the ‘base’ image with:
./build.sh base <distro>-<version>
After building the base image as above, head over to the apache/couchdb-pkg repository and follow the instructions there.
bin/ directory to install the dependencies correctly on your new OS/version/platform. Push a PR with these changes.dockerfiles directory for your new OS../build.sh base <distro>-<version>. Solve any problems with the build process here../build.sh platform <distro>-<version>. Solve any problems with the build process here.Jenkinsfile. Ask if you need help.We are eager for contributions to enhance the build scripts to support setting up machines with the necessary build environment for:
as well as alternative architectures for the already supported image types (armhf, ppc64le, s390x, sparc, etc).
We know that Docker won't support some of these, but we should be able to at least expand the install scripts for all of these platforms.
See: