Add a note about the python 3 package names in the upgrade guide.
[arvados.git] / doc / admin / upgrading.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
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 For Arvados administrators, this page will cover what you need to know and do in order to ensure a smooth upgrade of your Arvados installation.  For general release notes covering features added and bugs fixed, see "Arvados releases":https://arvados.org/releases .
14
15 h2. General process
16
17 # Consult upgrade notes below to see if any manual configuration updates are necessary.
18 # Wait for the cluster to be idle and stop Arvados services.
19 # Make a backup of your database, as a precaution.
20 # Install new packages using @apt-get upgrade@ or @yum upgrade@.
21 # Wait for package installation scripts as they perform any necessary data migrations.
22 # Restart Arvados services.
23
24 h2. Upgrade notes
25
26 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.
27
28 {% comment %}
29 Note to developers: Add new items at the top. Include the date, issue number, commit, and considerations/instructions for those about to upgrade.
30
31 TODO: extract this information based on git commit messages and generate changelogs / release notes automatically.
32 {% endcomment %}
33
34 <notextile>
35 <div class="releasenotes">
36 </notextile>
37
38 h2(#main). v2.1.2 (as of 2021-02-22)
39
40 "Upgrading from 2.1.0":#v2_1_0
41
42 h3. System token requirements
43
44 System services now log a warning at startup if any of the system tokens (@ManagementToken@, @SystemRootToken@, and @Collections.BlobSigningKey@) are less than 32 characters, or contain characters other than a-z, A-Z, and 0-9. After upgrading, run @arvados-server config-check@ and update your configuration file if needed to resolve any warnings.
45
46 The @API.RailsSessionSecretToken@ configuration key has been removed. Delete this entry from your configuration file after upgrading.
47
48 h2(#v2_1_0). v2.1.0 (2020-10-13)
49
50 "Upgrading from 2.0.0":#v2_0_0
51
52 h3. LoginCluster conflicts with other Login providers
53
54 A satellite cluster that delegates its user login to a central user database must only have `Login.LoginCluster` set, or it will return an error.  This is a change in behavior, previously it would return an error if another login provider was _not_ configured, even though the provider would never be used.
55
56 h3. Minimum supported Python version is now 3.5
57
58 We no longer publish Python 2 based distribution packages for our Python components. There are equivalent packages based on Python 3, but their names are slightly different. If you were using the Python 2 based packages, you can install the Python 3 based package for a drop in replacement. On Debian and Ubuntu:
59
60 <pre>
61     apt remove python-arvados-fuse && apt install python3-arvados-fuse
62     apt remove python-arvados-python-client && apt install python3-arvados-python-client
63     apt remove python-arvados-cwl-runner && apt install python3-arvados-cwl-runner
64     apt remove python-crunchstat-summary && apt install python3-crunchstat-summary
65     apt remove python-cwltest && apt install python3-cwltest
66 </pre>
67
68 On CentOS:
69
70 <pre>
71     yum remove python-arvados-fuse && yum install rh-python36-python-arvados-fuse
72     yum remove python-arvados-python-client && yum install rh-python36-python-arvados-python-client
73     yum remove python-arvados-cwl-runner && yum install rh-python36-python-arvados-cwl-runner
74     yum remove python-crunchstat-summary && yum install rh-python36-python-crunchstat-summary
75     yum remove python-cwltest && yum install rh-python36-python-cwltest
76 </pre>
77
78 h3. Minimum supported Ruby version is now 2.5
79
80 The minimum supported Ruby version is now 2.5.  If you are running Arvados on Debian 9 or Ubuntu 16.04, you may need to switch to using RVM or upgrade your OS.  See "Install Ruby and Bundler":../install/ruby.html for more information.
81
82 h3. Removing libpam-arvados, replaced with libpam-arvados-go
83
84 The Python-based PAM package has been replaced with a version written in Go. See "using PAM for authentication":{{site.baseurl}}/install/setup-login.html#pam for details.
85
86 h3. Removing sso-provider
87
88 The SSO (single sign-on) component is deprecated and will not be supported in future releases. Existing configurations will continue to work in this release, but you should switch to one of the built-in authentication mechanisms as soon as possible. See "setting up web based login":{{site.baseurl}}/install/setup-login.html for details.
89
90 After migrating your configuration, uninstall the @arvados-sso-provider@ package.
91
92 h3. S3 signatures
93
94 Keepstore now uses "V4 signatures":https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html by default for S3 requests. If you are using Amazon S3, no action is needed; all regions support V4 signatures. If you are using a different S3-compatible service that does not support V4 signatures, add @V2Signature: true@ to your volume driver parameters to preserve the old behavior. See "configuring S3 object storage":{{site.baseurl}}/install/configure-s3-object-storage.html.
95
96 h3. New permission system constraints
97
98 Some constraints on the permission system have been added, in particular @role@ and @project@ group types now have distinct behavior. These constraints were already de-facto imposed by the Workbench UI, so on most installations the only effect of this migration will be to reassign @role@ groups to the system user and create a @can_manage@ permission link for the previous owner.
99
100 # The @group_class@ field must be either @role@ or @project@. Invalid group_class are migrated to @role@.
101 # A @role@ cannot own things. Anything owned by a role is migrated to a @can_manage@ link and reassigned to the system user.
102 # Only @role@ and @user@ can have outgoing permission links. Permission links originating from projects are deleted by the migration.
103 # A @role@ is always owned by the system_user. When a group is created, it creates a @can_manage@ link for the object that would have been assigned to @owner_uuid@.  Migration adds @can_manage@ links and reassigns roles to the system user.  This also has the effect of requiring that all @role@ groups have unique names on the system.  If there is a name collision during migration, roles will be renamed to ensure they are unique.
104 # A permission link can have the permission level (@name@) updated but not @head_uuid@, @tail_uuid@ or @link_class@.
105
106 The @arvados-sync-groups@ tool has been updated to reflect these constraints, so it is important to use the version of @arvados-sync-groups@ that matches the API server version.
107
108 Before upgrading, use the following commands to find out which groups and permissions in your database will be automatically modified or deleted during the upgrade.
109
110 To determine which groups have invalid @group_class@ (these will be migrated to @role@ groups):
111
112 <pre>
113 arv group list --filters '[["group_class", "not in", ["project", "role"]]]'
114 </pre>
115
116 To list all @role@ groups, which will be reassigned to the system user (unless @owner_uuid@ is already the system user):
117
118 <pre>
119 arv group list --filters '[["group_class", "=", "role"]]'
120 </pre>
121
122 To list which @project@ groups have outgoing permission links (such links are now invalid and will be deleted by the migration):
123
124 <pre>
125 for uuid in $(arv link list --filters '[["link_class", "=", "permission"], ["tail_uuid", "like", "%-j7d0g-%"]]' |
126               jq -r .items[].tail_uuid | sort | uniq) ; do
127    arv group list --filters '[["group_class", "=", "project"], ["uuid", "=", "'$uuid'"]]' | jq .items
128 done
129 </pre>
130
131 h4. "Public favorites" moved to their own project
132
133 As a side effect of new permission system constraints, "star" links (indicating shortcuts in Workbench) that were previously owned by "All users" (which is now a "role" and cannot own things) will be migrated to a new system project called "Public favorites" which is readable by the "Anonymous users" role.
134
135 h2(#v2_0_0). v2.0.0 (2020-02-07)
136
137 "Upgrading from 1.4":#v1_4_1
138
139 Arvados 2.0 is a major upgrade, with many changes.  Please read these upgrade notes carefully before you begin.
140
141 h3. Migrating to centralized config.yml
142
143 See "Migrating Configuration":config-migration.html for notes on migrating legacy per-component configuration files to the new centralized @/etc/arvados/config.yml@.
144
145 To ensure a smooth transition, the per-component config files continue to be read, and take precedence over the centralized configuration.  Your cluster should continue to function after upgrade but before doing the full configuration migration.  However, several services (keepstore, keep-web, keepproxy) require a minimal `/etc/arvados/config.yml` to start:
146
147 <pre>
148 Clusters:
149   zzzzz:
150     Services:
151       Controller:
152         ExternalURL: "https://zzzzz.example.com"
153 </pre>
154
155 h3. Keep-balance configuration migration
156
157 (feature "#14714":https://dev.arvados.org/issues/14714 ) The keep-balance service can now be configured using the centralized configuration file at @/etc/arvados/config.yml@. The following command line and configuration options have changed.
158
159 You can no longer specify types of keep services to balance via the @KeepServiceTypes@ config option in the legacy config at @/etc/arvados/keep-balance/keep-balance.yml@. If you are still using the legacy config and @KeepServiceTypes@ has a value other than "disk", keep-balance will produce an error.
160
161 You can no longer specify individual keep services to balance via the @config.KeepServiceList@ command line option or @KeepServiceList@ legacy config option. Instead, keep-balance will operate on all keepstore servers with @service_type:disk@ as reported by the @arv keep_service list@ command. If you are still using the legacy config, @KeepServiceList@ should be removed or keep-balance will produce an error.
162
163 Please see the "config migration guide":{{site.baseurl}}/admin/config-migration.html and "keep-balance install guide":{{site.baseurl}}/install/install-keep-balance.html for more details.
164
165 h3. Arv-git-httpd configuration migration
166
167 (feature "#14712":https://dev.arvados.org/issues/14712 ) The arv-git-httpd package can now be configured using the centralized configuration file at @/etc/arvados/config.yml@. Configuration via individual command line arguments is no longer available. Please see "arv-git-httpd's config migration guide":{{site.baseurl}}/admin/config-migration.html#arv-git-httpd for more details.
168
169 h3. Keepstore and keep-web configuration migration
170
171 keepstore and keep-web no longer support configuration via (previously deprecated) command line configuration flags and environment variables.
172
173 keep-web now supports the legacy @keep-web.yml@ config format (used by Arvados 1.4) and the new cluster config file format. Please check "keep-web's install guide":{{site.baseurl}}/install/install-keep-web.html for more details.
174
175 keepstore now supports the legacy @keepstore.yml@ config format (used by Arvados 1.4) and the new cluster config file format. Please check the "keepstore config migration notes":{{site.baseurl}}/admin/config-migration.html#keepstore and "keepstore install guide":{{site.baseurl}}/install/install-keepstore.html for more details.
176
177 h3. Keepproxy configuration migration
178
179 (feature "#14715":https://dev.arvados.org/issues/14715 ) Keepproxy can now be configured using the centralized config at @/etc/arvados/config.yml@. Configuration via individual command line arguments is no longer available and the @DisableGet@, @DisablePut@, and @PIDFile@ configuration options are no longer supported. If you are still using the legacy config and @DisableGet@ or @DisablePut@ are set to true or @PIDFile@ has a value, keepproxy will produce an error and fail to start. Please see "keepproxy's config migration guide":{{site.baseurl}}/admin/config-migration.html#keepproxy for more details.
180
181 h3. Delete "keep_services" records
182
183 After all keepproxy and keepstore configurations have been migrated to the centralized configuration file, all keep_services records you added manually during installation should be removed. System logs from keepstore and keepproxy at startup, as well as the output of @arvados-server config-check@, will remind you to do this.
184
185 <notextile><pre><code>$ export ARVADOS_API_HOST=...
186 $ export ARVADOS_API_TOKEN=...
187 $ arv --format=uuid keep_service list | xargs -n1 arv keep_service delete --uuid
188 </code></pre></notextile>
189
190 Once these old records are removed, @arv keep_service list@ will instead return the services listed under Services/Keepstore/InternalURLs and Services/Keepproxy/ExternalURL in your centralized configuration file.
191
192 h3. Enabling Postgres trigram indexes
193
194 Feature "#15106":https://dev.arvados.org/issues/15106 improves the speed and functionality of full text search by introducing trigram indexes on text searchable database columns via a migration. Prior to updating, you must first install the postgresql-contrib package on your system and subsequently run the <code class="userprint">CREATE EXTENSION pg_trgm</code> SQL command on the arvados_production database as a postgres superuser.
195
196 The "postgres-contrib package":https://www.postgresql.org/docs/10/contrib.html has been supported since PostgreSQL version 9.4. The version of the contrib package should match the version of your PostgreSQL installation. Using 9.5 as an example, the package can be installed and the extension enabled using the following:
197
198 <strong>Centos 7</strong>
199 <notextile>
200 <pre><code>~$ <span class="userinput">sudo yum install -y postgresql95-contrib</span>
201 ~$ <span class="userinput">su - postgres -c "psql -d 'arvados_production' -c 'CREATE EXTENSION IF NOT EXISTS pg_trgm'"</span>
202 </code></pre>
203 </notextile>
204
205 <strong>RHEL 7</strong>
206 <notextile>
207 <pre><code>~$ <span class="userinput">sudo yum install -y rh-postgresql95-postgresql-contrib</span>
208 ~$ <span class="userinput">su - postgres -c "psql -d 'arvados_production' -c 'CREATE EXTENSION IF NOT EXISTS pg_trgm'"</span>
209 </code></pre>
210 </notextile>
211
212 <strong>Debian or Ubuntu</strong>
213 <notextile>
214 <pre><code>~$ <span class="userinput">sudo apt-get install -y postgresql-contrib-9.5</span>
215 ~$ <span class="userinput">sudo -u postgres psql -d 'arvados_production' -c 'CREATE EXTENSION IF NOT EXISTS pg_trgm'</span>
216 </code></pre>
217 </notextile>
218
219 Subsequently, the <code class="userinput">psql -d 'arvados_production' -c '\dx'</code> command will display the installed extensions for the arvados_production database. This list should now contain @pg_trgm@.
220
221 h3. New Workbench 2
222
223 Workbench 2 is now ready for regular use.  Follow the instructions to "install workbench 2":../install/install-workbench2-app.html
224
225 h3. New property vocabulary format for Workbench2
226
227 (feature "#14151":https://dev.arvados.org/issues/14151) Workbench2 supports a new vocabulary format and it isn't compatible with the previous one, please read the "workbench2 vocabulary format admin page":{{site.baseurl}}/admin/workbench2-vocabulary.html for more information.
228
229 h3. Cloud installations only: node manager replaced by arvados-dispatch-cloud
230
231 Node manager is deprecated and replaced by @arvados-dispatch-cloud@.  No automated config migration is available.  Follow the instructions to "install the cloud dispatcher":../install/crunch2-cloud/install-dispatch-cloud.html
232
233 *Only one dispatch process should be running at a time.* If you are migrating a system that currently runs Node manager and @crunch-dispatch-slurm@, it is safest to remove the @crunch-dispatch-slurm@ service entirely before installing @arvados-dispatch-cloud@.
234
235 <notextile>
236 <pre><code>~$ <span class="userinput">sudo systemctl --now disable crunch-dispatch-slurm</span>
237 ~$ <span class="userinput">sudo apt-get remove crunch-dispatch-slurm</span>
238 </code></pre>
239 </notextile>
240
241 h3. Jobs API is read-only
242
243 (task "#15133":https://dev.arvados.org/issues/15133 ) The legacy 'jobs' API is now read-only.  It has been superceded since Arvados 1.1 by containers / container_requests (aka crunch v2).  Arvados installations since the end of 2017 (v1.1.0) have probably only used containers, and are unaffected by this change.
244
245 So that older Arvados sites don't lose access to legacy records, the API has been converted to read-only.  Creating and updating jobs (and related types job_task, pipeline_template and pipeline_instance) is disabled and much of the business logic related has been removed, along with various other code specific to the jobs API.  Specifically, the following programs associated with the jobs API have been removed: @crunch-dispatch.rb@, @crunch-job@, @crunchrunner@, @arv-run-pipeline-instance@, @arv-run@.
246
247 h3. "/" prohibited in collection and project names
248
249 (issue "#15836":https://dev.arvados.org/issues/15836) By default, Arvados now rejects new names containing the @/@ character when creating or renaming collections and projects. Previously, these names were permitted, but the resulting objects were invisible in the WebDAV "home" tree. If you prefer, you can restore the previous behavior, and optionally configure a substitution string to make the affected objects accessible via WebDAV. See @ForwardSlashNameSubstitution@ in the "configuration reference":config.html.
250
251 h3. No longer stripping ':' from strings in serialized database columns
252
253 (bug "#15311":https://dev.arvados.org/issues/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.
254
255 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@.
256
257 h3. Scoped tokens should use PATCH for updates
258
259 The API server accepts both PUT and PATCH for updates, but they will be normalized to PATCH by arvados-controller.  Scoped tokens should be updated accordingly.
260
261
262
263 h2(#v1_4_1). v1.4.1 (2019-09-20)
264
265 "Upgrading from 1.4.0":#v1_4_0
266
267 h3. Centos7 Python 3 dependency upgraded to rh-python36
268
269 The Python 3 dependency for Centos7 Arvados packages was upgraded from rh-python35 to rh-python36.
270
271 h2(#v1_4_0). v1.4.0 (2019-06-05)
272
273 "Upgrading from 1.3.3":#v1_3_3
274
275 h3. Populating the new file_count and file_size_total columns on the collections table
276
277 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.
278
279 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.
280
281 h3. Stricter collection manifest validation on the API server
282
283 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.
284
285 You could set up a new rvm gemset and install the specific arvados gem for testing, like so:
286
287 <notextile>
288 <pre><code>~$ <span class="userinput">rvm gemset create rubysdk-test</span>
289 ~$ <span class="userinput">rvm gemset use rubysdk-test</span>
290 ~$ <span class="userinput">gem install arvados -v 1.3.1.20190301212059</span>
291 </code></pre>
292 </notextile>
293
294 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:
295
296 {% codeblock as ruby %}
297 require 'arvados'
298 require 'arvados/keep'
299
300 api = Arvados.new
301 offset = 0
302 batch_size = 100
303 invalid = []
304
305 while true
306     begin
307         req = api.collection.index(
308             :select => [:uuid, :created_at, :manifest_text],
309             :include_trash => true, :include_old_versions => true,
310             :limit => batch_size, :offset => offset)
311     rescue
312         invalid.each {|c| puts "#{c[:uuid]} (Created at #{c[:created_at]}): #{c[:error]}" }
313         raise
314     end
315
316     req[:items].each do |col|
317         begin
318             Keep::Manifest.validate! col[:manifest_text]
319         rescue Exception => e
320             puts "Collection #{col[:uuid]} manifest not valid"
321             invalid << {uuid: col[:uuid], error: e, created_at: col[:created_at]}
322         end
323     end
324     puts "Checked #{offset} / #{req[:items_available]} - Invalid: #{invalid.size}"
325     offset += req[:limit]
326     break if offset > req[:items_available]
327 end
328
329 if invalid.empty?
330     puts "No invalid collection manifests found"
331 else
332     invalid.each {|c| puts "#{c[:uuid]} (Created at #{c[:created_at]}): #{c[:error]}" }
333 end
334 {% endcodeblock %}
335
336 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.
337
338 h3. Python packaging change
339
340 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.
341
342 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.).
343
344 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.
345
346 This can be done by activating the virtualenv outside of the script:
347
348 <notextile>
349 <pre>~$ <code class="userinput">source /usr/share/python2.7/dist/python-arvados-python-client/bin/activate</code>
350 (python-arvados-python-client) ~$ <code class="userinput">path-to-the-python-script</code>
351 </pre>
352 </notextile>
353
354 Or alternatively, by updating the shebang line at the start of the script to:
355
356 <notextile>
357 <pre>
358 #!/usr/share/python2.7/dist/python-arvados-python-client/bin/python
359 </pre>
360 </notextile>
361
362 h3. python-arvados-cwl-runner deb/rpm package now conflicts with python-cwltool deb/rpm package
363
364 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.
365
366 h3. Centos7 Python 3 dependency upgraded to rh-python35
367
368 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.
369
370 h3. Centos7 package for libpam-arvados depends on the python-pam package, which is available from EPEL
371
372 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.
373
374 h3. New configuration
375
376 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.
377
378 h2(#v1_3_3). v1.3.3 (2019-05-14)
379
380 "Upgrading from 1.3.0":#v1_3_0
381
382 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.
383
384 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/arvados/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.
385
386 h2(#v1_3_0). v1.3.0 (2018-12-05)
387
388 "Upgrading from 1.2":#v1_2_0
389
390 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.
391
392 The @arvados-controller@ component now requires the /etc/arvados/config.yml file to be present.
393
394 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.
395
396 h2(#v1_2_1). v1.2.1 (2018-11-26)
397
398 There are no special upgrade notes for this release.
399
400 h2(#v1_2_0). v1.2.0 (2018-09-05)
401
402 "Upgrading from 1.1.2 or 1.1.3":#v1_1_2
403
404 h3. Regenerate Postgres table statistics
405
406 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:
407
408 <pre>
409 #!/bin/bash
410
411 set -e
412 set -u
413
414 tables=`echo "\dt" | psql arvados_production | grep public|awk -e '{print $3}'`
415
416 for t in $tables; do
417     echo "echo 'analyze $t' | psql arvados_production"
418     time echo "analyze $t" | psql arvados_production
419 done
420 </pre>
421
422 If you also need to do the vacuum, you could adapt the script to run 'vacuum analyze' instead of 'analyze'.
423
424 h3. New component: arvados-controller
425
426 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.
427
428 To add the Arvados Controller to your system please refer to the "installation instructions":../install/install-api-server.html after upgrading your system to 1.2.0.
429
430 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.
431
432 h2(#v1_1_4). v1.1.4 (2018-04-10)
433
434 "Upgrading from 1.1.3":#v1_1_3
435
436 h3. arvados-cwl-runner regressions (2018-04-05)
437
438 <strong>Secondary files missing from toplevel workflow inputs</strong>
439
440 This only affects workflows that rely on implicit discovery of secondaryFiles.
441
442 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.
443
444 As an example, the following workflow will fail because the @toplevel_input@ does not declare the @secondaryFiles@ that are expected by @step_input@:
445
446 <pre>
447 class: Workflow
448 cwlVersion: v1.0
449 inputs:
450   toplevel_input: File
451 outputs: []
452 steps:
453   step1:
454     in:
455       step_input: toplevel_input
456     out: []
457     run:
458       id: sub
459       class: CommandLineTool
460       inputs:
461         step_input:
462           type: File
463           secondaryFiles:
464             - .idx
465       outputs: []
466       baseCommand: echo
467 </pre>
468
469 When run, this produces an error like this:
470
471 <pre>
472 cwltool ERROR: [step step1] Cannot make job: Missing required secondary file 'hello.txt.idx' from file object: {
473     "basename": "hello.txt",
474     "class": "File",
475     "location": "keep:ade9d0e032044bd7f58daaecc0d06bc6+51/hello.txt",
476     "size": 0,
477     "nameroot": "hello",
478     "nameext": ".txt",
479     "secondaryFiles": []
480 }
481 </pre>
482
483 To fix this error, add the appropriate @secondaryFiles@ section to @toplevel_input@
484
485 <notextile>
486 <pre><code>class: Workflow
487 cwlVersion: v1.0
488 inputs:
489   <span class="userinput">toplevel_input:
490     type: File
491     secondaryFiles:
492       - .idx</span>
493 outputs: []
494 steps:
495   step1:
496     in:
497       step_input: toplevel_input
498     out: []
499     run:
500       id: sub
501       class: CommandLineTool
502       inputs:
503         step_input:
504           type: File
505           secondaryFiles:
506             - .idx
507       outputs: []
508       baseCommand: echo
509 </code></pre>
510 </notextile>
511
512 This bug has been fixed in Arvados release v1.2.0.
513
514 <strong>Secondary files on default file inputs</strong>
515
516 @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:
517
518 <pre>
519 class: CommandLineTool
520 inputs:
521   step_input:
522     type: File
523     secondaryFiles:
524       - .idx
525     default:
526       class: File
527       location: hello.txt
528 outputs: []
529 baseCommand: echo
530 </pre>
531
532 When run, this produces an error like this:
533
534 <pre>
535 2018-05-03 10:58:47 cwltool ERROR: Unhandled error, try again with --debug for more information:
536   [Errno 2] File not found: u'hello.txt.idx'
537 </pre>
538
539 To fix this, manually upload the primary and secondary files to keep and explicitly declare @secondaryFiles@ on the default primary file:
540
541 <notextile>
542 <pre><code>class: CommandLineTool
543 inputs:
544   step_input:
545     type: File
546     secondaryFiles:
547       - .idx
548     <span class="userinput">default:
549       class: File
550       location: keep:4d8a70b1e63b2aad6984e40e338e2373+69/hello.txt
551       secondaryFiles:
552        - class: File
553          location: keep:4d8a70b1e63b2aad6984e40e338e2373+69/hello.txt.idx</span>
554 outputs: []
555 baseCommand: echo
556 </code></pre>
557 </notextile>
558
559 This bug has been fixed in Arvados release v1.2.0.
560
561 h2(#v1_1_3). v1.1.3 (2018-02-08)
562
563 There are no special upgrade notes for this release.
564
565 h2(#v1_1_2). v1.1.2 (2017-12-22)
566
567 "Upgrading from 1.1.0 or 1.1.1":#v1_1_0
568
569 h3. The minimum version for Postgres is now 9.4 (2017-12-08)
570
571 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.
572
573 * Debian 8 (pg 9.4) and Debian 9 (pg 9.6) do not require an upgrade
574 * Ubuntu 16.04 (pg 9.5) does not require an upgrade
575 * Ubuntu 14.04 (pg 9.3) requires upgrade to Postgres 9.4: https://www.postgresql.org/download/linux/ubuntu/
576 * 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
577 *# Create a database backup using @pg_dump@
578 *# 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/
579 *# Restore from the backup using @psql@
580
581 h2(#v1_1_1). v1.1.1 (2017-11-30)
582
583 There are no special upgrade notes for this release.
584
585 h2(#v1_1_0). v1.1.0 (2017-10-24)
586
587 h3. The minimum version for Postgres is now 9.3 (2017-09-25)
588
589 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.
590
591 * Debian 8 (pg 9.4) and Debian 9 (pg 9.6) do not require an upgrade
592 * Ubuntu 16.04 (pg 9.5) does not require an upgrade
593 * Ubuntu 14.04 (pg 9.3) is compatible, however upgrading to Postgres 9.4 is recommended: https://www.postgresql.org/download/linux/ubuntu/
594 * 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
595 *# Create a database backup using @pg_dump@
596 *# 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/
597 *# Restore from the backup using @psql@
598
599 h2(#older). Older versions
600
601 h3. Upgrade slower than usual (2017-06-30)
602
603 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.
604
605 * 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.
606 * The conversion runs as a database migration, i.e., during the deb/rpm package upgrade process, while your API server is unavailable.
607 * Expect it to take about 1 minute per 20K jobs that have ever been created/run.
608
609 h3. Service discovery overhead change in keep-web (2017-06-05)
610
611 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.
612
613 * 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.
614
615 h3. Node manager now has an http endpoint for management (2017-04-12)
616
617 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.
618
619 * To enable it, add to your configuration file: <pre>[Manage]
620   address = 127.0.0.1
621   port = 8989</pre>
622 * The server responds to @http://{address}:{port}/status.json@ with a summary of how many nodes are in each state (booting, busy, shutdown, etc.)
623
624 h3. New websockets component (2017-03-23)
625
626 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.
627 * See http://doc.arvados.org/install/install-ws.html for install/upgrade instructions.
628 * Remove the old puma server after the upgrade is complete. Example, with runit: <pre>
629 $ sudo sv down /etc/sv/puma
630 $ sudo rm -r /etc/sv/puma
631 </pre> Example, with systemd: <pre>
632 $ systemctl disable puma
633 $ systemctl stop puma
634 </pre>
635
636 h3. Change of database encoding for hashes and arrays (2017-03-06)
637
638 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.
639
640 * Aside from a slight performance improvement, this should have no externally visible effect.
641 * Downgrading past this version is not supported, and is likely to cause errors. If this happens, the solution is to upgrade past this version.
642 * After upgrading, make sure to restart puma and crunch-dispatch-* processes.
643
644 h3. Docker image format compatibility check (2017-02-03)
645
646 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.
647 * 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>
648 * 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.
649 * *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.*
650
651 h3. Debian and RPM packages now have systemd unit files (2016-09-27)
652
653 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).
654
655 * On Debian-based systems using systemd, services are enabled automatically when packages are installed.
656 * 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>.
657 * 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>
658 * To migrate from runit to systemd after installing the new packages, we recommend the following procedure:
659 *# Bring down the runit service: "sv down /etc/sv/keep-web"
660 *# Create a JSON configuration file (e.g., /etc/arvados/keep-web/keep-web.yml -- see "keep-web -help")
661 *# Ensure the service is running correctly under systemd: "systemctl status keep-web" / "journalctl -u keep-web"
662 *# Remove the runit service so it doesn't start at next boot
663 * Affected services:
664 ** keep-balance - /etc/arvados/keep-balance/keep-balance.yml
665 ** keep-web - /etc/arvados/keep-web/keep-web.yml
666 ** keepproxy - /etc/arvados/keepproxy/keepproxy.yml
667 ** arvados-git-httpd - /etc/arvados/arv-git-httpd/arv-git-httpd.yml
668
669 h3. Installation paths for Python modules and script changed (2016-05-31)
670
671 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.
672
673 * 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.
674 * 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.
675
676 h3. Crunchrunner package is required on compute and shell nodes (2016-04-25)
677
678 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.
679
680 * On each Debian-based compute node and shell node, run: @sudo apt-get install crunchrunner@
681 * On each Red Hat-based compute node and shell node, run: @sudo yum install crunchrunner@
682
683 h3. Keep permission signature algorithm change (2016-04-21)
684
685 Commit "3c88abd":https://dev.arvados.org/projects/arvados/repository/revisions/3c88abd changes the Keep permission signature algorithm.
686
687 * 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.
688 * Jobs and client operations that are in progress during the upgrade (including arv-put's "resume cache") will fail.
689
690 h3. Workbench's "Getting Started" popup disabled by default (2015-01-05)
691
692 Commit "e1276d6e":https://dev.arvados.org/projects/arvados/repository/revisions/e1276d6e disables Workbench's "Getting Started" popup by default.
693
694 * If you want new users to continue seeing this popup, set @enable_getting_started_popup: true@ in Workbench's @application.yml@ configuration.
695
696 h3. Crunch jobs now have access to Keep-backed writable scratch storage (2015-12-03)
697
698 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)
699
700 * 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
701 * 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.
702
703 h3. Recommended configuration change for keep-web (2015-11-11)
704
705 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)
706
707 * proxy/dns/ssl config should be updated to route "https://download.ClusterID.example.com/" requests to keep-web (alongside the existing "collections" routing)
708 * keep-web command line adds @-attachment-only-host download.ClusterID.example.com@
709 * Workbench config adds @keep_web_download_url@
710 * More info on the (still beta/non-TOC-linked) "keep-web doc page":http://doc.arvados.org/install/install-keep-web.html
711
712 h3. Stopped containers are now automatically removed on compute nodes (2015-11-04)
713
714 Commit "1d1c6de":https://dev.arvados.org/projects/arvados/repository/revisions/1d1c6de removes stopped containers (see "#7444":https://dev.arvados.org/issues/7444)
715
716 * 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.
717
718 h3. New keep-web service (2015-11-04)
719
720 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).
721
722 * 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).
723
724 <notextile>
725 </div>
726 </notextile>