All-in-one package

(draft / work in progress, see #16306 and arvados-server boot)

"arvados-server-easy" is a debian/rpm package that can be used to create a single-node production cluster from scratch with minimal effort:

apt-get install arvados-server-easy
arvados-server init -cluster-id x1234
systemctl start arvados

This page is mostly about how we build/maintain the package, rather than how to use it.

Building

source:cmd/arvados-dev (similar to arvados-client/server) has:
  • a "buildpackage" subcommand that creates a deb/rpm package from source (i.e., a checkout of the arvados source tree, possibly with local modifications). It takes care of installing dependencies, fpm, etc.
  • "docker-build-install", a bash script (could move to Go) that builds a package for a given OS version by injecting the buildpackage command into a docker container with that OS version, installs the resulting package into a new base OS image, and saves the resulting image for testing purposes. (currently, debian:10 is implemented)
  • "docker-boot", a bash script (could move to Go) that brings up a cluster using the testing image (the one with arvados-server-easy already installed), optionally injecting local changes to enable a quicker dev cycle. For example, "docker-boot.sh cmd/arvados-server" builds a new arvados-server binary on the host, then starts a container using the test image but with the new arvados-server binary bind-mounted over the packaged one.

Package publishing outline (pseudocode):

./cmd/arvados-dev/docker-build-install.sh --os debian:10 --force-buildimage --force-installimage

Hacking

Development cycle, when working on Go programs and other things that docker-boot.sh knows how to rebuild+overlay:

./cmd/arvados-dev/docker-build-install.sh --os debian:10 # takes 10+ minutes
./cmd/arvados-dev/docker-boot.sh
# (edit some Go code locally)
./cmd/arvados-dev/docker-boot.sh cmd/arvados-server      # takes 15+ seconds to start postgresql, create db, etc., and boot
# (edit some Go code locally)
./cmd/arvados-dev/docker-boot.sh cmd/arvados-server nginx.conf
# ...

Development cycle when working on packaging parts:
  • Rebuild the package-building image from base OS image, then use it to build a new package (this is slow because it downloads/installs OS package dependencies, compiles Ruby, etc.):
    ./cmd/arvados-dev/docker-build-install.sh --os debian:10 --force-buildimage
  • Build a new package, then install it onto a base OS image (this checks whether the package still installs & boots correctly after you change the OS dependencies in source:lib/install, or after the base OS itself has changed):
    ./cmd/arvados-dev/docker-build-install.sh --os debian:10 --force-installimage
  • Build a new package, and reinstall it on the existing cached installimage (this builds and tests an actual package, but skips re-downloading/re-installing all of its OS dependencies):
    ./cmd/arvados-dev/docker-build-install.sh --os debian:10