From bf61cff178681a22a1695e528dd0b3c7a217d448 Mon Sep 17 00:00:00 2001 From: Lucas Di Pentima Date: Tue, 28 Nov 2023 17:44:33 -0300 Subject: [PATCH] 20690: Documentation updates, upgrade notes added. Arvados-DCO-1.1-Signed-off-by: Lucas Di Pentima --- doc/admin/upgrading.html.textile.liquid | 4 ++++ doc/install/salt-multi-host.html.textile.liquid | 17 +++++------------ .../salt-single-host.html.textile.liquid | 10 ++-------- 3 files changed, 11 insertions(+), 20 deletions(-) diff --git a/doc/admin/upgrading.html.textile.liquid b/doc/admin/upgrading.html.textile.liquid index 739a08b5b3..17ca6e00fe 100644 --- a/doc/admin/upgrading.html.textile.liquid +++ b/doc/admin/upgrading.html.textile.liquid @@ -32,6 +32,10 @@ h2(#main). development main "previous: Upgrading to 2.7.0":#v2_7_0 +h3. Remove Workbench1 packages after upgrading the salt installer + +If you have an Arvados cluster deployed with a previous version of the installer and you're planning on upgrading the installer, please take into consideration that the already installed workbench1 package will need to be uninstalled manually from the workbench instance. + h3. Remove Workbench1 packages and configuration The Workbench1 application has been removed from the Arvados distribution. We recommend the following follow-up steps. diff --git a/doc/install/salt-multi-host.html.textile.liquid b/doc/install/salt-multi-host.html.textile.liquid index eaffcf582c..a3cdd03300 100644 --- a/doc/install/salt-multi-host.html.textile.liquid +++ b/doc/install/salt-multi-host.html.textile.liquid @@ -233,10 +233,10 @@ The installer will set up the Arvados services on your machines. Here is the de # KEEPSTORE nodes (at least 1 if using S3 as a Keep backend, else 2) ## arvados keepstore (recommendend hostnames @keep0.${DOMAIN}@ and @keep1.${DOMAIN}@) # WORKBENCH node -## arvados workbench (recommendend hostname @workbench.${DOMAIN}@) -## arvados workbench2 (recommendend hostname @workbench2.${DOMAIN}@) -## arvados webshell (recommendend hostname @webshell.${DOMAIN}@) -## arvados websocket (recommendend hostname @ws.${DOMAIN}@) +## arvados legacy workbench URLs (recommendend hostname @workbench.${DOMAIN}@) +## arvados workbench2 (recommendend hostname @workbench2.${DOMAIN}@) +## arvados webshell (recommendend hostname @webshell.${DOMAIN}@) +## arvados websocket (recommendend hostname @ws.${DOMAIN}@) ## arvados cloud dispatcher ## arvados keepbalance ## arvados keepproxy (recommendend hostname @keep.${DOMAIN}@) @@ -284,7 +284,6 @@ BLOB_SIGNING_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX MANAGEMENT_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX SYSTEM_ROOT_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ANONYMOUS_USER_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -WORKBENCH_SECRET_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX DATABASE_PASSWORD=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX # Set @DATABASE_PASSWORD@ to a random string (unless you "already have a database":#ext-database then you should set it to that database's password) @@ -409,13 +408,7 @@ The installer records log files for each deployment. Most service logs go to @/var/log/syslog@. -The logs for Rails API server and for Workbench can be found in - -@/var/www/arvados-api/current/log/production.log@ -and -@/var/www/arvados-workbench/current/log/production.log@ - -on the appropriate instances. +The logs for Rails API server can be found in @/var/www/arvados-api/current/log/production.log@ on the appropriate instance(s). Workbench 2 is a client-side Javascript application. If you are having trouble loading Workbench 2, check the browser's developer console (this can be found in "Tools → Developer Tools"). diff --git a/doc/install/salt-single-host.html.textile.liquid b/doc/install/salt-single-host.html.textile.liquid index 8ad79d86e8..92c1aa2645 100644 --- a/doc/install/salt-single-host.html.textile.liquid +++ b/doc/install/salt-single-host.html.textile.liquid @@ -48,7 +48,7 @@ Determine if you will use a single hostname, or multiple hostnames. If you are using multiple hostnames, determine the base domain for the cluster. This will be referred to as @${DOMAIN}@. -For example, if CLUSTER is @xarv1@ and DOMAIN is @example.com@, then @controller.${CLUSTER}.${DOMAIN}@" means @controller.xarv1.example.com@. +For example, if CLUSTER is @xarv1@ and DOMAIN is @example.com@, then @controller.${CLUSTER}.${DOMAIN}@ means @controller.xarv1.example.com@. h3. Machine specification @@ -190,13 +190,7 @@ The installer records log files for each deployment. Most service logs go to @/var/log/syslog@. -The logs for Rails API server and for Workbench can be found in - -@/var/www/arvados-api/current/log/production.log@ -and -@/var/www/arvados-workbench/current/log/production.log@ - -on the appropriate instances. +The logs for Rails API server can be found in @/var/www/arvados-api/current/log/production.log@ on the appropriate instance. Workbench 2 is a client-side Javascript application. If you are having trouble loading Workbench 2, check the browser's developer console (this can be found in "Tools → Developer Tools"). -- 2.30.2