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