Merge branch '18078-reacquire-fuse-lock' into main refs #18078
[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). development main (as of 2021-09-02)
39
40 "Upgrading from 2.2.0":#v2_2_0
41
42 h3. Removed unused @update_uuid@ endpoint for users.
43
44 The @update_uuid@ endpoint was superseded by the "link accounts feature":{{site.baseurl}}/admin/link-accounts.html, so it's no longer available.
45
46 h3. Removed deprecated '@@' search operator
47
48 The '@@' full text search operator, previously deprecated, has been removed. To perform a string search across multiple columns, use the 'ilike' operator on 'any' column as described in the "available list method filter section":{{site.baseurl}}/api/methods.html#substringsearchfilter of the API documentation.
49
50 h3. Storage classes must be defined explicitly
51
52 If your configuration uses the StorageClasses attribute on any Keep volumes, you must add a new @StorageClasses@ section that lists all of your storage classes. Refer to the updated documentation about "configuring storage classes":{{site.baseurl}}/admin/storage-classes.html for details.
53
54 h3. keep-balance requires access to PostgreSQL
55
56 Make sure the keep-balance process can connect to your PostgreSQL server using the settings in your config file. (In previous versions, keep-balance accessed the database through controller instead of connecting to the database server directly.)
57
58 h3. crunch-dispatch-local now requires config.yml
59
60 The @crunch-dispatch-local@ dispatcher now reads the API host and token from the system wide @/etc/arvados/config.yml@ .  It will fail to start that file is not found or not readable.
61
62 h3. Multi-file docker image collections
63
64 Typically a docker image collection contains a single @.tar@ file at the top level. Handling of atypical cases has changed. If a docker image collection contains files with extensions other than @.tar@, they will be ignored (previously they could cause errors). If a docker image collection contains multiple @.tar@ files, it will cause an error at runtime, "cannot choose from multiple tar files in image collection" (previously one of the @.tar@ files was selected). Subdirectories are ignored. The @arv keep docker@ command always creates a collection with a single @.tar@ file, and never uses subdirectories, so this change will not affect most users.
65
66 h2(#v2_2_0). v2.2.0 (2021-06-03)
67
68 "Upgrading from 2.1.0":#v2_1_0
69
70 h3. New spelling of S3 credential configs
71
72 If you use the S3 driver for Keep volumes and specify credentials in your configuration file (as opposed to using an IAM role), you should change the spelling of the @AccessKey@ and @SecretKey@ config keys to @AccessKeyID@ and @SecretAccessKey@. If you don't update them, the previous spellings will still be accepted, but warnings will be logged at server startup.
73
74 h3. New proxy parameters for arvados-controller
75
76 In your Nginx configuration file (@/etc/nginx/conf.d/arvados-api-and-controller.conf@), add the following lines to the @location /@ block with @http://controller@ (see "Update nginx configuration":{{site.baseurl}}/install/install-api-server.html#update-nginx for an example) and reload/restart Nginx (@sudo nginx -s reload@).
77
78 <pre>
79     proxy_set_header      Upgrade           $http_upgrade;
80     proxy_set_header      Connection        "upgrade";
81 </pre>
82
83 h3. Changes on the collection's @preserve_version@ attribute semantics
84
85 The @preserve_version@ attribute on collections was originally designed to allow clients to persist a preexisting collection version. This forced clients to make 2 requests if the intention is to "make this set of changes in a new version that will be kept", so we have changed the semantics to do just that: When passing @preserve_version=true@ along with other collection updates, the current version is persisted and also the newly created one will be persisted on the next update.
86
87 h3. System token requirements
88
89 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.
90
91 The @API.RailsSessionSecretToken@ configuration key has been removed. Delete this entry from your configuration file after upgrading.
92
93 h3. Centos7 Python 3 dependency upgraded to python3
94
95 Now that Python 3 is part of the base repository in CentOS 7, the Python 3 dependency for Centos7 Arvados packages was changed from SCL rh-python36 to python3.
96
97 h3. ForceLegacyAPI14 option removed
98
99 The ForceLegacyAPI14 configuration option has been removed. In the unlikely event it is mentioned in your config file, remove it to avoid "deprecated/unknown config" warning logs.
100
101 h2(#v2_1_0). v2.1.0 (2020-10-13)
102
103 "Upgrading from 2.0.0":#v2_0_0
104
105 h3. LoginCluster conflicts with other Login providers
106
107 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.
108
109 h3. Minimum supported Python version is now 3.5
110
111 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:
112
113 <pre>
114     apt remove python-arvados-fuse && apt install python3-arvados-fuse
115     apt remove python-arvados-python-client && apt install python3-arvados-python-client
116     apt remove python-arvados-cwl-runner && apt install python3-arvados-cwl-runner
117     apt remove python-crunchstat-summary && apt install python3-crunchstat-summary
118     apt remove python-cwltest && apt install python3-cwltest
119 </pre>
120
121 On CentOS:
122
123 <pre>
124     yum remove python-arvados-fuse && yum install python3-arvados-fuse
125     yum remove python-arvados-python-client && yum install python3-arvados-python-client
126     yum remove python-arvados-cwl-runner && yum install python3-arvados-cwl-runner
127     yum remove python-crunchstat-summary && yum install python3-crunchstat-summary
128     yum remove python-cwltest && yum install python3-cwltest
129 </pre>
130
131 h3. Minimum supported Ruby version is now 2.5
132
133 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.
134
135 h3. Removing libpam-arvados, replaced with libpam-arvados-go
136
137 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.
138
139 h3. Removing sso-provider
140
141 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.
142
143 After migrating your configuration, uninstall the @arvados-sso-provider@ package.
144
145 h3. S3 signatures
146
147 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.
148
149 h3. New permission system constraints
150
151 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.
152
153 # The @group_class@ field must be either @role@ or @project@. Invalid group_class are migrated to @role@.
154 # A @role@ cannot own things. Anything owned by a role is migrated to a @can_manage@ link and reassigned to the system user.
155 # Only @role@ and @user@ can have outgoing permission links. Permission links originating from projects are deleted by the migration.
156 # 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.
157 # A permission link can have the permission level (@name@) updated but not @head_uuid@, @tail_uuid@ or @link_class@.
158
159 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.
160
161 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.
162
163 To determine which groups have invalid @group_class@ (these will be migrated to @role@ groups):
164
165 <pre>
166 arv group list --filters '[["group_class", "not in", ["project", "role"]]]'
167 </pre>
168
169 To list all @role@ groups, which will be reassigned to the system user (unless @owner_uuid@ is already the system user):
170
171 <pre>
172 arv group list --filters '[["group_class", "=", "role"]]'
173 </pre>
174
175 To list which @project@ groups have outgoing permission links (such links are now invalid and will be deleted by the migration):
176
177 <pre>
178 for uuid in $(arv link list --filters '[["link_class", "=", "permission"], ["tail_uuid", "like", "%-j7d0g-%"]]' |
179               jq -r .items[].tail_uuid | sort | uniq) ; do
180    arv group list --filters '[["group_class", "=", "project"], ["uuid", "=", "'$uuid'"]]' | jq .items
181 done
182 </pre>
183
184 h4. "Public favorites" moved to their own project
185
186 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.
187
188 h2(#v2_0_0). v2.0.0 (2020-02-07)
189
190 "Upgrading from 1.4":#v1_4_1
191
192 Arvados 2.0 is a major upgrade, with many changes.  Please read these upgrade notes carefully before you begin.
193
194 h3. Migrating to centralized config.yml
195
196 See "Migrating Configuration":config-migration.html for notes on migrating legacy per-component configuration files to the new centralized @/etc/arvados/config.yml@.
197
198 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:
199
200 <pre>
201 Clusters:
202   zzzzz:
203     Services:
204       Controller:
205         ExternalURL: "https://zzzzz.example.com"
206 </pre>
207
208 h3. Keep-balance configuration migration
209
210 (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.
211
212 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.
213
214 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.
215
216 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.
217
218 h3. Arv-git-httpd configuration migration
219
220 (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.
221
222 h3. Keepstore and keep-web configuration migration
223
224 keepstore and keep-web no longer support configuration via (previously deprecated) command line configuration flags and environment variables.
225
226 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.
227
228 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.
229
230 h3. Keepproxy configuration migration
231
232 (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.
233
234 h3. Delete "keep_services" records
235
236 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.
237
238 <notextile><pre><code>$ export ARVADOS_API_HOST=...
239 $ export ARVADOS_API_TOKEN=...
240 $ arv --format=uuid keep_service list | xargs -n1 arv keep_service delete --uuid
241 </code></pre></notextile>
242
243 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.
244
245 h3. Enabling Postgres trigram indexes
246
247 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.
248
249 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:
250
251 <strong>Centos 7</strong>
252 <notextile>
253 <pre><code>~$ <span class="userinput">sudo yum install -y postgresql95-contrib</span>
254 ~$ <span class="userinput">su - postgres -c "psql -d 'arvados_production' -c 'CREATE EXTENSION IF NOT EXISTS pg_trgm'"</span>
255 </code></pre>
256 </notextile>
257
258 <strong>RHEL 7</strong>
259 <notextile>
260 <pre><code>~$ <span class="userinput">sudo yum install -y rh-postgresql95-postgresql-contrib</span>
261 ~$ <span class="userinput">su - postgres -c "psql -d 'arvados_production' -c 'CREATE EXTENSION IF NOT EXISTS pg_trgm'"</span>
262 </code></pre>
263 </notextile>
264
265 <strong>Debian or Ubuntu</strong>
266 <notextile>
267 <pre><code>~$ <span class="userinput">sudo apt-get install -y postgresql-contrib-9.5</span>
268 ~$ <span class="userinput">sudo -u postgres psql -d 'arvados_production' -c 'CREATE EXTENSION IF NOT EXISTS pg_trgm'</span>
269 </code></pre>
270 </notextile>
271
272 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@.
273
274 h3. New Workbench 2
275
276 Workbench 2 is now ready for regular use.  Follow the instructions to "install workbench 2":../install/install-workbench2-app.html
277
278 h3. New property vocabulary format for Workbench2
279
280 (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.
281
282 h3. Cloud installations only: node manager replaced by arvados-dispatch-cloud
283
284 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
285
286 *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@.
287
288 <notextile>
289 <pre><code>~$ <span class="userinput">sudo systemctl --now disable crunch-dispatch-slurm</span>
290 ~$ <span class="userinput">sudo apt-get remove crunch-dispatch-slurm</span>
291 </code></pre>
292 </notextile>
293
294 h3. Jobs API is read-only
295
296 (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.
297
298 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@.
299
300 h3. "/" prohibited in collection and project names
301
302 (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.
303
304 h3. No longer stripping ':' from strings in serialized database columns
305
306 (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.
307
308 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@.
309
310 h3. Scoped tokens should use PATCH for updates
311
312 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.
313
314
315
316 h2(#v1_4_1). v1.4.1 (2019-09-20)
317
318 "Upgrading from 1.4.0":#v1_4_0
319
320 h3. Centos7 Python 3 dependency upgraded to rh-python36
321
322 The Python 3 dependency for Centos7 Arvados packages was upgraded from rh-python35 to rh-python36.
323
324 h2(#v1_4_0). v1.4.0 (2019-06-05)
325
326 "Upgrading from 1.3.3":#v1_3_3
327
328 h3. Populating the new file_count and file_size_total columns on the collections table
329
330 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.
331
332 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.
333
334 h3. Stricter collection manifest validation on the API server
335
336 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.
337
338 You could set up a new rvm gemset and install the specific arvados gem for testing, like so:
339
340 <notextile>
341 <pre><code>~$ <span class="userinput">rvm gemset create rubysdk-test</span>
342 ~$ <span class="userinput">rvm gemset use rubysdk-test</span>
343 ~$ <span class="userinput">gem install arvados -v 1.3.1.20190301212059</span>
344 </code></pre>
345 </notextile>
346
347 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:
348
349 {% codeblock as ruby %}
350 require 'arvados'
351 require 'arvados/keep'
352
353 api = Arvados.new
354 offset = 0
355 batch_size = 100
356 invalid = []
357
358 while true
359     begin
360         req = api.collection.index(
361             :select => [:uuid, :created_at, :manifest_text],
362             :include_trash => true, :include_old_versions => true,
363             :limit => batch_size, :offset => offset)
364     rescue
365         invalid.each {|c| puts "#{c[:uuid]} (Created at #{c[:created_at]}): #{c[:error]}" }
366         raise
367     end
368
369     req[:items].each do |col|
370         begin
371             Keep::Manifest.validate! col[:manifest_text]
372         rescue Exception => e
373             puts "Collection #{col[:uuid]} manifest not valid"
374             invalid << {uuid: col[:uuid], error: e, created_at: col[:created_at]}
375         end
376     end
377     puts "Checked #{offset} / #{req[:items_available]} - Invalid: #{invalid.size}"
378     offset += req[:limit]
379     break if offset > req[:items_available]
380 end
381
382 if invalid.empty?
383     puts "No invalid collection manifests found"
384 else
385     invalid.each {|c| puts "#{c[:uuid]} (Created at #{c[:created_at]}): #{c[:error]}" }
386 end
387 {% endcodeblock %}
388
389 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.
390
391 h3. Python packaging change
392
393 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.
394
395 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.).
396
397 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.
398
399 This can be done by activating the virtualenv outside of the script:
400
401 <notextile>
402 <pre>~$ <code class="userinput">source /usr/share/python2.7/dist/python-arvados-python-client/bin/activate</code>
403 (python-arvados-python-client) ~$ <code class="userinput">path-to-the-python-script</code>
404 </pre>
405 </notextile>
406
407 Or alternatively, by updating the shebang line at the start of the script to:
408
409 <notextile>
410 <pre>
411 #!/usr/share/python2.7/dist/python-arvados-python-client/bin/python
412 </pre>
413 </notextile>
414
415 h3. python-arvados-cwl-runner deb/rpm package now conflicts with python-cwltool deb/rpm package
416
417 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.
418
419 h3. Centos7 Python 3 dependency upgraded to rh-python35
420
421 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.
422
423 h3. Centos7 package for libpam-arvados depends on the python-pam package, which is available from EPEL
424
425 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.
426
427 h3. New configuration
428
429 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.
430
431 h2(#v1_3_3). v1.3.3 (2019-05-14)
432
433 "Upgrading from 1.3.0":#v1_3_0
434
435 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.
436
437 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/main/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.
438
439 h2(#v1_3_0). v1.3.0 (2018-12-05)
440
441 "Upgrading from 1.2":#v1_2_0
442
443 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.
444
445 The @arvados-controller@ component now requires the /etc/arvados/config.yml file to be present.
446
447 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.
448
449 h2(#v1_2_1). v1.2.1 (2018-11-26)
450
451 There are no special upgrade notes for this release.
452
453 h2(#v1_2_0). v1.2.0 (2018-09-05)
454
455 "Upgrading from 1.1.2 or 1.1.3":#v1_1_2
456
457 h3. Regenerate Postgres table statistics
458
459 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:
460
461 <pre>
462 #!/bin/bash
463
464 set -e
465 set -u
466
467 tables=`echo "\dt" | psql arvados_production | grep public|awk -e '{print $3}'`
468
469 for t in $tables; do
470     echo "echo 'analyze $t' | psql arvados_production"
471     time echo "analyze $t" | psql arvados_production
472 done
473 </pre>
474
475 If you also need to do the vacuum, you could adapt the script to run 'vacuum analyze' instead of 'analyze'.
476
477 h3. New component: arvados-controller
478
479 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.
480
481 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.
482
483 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.
484
485 h2(#v1_1_4). v1.1.4 (2018-04-10)
486
487 "Upgrading from 1.1.3":#v1_1_3
488
489 h3. arvados-cwl-runner regressions (2018-04-05)
490
491 <strong>Secondary files missing from toplevel workflow inputs</strong>
492
493 This only affects workflows that rely on implicit discovery of secondaryFiles.
494
495 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.
496
497 As an example, the following workflow will fail because the @toplevel_input@ does not declare the @secondaryFiles@ that are expected by @step_input@:
498
499 <pre>
500 class: Workflow
501 cwlVersion: v1.0
502 inputs:
503   toplevel_input: File
504 outputs: []
505 steps:
506   step1:
507     in:
508       step_input: toplevel_input
509     out: []
510     run:
511       id: sub
512       class: CommandLineTool
513       inputs:
514         step_input:
515           type: File
516           secondaryFiles:
517             - .idx
518       outputs: []
519       baseCommand: echo
520 </pre>
521
522 When run, this produces an error like this:
523
524 <pre>
525 cwltool ERROR: [step step1] Cannot make job: Missing required secondary file 'hello.txt.idx' from file object: {
526     "basename": "hello.txt",
527     "class": "File",
528     "location": "keep:ade9d0e032044bd7f58daaecc0d06bc6+51/hello.txt",
529     "size": 0,
530     "nameroot": "hello",
531     "nameext": ".txt",
532     "secondaryFiles": []
533 }
534 </pre>
535
536 To fix this error, add the appropriate @secondaryFiles@ section to @toplevel_input@
537
538 <notextile>
539 <pre><code>class: Workflow
540 cwlVersion: v1.0
541 inputs:
542   <span class="userinput">toplevel_input:
543     type: File
544     secondaryFiles:
545       - .idx</span>
546 outputs: []
547 steps:
548   step1:
549     in:
550       step_input: toplevel_input
551     out: []
552     run:
553       id: sub
554       class: CommandLineTool
555       inputs:
556         step_input:
557           type: File
558           secondaryFiles:
559             - .idx
560       outputs: []
561       baseCommand: echo
562 </code></pre>
563 </notextile>
564
565 This bug has been fixed in Arvados release v1.2.0.
566
567 <strong>Secondary files on default file inputs</strong>
568
569 @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:
570
571 <pre>
572 class: CommandLineTool
573 inputs:
574   step_input:
575     type: File
576     secondaryFiles:
577       - .idx
578     default:
579       class: File
580       location: hello.txt
581 outputs: []
582 baseCommand: echo
583 </pre>
584
585 When run, this produces an error like this:
586
587 <pre>
588 2018-05-03 10:58:47 cwltool ERROR: Unhandled error, try again with --debug for more information:
589   [Errno 2] File not found: u'hello.txt.idx'
590 </pre>
591
592 To fix this, manually upload the primary and secondary files to keep and explicitly declare @secondaryFiles@ on the default primary file:
593
594 <notextile>
595 <pre><code>class: CommandLineTool
596 inputs:
597   step_input:
598     type: File
599     secondaryFiles:
600       - .idx
601     <span class="userinput">default:
602       class: File
603       location: keep:4d8a70b1e63b2aad6984e40e338e2373+69/hello.txt
604       secondaryFiles:
605        - class: File
606          location: keep:4d8a70b1e63b2aad6984e40e338e2373+69/hello.txt.idx</span>
607 outputs: []
608 baseCommand: echo
609 </code></pre>
610 </notextile>
611
612 This bug has been fixed in Arvados release v1.2.0.
613
614 h2(#v1_1_3). v1.1.3 (2018-02-08)
615
616 There are no special upgrade notes for this release.
617
618 h2(#v1_1_2). v1.1.2 (2017-12-22)
619
620 "Upgrading from 1.1.0 or 1.1.1":#v1_1_0
621
622 h3. The minimum version for Postgres is now 9.4 (2017-12-08)
623
624 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.
625
626 * Debian 8 (pg 9.4) and Debian 9 (pg 9.6) do not require an upgrade
627 * Ubuntu 16.04 (pg 9.5) does not require an upgrade
628 * Ubuntu 14.04 (pg 9.3) requires upgrade to Postgres 9.4: https://www.postgresql.org/download/linux/ubuntu/
629 * 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
630 *# Create a database backup using @pg_dump@
631 *# 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/
632 *# Restore from the backup using @psql@
633
634 h2(#v1_1_1). v1.1.1 (2017-11-30)
635
636 There are no special upgrade notes for this release.
637
638 h2(#v1_1_0). v1.1.0 (2017-10-24)
639
640 h3. The minimum version for Postgres is now 9.3 (2017-09-25)
641
642 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.
643
644 * Debian 8 (pg 9.4) and Debian 9 (pg 9.6) do not require an upgrade
645 * Ubuntu 16.04 (pg 9.5) does not require an upgrade
646 * Ubuntu 14.04 (pg 9.3) is compatible, however upgrading to Postgres 9.4 is recommended: https://www.postgresql.org/download/linux/ubuntu/
647 * 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
648 *# Create a database backup using @pg_dump@
649 *# 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/
650 *# Restore from the backup using @psql@
651
652 h2(#older). Older versions
653
654 h3. Upgrade slower than usual (2017-06-30)
655
656 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.
657
658 * 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.
659 * The conversion runs as a database migration, i.e., during the deb/rpm package upgrade process, while your API server is unavailable.
660 * Expect it to take about 1 minute per 20K jobs that have ever been created/run.
661
662 h3. Service discovery overhead change in keep-web (2017-06-05)
663
664 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.
665
666 * 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.
667
668 h3. Node manager now has an http endpoint for management (2017-04-12)
669
670 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.
671
672 * To enable it, add to your configuration file: <pre>[Manage]
673   address = 127.0.0.1
674   port = 8989</pre>
675 * The server responds to @http://{address}:{port}/status.json@ with a summary of how many nodes are in each state (booting, busy, shutdown, etc.)
676
677 h3. New websockets component (2017-03-23)
678
679 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.
680 * See http://doc.arvados.org/install/install-ws.html for install/upgrade instructions.
681 * Remove the old puma server after the upgrade is complete. Example, with runit: <pre>
682 $ sudo sv down /etc/sv/puma
683 $ sudo rm -r /etc/sv/puma
684 </pre> Example, with systemd: <pre>
685 $ systemctl disable puma
686 $ systemctl stop puma
687 </pre>
688
689 h3. Change of database encoding for hashes and arrays (2017-03-06)
690
691 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.
692
693 * Aside from a slight performance improvement, this should have no externally visible effect.
694 * Downgrading past this version is not supported, and is likely to cause errors. If this happens, the solution is to upgrade past this version.
695 * After upgrading, make sure to restart puma and crunch-dispatch-* processes.
696
697 h3. Docker image format compatibility check (2017-02-03)
698
699 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.
700 * 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>
701 * 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.
702 * *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.*
703
704 h3. Debian and RPM packages now have systemd unit files (2016-09-27)
705
706 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).
707
708 * On Debian-based systems using systemd, services are enabled automatically when packages are installed.
709 * 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>.
710 * 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>
711 * To migrate from runit to systemd after installing the new packages, we recommend the following procedure:
712 *# Bring down the runit service: "sv down /etc/sv/keep-web"
713 *# Create a JSON configuration file (e.g., /etc/arvados/keep-web/keep-web.yml -- see "keep-web -help")
714 *# Ensure the service is running correctly under systemd: "systemctl status keep-web" / "journalctl -u keep-web"
715 *# Remove the runit service so it doesn't start at next boot
716 * Affected services:
717 ** keep-balance - /etc/arvados/keep-balance/keep-balance.yml
718 ** keep-web - /etc/arvados/keep-web/keep-web.yml
719 ** keepproxy - /etc/arvados/keepproxy/keepproxy.yml
720 ** arvados-git-httpd - /etc/arvados/arv-git-httpd/arv-git-httpd.yml
721
722 h3. Installation paths for Python modules and script changed (2016-05-31)
723
724 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.
725
726 * 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.
727 * 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.
728
729 h3. Crunchrunner package is required on compute and shell nodes (2016-04-25)
730
731 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.
732
733 * On each Debian-based compute node and shell node, run: @sudo apt-get install crunchrunner@
734 * On each Red Hat-based compute node and shell node, run: @sudo yum install crunchrunner@
735
736 h3. Keep permission signature algorithm change (2016-04-21)
737
738 Commit "3c88abd":https://dev.arvados.org/projects/arvados/repository/revisions/3c88abd changes the Keep permission signature algorithm.
739
740 * 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.
741 * Jobs and client operations that are in progress during the upgrade (including arv-put's "resume cache") will fail.
742
743 h3. Workbench's "Getting Started" popup disabled by default (2015-01-05)
744
745 Commit "e1276d6e":https://dev.arvados.org/projects/arvados/repository/revisions/e1276d6e disables Workbench's "Getting Started" popup by default.
746
747 * If you want new users to continue seeing this popup, set @enable_getting_started_popup: true@ in Workbench's @application.yml@ configuration.
748
749 h3. Crunch jobs now have access to Keep-backed writable scratch storage (2015-12-03)
750
751 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)
752
753 * 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
754 * 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.
755
756 h3. Recommended configuration change for keep-web (2015-11-11)
757
758 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)
759
760 * proxy/dns/ssl config should be updated to route "https://download.ClusterID.example.com/" requests to keep-web (alongside the existing "collections" routing)
761 * keep-web command line adds @-attachment-only-host download.ClusterID.example.com@
762 * Workbench config adds @keep_web_download_url@
763 * More info on the (still beta/non-TOC-linked) "keep-web doc page":http://doc.arvados.org/install/install-keep-web.html
764
765 h3. Stopped containers are now automatically removed on compute nodes (2015-11-04)
766
767 Commit "1d1c6de":https://dev.arvados.org/projects/arvados/repository/revisions/1d1c6de removes stopped containers (see "#7444":https://dev.arvados.org/issues/7444)
768
769 * 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.
770
771 h3. New keep-web service (2015-11-04)
772
773 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).
774
775 * 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).
776
777 <notextile>
778 </div>
779 </notextile>