X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/d913210ab6a77cc174a3d9e34062aa6adb542a43..4dce2661e80da9b65e5a548c863d61239233d6b0:/doc/admin/upgrading.html.textile.liquid diff --git a/doc/admin/upgrading.html.textile.liquid b/doc/admin/upgrading.html.textile.liquid index ac697d8707..c409b6f32b 100644 --- a/doc/admin/upgrading.html.textile.liquid +++ b/doc/admin/upgrading.html.textile.liquid @@ -35,26 +35,131 @@ TODO: extract this information based on git commit messages and generate changel
+ proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; +h3. Changes on the collection's @preserve_version@ attribute semantics 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. +h3. System token requirements + +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. + +The @API.RailsSessionSecretToken@ configuration key has been removed. Delete this entry from your configuration file after upgrading. + h3. Centos7 Python 3 dependency upgraded to python3 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. +h3. ForceLegacyAPI14 option removed + +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. + h2(#v2_1_0). v2.1.0 (2020-10-13) -"Upgrading from 2.0.0":#v2_0_0 +"previous: Upgrading to 2.0.0":#v2_0_0 h3. LoginCluster conflicts with other Login providers 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. +h3. Minimum supported Python version is now 3.5 + +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: + +
+ apt remove python-arvados-fuse && apt install python3-arvados-fuse + apt remove python-arvados-python-client && apt install python3-arvados-python-client + apt remove python-arvados-cwl-runner && apt install python3-arvados-cwl-runner + apt remove python-crunchstat-summary && apt install python3-crunchstat-summary + apt remove python-cwltest && apt install python3-cwltest ++ +On CentOS: + +
+ yum remove python-arvados-fuse && yum install python3-arvados-fuse + yum remove python-arvados-python-client && yum install python3-arvados-python-client + yum remove python-arvados-cwl-runner && yum install python3-arvados-cwl-runner + yum remove python-crunchstat-summary && yum install python3-crunchstat-summary + yum remove python-cwltest && yum install python3-cwltest ++ h3. Minimum supported Ruby version is now 2.5 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. @@ -114,7 +219,7 @@ As a side effect of new permission system constraints, "star" links (indicating h2(#v2_0_0). v2.0.0 (2020-02-07) -"Upgrading from 1.4":#v1_4_1 +"previous: Upgrading to 1.4.1":#v1_4_1 Arvados 2.0 is a major upgrade, with many changes. Please read these upgrade notes carefully before you begin. @@ -204,7 +309,7 @@ Workbench 2 is now ready for regular use. Follow the instructions to "install w h3. New property vocabulary format for Workbench2 -(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. +(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. h3. Cloud installations only: node manager replaced by arvados-dispatch-cloud @@ -242,7 +347,7 @@ The API server accepts both PUT and PATCH for updates, but they will be normaliz h2(#v1_4_1). v1.4.1 (2019-09-20) -"Upgrading from 1.4.0":#v1_4_0 +"previous: Upgrading to 1.4.0":#v1_4_0 h3. Centos7 Python 3 dependency upgraded to rh-python36 @@ -250,7 +355,7 @@ The Python 3 dependency for Centos7 Arvados packages was upgraded from rh-python h2(#v1_4_0). v1.4.0 (2019-06-05) -"Upgrading from 1.3.3":#v1_3_3 +"previous: Upgrading to 1.3.3":#v1_3_3 h3. Populating the new file_count and file_size_total columns on the collections table @@ -319,7 +424,7 @@ h3. Python packaging change 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. -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.). +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.). 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. @@ -357,15 +462,15 @@ Arvados is migrating to a centralized configuration file for all components. Du h2(#v1_3_3). v1.3.3 (2019-05-14) -"Upgrading from 1.3.0":#v1_3_0 +"previous: Upgrading to 1.3.0":#v1_3_0 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. -We've put together a "wiki page":https://dev.arvados.org/projects/arvados/wiki/Recovering_lost_data which outlines how to recover blocks which have been put in the trash, but not yet deleted, as well as how to identify any collections which have missing blocks so that they can be regenerated. The keep-balance component has been enhanced to provide a list of missing blocks and affected collections and we've provided a "utility script":https://github.com/arvados/arvados/blob/master/tools/keep-xref/keep-xref.py which can be used to identify the workflows that generated those collections and who ran those workflows, so that they can be rerun. +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. h2(#v1_3_0). v1.3.0 (2018-12-05) -"Upgrading from 1.2":#v1_2_0 +"previous: Upgrading to 1.2":#v1_2_0 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. @@ -379,7 +484,7 @@ There are no special upgrade notes for this release. h2(#v1_2_0). v1.2.0 (2018-09-05) -"Upgrading from 1.1.2 or 1.1.3":#v1_1_2 +"previous: Upgrading to 1.1.2 or 1.1.3":#v1_1_2 h3. Regenerate Postgres table statistics @@ -411,7 +516,7 @@ Verify your setup by confirming that API calls appear in the controller's logs ( h2(#v1_1_4). v1.1.4 (2018-04-10) -"Upgrading from 1.1.3":#v1_1_3 +"previous: Upgrading to 1.1.3":#v1_1_3 h3. arvados-cwl-runner regressions (2018-04-05) @@ -544,7 +649,7 @@ There are no special upgrade notes for this release. h2(#v1_1_2). v1.1.2 (2017-12-22) -"Upgrading from 1.1.0 or 1.1.1":#v1_1_0 +"previous: Upgrading to 1.1.0 or 1.1.1":#v1_1_0 h3. The minimum version for Postgres is now 9.4 (2017-12-08)