Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/couchdb-ci
Apache CouchDB Continuous Integration (CI) support repository
https://github.com/apache/couchdb-ci
apache big-data cloud couchdb cplusplus database erlang http javascript network-client network-server
Last synced: 3 months ago
JSON representation
Apache CouchDB Continuous Integration (CI) support repository
- Host: GitHub
- URL: https://github.com/apache/couchdb-ci
- Owner: apache
- Created: 2015-07-04T07:00:05.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T17:43:12.000Z (3 months ago)
- Last Synced: 2024-10-01T01:09:06.705Z (3 months ago)
- Topics: apache, big-data, cloud, couchdb, cplusplus, database, erlang, http, javascript, network-client, network-server
- Language: Shell
- Homepage: https://github.com/apache/couchdb-ci
- Size: 10.1 MB
- Stars: 10
- Watchers: 20
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CouchDB Continuous Integration (CI) support repo
The main purpose of this repository is to provide scripts that:
* Install the necessary build-time dependencies for CouchDB on a number of platforms, either inside or outside of a container or VM
* Build Docker containers with those dependencies necessary to build binary JavaScript (SpiderMonkey 1.8.5) packages
* Build Docker containers with all dependencies necessary to build CouchDB, including Erlang and JavaScript
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](https://ci-couchdb.apache.org/blue/organizations/jenkins/pipelines) 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.
# Supported Configurations
See Docker Hub for the latest supported images:
- https://hub.docker.com/r/apache/couchdbci-debian/tags
- https://hub.docker.com/r/apache/couchdbci-ubuntu/tags
- https://hub.docker.com/r/apache/couchdbci-centos/tags
---
# Docker
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.
## Authenticating to Docker Hub
1. You need a Docker Cloud account with access to the `apache` organization to upload images. Ask the CouchDB PMC for assistance with this.
2. `export DOCKER_ID_USER="username"`
3. `docker login -u $username` and enter your password. (If using `podman` specify the registry `docker login -u $username docker.io`)
## Building a "platform image"
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 -
```
## Overriding the Erlang, Elixir or Node 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=18 ELIXIRVERSION=v1.17.2 ERLANGVERSION=25.3.2.13 ./build.sh platform debian-bullseye
```
## Building images for other architectures
### Multi-arch images with Docker Buildx
Use Docker's
[Buildx](https://docs.docker.com/buildx/working-with-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 --name apache-couchdb --use
```
The `build.sh` script has `buildx-base` and `buildx-platform` targets that will
will build **and upload** a new multi-arch container image to the registry. For
example:
```
./build.sh buildx-platform debian-bookworm
```
The `$BUILDX_PLATFORMS` environment variable can be used to override the default
set of target platforms that will be supplied to the buildx builder.
# Useful things you can do
## Update images used for package releases with new Erlang versions
```
ERLANGVERSION=24.3.4.7 ./build.sh buildx-platform-release
```
This will build all the Debian and RHEL-clone OS images on x86-64 with that version of Erlang
## Update images used for CI with new Erlang versions
```
ERLANGVERSION=24.3.4.7 ./build.sh buildx-platform debian-bookworm
```
This will update Debian Bullseye OS image for all architectures (x86,
ppc64le, arm64) with that version of Erlang. Do this for the images
which are used with non-x86 architectures.
If the same image is used for release package building and CI, run
this command after `buildx-platform-release` to ensure that the
debian-bullseye will be a rebuilt as a multi-arch image. Otherwise,
buildx-platform-release creates as x86 only.
## Update Debian Bullseye image with 25.2
```
BUILDX_PLATFORMS=linux/amd64 ERLANGVERSION=25.2 ./build.sh buildx-platform debian-bookworm
```
In this case, since we're not using 25.2 for multi-arch testing, opt to build it only for x86.
## Full `build.sh` options
```
./build.sh [OPTIONS]
Recognized commands:
clean Removes all images for .
clean-all Removes all images for all platforms.
*buildx-platform Builds a multi-architecture image with Erlang & JS support.
*buildx-platform-release Builds x86-64 images with default Erlang for all supported release OSes
couch Builds and tests CouchDB for .
couch-all Builds and tests CouchDB on all platforms.
Commands marked with * require appropriate Docker Hub credentials.
```
## Interactively working in a built container
After building the image as above:
```
docker run -it couchdbdev/
```
where `` is of the format `--`, such as `debian-bookworm-erlang-25.3.2.13`.
## Running the CouchDB build in a published container
```
./build.sh couch -
```
## Building SpiderMonkey 1.8.5 convenience packages
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 -
```
After building the base image as above, head over to the [apache/couchdb-pkg](https://github.com/apache/couchdb-pkg) repository and follow the instructions there.
## Adding support for a new release/platform/architecture
1. Update the build scripts in the `bin/` directory to install the dependencies correctly on your new OS/version/platform. Push a PR with these changes.
1. Copy and customize an appropriate Dockerfile in the `dockerfiles` directory for your new OS.
1. If a supported SpiderMonkey library is not available on the target platform, build a base image using `./build.sh base -`. Solve any problems with the build process here.
1. Using the [apache/couchdb-pkg](https://github.com/apache/couchdb-pkg) repository, validate you can build the JS package. Fix any problems in that repo that arise and raise a new PR. Open a new issue on that PR requesting that the JS packages be made available through the CouchDB repository/download infrastructure.
1. Build a full platform image with `./build.sh platform -`. Solve any problems with the build process here.
1. Submit a PR against the [apache/couchdb](https://github.com/apache/couchdb) repository, adding the new platform to the top level `Jenkinsfile`. Ask if you need help.
---
# Other platforms
We are eager for contributions to enhance the build scripts to support setting up machines with the necessary build environment for:
* NetBSD
* OpenBSD
* macOS
* Windows x64 (see [apache/couchdb-glazier](https://github.com/apache/couchdb-glazier]) for the current approach)
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.
# Background
See:
* this [thread](https://www.mail-archive.com/dev%40couchdb.apache.org/msg43591.html) on the couchdb-dev mailing list and
* this [ASF Infra ticket](https://issues.apache.org/jira/browse/INFRA-10126).
for the origins of this work.