Support for upgrades.

- by Joel Aufrecht
+Support for upgrades.

Prev	Chapter�5.�Upgrading	Next

Support for upgrades.

by Joel Aufrecht

OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff. -

Starting with Version 4.5, all OpenACS core packages support +

Starting with Version 4.5, all OpenACS core packages support automatic upgrade. That means that, if you have OpenACS 4.5 or better, you should always be able to upgrade all of your core packages automatically. If you haven't changed anything, no manual intervention should be required. If you are running OpenACS prior to 4.5, upgrading will require manual effort.

Checklist

The required platform for OpenACS 4.6 is the same as 4.5, with the excepion of OpenFTS. You now need OpenFTS 0.3.2, not 0.2. - OpenACS 4.6 does not support PostGreSQL 7.3.

A computer with OpenACS 4.5.
OpenACS 4.6 tarball
Required for Full Text Search on PostGreSQL: OpenFTS 0.3.2

Overview

OpenACS consists of files and a database schema. The files + OpenACS 4.6 does not support PostGreSQL 7.3.

A computer with OpenACS 4.5.
OpenACS 4.6 tarball
Required for Full Text Search on PostGreSQL: OpenFTS 0.3.2

Overview

OpenACS consists of files and a database schema. The files in the OpenACS 4.6 tarball include database upgrade scripts. To start the upgrade, replace your existing files with the new files and then restart the server. Then, browse to the APM, which will detect the new packages and offer to run the appropriate database upgrade scripts. After restarting the server again, the upgrade is - complete.

Figure�5.1.�Assumptions in this section

name of OpenACS user	nsadmin
OpenACS server name	openacs-dev
Root of OpenACS file tree	/web/openacs-dev
Database backup directory	/backup/openacs/

Upgrading on Linux/Unix

Make a Backup.�Back up the database and file system (see the section called “Snapshot backup and recovery”).
OPTIONAL: Upgrade OpenFTS.�OpenACS Full Text Search requires several pieces: the OpenFTS code, some database functions, and the OpenFTS Engine. If you have OpenFTS 0.2, you'll need to upgrade to to OpenFTS 0.3.2. This is backwards-compatible - + complete.
Figure�5.1.�Assumptions in this section
name of OpenACS user nsadmin
OpenACS server name openacs-dev
Root of OpenACS file tree /web/openacs-dev
Database backup directory /backup/openacs/

Upgrading on Linux/Unix

Make a Backup.�Back up the database and file system (see the section called “Snapshot backup and recovery”).
OPTIONAL: Upgrade OpenFTS.�OpenACS Full Text Search requires several pieces: the OpenFTS code, some database functions, and the OpenFTS Engine. If you have OpenFTS 0.2, you'll need to upgrade to to OpenFTS 0.3.2. This is backwards-compatible - completing this step will not break a working OpenFTS Engine from 4.5.
1. Uninstall the old OpenFTS Engine
  1. Browse to http://yourserver/openfts.
  2. Click Administration.
  3. Click Drop OpenFTS Engine
2. Build and install the new OpenFTS driver and supporting tcl procedures. (This section of shell code is not fully documented; please exercise care.)
```
cd /usr/local/src/
@@ -49,7 +48,9 @@
 su - nsadmin
 psql openacs-dev -f /usr/local/pgsql/share/contrib/openfts.sql
 psql openacs-dev -f /usr/local/src/postgresql-7.2.3/contrib/tsearch/tsearch.sql
-exit
```

Stop the server.�

[root@localhost root]# svc -d /service/openacs-dev

Upgrade the file tree.�If you are using CVS, you will unpack the OpenACS 4.6 tarball into a working directory and then import that directory into cvs. If you have changed files in the core packages, cvs will attempt to merge your changes. You may have to manually merge some conflicts. When that's finished, you can update your normal development checkout directory and the new files will appear. If you aren't using CVS, you can unpack the tarball on top of your existing tree, but any customizations you've made to the kernel or core packages will be erased.
- Upgrading files without CVS.�Unpack the tarball into a new directory and copy its contents on top of your working directory.
```
[root@localhost root]# su - nsadmin
+exit
```

+ Stop the server +

[root@localhost root]# svc -d /service/openacs-dev

Upgrade the file tree.�If you are using CVS, you will unpack the OpenACS 4.6 tarball into a working directory and then import that directory into cvs. If you have changed files in the core packages, cvs will attempt to merge your changes. You may have to manually merge some conflicts. When that's finished, you can update your normal development checkout directory and the new files will appear. If you aren't using CVS, you can unpack the tarball on top of your existing tree, but any customizations you've made to the kernel or core packages will be erased.

Upgrading files without CVS.�Unpack the tarball into a new directory and copy its contents on top of your working directory.

[root@localhost root]# su - nsadmin
 [nsadmin@localhost aolserver]$ cd /web
 [nsadmin@localhost web]$ tar xzf /tmp/openacs-4-6.tgz
 [nsadmin@localhost web]$ cp -r openacs-4-6/* openacs-4
@@ -59,7 +60,9 @@
 cd /web
 tar xzf /tmp/openacs-4-6.tgz
 cp -r openacs-4-6/* openacs-4
-exit

Upgrading files with CVS.�

Unpack the new files into a working directory.
```
[root@localhost root]# su - nsadmin
+exit
```

+ Upgrading files with CVS +

Unpack the new files into a working directory.

[root@localhost root]# su - nsadmin
 [nsadmin@localhost aolserver]$ cd /tmp
 [nsadmin@localhost tmp]$ tar xzv openacs-4-6.tgz
 [nsadmin@localhost tmp]$ cd openacs-4.6
@@ -89,11 +92,13 @@
 [root@localhost root]#
 cd /web/openacs-dev
 cvs up -Pd
-exit

Start the server.�

[root@localhost root]# svc -u /service/openacs-dev

Use APM to upgrade the database.�

Browse to the package manager, http://yourserver/acs-admin/apm.
Click Install packages.
Select the packages you want to install. This should +exit

+ Start the server +

[root@localhost root]# svc -u /service/openacs-dev

Use APM to upgrade the database.�

Browse to the package manager, http://yourserver/acs-admin/apm.
Click Install packages.
Select the packages you want to install. This should be everything that says upgrade, plus any new packages you want. It's safest to upgrade the kernel by itself, and then come back and upgrade the rest of the desired packages in a second pass.
On the next screen, click Install Packages

When prompted, restart the server:

[root@localhost root]# restart-aolserver openacs-dev

Wait a minute, then browse to the package manager, http://yourserver/acs-admin/apm.
Check that the kernel upgrade worked by clicking All and making sure that acs-kernel version is 5.0.0b1.

OPTIONAL: Install the new OpenFTS Engine.�If you want to upgrade the OpenFTS Engine, do these steps. (You must have already upgraded the OpenFTS driver to - 0.3.2.)

Browse to http://yourserver/admin/site-map
On the openfts line, click on set parameters.
Change the value of openfts_tcl_src_path from /usr/local/src/Search-OpenFTS-tcl-0.2/ to /usr/local/src/Search-OpenFTS-tcl-0.3.2/
Click Set Parameters

[root@localhost root]# restart-aolserver openacs-dev

Browse to http://yourserver/openfts
Click Administration.
Click Initialize OpenFTS Engine

Rollback.�If anything goes wrong, roll back to the backup snapshot.

($Id$)

Prev	Home	Next
Chapter�5.�Upgrading	Up	Chapter�6.�Maintenance