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.1 is recommended. The minimum supported version
  10     is 9.1.
  11   * **Linux**: Evergreen 2.6 has been tested on Debian Wheezy (7.0), Debian Squeeze (6.0),
  12     Ubuntu Precise Pangolin (12.04) and Ubuntu Lucid Lynx (10.04). If you are
  13     running an older version of these distributions, you may want to upgrade
  14     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 2.3.0.
  17
  18 In the following instructions, you are asked to perform certain steps as either the root or opensrf user.
  19
  20   * **Debian**: To become the root user, issue the `su` command and enter the password of the root user.
  21   * **Ubuntu**: To become the root user, issue the `sudo su` command and enter the password of your current user.
  22
  23 To switch from the root user to a different user, issue the `su - [user]`
  24 command; for example, `su - opensrf`. Once you have become a non-root user, to
  25 become the root user again simply issue the `exit` command.
  26
  27 Upgrade the Evergreen code
  28 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  29 The following steps guide you through a simplistic upgrade of a production
  30 server. You must adjust these steps to accommodate your customizations such
  31 as catalogue skins.
  32
  33 . Stop Evergreen and back up your data:
  34  .. As root, stop the Apache web server.
  35  .. As the opensrf user, stop all Evergreen and OpenSRF services:
  36 +
  37 [source, bash]
  38 -----------------------------
  39 osrf_control --localhost --stop-all
  40 -----------------------------
  41 +
  42  .. Back up the /openils directory.
  43 . Upgrade OpenSRF. Download and install the latest version of OpenSRF from
  44 the http://evergreen-ils.org/opensrf-downloads/[OpenSRF download page].
  45 . As the opensrf user, download and extract Evergreen 2.6:
  46 +
  47 [source, bash]
  48 -----------------------------------------------
  49 wget http://evergreen-ils.org/downloads/Evergreen-ILS-2.6.1.tar.gz
  50 tar xzf Evergreen-ILS-2.6.1.tar.gz
  51 -----------------------------------------------
  52 +
  53 [NOTE]
  54 For the latest edition of Evergreen, check the http://evergreen-ils.org/downloads.php[Evergreen download page] and adjust upgrading instructions accordingly.
  55
  56 . As the root user, install the prerequisites:
  57 +
  58 [source, bash]
  59 ---------------------------------------------
  60 cd /home/opensrf/Evergreen-ILS-2.6.1
  61 ---------------------------------------------
  62 +
  63 On the next command, replace `[distribution]` with one of these values for your
  64 distribution of Debian or Ubuntu:
  65 +
  66 indexterm:[Linux, Debian]
  67 indexterm:[Linux, Ubuntu]
  68 +
  69   * `debian-wheezy` for Debian Wheezy (7.0)
  70   * `debian-squeeze` for Debian Squeeze (6.0)
  71   * `ubuntu-precise` for Ubuntu Precise Pangolin (12.04)
  72   * `ubuntu-lucid` for Ubuntu Lucid Lynx (10.04)
  73 +
  74 [source, bash]
  75 ------------------------------------------------------------
  76 make -f Open-ILS/src/extras/Makefile.install [distribution]
  77 ------------------------------------------------------------
  78 +
  79 . As the opensrf user, configure and compile Evergreen:
  80 +
  81 [source, bash]
  82 ------------------------------------------------------------
  83 cd /home/opensrf/Evergreen-ILS-2.6.1
  84 ./configure --prefix=/openils --sysconfdir=/openils/conf
  85 make
  86 ------------------------------------------------------------
  87 +
  88 . As the root user, install Evergreen:
  89 +
  90 [source, bash]
  91 ------------------------------------------------------------
  92 cd /home/opensrf/Evergreen-ILS-2.6.1
  93 make STAFF_CLIENT_STAMP_ID=rel_2_6_1 install
  94 ------------------------------------------------------------
  95 +
  96 . As the root user, change all files to be owned by the opensrf user and group:
  97 +
  98 [source, bash]
  99 ------------------------------------------------------------
 100 chown -R opensrf:opensrf /openils
 101 ------------------------------------------------------------
 102 +
 103 . As the opensrf user, update the server symlink in /openils/var/web/xul/:
 104 +
 105 [source, bash]
 106 -----------------------------------------------------------
 107 cd /openils/var/web/xul/
 108 rm server
 109 ln -sf rel_2_6_1/server server
 110 ----------------------------------------------------------
 111 +
 112 . As the opensrf user, update opensrf_core.xml and opensrf.xml by copying the
 113   new example files (/openils/conf/opensrf_core.xml.example and
 114   /openils/conf/opensrf.xml). The _-b_ option creates a backup copy of the old file.
 115 +
 116 [source, bash]
 117 ----------------------------------------------------------
 118 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
 119 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
 120 ----------------------------------------------------------
 121 +
 122 [CAUTION]
 123 Copying these configuration files will remove any customizations you have made to them. Remember to redo your customizations after copying them.
 124 +
 125 . As the opensrf user, update the configuration files:
 126 +
 127 [source, bash]
 128 -------------------------------------------------------------------------
 129 cd /home/opensrf/Evergreen-ILS-2.6.1
 130 perl Open-ILS/src/support-scripts/eg_db_config --update-config --service all \
 131 --create-offline --database evergreen --host localhost --user evergreen --password evergreen
 132 -------------------------------------------------------------------------
 133 +
 134 . As the _root_ user, update the Apache files:
 135 +
 136 indexterm:[Apache]
 137 +
 138 [CAUTION]
 139 Copying these Apache configuration files will remove any customizations you have made to them. Remember to redo your customizations after copying them.
 140 For example, if you purchased an SSL certificate, you will need to edit eg.conf to point to the appropriate SSL certificate files.
 141 +
 142 .. Update _/etc/apache2/eg_startup_ by copying the example from _Open-ILS/examples/apache/eg_startup_.
 143 +
 144 [source, bash]
 145 ----------------------------------------------------------
 146 cp /home/opensrf/Evergreen-ILS-2.6.1/Open-ILS/examples/apache/eg_startup /etc/apache2/eg_startup
 147 ----------------------------------------------------------
 148 +
 149 .. Update /etc/apache2/eg_vhost.conf by copying the example from Open-ILS/examples/apache/eg_vhost.conf.
 150 +
 151 [source, bash]
 152 ----------------------------------------------------------
 153 cp /home/opensrf/Evergreen-ILS-2.6.1/Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/eg_vhost.conf
 154 ----------------------------------------------------------
 155 +
 156 .. Update /etc/apache2/sites-available/eg.conf by copying the example from Open-ILS/examples/apache/eg.conf.
 157 +
 158 [source, bash]
 159 ----------------------------------------------------------
 160 cp /home/opensrf/Evergreen-ILS-2.6.1/Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/eg.conf
 161 ----------------------------------------------------------
 162
 163 Upgrade the Evergreen database schema
 164 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 165
 166 indexterm:[database schema]
 167
 168 The upgrade of the Evergreen database schema is the lengthiest part of the
 169 upgrade process for sites with a significant amount of production data.
 170
 171 Before running the upgrade script against your production Evergreen database,
 172 back up your database, restore it to a test server, and run the upgrade script
 173 against the test server. This enables you to determine how long the upgrade
 174 will take and whether any local customizations present problems for the
 175 stock upgrade script that require further tailoring of the upgrade script.
 176 The backup also enables you to cleanly restore your production data if
 177 anything goes wrong during the upgrade.
 178
 179 [NOTE]
 180 =============
 181 Evergreen provides incremental upgrade scripts that allow you to upgrade
 182 from one minor version to the next until you have the current version of
 183 the schema. For example, if you want to upgrade from 2.5.1 to 2.6.1, you
 184 would run the following upgrade scripts:
 185
 186 - 2.5.1-2.5.2-upgrade-db.sql
 187 - 2.5.2-2.5.3-upgrade-db.sql
 188 - 2.5.3-2.6.0-upgrade-db.sql (this is a major version upgrade)
 189 - 2.6.0-2.6.1-upgrade-db.sql
 190
 191 Note that you do *not* want to run additional 2.5 scripts to upgrade to the
 192 newest version of 2.5, since currently there is no automated way to upgrade
 193 from 2.5.4+ to 2.6. Only upgrade as far as necessary to reach the major
 194 version upgrade script (in this example, as far as 2.5.3).
 195
 196 To upgrade across multiple major versions (e.g. from 2.3.0 to 2.6.1), use
 197 the same logic to utilize the provided major version upgrade scripts. For
 198 example:
 199
 200 - 2.3-2.4.0-upgrade-db.sql
 201 - 2.3-2.4-supplemental.sh
 202 - (run all incremental scripts from 2.4.0 to 2.4.3)
 203 - 2.4.3-2.5.0-upgrade-db.sql
 204 - (run all incremental scripts from 2.5.0 to 2.5.3)
 205 - 2.5.3-2.6.0-upgrade-db.sql
 206 - 2.6.0-2.6.1-upgrade-db.sql
 207 =============
 208
 209 [CAUTION]
 210 Pay attention to error output as you run the upgrade scripts. If you encounter errors
 211 that you cannot resolve yourself through additional troubleshooting, please
 212 report the errors to the http://evergreen-ils.org/communicate/mailing-lists/[Evergreen
 213 Technical Discussion List].
 214
 215 Run the following steps (including other upgrade scripts, as noted above)
 216 as a user with the ability to connect to the database server.
 217
 218 [source, bash]
 219 ----------------------------------------------------------
 220 cd /home/opensrf/Evergreen-ILS-2.6.1/Open-ILS/src/sql/Pg
 221 psql -U evergreen -h localhost -f version-upgrade/2.5.3-2.6.0-upgrade-db.sql evergreen
 222 ----------------------------------------------------------
 223
 224 [TIP]
 225 After the `2.5.3-2.6.0-upgrade-db.sql` script finishes, you will see a
 226 note on how to reingest your bib records. You may run this after you have
 227 completed the entire upgrade and tested your system. Reingesting records
 228 may take a long time depending on the number of bib records in your system.
 229
 230 Restart Evergreen and Test
 231 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 232 . As the opensrf user, start all Evergreen and OpenSRF services:
 233 +
 234 [source, bash]
 235 --------------------------------------------------------------
 236 osrf_control --localhost --start-all
 237 --------------------------------------------------------------
 238 +
 239 . As the opensrf user, run autogen to refresh the static organizational data files:
 240 +
 241 [source, bash]
 242 --------------------------------------------------------------
 243 cd /openils/bin
 244 ./autogen.sh
 245 --------------------------------------------------------------
 246 +
 247 . Start srfsh and try logging in using your Evergreen username and password:
 248 +
 249 [source, bash]
 250 --------------------------------------------------------------
 251 /openils/bin/srfsh
 252 srfsh% login username password
 253 --------------------------------------------------------------
 254 +
 255 You should see a result like:
 256 +
 257 [source, bash]
 258 ------------------------------------------------------
 259 Received Data: "250bf1518c7527a03249858687714376"
 260     ------------------------------------
 261     Request Completed Successfully
 262     Request Time in seconds: 0.045286
 263     ------------------------------------
 264
 265     Received Data: {
 266        "ilsevent":0,
 267        "textcode":"SUCCESS",
 268        "desc":" ",
 269        "pid":21616,
 270        "stacktrace":"oils_auth.c:304",
 271        "payload":{
 272           "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
 273           "authtime":420
 274        }
 275
 276     }
 277
 278     ------------------------------------
 279     Request Completed Successfully
 280     Request Time in seconds: 1.336568
 281     ------------------------------------
 282 ----------------------------------------------------------
 283 +
 284 If this does not work, it's time to do some troubleshooting.
 285 +
 286 . As the root user, start the Apache web server.
 287 +
 288 If you encounter errors, refer to the troubleshooting section of this documentation for tips on finding solutions and seeking further assistance
 289 from the Evergreen community.