| Prev | Chapter 5. Upgrading | Next |
|---|
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.
It's always a good idea to precede an upgrade attempt with a snapshot backup.
OpenACS consists of files and a database schema. The files in a new tarball include database upgrade scripts. To start the upgrade, replace your existing files with the new files and 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.
Current working notes in Forum OpenACS Development: 4.6.3 upgrade to 5-HEAD: final results.
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.
Required for Full Text Search on PostgreSQL: OpenFTS 0.3.2
Upgrade Sequence
Make a Backup. Back up the database and file system (see the section called “Manual 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.
Uninstall the old OpenFTS Engine
Browse to http://yourserver/openfts.
Click Administration.
Click
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/ tar xzf /tmp/Search-OpenFTS-tcl-0.3.2.tar.gz chown -R root.root Search-OpenFTS-tcl-0.3.2/ cd Search-OpenFTS-tcl-0.3.2/ ./configure --with-aolserver-src=/usr/local/src/aolserver/aolserver --with-tcl=/usr/lib/ cd aolserver/ make
Back up the old fts driver as a precaution and install the newly compiled one
mv /usr/local/aolserver/bin/nsfts.so /usr/local/aolserver/bin/nsfts-0.2.so cp nsfts.so /usr/local/aolserver/bin
Build and install the postgres code
cd /usr/local/src/Search-OpenFTS-tcl-0.3.2/ cp -r pgsql_contrib_openfts /usr/local/src/postgresql-7.2.3/contrib /usr/local/src/postgresql-7.2.3/contrib/pgsql_contrib_openfts make su - postgres cd tsearch/ make make install exit
In order for the OpenACS 4.6 OpenFTS Engine to use the OpenFTS 0.3.2 driver, we need some commands added to the database.
[root@localhost root]# su - nsadmin [nsadmin@localhost dev]$ psql openacs-dev -f /usr/local/pgsql/share/contrib/openfts.sql CREATE CREATE [nsadmin@localhost dev]$ psql openacs-dev -f /usr/local/src/postgresql-7.2.3/contrib/tsearch/tsearch.sql BEGIN CREATE (~30 more lines) [nsadmin@localhost dev]$ exit [root@localhost root]# 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-devUpgrade 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
[nsadmin@localhost openacs-upgrade]$ exit
[root@localhost root]#
su - nsadmin
cd /web
tar xzf /tmp/openacs-4-6.tgz
cp -r openacs-4-6/* openacs-4
exitUpgrading 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
Import the new files into your cvs repository; where they match existing files, they will become the new version of the file.
[nsadmin@localhost openacs-4.6]$ cvs import -m "upgrade to OpenACS 4.6" openacs OpenACS openacs-4-6
Create a new directory as temporary working space to reconcile conflicts between the new files and your current work. The example uses the cvs keyword yesterday, making the assumption that you haven't checked in new code to your local tree in the last day.
[nsadmin@localhost openacs-4.6]$ cd /web
[nsadmin@localhost tmp]$ mkdir openacs-upgrade
[nsadmin@localhost tmp]$ cvs checkout -d openacs-upgrade -jOpenACS:yesterday -jOpenACS openacs > cvs.txt 2>&1
(CVS feedback here)
su - nsadmin
cd /tmp
tar xzv openacs-4-6.tgz
cd openacs-4.6
cvs import -m "upgrade to OpenACS 4.6" openacs OpenACS openacs-4-6
cd /tmp
mkdir openacs-upgrade
cvs checkout -d openacs-upgrade -jOpenACS:yesterday -jOpenACS openacs > cvs.txt 2>&1
The file /tmp/openacs-upgrade/cvs.txt contains the results of the upgrade. If you changed files that are part of the OpenACS tarball and those changes conflict with the 4.5-4.6 upgrade, you'll have to manually reconcile them. Use the emacs command M-x sort-lines and then, for each line that starts with a C, open that file and manually resolve the conflict by deleting the excess lines. When you're finished, or if there aren't any conflicts, save and exit.
Once you've fixed any conflicts, commit the new code to your local tree.
[nsadmin@localhost tmp]$ cd openacs-upgrade
[nsadmin@localhost openacs-upgrade]$ cvs commit -m "Upgraded to 4.6"
cd openacs-upgrade
cvs commit -m "Upgraded to 4.6"Update your working tree with the new files. The CVS flags ensure that new directories are created and pruned directories destroyed.
[nsadmin@localhost openacs-upgrade]$ cd /web/openacs-dev [nsadmin@localhost openacs-dev]$ cvs up -Pd (CVS feedback) [nsadmin@localhost openacs-dev]$ exit [root@localhost root]# cd /web/openacs-dev cvs up -Pd exit
Start the server
[root@localhost root]# svc -u /service/openacs-devUse 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
When prompted, restart the server:
[root@localhost root]# restart-aolserver openacs-devWait 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.0b4.
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
[root@localhost root]# restart-aolserver openacs-devBrowse to http://yourserver/openfts
Click Administration.
Click
Rollback. If anything goes wrong, roll back to the backup snapshot.