From 70d4cba7d4aef3063fb549a77b45951c339cc57c Mon Sep 17 00:00:00 2001 From: Ward Vandewege Date: Wed, 16 Feb 2022 19:29:34 -0500 Subject: [PATCH] 18702: consolidate upgrade instructions in one place; move the "maintenance and upgrading" page to the admin directory, fix a few small things on the upgrade notes page. Arvados-DCO-1.1-Signed-off-by: Ward Vandewege --- doc/_config.yml | 2 +- .../maintenance-and-upgrading.html.textile.liquid | 12 ++++++++---- doc/admin/upgrading.html.textile.liquid | 15 ++++----------- doc/install/salt-multi-host.html.textile.liquid | 2 +- doc/install/salt-single-host.html.textile.liquid | 2 +- 5 files changed, 15 insertions(+), 18 deletions(-) rename doc/{install => admin}/maintenance-and-upgrading.html.textile.liquid (80%) diff --git a/doc/_config.yml b/doc/_config.yml index a2662200d0..f2ddd7f58c 100644 --- a/doc/_config.yml +++ b/doc/_config.yml @@ -224,7 +224,7 @@ navbar: - admin/config.html.textile.liquid - Maintenance and upgrading: - admin/upgrading.html.textile.liquid - - install/maintenance-and-upgrading.html.textile.liquid + - admin/maintenance-and-upgrading.html.textile.liquid - Core: - install/install-api-server.html.textile.liquid - Keep: diff --git a/doc/install/maintenance-and-upgrading.html.textile.liquid b/doc/admin/maintenance-and-upgrading.html.textile.liquid similarity index 80% rename from doc/install/maintenance-and-upgrading.html.textile.liquid rename to doc/admin/maintenance-and-upgrading.html.textile.liquid index 8cfbbe8dcb..7d0ca84d25 100644 --- a/doc/install/maintenance-and-upgrading.html.textile.liquid +++ b/doc/admin/maintenance-and-upgrading.html.textile.liquid @@ -54,7 +54,11 @@ h2(#upgrading). Upgrading Arvados Upgrading Arvados typically involves the following steps: -* consult the "upgrade notes":{{site.baseurl}}/admin/upgrading.html and the "release notes":https://arvados.org/releases/ for the release you want to upgrade to -* rebuild and deploy the "compute node image":crunch2-cloud/install-compute-node.html (cloud only) -* update the configuration file for the new release (see "Maintaining Arvados":#maintaining above) -* upgrade the Arvados components on the system nodes +# consult the "upgrade notes":{{site.baseurl}}/admin/upgrading.html and the "release notes":https://arvados.org/releases/ for the release you want to upgrade to +# Wait for the cluster to be idle and stop Arvados services. +# Make a backup of your database, as a precaution. +# update the configuration file for the new release, if necessary (see "Maintaining Arvados":#maintaining above) +# rebuild and deploy the "compute node image":{{site.baseurl}}/install/crunch2-cloud/install-compute-node.html (cloud only) +# Install new packages using @apt-get upgrade@ or @yum upgrade@. +# Wait for package installation scripts as they perform any necessary data migrations. +# Verify that the Arvados services were restarted as part of the package upgrades. diff --git a/doc/admin/upgrading.html.textile.liquid b/doc/admin/upgrading.html.textile.liquid index 2294fe36dd..cf5ef55c1f 100644 --- a/doc/admin/upgrading.html.textile.liquid +++ b/doc/admin/upgrading.html.textile.liquid @@ -10,20 +10,13 @@ Copyright (C) The Arvados Authors. All rights reserved. SPDX-License-Identifier: CC-BY-SA-3.0 {% endcomment %} -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 . +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. -h2. General process - -# Consult upgrade notes below to see if any manual configuration updates are necessary. -# Wait for the cluster to be idle and stop Arvados services. -# Make a backup of your database, as a precaution. -# Install new packages using @apt-get upgrade@ or @yum upgrade@. -# Wait for package installation scripts as they perform any necessary data migrations. -# Restart Arvados services. +Upgrade instructions can be found at "Maintenance and upgrading":{{site.baseurl}}/admin/maintenance-and-upgrading.html#upgrading. h2. Upgrade notes -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. +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. {% comment %} Note to developers: Add new items at the top. Include the date, issue number, commit, and considerations/instructions for those about to upgrade. @@ -37,7 +30,7 @@ TODO: extract this information based on git commit messages and generate changel h2(#main). development main (as of 2021-11-10) -"previous: Upgrading from 2.3.0":#v2_3_0 +"previous: Upgrading to 2.3.0":#v2_3_0 h3. Preemptible instance types are used automatically, if any are configured diff --git a/doc/install/salt-multi-host.html.textile.liquid b/doc/install/salt-multi-host.html.textile.liquid index d06a190ad0..10f2e32ef1 100644 --- a/doc/install/salt-multi-host.html.textile.liquid +++ b/doc/install/salt-multi-host.html.textile.liquid @@ -294,4 +294,4 @@ h2(#post_install). After the installation Once the installation is complete, it is recommended to keep a copy of your local configuration files. Committing them to version control is a good idea. -Re-running the Salt-based installer is not recommended for maintaining and upgrading Arvados, please see "Maintenance and upgrading":maintenance-and-upgrading.html for more information. +Re-running the Salt-based installer is not recommended for maintaining and upgrading Arvados, please see "Maintenance and upgrading":{{site.baseurl}}/admin/maintenance-and-upgrading.html for more information. diff --git a/doc/install/salt-single-host.html.textile.liquid b/doc/install/salt-single-host.html.textile.liquid index a3fa63c25a..0f06412f91 100644 --- a/doc/install/salt-single-host.html.textile.liquid +++ b/doc/install/salt-single-host.html.textile.liquid @@ -272,4 +272,4 @@ h2(#post_install). After the installation Once the installation is complete, it is recommended to keep a copy of your local configuration files. Committing them to version control is a good idea. -Re-running the Salt-based installer is not recommended for maintaining and upgrading Arvados, please see "Maintenance and upgrading":maintenance-and-upgrading.html for more information. +Re-running the Salt-based installer is not recommended for maintaining and upgrading Arvados, please see "Maintenance and upgrading":{{site.baseurl}}/admin/maintenance-and-upgrading.html for more information. -- 2.30.2