docs/installation/server_upgrade.adoc

   1 Upgrading the Evergreen Server
   2 ------------------------------
   3 Before upgrading, it is important to carefully plan an upgrade strategy to minimize system downtime and service interruptions.
   4 All of the steps in this chapter are to be completed from the command line.
   5
   6 Software Prerequisites
   7 ~~~~~~~~~~~~~~~~~~~~~~
   8
   9   * **PostgreSQL**: The minimum supported version is 9.4.
  10   * **Linux**: Evergreen 2.12.0 has been tested on Debian Stretch (9.0),
  11     Debian Jessie (8.0), Debian Wheezy (7.0), Ubuntu Xenial Xerus (16.04),
  12     and Ubuntu Trusty Tahr (14.04).
  13     If you are running an older version of these distributions, you may want
  14     to upgrade before upgrading Evergreen. For instructions on upgrading these
  15     distributions, visit the Debian or Ubuntu websites.
  16   * **OpenSRF**: The minimum supported version of OpenSRF is 3.0.0.
  17
  18
  19 In the following instructions, you are asked to perform certain steps as either the *root* or *opensrf* user.
  20
  21   * **Debian**: To become the *root* user, issue the `su` command and enter the password of the root user.
  22   * **Ubuntu**: To become the *root* user, issue the `sudo su` command and enter the password of your current user.
  23
  24 To switch from the *root* user to a different user, issue the `su - [user]`
  25 command; for example, `su - opensrf`. Once you have become a non-root user, to
  26 become the *root* user again simply issue the `exit` command.
  27
  28 Upgrade the Evergreen code
  29 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  30 The following steps guide you through a simplistic upgrade of a production
  31 server. You must adjust these steps to accommodate your customizations such
  32 as catalogue skins.
  33
  34 . Stop Evergreen and back up your data:
  35  .. As *root*, stop the Apache web server.
  36  .. As the *opensrf* user, stop all Evergreen and OpenSRF services:
  37 +
  38 [source, bash]
  39 -----------------------------
  40 osrf_control --localhost --stop-all
  41 -----------------------------
  42 +
  43  .. Back up the /openils directory.
  44 . Upgrade OpenSRF. Download and install the latest version of OpenSRF from
  45 the https://evergreen-ils.org/opensrf-downloads/[OpenSRF download page].
  46 . As the *opensrf* user, download and extract Evergreen 2.12.0:
  47 +
  48 [source, bash]
  49 -----------------------------------------------
  50 wget https://evergreen-ils.org/downloads/Evergreen-ILS-2.12.0.tar.gz
  51 tar xzf Evergreen-ILS-2.12.0.tar.gz
  52 -----------------------------------------------
  53 +
  54 [NOTE]
  55 For the latest edition of Evergreen, check the https://evergreen-ils.org/egdownloads/[Evergreen download page] and adjust upgrading instructions accordingly.
  56
  57 . As the *root* user, install the prerequisites:
  58 +
  59 [source, bash]
  60 ---------------------------------------------
  61 cd /home/opensrf/Evergreen-ILS-2.12.0
  62 ---------------------------------------------
  63 +
  64 On the next command, replace `[distribution]` with one of these values for your
  65 distribution of Debian or Ubuntu:
  66 +
  67 indexterm:[Linux, Debian]
  68 indexterm:[Linux, Ubuntu]
  69 +
  70   * `debian-jessie` for Debian Jessie (8.0) (See https://bugs.launchpad.net/evergreen/+bug/1342227[Bug 134222] if you want to use EDI)
  71   * `debian-wheezy` for Debian Wheezy (7.0)
  72   * `ubuntu-xenial` for Ubuntu Xenial Xerus (16.04) (EDI compatibility in progress)
  73   * `ubuntu-trusty` for Ubuntu Trusty Tahr (14.04) (See https://bugs.launchpad.net/evergreen/+bug/1342227[Bug 134222] if you want to use EDI)
  74
  75 +
  76 [source, bash]
  77 ------------------------------------------------------------
  78 make -f Open-ILS/src/extras/Makefile.install [distribution]
  79 ------------------------------------------------------------
  80 +
  81 . As the *opensrf* user, configure and compile Evergreen:
  82 +
  83 [source, bash]
  84 ------------------------------------------------------------
  85 cd /home/opensrf/Evergreen-ILS-2.12.0
  86 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
  87 make
  88 ------------------------------------------------------------
  89 +
  90 These instructions assume that you have also installed OpenSRF under /openils/. If not, please adjust PATH as needed so that the Evergreen configure script can find osrf_config.
  91 +
  92 . As the *root* user, install Evergreen:
  93 +
  94 [source, bash]
  95 ------------------------------------------------------------
  96 cd /home/opensrf/Evergreen-ILS-2.12.0
  97 make install
  98 ------------------------------------------------------------
  99 +
 100
 101 **Note** that this version of Evergreen does not use the legacy XUL staff
 102 client by default, but if you wish to use a versioned XUL staff client, you
 103 can supply `STAFF_CLIENT_STAMP` during the `make install` step like this:
 104 +
 105 [source, bash]
 106 ------------------------------------------------------------
 107 cd /home/opensrf/Evergreen-ILS-2.12.0
 108 make STAFF_CLIENT_STAMP_ID=rel_2_12_rc install
 109 ------------------------------------------------------------
 110 +
 111 . As the *root* user, change all files to be owned by the opensrf user and group:
 112 +
 113 [source, bash]
 114 ------------------------------------------------------------
 115 chown -R opensrf:opensrf /openils
 116 ------------------------------------------------------------
 117 +
 118 . (Optional, only if you are using the legacy staff client)
 119   As the *opensrf* user, update the server symlink in /openils/var/web/xul/:
 120 +
 121 [source, bash]
 122 -----------------------------------------------------------
 123 cd /openils/var/web/xul/
 124 rm server
 125 ln -sf rel_2_12_rc/server server
 126 ----------------------------------------------------------
 127 +
 128 . As the *opensrf* user, update opensrf_core.xml and opensrf.xml by copying the
 129   new example files (/openils/conf/opensrf_core.xml.example and
 130   /openils/conf/opensrf.xml). The _-b_ option creates a backup copy of the old file.
 131 +
 132 [source, bash]
 133 ----------------------------------------------------------
 134 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
 135 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
 136 ----------------------------------------------------------
 137 +
 138 [CAUTION]
 139 Copying these configuration files will remove any customizations you have made to them. Remember to redo your customizations after copying them.
 140 +
 141 . As the *opensrf* user, update the configuration files:
 142 +
 143 [source, bash]
 144 -------------------------------------------------------------------------
 145 cd /home/opensrf/Evergreen-ILS-2.12.0
 146 perl Open-ILS/src/support-scripts/eg_db_config --update-config --service all \
 147 --create-offline --database evergreen --host localhost --user evergreen --password evergreen
 148 -------------------------------------------------------------------------
 149 +
 150 . As the *root* user, update the Apache files:
 151 +
 152 indexterm:[Apache]
 153 +
 154 Use the example configuration files in `Open-ILS/examples/apache/` (for
 155 Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
 156 versions 2.4 or greater) to configure your Web server for the Evergreen
 157 catalog, staff client, Web services, and administration interfaces. Issue the
 158 following commands as the *root* Linux account:
 159 +
 160 [CAUTION]
 161 Copying these Apache configuration files will remove any customizations you have made to them. Remember to redo your customizations after copying them.
 162 For example, if you purchased an SSL certificate, you will need to edit eg.conf to point to the appropriate SSL certificate files.
 163 The diff command can be used to show the differences between the distribution version and your customized version. `diff <customized file> <dist file>`
 164 +
 165 .. Update _/etc/apache2/eg_startup_ by copying the example from _Open-ILS/examples/apache/eg_startup_.
 166 +
 167 [source, bash]
 168 ----------------------------------------------------------
 169 cp /home/opensrf/Evergreen-ILS-2.12.0/Open-ILS/examples/apache/eg_startup /etc/apache2/eg_startup
 170 ----------------------------------------------------------
 171 +
 172 .. Update /etc/apache2/eg_vhost.conf by copying the example from Open-ILS/examples/apache/eg_vhost.conf.
 173 +
 174 [source, bash]
 175 ----------------------------------------------------------
 176 cp /home/opensrf/Evergreen-ILS-2.12.0/Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/eg_vhost.conf
 177 ----------------------------------------------------------
 178 +
 179 .. Update /etc/apache2/sites-available/eg.conf by copying the example from Open-ILS/examples/apache/eg.conf.
 180 +
 181 [source, bash]
 182 ----------------------------------------------------------
 183 cp /home/opensrf/Evergreen-ILS-2.12.0/Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/eg.conf
 184 ----------------------------------------------------------
 185
 186 Upgrade the Evergreen database schema
 187 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 188
 189 indexterm:[database schema]
 190
 191 The upgrade of the Evergreen database schema is the lengthiest part of the
 192 upgrade process for sites with a significant amount of production data.
 193
 194 Before running the upgrade script against your production Evergreen database,
 195 back up your database, restore it to a test server, and run the upgrade script
 196 against the test server. This enables you to determine how long the upgrade
 197 will take and whether any local customizations present problems for the
 198 stock upgrade script that require further tailoring of the upgrade script.
 199 The backup also enables you to cleanly restore your production data if
 200 anything goes wrong during the upgrade.
 201
 202 [NOTE]
 203 =============
 204 Evergreen provides incremental upgrade scripts that allow you to upgrade
 205 from one minor version to the next until you have the current version of
 206 the schema. For example, if you want to upgrade from 2.5.1 to 2.12.0, you
 207 would run the following upgrade scripts:
 208
 209 - 2.5.1-2.5.2-upgrade-db.sql
 210 - 2.5.2-2.5.3-upgrade-db.sql
 211 - 2.5.3-2.6.0-upgrade-db.sql (this is a major version upgrade)
 212 - 2.6.2-2.6.3-upgrade-db.sql
 213 - 2.6.3-2.7.0-upgrade-db.sql (this is a major version upgrade)
 214 - 2.7.0-2.7.1-upgrade-db.sql
 215 - 2.7.1-2.7.2-upgrade-db.sql
 216 - 2.7.2-2.7.3-upgrade-db.sql
 217 - 2.7.3-2.7.4-upgrade-db.sql
 218 - 2.7.4-2.8.0-upgrade-db.sql (this is a major version upgrade)
 219 - 2.8.0-2.8.1-upgrade-db.sql
 220 - 2.8.1-2.8.2-upgrade-db.sql
 221 - 2.8.2-2.8.3-upgrade-db.sql
 222 - 2.8.3-2.8.4-upgrade-db.sql
 223 - 2.8.4-2.9.0-upgrade-db.sql (this is a major version upgrade)
 224 - 2.9.0-2.9.1-upgrade-db.sql
 225 - 2.9.1-2.9.2-upgrade-db.sql
 226 - 2.9.2-2.9.3-upgrade-db.sql
 227 - 2.9.3-2.10.0-upgrade-db.sql
 228 - 2.10.0-2.10.1-upgrade-db.sql
 229 - 2.10.1-2.10.2-upgrade-db.sql
 230 - 2.10.2-2.10.3-upgrade-db.sql
 231 - 2.10.3-2.10.4-upgrade-db.sql
 232 - 2.10.4-2.10.5-upgrade-db.sql
 233 - 2.10.5-2.10.6-upgrade-db.sql
 234 - 2.10.6-2.10.7-upgrade-db.sql
 235 - 2.10.7-2.11.0-upgrade-db.sql (this is a major version upgrade)
 236 - 2.11.0-2.11.1-upgrade-db.sql
 237 - 2.11.1-2.11.2-upgrade-db.sql
 238 - 2.11.2-2.11.3-upgrade-db.sql
 239 - 2.11.3-2.12.0-upgrade-db.sql (this is a major version upgrade)
 240
 241 Note that you do *not* want to run additional 2.5 scripts to upgrade to the
 242 newest version of 2.5, since currently there is no automated way to upgrade
 243 from 2.5.4+ to 2.6. Only upgrade as far as necessary to reach the major
 244 version upgrade script (in this example, as far as 2.5.3).
 245
 246 To upgrade across multiple major versions (e.g. from 2.3.0 to 2.12.0), use
 247 the same logic to utilize the provided major version upgrade scripts. For
 248 example:
 249
 250 - 2.3-2.4.0-upgrade-db.sql
 251 - 2.3-2.4-supplemental.sh
 252 - (run all incremental scripts from 2.4.0 to 2.4.3)
 253 - 2.4.3-2.5.0-upgrade-db.sql
 254 - (run all incremental scripts from 2.5.0 to 2.5.3)
 255 - 2.5.3-2.6.0-upgrade-db.sql
 256 - (run all incremental scripts from 2.6.0 to 2.6.3)
 257 - 2.6.3-2.7.0-upgrade-db.sql
 258 - (run all incremental scripts from 2.7.0 to 2.7.4)
 259 - 2.7.4-2.8.0-upgrade-db.sql
 260 - (run all incremental scripts from 2.8.0 to 2.8.4)
 261 - 2.8.4-2.9.0-upgrade-db.sql
 262 - (run all incremental scripts from 2.9.0 to 2.9.3)
 263 - 2.9.3-2.10.0-upgrade-db.sql
 264 - (run all incremental scripts from 2.10.0 to 2.10.7)
 265 - 2.10.7-2.11.0-upgrade-db.sql
 266 - (run all incremental scripts from 2.11.0 to 2.11.3)
 267 - 2.11.3-2.12.0-upgrade-db.sql
 268
 269 =============
 270
 271 [CAUTION]
 272 Pay attention to error output as you run the upgrade scripts. If you encounter errors
 273 that you cannot resolve yourself through additional troubleshooting, please
 274 report the errors to the https://evergreen-ils.org/communicate/mailing-lists/[Evergreen
 275 Technical Discussion List].
 276
 277 Run the following steps (including other upgrade scripts, as noted above)
 278 as a user with the ability to connect to the database server.
 279
 280 [source, bash]
 281 ----------------------------------------------------------
 282 cd /home/opensrf/Evergreen-ILS-2.12.0/Open-ILS/src/sql/Pg
 283 psql -U evergreen -h localhost -f version-upgrade/2.11.3-2.12.0-upgrade-db.sql evergreen
 284 ----------------------------------------------------------
 285
 286 [TIP]
 287 After the some database upgrade scripts finish, you may see a
 288 note on how to reingest your bib records. You may run this after you have
 289 completed the entire upgrade and tested your system. Reingesting records
 290 may take a long time depending on the number of bib records in your system.
 291
 292 Restart Evergreen and Test
 293 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 294 . As the *root* user, restart memcached to clear out all old user sessions.
 295 +
 296 [source, bash]
 297 --------------------------------------------------------------
 298 service memcached restart
 299 --------------------------------------------------------------
 300 +
 301 . As the *opensrf* user, start all Evergreen and OpenSRF services:
 302 +
 303 [source, bash]
 304 --------------------------------------------------------------
 305 osrf_control --localhost --start-all
 306 --------------------------------------------------------------
 307 +
 308 . As the *opensrf* user, run autogen to refresh the static organizational data files:
 309 +
 310 [source, bash]
 311 --------------------------------------------------------------
 312 cd /openils/bin
 313 ./autogen.sh
 314 --------------------------------------------------------------
 315 +
 316 . Start srfsh and try logging in using your Evergreen username and password:
 317 +
 318 [source, bash]
 319 --------------------------------------------------------------
 320 /openils/bin/srfsh
 321 srfsh% login username password
 322 --------------------------------------------------------------
 323 +
 324 You should see a result like:
 325 +
 326 [source, bash]
 327 ------------------------------------------------------
 328 Received Data: "250bf1518c7527a03249858687714376"
 329     ------------------------------------
 330     Request Completed Successfully
 331     Request Time in seconds: 0.045286
 332     ------------------------------------
 333
 334     Received Data: {
 335        "ilsevent":0,
 336        "textcode":"SUCCESS",
 337        "desc":" ",
 338        "pid":21616,
 339        "stacktrace":"oils_auth.c:304",
 340        "payload":{
 341           "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
 342           "authtime":420
 343        }
 344
 345     }
 346
 347     ------------------------------------
 348     Request Completed Successfully
 349     Request Time in seconds: 1.336568
 350     ------------------------------------
 351 ----------------------------------------------------------
 352 +
 353 If this does not work, it's time to do some <<install-troubleshooting-1,troubleshooting>>.
 354 +
 355 . As the *root* user, start the Apache web server.
 356 +
 357 If you encounter errors, refer to the <<install-troubleshooting-1,troubleshooting>> section
 358 of this documentation for tips on finding solutions and seeking further assistance
 359 from the Evergreen community.
 360
 361 Review Release Notes
 362 ~~~~~~~~~~~~~~~~~~~~
 363
 364 Review this version's release notes for other tasks
 365 that need to be done after upgrading.  If you have upgraded over several
 366 major versions, you will need to review the release notes for each version also.