Arvados

h1. Upgrading to master

What you need to know and do in order to upgrade your Arvados site to the latest master.

h2. Basics

    apt-get dist-upgrade

(TODO: best order to upgrade? other best practices?)

h2. Notable changes

Some versions introduce changes that require special attention when upgrading: e.g., there is a new service to install, or there is a change to the default configuration that you might need to override in order to preserve the old behavior.

(Note to developers: Add new items at the top. Include a relevant commit hash (probably a merge), date, issue number/link, and considerations/instructions for those about to upgrade.)

2016-04-21: commit:3c88abd changes the Keep permission signature algorithm.

* All software components that generate signatures must be upgraded together. These are: keepstore, API server, data manager, keep-block-check, and keep-rsync. For example, if keepstore < 0.1.20160421183420 but API server >= 0.1.20160421183420, clients will not be able to read or write data in Keep.

* Jobs and client operations that are in progress during the upgrade (including arv-put's "resume cache") will fail.

2016-04-18: commit:a7d819f6 requires the crunchrunner package to be installed on compute nodes in order to run CWL workflows.

* On each Debian-based compute node, run: @sudo apt-get install crunchrunner@

* On each Red Hat-based compute node, run: @sudo yum install crunchrunner@

2015-01-05: commit:e1276d6e disables Workbench's "Getting Started" popup by default.

* If you want new users to continue seeing this popup, set @enable_getting_started_popup: true@ in Workbench's @application.yml@ configuration.

2015-12-03: commit:5590c9ac makes a Keep-backed writable scratch directory available in crunch jobs (see #7751)

* All compute nodes must be upgraded to arvados-fuse >= 0.1.2015112518060 because crunch-job uses some new arv-mount flags (--mount-tmp, --mount-by-pdh) introduced in merge commit:346a558

* Jobs will fail if the API server (in particular crunch-job from the arvados-cli gem) is upgraded without upgrading arvados-fuse on compute nodes.

2015-11-11: commit:1e2ace5 changes recommended config for keep-web (see #5824)

* proxy/dns/ssl config should be updated to route "https://download.uuid_prefix.arvadosapi.com/" requests to keep-web (alongside the existing "collections" routing)

* keep-web command line adds @-attachment-only-host download.uuid_prefix.arvadosapi.com@

* Workbench config adds @keep_web_download_url@

* More info on the (still beta/non-TOC-linked) "keep-web doc page":http://doc.arvados.org/install/install-keep-web.html

2015-11-04: commit:1d1c6de removes stopped containers (see #7444)

* arvados-docker-cleaner removes _all_ docker containers as soon as they exit, effectively making @docker run@ default to @--rm@. If you run arvados-docker-cleaner on a host that does anything other than run crunch-jobs, and you still want to be able to use @docker start@, read the "new doc page":http://doc.arvados.org/install/install-compute-node.html to learn how to turn this off before upgrading.

2015-11-04: commit:21006cf adds a keep-web service (see #5824)

* Nothing relies on it yet, but early adopters can install it now by following http://doc.arvados.org/install/install-keep-web.html (it is not yet linked in the TOC).