Lp 1901899: Remove Ubuntu 16.04 Xenial Xerus
[Evergreen.git] / docs / modules / installation / pages / server_upgrade.adoc
1 = Upgrading the Evergreen Server =
2 :toc:
3
4 Before upgrading, it is important to carefully plan an upgrade strategy to minimize system downtime and service interruptions.
5 All of the steps in this chapter are to be completed from the command line.
6
7 == Software Prerequisites ==
8
9   * **PostgreSQL**: The minimum supported version is 9.6.
10   * **Linux**: Evergreen 3.X.X has been tested on Debian Stretch
11     (9.0), Debian Jessie (8.0), Ubuntu Bionic Beaver (18.04), and
12     Ubuntu Focal Fossa (20.04).  If you are running an older version
13     of these distributions, you may want to upgrade before upgrading
14     Evergreen. For instructions on upgrading these distributions,
15     visit the Debian or Ubuntu websites.
16   * **OpenSRF**: The minimum supported version of OpenSRF is 3.2.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 catalog 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 3.X.X:
47 +
48 [source, bash]
49 -----------------------------------------------
50 wget https://evergreen-ils.org/downloads/Evergreen-ILS-3.X.X.tar.gz
51 tar xzf Evergreen-ILS-3.X.X.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-3.X.X
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-stretch` for Debian Stretch (9.0) (EDI compatibility in progress)
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   * `ubuntu-bionic` for Ubuntu Bionic Beaver (18.04) (EDI compatibility in progress)
73   * `ubuntu-focal` for Ubuntu Focal Fossa (20.04) (EDI compatibility in progress)
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-3.X.X
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-3.X.X
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-3.X.X
108 make STAFF_CLIENT_STAMP_ID=rel_3_x_x 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_3_x_x/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-3.X.X
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-3.X.X/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-3.X.X/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-3.X.X/Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/eg.conf
184 ----------------------------------------------------------
185
186 == Upgrade the Evergreen database schema ==
187
188 indexterm:[database schema]
189
190 The upgrade of the Evergreen database schema is the lengthiest part of the
191 upgrade process for sites with a significant amount of production data.
192
193 Before running the upgrade script against your production Evergreen database,
194 back up your database, restore it to a test server, and run the upgrade script
195 against the test server. This enables you to determine how long the upgrade
196 will take and whether any local customizations present problems for the
197 stock upgrade script that require further tailoring of the upgrade script.
198 The backup also enables you to cleanly restore your production data if
199 anything goes wrong during the upgrade.
200
201 [NOTE]
202 =============
203 Evergreen provides incremental upgrade scripts that allow you to upgrade
204 from one minor version to the next until you have the current version of
205 the schema. For example, if you want to upgrade from 2.9.0 to 2.11.0, you
206 would run the following upgrade scripts:
207
208 - 2.9.0-2.9.1-upgrade-db.sql
209 - 2.9.1-2.9.2-upgrade-db.sql
210 - 2.9.2-2.9.3-upgrade-db.sql
211 - 2.9.3-2.10.0-upgrade-db.sql (this is a major version upgrade)
212 - 2.10.0-2.10.1-upgrade-db.sql
213 - 2.10.1-2.10.2-upgrade-db.sql
214 - 2.10.2-2.10.3-upgrade-db.sql
215 - 2.10.3-2.10.4-upgrade-db.sql
216 - 2.10.4-2.10.5-upgrade-db.sql
217 - 2.10.5-2.10.6-upgrade-db.sql
218 - 2.10.6-2.10.7-upgrade-db.sql
219 - 2.10.7-2.11.0-upgrade-db.sql (this is a major version upgrade)
220
221 Note that you do *not* necessarily want to run additional upgrade scripts to
222 upgrade to the newest version, since currently there is no automated way, for
223 example to upgrade from 2.9.4+ to 2.10. Only upgrade as far as necessary to
224 reach the major version upgrade script (in this example, as far as 2.9.3).
225
226 =============
227
228 [CAUTION]
229 Pay attention to error output as you run the upgrade scripts. If you encounter errors
230 that you cannot resolve yourself through additional troubleshooting, please
231 report the errors to the https://evergreen-ils.org/communicate/mailing-lists/[Evergreen
232 Technical Discussion List].
233
234 Run the following steps (including other upgrade scripts, as noted above)
235 as a user with the ability to connect to the database server.
236
237 [source, bash]
238 ----------------------------------------------------------
239 cd /home/opensrf/Evergreen-ILS-3.X.X/Open-ILS/src/sql/Pg
240 psql -U evergreen -h localhost -f version-upgrade/3.X.W-3.X.X-upgrade-db.sql evergreen
241 ----------------------------------------------------------
242
243 [TIP]
244 After the some database upgrade scripts finish, you may see a
245 note on how to reingest your bib records. You may run this after you have
246 completed the entire upgrade and tested your system. Reingesting records
247 may take a long time depending on the number of bib records in your system.
248
249 == Restart Evergreen and Test ==
250
251 . As the *root* user, restart memcached to clear out all old user sessions.
252 +
253 [source, bash]
254 --------------------------------------------------------------
255 service memcached restart
256 --------------------------------------------------------------
257 +
258 . As the *opensrf* user, start all Evergreen and OpenSRF services:
259 +
260 [source, bash]
261 --------------------------------------------------------------
262 osrf_control --localhost --start-all
263 --------------------------------------------------------------
264 +
265 . As the *opensrf* user, run autogen to refresh the static organizational data files:
266 +
267 [source, bash]
268 --------------------------------------------------------------
269 cd /openils/bin
270 ./autogen.sh
271 --------------------------------------------------------------
272 +
273 . Start srfsh and try logging in using your Evergreen username and password:
274 +
275 [source, bash]
276 --------------------------------------------------------------
277 /openils/bin/srfsh
278 srfsh% login username password
279 --------------------------------------------------------------
280 +
281 You should see a result like:
282 +
283 [source, bash]
284 --------------------------------------------------------------
285 Received Data: "250bf1518c7527a03249858687714376"
286     ------------------------------------
287     Request Completed Successfully
288     Request Time in seconds: 0.045286
289     ------------------------------------
290
291     Received Data: {
292        "ilsevent":0,
293        "textcode":"SUCCESS",
294        "desc":" ",
295        "pid":21616,
296        "stacktrace":"oils_auth.c:304",
297        "payload":{
298           "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
299           "authtime":420
300        }
301
302     }
303
304     ------------------------------------
305     Request Completed Successfully
306     Request Time in seconds: 1.336568
307     ------------------------------------
308 --------------------------------------------------------------
309 +
310 If this does not work, it's time to do some
311 xref:installation:server_installation.adoc#install-troubleshooting-1[troubleshooting].
312 +
313 . As the *root* user, start the Apache web server.
314 +
315 If you encounter errors, refer to the
316 xref:installation:server_installation.adoc#install-troubleshooting-1[troubleshooting] section 
317 of this documentation for tips on finding solutions and seeking further assistance
318 from the Evergreen community.
319
320 == Review Release Notes ==
321
322 Review this version's release notes for other tasks
323 that need to be done after upgrading.  If you have upgraded over several 
324 major versions, you will need to review the release notes for each version also.