b25dc10916063b63a3bd54d1255cef35569d53a6
[arvados.git] / doc / admin / upgrading.html.textile.liquid
1 ---
2 layout: default
3 navsection: admin
4 title: "Upgrading Arvados and Release notes"
5 ...
6
7 {% comment %}
8 Copyright (C) The Arvados Authors. All rights reserved.
9
10 SPDX-License-Identifier: CC-BY-SA-3.0
11 {% endcomment %}
12
13 What you need to know and do in order to upgrade your Arvados installation.
14
15 h2. General process
16
17 # Wait for the cluster to be idle and stop Arvados services.
18 # Install new packages using @apt-get upgrade@ or @yum upgrade@.
19 # Package installation scripts will perform any necessary data migrations.
20 # Consult upgrade notes below to see if any manual configuration updates are necessary.
21 # Restart Arvados services.
22
23 h2. Upgrade notes
24
25 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.
26
27 {% comment %}
28 Note to developers: Add new items at the top. Include the date, issue number, commit, and considerations/instructions for those about to upgrade.
29
30 TODO: extract this information based on git commit messages and generate changelogs / release notes automatically.
31 {% endcomment %}
32
33 table(table table-bordered table-condensed).
34 |_. development|"master":#master|\3.|
35 |_. latest stable|"v1.4.0":#v1_4_0|\3.|
36 |_\5. past stable|
37 |"v1.3.3":#v1_3_3|"v1.3.0":#v1_3_0|\3.|
38 |"v1.2.1":#v1_2_1|"v1.2.0":#v1_2_0|\3.|
39 |"v1.1.4":#v1_1_4|"v1.1.3":#v1_1_3|"v1.1.2":#v1_1_2|"v1.1.1":#v1_1_1|"v1.1.0":#v1_1_0|
40 |\5. "older":#older|
41
42 h3(#master). development master (as of 2019-06-07)
43
44 h4. No longer stripping ':' from strings in serialized database columns
45
46  (bug #15311) Strings read from serialized columns in the database with a leading ':' would have the ':' stripped after loading the record.  This behavior existed due to legacy serialization behavior which stored Ruby symbols with a leading ':'.  Unfortunately this corrupted fields where the leading ":" was intentional.  This behavior has been removed.
47
48 You can test if any records in your database are affected by going to the API server directory and running @bundle exec rake symbols:check@.  This will report which records contain fields with a leading ':' that would previously have been stripped.  If there are records to be updated, you can update the database using @bundle exec rake symbols:stringify@.
49
50 h3(#v1_4_0). v1.4.0 (2019-06-05)
51
52 h4. Populating the new file_count and file_size_total columns on the collections table
53
54 As part of story "#14484":https://dev.arvados.org/issues/14484, two new columns were added to the collections table in a database migration. If your installation has a large collections table, this migration may take some time. We've seen it take ~5 minutes on an installation with 250k collections, but your mileage may vary.
55
56 The new columns are initialized with a zero value. In order to populate them, it is necessary to run a script called <code class="userinput">populate-file-info-columns-in-collections.rb</code> from the scripts directory of the API server. This can be done out of band, ideally directly after the API server has been upgraded to v1.4.0.
57
58 h4. Stricter collection manifest validation on the API server
59
60 As a consequence of "#14482":https://dev.arvados.org/issues/14482, the Ruby SDK does a more rigorous collection manifest validation. Collections created after 2015-05 are unlikely to be invalid, however you may check for invalid manifests using the script below.
61
62 You could set up a new rvm gemset and install the specific arvados gem for testing, like so:
63
64 <notextile>
65 <pre><code>~$ <span class="userinput">rvm gemset create rubysdk-test</span>
66 ~$ <span class="userinput">rvm gemset use rubysdk-test</span>
67 ~$ <span class="userinput">gem install arvados -v 1.3.1.20190301212059</span>
68 </code></pre>
69 </notextile>
70
71 Next, you can run the following script using admin credentials, it will scan the whole collection database and report any collection that didn't pass the check:
72
73 {% codeblock as ruby %}
74 require 'arvados'
75 require 'arvados/keep'
76
77 api = Arvados.new
78 offset = 0
79 batch_size = 100
80 invalid = []
81
82 while true
83     begin
84         req = api.collection.index(
85             :select => [:uuid, :created_at, :manifest_text],
86             :include_trash => true, :include_old_versions => true,
87             :limit => batch_size, :offset => offset)
88     rescue
89         invalid.each {|c| puts "#{c[:uuid]} (Created at #{c[:created_at]}): #{c[:error]}" }
90         raise
91     end
92
93     req[:items].each do |col|
94         begin
95             Keep::Manifest.validate! col[:manifest_text]
96         rescue Exception => e
97             puts "Collection #{col[:uuid]} manifest not valid"
98             invalid << {uuid: col[:uuid], error: e, created_at: col[:created_at]}
99         end
100     end
101     puts "Checked #{offset} / #{req[:items_available]} - Invalid: #{invalid.size}"
102     offset += req[:limit]
103     break if offset > req[:items_available]
104 end
105
106 if invalid.empty?
107     puts "No invalid collection manifests found"
108 else
109     invalid.each {|c| puts "#{c[:uuid]} (Created at #{c[:created_at]}): #{c[:error]}" }
110 end
111 {% endcodeblock %}
112
113 The script will return a final report enumerating any invalid collection by UUID, with its creation date and error message so you can take the proper correction measures, if needed.
114
115 h4. Python packaging change
116
117 As part of story "#9945":https://dev.arvados.org/issues/9945, the distribution packaging (deb/rpm) of our Python packages has changed. These packages now include a built-in virtualenv to reduce dependencies on system packages. We have also stopped packaging and publishing backports for all the Python dependencies of our packages, as they are no longer needed.
118
119 One practical consequence of this change is that the use of the Arvados Python SDK (aka "import arvados") will require a tweak if the SDK was installed from a distribution package. It now requires the loading of the virtualenv environment from our packages. The "Install documentation for the Arvados Python SDK":/sdk/python/sdk-python.html reflects this change. This does not affect the use of the command line tools (e.g. arv-get, etc.).
120
121 Python scripts that rely on the distribution Arvados Python SDK packages to import the Arvados SDK will need to be tweaked to load the correct Python environment.
122
123 This can be done by activating the virtualenv outside of the script:
124
125 <notextile>
126 <pre>~$ <code class="userinput">source /usr/share/python2.7/dist/python-arvados-python-client/bin/activate</code>
127 (python-arvados-python-client) ~$ <code class="userinput">path-to-the-python-script</code>
128 </pre>
129 </notextile>
130
131 Or alternatively, by updating the shebang line at the start of the script to:
132
133 <notextile>
134 <pre>
135 #!/usr/share/python2.7/dist/python-arvados-python-client/bin/python
136 </pre>
137 </notextile>
138
139 h4. python-arvados-cwl-runner deb/rpm package now conflicts with python-cwltool deb/rpm package
140
141 As part of story "#9945":https://dev.arvados.org/issues/9945, the distribution packaging (deb/rpm) of our Python packages has changed. The python-arvados-cwl-runner package now includes a version of cwltool. If present, the python-cwltool and cwltool distribution packages will need to be uninstalled before the python-arvados-cwl-runner deb or rpm package can be installed.
142
143 h4. Centos7 Python 3 dependency upgraded to rh-python35
144
145 As part of story "#9945":https://dev.arvados.org/issues/9945, the Python 3 dependency for Centos7 Arvados packages was upgraded from SCL python33 to rh-python35.
146
147 h4. Centos7 package for libpam-arvados depends on the python-pam package, which is available from EPEL
148
149 As part of story "#9945":https://dev.arvados.org/issues/9945, it was discovered that the Centos7 package for libpam-arvados was missing a dependency on the python-pam package, which is available from the EPEL repository. The dependency has been added to the libpam-arvados package. This means that going forward, the EPEL repository will need to be enabled to install libpam-arvados on Centos7.
150
151 h4. New configuration
152
153 Arvados is migrating to a centralized configuration file for all components.  During the migration, legacy configuration files will continue to be loaded.  See "Migrating Configuration":config-migration.html for details.
154
155 h3(#v1_3_3). v1.3.3 (2019-05-14)
156
157 This release corrects a potential data loss issue, if you are running Arvados 1.3.0 or 1.3.1 we strongly recommended disabling @keep-balance@ until you can upgrade to 1.3.3 or 1.4.0. With keep-balance disabled, there is no chance of data loss.
158
159 We've put together a "wiki page":https://dev.arvados.org/projects/arvados/wiki/Recovering_lost_data which outlines how to recover blocks which have been put in the trash, but not yet deleted, as well as how to identify any collections which have missing blocks so that they can be regenerated. The keep-balance component has been enhanced to provide a list of missing blocks and affected collections and we've provided a "utility script":https://github.com/curoverse/arvados/blob/master/tools/keep-xref/keep-xref.py  which can be used to identify the workflows that generated those collections and who ran those workflows, so that they can be rerun.
160
161 h3(#v1_3_0). v1.3.0 (2018-12-05)
162
163 This release includes several database migrations, which will be executed automatically as part of the API server upgrade. On large Arvados installations, these migrations will take a while. We've seen the upgrade take 30 minutes or more on installations with a lot of collections.
164
165 The @arvados-controller@ component now requires the /etc/arvados/config.yml file to be present. See <a href="{{ site.baseurl }}/install/install-controller.html#configuration">the @arvados-controller@ installation instructions</a>.
166
167 Support for the deprecated "jobs" API is broken in this release.  Users who rely on it should not upgrade.  This will be fixed in an upcoming 1.3.1 patch release, however users are "encouraged to migrate":upgrade-crunch2.html as support for the "jobs" API will be dropped in an upcoming release.  Users who are already using the "containers" API are not affected.
168
169 h3(#v1_2_1). v1.2.1 (2018-11-26)
170
171 There are no special upgrade notes for this release.
172
173 h3(#v1_2_0). v1.2.0 (2018-09-05)
174
175 h4. Regenerate Postgres table statistics
176
177 It is recommended to regenerate the table statistics for Postgres after upgrading to v1.2.0. If autovacuum is enabled on your installation, this script would do the trick:
178
179 <pre>
180 #!/bin/bash
181
182 set -e
183 set -u
184
185 tables=`echo "\dt" | psql arvados_production | grep public|awk -e '{print $3}'`
186
187 for t in $tables; do
188     echo "echo 'analyze $t' | psql arvados_production"
189     time echo "analyze $t" | psql arvados_production
190 done
191 </pre>
192
193 If you also need to do the vacuum, you could adapt the script to run 'vacuum analyze' instead of 'analyze'.
194
195 h4. New component: arvados-controller
196
197 Commit "db5107dca":https://dev.arvados.org/projects/arvados/repository/revisions/db5107dca adds a new system service, arvados-controller. More detail is available in story "#13496":https://dev.arvados.org/issues/13497.
198
199 To add the Arvados Controller to your system please refer to the "installation instructions":../install/install-controller.html after upgrading your system to 1.2.0.
200
201 Verify your setup by confirming that API calls appear in the controller's logs (_e.g._, @journalctl -fu arvados-controller@) while loading a workbench page.
202
203 h3(#v1_1_4). v1.1.4 (2018-04-10)
204
205 h4. arvados-cwl-runner regressions (2018-04-05)
206
207 <strong>Secondary files missing from toplevel workflow inputs</strong>
208
209 This only affects workflows that rely on implicit discovery of secondaryFiles.
210
211 If a workflow input does not declare @secondaryFiles@ corresponding to the @secondaryFiles@ of workflow steps which use the input, the workflow would inconsistently succeed or fail depending on whether the input values were specified as local files or referenced an existing collection (and whether the existing collection contained the secondary files or not).  To ensure consistent behavior, the workflow is now required to declare in the top level workflow inputs any secondaryFiles that are expected by workflow steps.
212
213 As an example, the following workflow will fail because the @toplevel_input@ does not declare the @secondaryFiles@ that are expected by @step_input@:
214
215 <pre>
216 class: Workflow
217 cwlVersion: v1.0
218 inputs:
219   toplevel_input: File
220 outputs: []
221 steps:
222   step1:
223     in:
224       step_input: toplevel_input
225     out: []
226     run:
227       id: sub
228       class: CommandLineTool
229       inputs:
230         step_input:
231           type: File
232           secondaryFiles:
233             - .idx
234       outputs: []
235       baseCommand: echo
236 </pre>
237
238 When run, this produces an error like this:
239
240 <pre>
241 cwltool ERROR: [step step1] Cannot make job: Missing required secondary file 'hello.txt.idx' from file object: {
242     "basename": "hello.txt",
243     "class": "File",
244     "location": "keep:ade9d0e032044bd7f58daaecc0d06bc6+51/hello.txt",
245     "size": 0,
246     "nameroot": "hello",
247     "nameext": ".txt",
248     "secondaryFiles": []
249 }
250 </pre>
251
252 To fix this error, add the appropriate @secondaryFiles@ section to @toplevel_input@
253
254 <notextile>
255 <pre><code>class: Workflow
256 cwlVersion: v1.0
257 inputs:
258   <span class="userinput">toplevel_input:
259     type: File
260     secondaryFiles:
261       - .idx</span>
262 outputs: []
263 steps:
264   step1:
265     in:
266       step_input: toplevel_input
267     out: []
268     run:
269       id: sub
270       class: CommandLineTool
271       inputs:
272         step_input:
273           type: File
274           secondaryFiles:
275             - .idx
276       outputs: []
277       baseCommand: echo
278 </code></pre>
279 </notextile>
280
281 This bug has been fixed in Arvados release v1.2.0.
282
283 <strong>Secondary files on default file inputs</strong>
284
285 @File@ inputs that have default values and also expect @secondaryFiles@ and will fail to upload default @secondaryFiles@.  As an example, the following case will fail:
286
287 <pre>
288 class: CommandLineTool
289 inputs:
290   step_input:
291     type: File
292     secondaryFiles:
293       - .idx
294     default:
295       class: File
296       location: hello.txt
297 outputs: []
298 baseCommand: echo
299 </pre>
300
301 When run, this produces an error like this:
302
303 <pre>
304 2018-05-03 10:58:47 cwltool ERROR: Unhandled error, try again with --debug for more information:
305   [Errno 2] File not found: u'hello.txt.idx'
306 </pre>
307
308 To fix this, manually upload the primary and secondary files to keep and explicitly declare @secondaryFiles@ on the default primary file:
309
310 <notextile>
311 <pre><code>class: CommandLineTool
312 inputs:
313   step_input:
314     type: File
315     secondaryFiles:
316       - .idx
317     <span class="userinput">default:
318       class: File
319       location: keep:4d8a70b1e63b2aad6984e40e338e2373+69/hello.txt
320       secondaryFiles:
321        - class: File
322          location: keep:4d8a70b1e63b2aad6984e40e338e2373+69/hello.txt.idx</span>
323 outputs: []
324 baseCommand: echo
325 </code></pre>
326 </notextile>
327
328 This bug has been fixed in Arvados release v1.2.0.
329
330 h3(#v1_1_3). v1.1.3 (2018-02-08)
331
332 There are no special upgrade notes for this release.
333
334 h3(#v1_1_2). v1.1.2 (2017-12-22)
335
336 h4. The minimum version for Postgres is now 9.4 (2017-12-08)
337
338 As part of story "#11908":https://dev.arvados.org/issues/11908, commit "8f987a9271":https://dev.arvados.org/projects/arvados/repository/revisions/8f987a9271 introduces a dependency on Postgres 9.4. Previously, Arvados required Postgres 9.3.
339
340 * Debian 8 (pg 9.4) and Debian 9 (pg 9.6) do not require an upgrade
341 * Ubuntu 16.04 (pg 9.5) does not require an upgrade
342 * Ubuntu 14.04 (pg 9.3) requires upgrade to Postgres 9.4: https://www.postgresql.org/download/linux/ubuntu/
343 * CentOS 7 and RHEL7 (pg 9.2) require upgrade to Postgres 9.4. It is necessary to migrate of the contents of your database: https://www.postgresql.org/docs/9.0/static/migration.html
344 *# Create a database backup using @pg_dump@
345 *# Install the @rh-postgresql94@ backport package from either Software Collections: http://doc.arvados.org/install/install-postgresql.html or the Postgres developers: https://www.postgresql.org/download/linux/redhat/
346 *# Restore from the backup using @psql@
347
348 h3(#v1_1_1). v1.1.1 (2017-11-30)
349
350 There are no special upgrade notes for this release.
351
352 h3(#v1_1_0). v1.1.0 (2017-10-24)
353
354 h4. The minimum version for Postgres is now 9.3 (2017-09-25)
355
356 As part of story "#12032":https://dev.arvados.org/issues/12032, commit "68bdf4cbb1":https://dev.arvados.org/projects/arvados/repository/revisions/68bdf4cbb1 introduces a dependency on Postgres 9.3. Previously, Arvados required Postgres 9.1.
357
358 * Debian 8 (pg 9.4) and Debian 9 (pg 9.6) do not require an upgrade
359 * Ubuntu 16.04 (pg 9.5) does not require an upgrade
360 * Ubuntu 14.04 (pg 9.3) is compatible, however upgrading to Postgres 9.4 is recommended: https://www.postgresql.org/download/linux/ubuntu/
361 * CentOS 7 and RHEL7 (pg 9.2) should upgrade to Postgres 9.4. It is necessary to migrate of the contents of your database: https://www.postgresql.org/docs/9.0/static/migration.html
362 *# Create a database backup using @pg_dump@
363 *# Install the @rh-postgresql94@ backport package from either Software Collections: http://doc.arvados.org/install/install-postgresql.html or the Postgres developers: https://www.postgresql.org/download/linux/redhat/
364 *# Restore from the backup using @psql@
365
366 h3(#older). Older versions
367
368 h4. Upgrade slower than usual (2017-06-30)
369
370 As part of story "#11807":https://dev.arvados.org/issues/11807, commit "55aafbb":https://dev.arvados.org/projects/arvados/repository/revisions/55aafbb converts old "jobs" database records from YAML to JSON, making the upgrade process slower than usual.
371
372 * The migration can take some time if your database contains a substantial number of YAML-serialized rows (i.e., you installed Arvados before March 3, 2017 "660a614":https://dev.arvados.org/projects/arvados/repository/revisions/660a614 and used the jobs/pipelines APIs). Otherwise, the upgrade will be no slower than usual.
373 * The conversion runs as a database migration, i.e., during the deb/rpm package upgrade process, while your API server is unavailable.
374 * Expect it to take about 1 minute per 20K jobs that have ever been created/run.
375
376 h4. Service discovery overhead change in keep-web (2017-06-05)
377
378 As part of story "#9005":https://dev.arvados.org/issues/9005, commit "cb230b0":https://dev.arvados.org/projects/arvados/repository/revisions/cb230b0 reduces service discovery overhead in keep-web requests.
379
380 * When upgrading keep-web _or keepproxy_ to/past this version, make sure to update API server as well. Otherwise, a bad token in a request can cause keep-web to fail future requests until either keep-web restarts or API server gets upgraded.
381
382 h4. Node manager now has an http endpoint for management (2017-04-12)
383
384 As part of story "#11349":https://dev.arvados.org/issues/11349, commit "2c094e2":https://dev.arvados.org/projects/arvados/repository/revisions/2c094e2 adds a "management" http server to nodemanager.
385
386 * To enable it, add to your configuration file: <pre>[Manage]
387   address = 127.0.0.1
388   port = 8989</pre> (see example configuration files in source:services/nodemanager/doc or https://doc.arvados.org/install/install-nodemanager.html for more info)
389 * The server responds to @http://{address}:{port}/status.json@ with a summary of how many nodes are in each state (booting, busy, shutdown, etc.)
390
391 h4. New websockets component (2017-03-23)
392
393 As part of story "#10766":https://dev.arvados.org/issues/10766, commit "e8cc0d7":https://dev.arvados.org/projects/arvados/repository/revisions/e8cc0d7 replaces puma with arvados-ws as the recommended websocket server.
394 * See http://doc.arvados.org/install/install-ws.html for install/upgrade instructions.
395 * Remove the old puma server after the upgrade is complete. Example, with runit: <pre>
396 $ sudo sv down /etc/sv/puma
397 $ sudo rm -r /etc/sv/puma
398 </pre> Example, with systemd: <pre>
399 $ systemctl disable puma
400 $ systemctl stop puma
401 </pre>
402
403 h4. Change of database encoding for hashes and arrays (2017-03-06)
404
405 As part of story "#11168":https://dev.arvados.org/issues/11168, commit "660a614":https://dev.arvados.org/projects/arvados/repository/revisions/660a614 uses JSON instead of YAML to encode hashes and arrays in the database.
406
407 * Aside from a slight performance improvement, this should have no externally visible effect.
408 * Downgrading past this version is not supported, and is likely to cause errors. If this happens, the solution is to upgrade past this version.
409 * After upgrading, make sure to restart puma and crunch-dispatch-* processes.
410
411 h4. Docker image format compatibility check (2017-02-03)
412
413 As part of story "#10969":https://dev.arvados.org/issues/10969, commit "74a9dec":https://dev.arvados.org/projects/arvados/repository/revisions/74a9dec introduces a Docker image format compatibility check: the @arv keep docker@ command prevents users from inadvertently saving docker images that compute nodes won't be able to run.
414 * If your compute nodes run a version of *docker older than 1.10* you must override the default by adding to your API server configuration (@/etc/arvados/api/application.yml@): <pre><code class="yaml">docker_image_formats: ["v1"]</code></pre>
415 * Refer to the comments above @docker_image_formats@ in @/var/www/arvados-api/current/config/application.default.yml@ or source:services/api/config/application.default.yml or issue "#10969":https://dev.arvados.org/issues/10969 for more detail.
416 * *NOTE:* This does *not* include any support for migrating existing Docker images from v1 to v2 format. This will come later: for now, sites running Docker 1.9 or earlier should still *avoid upgrading Docker further than 1.9.*
417
418 h4. Debian and RPM packages now have systemd unit files (2016-09-27)
419
420 Several Debian and RPM packages -- keep-balance ("d9eec0b":https://dev.arvados.org/projects/arvados/repository/revisions/d9eec0b), keep-web ("3399e63":https://dev.arvados.org/projects/arvados/repository/revisions/3399e63), keepproxy ("6de67b6":https://dev.arvados.org/projects/arvados/repository/revisions/6de67b6), and arvados-git-httpd ("9e27ddf":https://dev.arvados.org/projects/arvados/repository/revisions/9e27ddf) -- now enable their respective components using systemd. These components prefer YAML configuration files over command line flags ("3bbe1cd":https://dev.arvados.org/projects/arvados/repository/revisions/3bbe1cd).
421
422 * On Debian-based systems using systemd, services are enabled automatically when packages are installed.
423 * On RedHat-based systems using systemd, unit files are installed but services must be enabled explicitly: e.g., <code>"sudo systemctl enable keep-web; sudo systemctl start keep-web"</code>.
424 * The new systemd-supervised services will not start up successfully until configuration files are installed in /etc/arvados/: e.g., <code>"Sep 26 18:23:55 62751f5bb946 keep-web[74]: 2016/09/26 18:23:55 open /etc/arvados/keep-web/keep-web.yml: no such file or directory"</code>
425 * To migrate from runit to systemd after installing the new packages, we recommend the following procedure:
426 *# Bring down the runit service: "sv down /etc/sv/keep-web"
427 *# Create a JSON configuration file (e.g., /etc/arvados/keep-web/keep-web.yml -- see "keep-web -help")
428 *# Ensure the service is running correctly under systemd: "systemctl status keep-web" / "journalctl -u keep-web"
429 *# Remove the runit service so it doesn't start at next boot
430 * Affected services:
431 ** keep-balance - /etc/arvados/keep-balance/keep-balance.yml
432 ** keep-web - /etc/arvados/keep-web/keep-web.yml
433 ** keepproxy - /etc/arvados/keepproxy/keepproxy.yml
434 ** arvados-git-httpd - /etc/arvados/arv-git-httpd/arv-git-httpd.yml
435
436 h4. Installation paths for Python modules and script changed (2016-05-31)
437
438 Commits "ae72b172c8":https://dev.arvados.org/projects/arvados/repository/revisions/ae72b172c8 and "3aae316c25":https://dev.arvados.org/projects/arvados/repository/revisions/3aae316c25 change the filesystem location where Python modules and scripts are installed.
439
440 * Previous packages installed these files to the distribution's preferred path under @/usr/local@ (or the equivalent location in a Software Collection).  Now they get installed to a path under @/usr@.  This improves compatibility with other Python packages provided by the distribution.  See "#9242":https://dev.arvados.org/issues/9242 for more background.
441 * If you simply import Python modules from scripts, or call Python tools relying on $PATH, you don't need to make any changes.  If you have hardcoded full paths to some of these files (e.g., in symbolic links or configuration files), you will need to update those paths after this upgrade.
442
443 h4. Crunchrunner package is required on compute and shell nodes (2016-04-25)
444
445 Commit "eebcb5e":https://dev.arvados.org/projects/arvados/repository/revisions/eebcb5e requires the crunchrunner package to be installed on compute nodes and shell nodes in order to run CWL workflows.
446
447 * On each Debian-based compute node and shell node, run: @sudo apt-get install crunchrunner@
448 * On each Red Hat-based compute node and shell node, run: @sudo yum install crunchrunner@
449
450 h4. Keep permission signature algorithm change (2016-04-21)
451
452 Commit "3c88abd":https://dev.arvados.org/projects/arvados/repository/revisions/3c88abd changes the Keep permission signature algorithm.
453
454 * All software components that generate signatures must be upgraded together. These are: keepstore, API server, 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.
455 * Jobs and client operations that are in progress during the upgrade (including arv-put's "resume cache") will fail.
456
457 h4. Workbench's "Getting Started" popup disabled by default (2015-01-05)
458
459 Commit "e1276d6e":https://dev.arvados.org/projects/arvados/repository/revisions/e1276d6e disables Workbench's "Getting Started" popup by default.
460
461 * If you want new users to continue seeing this popup, set @enable_getting_started_popup: true@ in Workbench's @application.yml@ configuration.
462
463 h4. Crunch jobs now have access to Keep-backed writable scratch storage (2015-12-03)
464
465 Commit "5590c9ac":https://dev.arvados.org/projects/arvados/repository/revisions/5590c9ac makes a Keep-backed writable scratch directory available in crunch jobs (see "#7751":https://dev.arvados.org/issues/7751)
466
467 * 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 "346a558":https://dev.arvados.org/projects/arvados/repository/revisions/346a558
468 * 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.
469
470 h4. Recommended configuration change for keep-web (2015-11-11)
471
472 Commit "1e2ace5":https://dev.arvados.org/projects/arvados/repository/revisions/1e2ace5 changes recommended config for keep-web (see "#5824":https://dev.arvados.org/issues/5824)
473
474 * proxy/dns/ssl config should be updated to route "https://download.uuid_prefix.arvadosapi.com/" requests to keep-web (alongside the existing "collections" routing)
475 * keep-web command line adds @-attachment-only-host download.uuid_prefix.arvadosapi.com@
476 * Workbench config adds @keep_web_download_url@
477 * More info on the (still beta/non-TOC-linked) "keep-web doc page":http://doc.arvados.org/install/install-keep-web.html
478
479 h4. Stopped containers are now automatically removed on compute nodes (2015-11-04)
480
481 Commit "1d1c6de":https://dev.arvados.org/projects/arvados/repository/revisions/1d1c6de removes stopped containers (see "#7444":https://dev.arvados.org/issues/7444)
482
483 * 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.
484
485 h4. New keep-web service (2015-11-04)
486
487 Commit "21006cf":https://dev.arvados.org/projects/arvados/repository/revisions/21006cf adds a new keep-web service (see "#5824":https://dev.arvados.org/issues/5824).
488
489 * Nothing relies on keep-web 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).