| Prev | Chapter 5. Upgrading | Next |
|---|
OpenACS is distributed as a collection of files, available as one big tarball, via CVS, and via automatic download from within the APM. Upgrades work by first changing the file system (via any of the previous methods), and then using the APM to scan the file system, find upgrade scripts, and execute them. This section describes how to upgrade the file system. Starting with OpenACS 5.0, this section can generally be skipped because the OpenACS APM can directly download new files from the openacs.org repository.
Many OpenACS site developers operate their own CVS repository to keep track of changes from the release OpenACS code. This part describes how to import the latest OpenACS version into your own repository. 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 for a site which is not in a CVS repository. Unpack the tarball into a new directory and copy its contents on top of your working directory.
[root root]# su - service0 [service0 aolserver]$ cd /var/lib/aolserver [service0 web]$ tar xzf /tmp/openacs-4-6.tgz [service0 web]$ cp -r openacs-4-6/* openacs-4 [service0 openacs-upgrade]$ exit [root root]# su - service0 cd /var/lib/aolserver tar xzf /tmp/openacs-4-6.tgz cp -r openacs-4-6/* openacs-4 exit
Upgrading files for a site in a private CVS repository
Step 1: Import new CVS code. There are two common ways to get new OpenACS code into your local CVS repository - via tarball or with a working CVS checkout of OpenACS. Both methods work well for starting your local repository; the second method is better for incremental additions or upgrades.
(a): via tarball. Download a current tarball and unpack the new files into a working directory.
[root root]# su - service0
[service0 aolserver]$ cd /tmp
[service0 tmp]$ tar xzf openacs-4-6.tgz
[service0 tmp]$ cd openacs-4.6(b): via cvs working checkout. Create a CVS checkout from OpenACS. The first time you do this, you will need to create the checkout directory. We use one dedicated directory for each branch of OpenACS - if you are using OpenACS 5.0,x, you only need an OpenACS 5.0 branch. The openacs-5-0-compat tag identifies the latest released version of OpenACS 5.0 (ie, 5.0.3 or 5.0.4) and the latest compatible version of each package, including .LRN. Each minor release of OpenACS since 5.0 has this tagging structure. (Ie., OpenACS 5.1.x has openacs-5-1-compat.)
[root root]# su - service0 [service0 aolserver]$ cd /var/lib/aolserver [service0 aolserver]$ cvs -d :pserver:anonymous@openacs.org:/cvsroot checkout -r openacs-5-0-compat openacs-4 [service0 aolserver]$ mv openacs-4 openacs-5-0
If this checkout already exists, you can simply update it instead of recreating it.
[root root]# su - service0 [service0 aolserver]$ cd /var/lib/aolserver/openacs-5-0 [service0 aolserver]$ cvs up -Pd
(c) A single package via cvs working checkout. You can add or upgrade a single package at a time, if you already have a cvs working directory.
[root root]# su - service0 [service0 aolserver]$ cd /var/lib/aolserver/openacs-5-0 [service0 openacs-5-0]$ cvs up -d myfirstpackage
In the next section, the import must be tailored to just this package.
Step 2: Merge New OpenACS code. Now that you have a local copy of the new OpenACS code, you need to import it into your local CVS repository and resolve any conflicts that occur.
Import the new files into your cvs repository; where they match existing files, they will become the new version of the file.
[service0 openacs-4.6]$ cvs -d /var/lib/cvs import -m "upgrade to OpenACS 4.6" openacs OpenACS openacs-4-6
If adding or upgrading a single package, run the cvs import from within the base directory of that package, and adjust the cvs command accordingly. In this example, we are adding the myfirstpackage package.
[root root]# su - service0 [service0 aolserver]$ cd /var/lib/aolserver/openacs-5-0/packagse/myfirstpackage [service0 myfirstpackage]$ cvs -d /var/lib/cvs/ import -m "importing package" service0/packages/myfirstpackage
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.
[service0 openacs-4.6]$ cd /var/lib/aolserver
[service0 tmp]$ mkdir service0-upgrade
[service0 tmp]$ cvs checkout -d openacs-upgrade -jOpenACS:yesterday -jOpenACS openacs > cvs.txt 2>&1
(CVS feedback here)
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.
[service0 tmp]$ cd openacs-upgrade [service0 openacs-upgrade]$ cvs commit -m "Upgraded to 4.6"
Step 3: Upgrade your local staging site. Update your working tree with the new files. The CVS flags ensure that new directories are created and pruned directories destroyed.
[service0 openacs-upgrade]$ cd /var/lib/aolserver/service0
[service0 service0]$ cvs up -Pd
(CVS feedback)
[service0 service0]$ exit
[root root]# Upgrading files for a site using the OpenACS.org CVS repository
[service0 ~]$ cd /var/lib/aolserver/service0
[service0 service0]$ cvs up -Pd
(CVS feedback)
[service0 service0]$If you are upgrading a production OpenACS site which is on a private CVS tree, this process lets you do the upgrade without risking extended downtime or an unusable site:
Declare a freeze on new cvs updates - ie, you cannot run cvs update on the production site
Make a manual backup of the production site in addition to the automated backups
Import the new code (for example, OpenACS 5.0.4, openacs-5-0-compat versions of ETP, blogger, and other applications) into a "vendor branch" of the service0 CVS tree, as described in "Upgrading a local CVS repository", step 1, above. As soon as we do this, any cvs update command on production might bring new code onto the production site, which would be bad.
Do step 2 above (merging conflicts in a service0-upgrade working tree).
Manually resolve any conflicts in the working upgrade tree
Use the upgrade script and a recent backup of the production database, to ake a new upgraded database called service0-upgrade. Now we have a new website called service0-upgrade.
Test the service0-upgrade site
If service0-upgrade is fully functional, do the real upgrade.
Take down the service0 site and put up a "down for maintenance" page.
Repeat the upgrade with the most recent database
Test the that the new site is functional. If so, change the upgraded site to respond to yourserver.net requests. If not, bring the original production site back up and return to the merge.