Merge branch '19070-update-workflow-deps' refs #19070
[arvados.git] / doc / admin / upgrading.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: "Arvados upgrade 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 Upgrade instructions can be found at "Maintenance and upgrading":{{site.baseurl}}/admin/maintenance-and-upgrading.html#upgrading.
16
17 h2. Upgrade notes
18
19 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. These notes are listed below, organized by release version. Scroll down to the version number you are upgrading to.
20
21 {% comment %}
22 Note to developers: Add new items at the top. Include the date, issue number, commit, and considerations/instructions for those about to upgrade.
23
24 TODO: extract this information based on git commit messages and generate changelogs / release notes automatically.
25 {% endcomment %}
26
27 <notextile>
28 <div class="releasenotes">
29 </notextile>
30
31 h2(#main). development main (as of 2022-04-08)
32
33 "previous: Upgrading to 2.4.0":#v2_4_0
34
35 h3. Now recommending Singularity 3.9.9
36
37 The compute image "build script":{{site.baseurl}}/install/crunch2-cloud/install-compute-node.html now installs Singularity 3.9.9 instead of 3.7.4. The newer version includes a bugfix that should resolve "intermittent loopback device errors":https://dev.arvados.org/issues/18489 when running containers.
38
39 h3. Changes to @arvados-cwl-runner --create-workflow@ and @--update-workflow@
40
41 When using @arvados-cwl-runner --create-workflow@ or @--update-workflow@, by default it will now make a copy of all collection and Docker image dependencies in the target project.  Running workflows retains the old behavior (use the dependencies wherever they are found).  The can be controlled explicit with @--copy-deps@ and @--no-copy-deps@.
42
43 h2(#v2_4_0). v2.4.0 (2022-04-08)
44
45 "previous: Upgrading to 2.3.1":#v2_3_1
46
47 h3. Default result order changed
48
49 When requesting a list of objects without an explicit @order@ parameter, the default order has changed from @modified_at desc, uuid asc@ to @modified_at desc, uuid desc@.  This means that if two objects have identical @modified_at@ timestamps, the tiebreaker will now be based on @uuid@ in decending order where previously it would be ascending order. The practical effect of this should be minor; with microsecond precision it is unusual to have two records with exactly the same timestamp, and order-sensitive queries should already provide an explicit @order@ parameter.
50
51 h3. Ubuntu 18.04 Arvados Python packages now depend on python-3.8
52
53 Ubuntu 18.04 ships with Python 3.6 as the default version of Python 3. Ubuntu also ships a version of Python 3.8, and the Arvados Python packages (@python3-arvados-cwl-runner@, @python3-arvados-fuse@, @python3-arvados-python-client@, @python3-arvados-user-activity@ and @python3-crunchstat-summary@) now depend on the @python-3.8@ system package.
54
55 This means that they are now installed under @/usr/share/python3.8@ (before, the path was @/usr/share/python3@). If you rely on the @python3@ executable from the packages (e.g. to load a virtualenv), you may need to update the path to that executable.
56
57 h3. Minimum supported Ruby version is now 2.6
58
59 The minimum supported Ruby version is now 2.6.  If you are running Arvados on Debian 10 or Ubuntu 18.04, you may need to switch to using RVM or upgrade your OS.  See "Install Ruby and Bundler":../install/ruby.html for more information.
60
61 h3. Anonymous token changes
62
63 The anonymous token configured in @Users.AnonymousUserToken@ must now be 32 characters or longer. This was already the suggestion in the documentation, now it is enforced. The @script/get_anonymous_user_token.rb@ script that was needed to register the anonymous user token in the database has been removed. Registration of the anonymous token is no longer necessary.
64
65 h3. Preemptible instance support changes
66
67 The @Containers.UsePreemptibleInstances@ option has been renamed to @Containers.AlwaysUsePreemptibleInstances@ and has the same behavior when @true@ and one or more preemptible instances are configured.  However, a value of @false@ no longer disables support for preemptible instances, instead users can now enable use of preemptible instances at the level of an individual workflow or workflow step.
68
69 In addition, there is a new configuration option @Containers.PreemptiblePriceFactor@ will automatically add a preemptible instance type corresponding to each regular instance type.  See "Using Preemptible instances":spot-instances.html for details.
70
71 h3. Default LSF arguments have changed
72
73 If you use LSF and your configuration specifies @Containers.LSF.BsubArgumentsList@, you should update it to include the new arguments (@"-R", "select[mem>=%MMB]", ...@, see "configuration reference":{{site.baseurl}}/admin/config.html). Otherwise, containers that are too big to run on any LSF host will remain in the LSF queue instead of being cancelled.
74
75 h3. Support for NVIDIA CUDA GPUs
76
77 Arvados now supports requesting NVIDIA CUDA GPUs for cloud and LSF (Slurm is currently not supported).  To be able to request GPU nodes, some additional configuration is needed:
78
79 "Including GPU support in cloud compute node image":{{site.baseurl}}/install/crunch2-cloud/install-compute-node.html#nvidia
80
81 "Configure cloud dispatcher for GPU support":{{site.baseurl}}/install/crunch2-cloud/install-dispatch-cloud.html#GPUsupport
82
83 "LSF GPU configuration":{{site.baseurl}}/install/crunch2-lsf/install-dispatch.html
84
85 h3. Role groups are visible to all users by default
86
87 The permission model has changed such that all role groups are visible to all active users. This enables users to share objects with groups they don't belong to. To preserve the previous behavior, where role groups are only visible to members and admins, add @RoleGroupsVisibleToAll: false@ to the @Users@ section of your configuration file.
88
89 h3. Previously trashed role groups will be deleted
90
91 Due to a bug in previous versions, the @DELETE@ operation on a role group caused the group to be flagged as trash in the database, but continue to grant permissions regardless. After upgrading, any role groups that had been trashed this way will be deleted. This might surprise some users if they were relying on permissions that were still in effect due to this bug. Future @DELETE@ operations on a role group will immediately delete the group and revoke the associated permissions.
92
93 h3. Dedicated keepstore process for each container
94
95 When Arvados runs a container via @arvados-dispatch-cloud@, the @crunch-run@ supervisor process now brings up its own keepstore server to handle I/O for mounted collections, outputs, and logs. With the default configuration, the keepstore process allocates one 64 MiB block buffer per VCPU requested by the container. For most workloads this will increase throughput, reduce total network traffic, and make it possible to run more containers at once without provisioning additional keepstore nodes to handle the I/O load.
96 * If you have containers that can effectively handle multiple I/O threads per VCPU, consider increasing the @Containers.LocalKeepBlobBuffersPerVCPU@ value.
97 * If you already have a robust permanent keepstore infrastructure, you can set @Containers.LocalKeepBlobBuffersPerVCPU@ to 0 to disable this feature and preserve the previous behavior of sending container I/O traffic to your separately provisioned keepstore servers.
98 * This feature is enabled only if no volumes use @AccessViaHosts@, and no volumes have underlying @Replication@ less than @Collections.DefaultReplication@. If the feature is configured but cannot be enabled due to an incompatible volume configuration, this will be noted in the @crunch-run.txt@ file in the container log.
99
100 h2(#v2_3_1). v2.3.1 (2021-11-24)
101
102 "previous: Upgrading to 2.3.0":#v2_3_0
103
104 h3. Users are visible to other users by default
105
106 When a new user is set up (either via @AutoSetupNewUsers@ config or via Workbench admin interface) the user immediately becomes visible to other users. To revert to the previous behavior, where the administrator must add two users to the same group using the Workbench admin interface in order for the users to see each other, change the new @Users.ActivatedUsersAreVisibleToOthers@ config to @false@.
107
108 h3. Backend support for vocabulary checking
109
110 If your installation uses the vocabulary feature on Workbench2, you will need to update the cluster configuration by moving the vocabulary definition file to the node where @controller@ runs, and set the @API.VocabularyPath@ configuration parameter to the local path where the file was placed.
111 This will enable the vocabulary checking cluster-wide, including Workbench2. The @Workbench.VocabularyURL@ configuration parameter is deprecated and will be removed in a future release.
112 You can read more about how this feature works on the "admin page":{{site.baseurl}}/admin/metadata-vocabulary.html.
113
114 h2(#v2_3_0). v2.3.0 (2021-10-27)
115
116 "previous: Upgrading to 2.2.0":#v2_2_0
117
118 h3. Ubuntu 18.04 packages for arvados-api-server and arvados-workbench now conflict with ruby-bundler
119
120 Ubuntu 18.04 ships with Bundler version 1.16.1, which is no longer compatible with the Gemfiles in the Arvados packages (made with Bundler 2.2.19). The Ubuntu 18.04 packages for arvados-api-server and arvados-workbench now conflict with the ruby-bundler package to work around this issue. The post-install scripts for arvados-api-server and arvados-workbench install the proper version of Bundler as a gem.
121
122 h3. Removed unused @update_uuid@ endpoint for users.
123
124 The @update_uuid@ endpoint was superseded by the "link accounts feature":{{site.baseurl}}/admin/link-accounts.html, so it's no longer available.
125
126 h3. Removed deprecated '@@' search operator
127
128 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.
129
130 h3. Storage classes must be defined explicitly
131
132 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.
133
134 h3. keep-balance requires access to PostgreSQL
135
136 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.)
137
138 h3. crunch-dispatch-local now requires config.yml
139
140 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.
141
142 h3. Multi-file docker image collections
143
144 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.
145
146 h2(#v2_2_0). v2.2.0 (2021-06-03)
147
148 "previous: Upgrading to 2.1.0":#v2_1_0
149
150 h3. New spelling of S3 credential configs
151
152 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.
153
154 h3. New proxy parameters for arvados-controller
155
156 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@).
157
158 <pre>
159     proxy_set_header      Upgrade           $http_upgrade;
160     proxy_set_header      Connection        "upgrade";
161 </pre>
162
163 h3. Changes on the collection's @preserve_version@ attribute semantics
164
165 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.
166
167 h3. System token requirements
168
169 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.
170
171 The @API.RailsSessionSecretToken@ configuration key has been removed. Delete this entry from your configuration file after upgrading.
172
173 h3. Centos7 Python 3 dependency upgraded to python3
174
175 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.
176
177 h3. ForceLegacyAPI14 option removed
178
179 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.
180
181 h2(#v2_1_0). v2.1.0 (2020-10-13)
182
183 "previous: Upgrading to 2.0.0":#v2_0_0
184
185 h3. LoginCluster conflicts with other Login providers
186
187 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.
188
189 h3. Minimum supported Python version is now 3.5
190
191 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:
192
193 <pre>
194     apt remove python-arvados-fuse && apt install python3-arvados-fuse
195     apt remove python-arvados-python-client && apt install python3-arvados-python-client
196     apt remove python-arvados-cwl-runner && apt install python3-arvados-cwl-runner
197     apt remove python-crunchstat-summary && apt install python3-crunchstat-summary
198     apt remove python-cwltest && apt install python3-cwltest
199 </pre>
200
201 On CentOS:
202
203 <pre>
204     yum remove python-arvados-fuse && yum install python3-arvados-fuse
205     yum remove python-arvados-python-client && yum install python3-arvados-python-client
206     yum remove python-arvados-cwl-runner && yum install python3-arvados-cwl-runner
207     yum remove python-crunchstat-summary && yum install python3-crunchstat-summary
208     yum remove python-cwltest && yum install python3-cwltest
209 </pre>
210
211 h3. Minimum supported Ruby version is now 2.5
212
213 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.
214
215 h3. Removing libpam-arvados, replaced with libpam-arvados-go
216
217 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.
218
219 h3. Removing sso-provider
220
221 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.
222
223 After migrating your configuration, uninstall the @arvados-sso-provider@ package.
224
225 h3. S3 signatures
226
227 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.
228
229 h3. New permission system constraints
230
231 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.
232
233 # The @group_class@ field must be either @role@ or @project@. Invalid group_class are migrated to @role@.
234 # A @role@ cannot own things. Anything owned by a role is migrated to a @can_manage@ link and reassigned to the system user.
235 # Only @role@ and @user@ can have outgoing permission links. Permission links originating from projects are deleted by the migration.
236 # 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.
237 # A permission link can have the permission level (@name@) updated but not @head_uuid@, @tail_uuid@ or @link_class@.
238
239 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.
240
241 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.
242
243 To determine which groups have invalid @group_class@ (these will be migrated to @role@ groups):
244
245 <pre>
246 arv group list --filters '[["group_class", "not in", ["project", "role"]]]'
247 </pre>
248
249 To list all @role@ groups, which will be reassigned to the system user (unless @owner_uuid@ is already the system user):
250
251 <pre>
252 arv group list --filters '[["group_class", "=", "role"]]'
253 </pre>
254
255 To list which @project@ groups have outgoing permission links (such links are now invalid and will be deleted by the migration):
256
257 <pre>
258 for uuid in $(arv link list --filters '[["link_class", "=", "permission"], ["tail_uuid", "like", "%-j7d0g-%"]]' |
259               jq -r .items[].tail_uuid | sort | uniq) ; do
260    arv group list --filters '[["group_class", "=", "project"], ["uuid", "=", "'$uuid'"]]' | jq .items
261 done
262 </pre>
263
264 h4. "Public favorites" moved to their own project
265
266 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.
267
268 h2(#v2_0_0). v2.0.0 (2020-02-07)
269
270 "previous: Upgrading to 1.4.1":#v1_4_1
271
272 Arvados 2.0 is a major upgrade, with many changes.  Please read these upgrade notes carefully before you begin.
273
274 h3. Migrating to centralized config.yml
275
276 See "Migrating Configuration":https://doc.arvados.org/v2.1/admin/config-migration.html for notes on migrating legacy per-component configuration files to the new centralized @/etc/arvados/config.yml@.
277
278 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:
279
280 <pre>
281 Clusters:
282   zzzzz:
283     Services:
284       Controller:
285         ExternalURL: "https://zzzzz.example.com"
286 </pre>
287
288 h3. Keep-balance configuration migration
289
290 (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.
291
292 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.
293
294 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.
295
296 Please see the "config migration guide":https://doc.arvados.org/v2.1/admin/config-migration.html and "keep-balance install guide":{{site.baseurl}}/install/install-keep-balance.html for more details.
297
298 h3. Arv-git-httpd configuration migration
299
300 (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":https://doc.arvados.org/v2.1/admin/config-migration.html#arv-git-httpd for more details.
301
302 h3. Keepstore and keep-web configuration migration
303
304 keepstore and keep-web no longer support configuration via (previously deprecated) command line configuration flags and environment variables.
305
306 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.
307
308 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":https://doc.arvados.org/v2.1/admin/config-migration.html#keepstore and "keepstore install guide":{{site.baseurl}}/install/install-keepstore.html for more details.
309
310 h3. Keepproxy configuration migration
311
312 (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":https://doc.arvados.org/v2.1/admin/config-migration.html#keepproxy for more details.
313
314 h3. Delete "keep_services" records
315
316 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.
317
318 <notextile><pre><code>$ export ARVADOS_API_HOST=...
319 $ export ARVADOS_API_TOKEN=...
320 $ arv --format=uuid keep_service list | xargs -n1 arv keep_service delete --uuid
321 </code></pre></notextile>
322
323 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.
324
325 h3. Enabling Postgres trigram indexes
326
327 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.
328
329 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:
330
331 <strong>Centos 7</strong>
332 <notextile>
333 <pre><code>~$ <span class="userinput">sudo yum install -y postgresql95-contrib</span>
334 ~$ <span class="userinput">su - postgres -c "psql -d 'arvados_production' -c 'CREATE EXTENSION IF NOT EXISTS pg_trgm'"</span>
335 </code></pre>
336 </notextile>
337
338 <strong>RHEL 7</strong>
339 <notextile>
340 <pre><code>~$ <span class="userinput">sudo yum install -y rh-postgresql95-postgresql-contrib</span>
341 ~$ <span class="userinput">su - postgres -c "psql -d 'arvados_production' -c 'CREATE EXTENSION IF NOT EXISTS pg_trgm'"</span>
342 </code></pre>
343 </notextile>
344
345 <strong>Debian or Ubuntu</strong>
346 <notextile>
347 <pre><code>~$ <span class="userinput">sudo apt-get install -y postgresql-contrib-9.5</span>
348 ~$ <span class="userinput">sudo -u postgres psql -d 'arvados_production' -c 'CREATE EXTENSION IF NOT EXISTS pg_trgm'</span>
349 </code></pre>
350 </notextile>
351
352 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@.
353
354 h3. New Workbench 2
355
356 Workbench 2 is now ready for regular use.  Follow the instructions to "install workbench 2":../install/install-workbench2-app.html
357
358 h3. New property vocabulary format for Workbench2
359
360 (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 "metadata vocabulary format admin page":{{site.baseurl}}/admin/metadata-vocabulary.html for more information.
361
362 h3. Cloud installations only: node manager replaced by arvados-dispatch-cloud
363
364 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
365
366 *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@.
367
368 <notextile>
369 <pre><code>~$ <span class="userinput">sudo systemctl --now disable crunch-dispatch-slurm</span>
370 ~$ <span class="userinput">sudo apt-get remove crunch-dispatch-slurm</span>
371 </code></pre>
372 </notextile>
373
374 h3. Jobs API is read-only
375
376 (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.
377
378 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@.
379
380 h3. "/" prohibited in collection and project names
381
382 (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.
383
384 h3. No longer stripping ':' from strings in serialized database columns
385
386 (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.
387
388 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@.
389
390 h3. Scoped tokens should use PATCH for updates
391
392 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.
393
394
395
396 h2(#v1_4_1). v1.4.1 (2019-09-20)
397
398 "previous: Upgrading to 1.4.0":#v1_4_0
399
400 h3. Centos7 Python 3 dependency upgraded to rh-python36
401
402 The Python 3 dependency for Centos7 Arvados packages was upgraded from rh-python35 to rh-python36.
403
404 h2(#v1_4_0). v1.4.0 (2019-06-05)
405
406 "previous: Upgrading to 1.3.3":#v1_3_3
407
408 h3. Populating the new file_count and file_size_total columns on the collections table
409
410 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.
411
412 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.
413
414 h3. Stricter collection manifest validation on the API server
415
416 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.
417
418 You could set up a new rvm gemset and install the specific arvados gem for testing, like so:
419
420 <notextile>
421 <pre><code>~$ <span class="userinput">rvm gemset create rubysdk-test</span>
422 ~$ <span class="userinput">rvm gemset use rubysdk-test</span>
423 ~$ <span class="userinput">gem install arvados -v 1.3.1.20190301212059</span>
424 </code></pre>
425 </notextile>
426
427 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:
428
429 {% codeblock as ruby %}
430 require 'arvados'
431 require 'arvados/keep'
432
433 api = Arvados.new
434 offset = 0
435 batch_size = 100
436 invalid = []
437
438 while true
439     begin
440         req = api.collection.index(
441             :select => [:uuid, :created_at, :manifest_text],
442             :include_trash => true, :include_old_versions => true,
443             :limit => batch_size, :offset => offset)
444     rescue
445         invalid.each {|c| puts "#{c[:uuid]} (Created at #{c[:created_at]}): #{c[:error]}" }
446         raise
447     end
448
449     req[:items].each do |col|
450         begin
451             Keep::Manifest.validate! col[:manifest_text]
452         rescue Exception => e
453             puts "Collection #{col[:uuid]} manifest not valid"
454             invalid << {uuid: col[:uuid], error: e, created_at: col[:created_at]}
455         end
456     end
457     puts "Checked #{offset} / #{req[:items_available]} - Invalid: #{invalid.size}"
458     offset += req[:limit]
459     break if offset > req[:items_available]
460 end
461
462 if invalid.empty?
463     puts "No invalid collection manifests found"
464 else
465     invalid.each {|c| puts "#{c[:uuid]} (Created at #{c[:created_at]}): #{c[:error]}" }
466 end
467 {% endcodeblock %}
468
469 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.
470
471 h3. Python packaging change
472
473 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.
474
475 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":{{ site.baseurl }}/sdk/python/sdk-python.html reflects this change. This does not affect the use of the command line tools (e.g. arv-get, etc.).
476
477 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.
478
479 This can be done by activating the virtualenv outside of the script:
480
481 <notextile>
482 <pre>~$ <code class="userinput">source /usr/share/python2.7/dist/python-arvados-python-client/bin/activate</code>
483 (python-arvados-python-client) ~$ <code class="userinput">path-to-the-python-script</code>
484 </pre>
485 </notextile>
486
487 Or alternatively, by updating the shebang line at the start of the script to:
488
489 <notextile>
490 <pre>
491 #!/usr/share/python2.7/dist/python-arvados-python-client/bin/python
492 </pre>
493 </notextile>
494
495 h3. python-arvados-cwl-runner deb/rpm package now conflicts with python-cwltool deb/rpm package
496
497 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.
498
499 h3. Centos7 Python 3 dependency upgraded to rh-python35
500
501 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.
502
503 h3. Centos7 package for libpam-arvados depends on the python-pam package, which is available from EPEL
504
505 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.
506
507 h3. New configuration
508
509 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":https://doc.arvados.org/v2.1/admin/config-migration.html for details.
510
511 h2(#v1_3_3). v1.3.3 (2019-05-14)
512
513 "previous: Upgrading to 1.3.0":#v1_3_0
514
515 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.
516
517 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.
518
519 h2(#v1_3_0). v1.3.0 (2018-12-05)
520
521 "previous: Upgrading to 1.2":#v1_2_0
522
523 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.
524
525 The @arvados-controller@ component now requires the /etc/arvados/config.yml file to be present.
526
527 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.
528
529 h2(#v1_2_1). v1.2.1 (2018-11-26)
530
531 There are no special upgrade notes for this release.
532
533 h2(#v1_2_0). v1.2.0 (2018-09-05)
534
535 "previous: Upgrading to 1.1.2 or 1.1.3":#v1_1_2
536
537 h3. Regenerate Postgres table statistics
538
539 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:
540
541 <pre>
542 #!/bin/bash
543
544 set -e
545 set -u
546
547 tables=`echo "\dt" | psql arvados_production | grep public|awk -e '{print $3}'`
548
549 for t in $tables; do
550     echo "echo 'analyze $t' | psql arvados_production"
551     time echo "analyze $t" | psql arvados_production
552 done
553 </pre>
554
555 If you also need to do the vacuum, you could adapt the script to run 'vacuum analyze' instead of 'analyze'.
556
557 h3. New component: arvados-controller
558
559 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.
560
561 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.
562
563 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.
564
565 h2(#v1_1_4). v1.1.4 (2018-04-10)
566
567 "previous: Upgrading to 1.1.3":#v1_1_3
568
569 h3. arvados-cwl-runner regressions (2018-04-05)
570
571 <strong>Secondary files missing from toplevel workflow inputs</strong>
572
573 This only affects workflows that rely on implicit discovery of secondaryFiles.
574
575 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.
576
577 As an example, the following workflow will fail because the @toplevel_input@ does not declare the @secondaryFiles@ that are expected by @step_input@:
578
579 <pre>
580 class: Workflow
581 cwlVersion: v1.0
582 inputs:
583   toplevel_input: File
584 outputs: []
585 steps:
586   step1:
587     in:
588       step_input: toplevel_input
589     out: []
590     run:
591       id: sub
592       class: CommandLineTool
593       inputs:
594         step_input:
595           type: File
596           secondaryFiles:
597             - .idx
598       outputs: []
599       baseCommand: echo
600 </pre>
601
602 When run, this produces an error like this:
603
604 <pre>
605 cwltool ERROR: [step step1] Cannot make job: Missing required secondary file 'hello.txt.idx' from file object: {
606     "basename": "hello.txt",
607     "class": "File",
608     "location": "keep:ade9d0e032044bd7f58daaecc0d06bc6+51/hello.txt",
609     "size": 0,
610     "nameroot": "hello",
611     "nameext": ".txt",
612     "secondaryFiles": []
613 }
614 </pre>
615
616 To fix this error, add the appropriate @secondaryFiles@ section to @toplevel_input@
617
618 <notextile>
619 <pre><code>class: Workflow
620 cwlVersion: v1.0
621 inputs:
622   <span class="userinput">toplevel_input:
623     type: File
624     secondaryFiles:
625       - .idx</span>
626 outputs: []
627 steps:
628   step1:
629     in:
630       step_input: toplevel_input
631     out: []
632     run:
633       id: sub
634       class: CommandLineTool
635       inputs:
636         step_input:
637           type: File
638           secondaryFiles:
639             - .idx
640       outputs: []
641       baseCommand: echo
642 </code></pre>
643 </notextile>
644
645 This bug has been fixed in Arvados release v1.2.0.
646
647 <strong>Secondary files on default file inputs</strong>
648
649 @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:
650
651 <pre>
652 class: CommandLineTool
653 inputs:
654   step_input:
655     type: File
656     secondaryFiles:
657       - .idx
658     default:
659       class: File
660       location: hello.txt
661 outputs: []
662 baseCommand: echo
663 </pre>
664
665 When run, this produces an error like this:
666
667 <pre>
668 2018-05-03 10:58:47 cwltool ERROR: Unhandled error, try again with --debug for more information:
669   [Errno 2] File not found: u'hello.txt.idx'
670 </pre>
671
672 To fix this, manually upload the primary and secondary files to keep and explicitly declare @secondaryFiles@ on the default primary file:
673
674 <notextile>
675 <pre><code>class: CommandLineTool
676 inputs:
677   step_input:
678     type: File
679     secondaryFiles:
680       - .idx
681     <span class="userinput">default:
682       class: File
683       location: keep:4d8a70b1e63b2aad6984e40e338e2373+69/hello.txt
684       secondaryFiles:
685        - class: File
686          location: keep:4d8a70b1e63b2aad6984e40e338e2373+69/hello.txt.idx</span>
687 outputs: []
688 baseCommand: echo
689 </code></pre>
690 </notextile>
691
692 This bug has been fixed in Arvados release v1.2.0.
693
694 h2(#v1_1_3). v1.1.3 (2018-02-08)
695
696 There are no special upgrade notes for this release.
697
698 h2(#v1_1_2). v1.1.2 (2017-12-22)
699
700 "previous: Upgrading to 1.1.0 or 1.1.1":#v1_1_0
701
702 h3. The minimum version for Postgres is now 9.4 (2017-12-08)
703
704 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.
705
706 * Debian 8 (pg 9.4) and Debian 9 (pg 9.6) do not require an upgrade
707 * Ubuntu 16.04 (pg 9.5) does not require an upgrade
708 * Ubuntu 14.04 (pg 9.3) requires upgrade to Postgres 9.4: https://www.postgresql.org/download/linux/ubuntu/
709 * 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
710 *# Create a database backup using @pg_dump@
711 *# 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/
712 *# Restore from the backup using @psql@
713
714 h2(#v1_1_1). v1.1.1 (2017-11-30)
715
716 There are no special upgrade notes for this release.
717
718 h2(#v1_1_0). v1.1.0 (2017-10-24)
719
720 h3. The minimum version for Postgres is now 9.3 (2017-09-25)
721
722 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.
723
724 * Debian 8 (pg 9.4) and Debian 9 (pg 9.6) do not require an upgrade
725 * Ubuntu 16.04 (pg 9.5) does not require an upgrade
726 * Ubuntu 14.04 (pg 9.3) is compatible, however upgrading to Postgres 9.4 is recommended: https://www.postgresql.org/download/linux/ubuntu/
727 * 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
728 *# Create a database backup using @pg_dump@
729 *# 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/
730 *# Restore from the backup using @psql@
731
732 h2(#older). Older versions
733
734 h3. Upgrade slower than usual (2017-06-30)
735
736 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.
737
738 * 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.
739 * The conversion runs as a database migration, i.e., during the deb/rpm package upgrade process, while your API server is unavailable.
740 * Expect it to take about 1 minute per 20K jobs that have ever been created/run.
741
742 h3. Service discovery overhead change in keep-web (2017-06-05)
743
744 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.
745
746 * 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.
747
748 h3. Node manager now has an http endpoint for management (2017-04-12)
749
750 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.
751
752 * To enable it, add to your configuration file: <pre>[Manage]
753   address = 127.0.0.1
754   port = 8989</pre>
755 * The server responds to @http://{address}:{port}/status.json@ with a summary of how many nodes are in each state (booting, busy, shutdown, etc.)
756
757 h3. New websockets component (2017-03-23)
758
759 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.
760 * See http://doc.arvados.org/install/install-ws.html for install/upgrade instructions.
761 * Remove the old puma server after the upgrade is complete. Example, with runit: <pre>
762 $ sudo sv down /etc/sv/puma
763 $ sudo rm -r /etc/sv/puma
764 </pre> Example, with systemd: <pre>
765 $ systemctl disable puma
766 $ systemctl stop puma
767 </pre>
768
769 h3. Change of database encoding for hashes and arrays (2017-03-06)
770
771 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.
772
773 * Aside from a slight performance improvement, this should have no externally visible effect.
774 * Downgrading past this version is not supported, and is likely to cause errors. If this happens, the solution is to upgrade past this version.
775 * After upgrading, make sure to restart puma and crunch-dispatch-* processes.
776
777 h3. Docker image format compatibility check (2017-02-03)
778
779 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.
780 * 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>
781 * 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.
782 * *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.*
783
784 h3. Debian and RPM packages now have systemd unit files (2016-09-27)
785
786 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).
787
788 * On Debian-based systems using systemd, services are enabled automatically when packages are installed.
789 * 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>.
790 * 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>
791 * To migrate from runit to systemd after installing the new packages, we recommend the following procedure:
792 *# Bring down the runit service: "sv down /etc/sv/keep-web"
793 *# Create a JSON configuration file (e.g., /etc/arvados/keep-web/keep-web.yml -- see "keep-web -help")
794 *# Ensure the service is running correctly under systemd: "systemctl status keep-web" / "journalctl -u keep-web"
795 *# Remove the runit service so it doesn't start at next boot
796 * Affected services:
797 ** keep-balance - /etc/arvados/keep-balance/keep-balance.yml
798 ** keep-web - /etc/arvados/keep-web/keep-web.yml
799 ** keepproxy - /etc/arvados/keepproxy/keepproxy.yml
800 ** arvados-git-httpd - /etc/arvados/arv-git-httpd/arv-git-httpd.yml
801
802 h3. Installation paths for Python modules and script changed (2016-05-31)
803
804 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.
805
806 * 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.
807 * 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.
808
809 h3. Crunchrunner package is required on compute and shell nodes (2016-04-25)
810
811 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.
812
813 * On each Debian-based compute node and shell node, run: @sudo apt-get install crunchrunner@
814 * On each Red Hat-based compute node and shell node, run: @sudo yum install crunchrunner@
815
816 h3. Keep permission signature algorithm change (2016-04-21)
817
818 Commit "3c88abd":https://dev.arvados.org/projects/arvados/repository/revisions/3c88abd changes the Keep permission signature algorithm.
819
820 * 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.
821 * Jobs and client operations that are in progress during the upgrade (including arv-put's "resume cache") will fail.
822
823 h3. Workbench's "Getting Started" popup disabled by default (2015-01-05)
824
825 Commit "e1276d6e":https://dev.arvados.org/projects/arvados/repository/revisions/e1276d6e disables Workbench's "Getting Started" popup by default.
826
827 * If you want new users to continue seeing this popup, set @enable_getting_started_popup: true@ in Workbench's @application.yml@ configuration.
828
829 h3. Crunch jobs now have access to Keep-backed writable scratch storage (2015-12-03)
830
831 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)
832
833 * 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
834 * 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.
835
836 h3. Recommended configuration change for keep-web (2015-11-11)
837
838 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)
839
840 * proxy/dns/ssl config should be updated to route "https://download.ClusterID.example.com/" requests to keep-web (alongside the existing "collections" routing)
841 * keep-web command line adds @-attachment-only-host download.ClusterID.example.com@
842 * Workbench config adds @keep_web_download_url@
843 * More info on the (still beta/non-TOC-linked) "keep-web doc page":http://doc.arvados.org/install/install-keep-web.html
844
845 h3. Stopped containers are now automatically removed on compute nodes (2015-11-04)
846
847 Commit "1d1c6de":https://dev.arvados.org/projects/arvados/repository/revisions/1d1c6de removes stopped containers (see "#7444":https://dev.arvados.org/issues/7444)
848
849 * 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.
850
851 h3. New keep-web service (2015-11-04)
852
853 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).
854
855 * 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).
856
857 <notextile>
858 </div>
859 </notextile>