docs/installation/server_upgrade.txt

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