| Prev | Chapter�9.�Maintenance | Next |
|---|
+
The purpose of backup is to enable recovery. Backup and recovery are always risky; here are some steps that minimize the chance recovery is necessary: @@ -34,106 +33,106 @@ OpenACS installations comprise files and database contents. If you follow the reference install and put all files, including configuration files, in - /web/service0/, + /web/service0/, and back up the database nightly to a file in - /web/service0/database-backup, + /web/service0/database-backup, then you can apply standard file-based backup strategies to - /web/service0 -
This section describes how to make a one-time backup of + /web/service0 +
This section describes how to make a one-time backup of the files and database. This is useful for rolling back to known-good versions of a service, such as at initial - installation and just before an upgrade.
PostGreSQL.�Create a backup file and verify that it was created and has a reasonable size (several megabytes).
[root@localhost root]# su - service0 -[service0@localhost service0]$ pg_dump -f /web/service0/database-backup/before_upgrade_to_4.6.dmp service0 -[service0@localhost service0]$ ls -al /web/service0/database-backup/before_upgrade_to_4.6.dmp + installation and just before an upgrade.
PostGreSQL.�Create a backup file and verify that it was created and has a reasonable size (several megabytes).
[root@localhost root]# su - service0 +[service0@localhost service0]$ pg_dump -f /web/service0/database-backup/before_upgrade_to_4.6.dmp service0 +[service0@localhost service0]$ ls -al /web/service0/database-backup/before_upgrade_to_4.6.dmp -rw-rw-r-x 1 service0 service0 4005995 Feb 21 18:28 /web/service0/database-backup/before_upgrade_to_4.6.dmp -[service0@localhost service0]$ exit +[service0@localhost service0]$ exit [root@localhost root]# -su - service0 -pg_dump -f /web/service0/database-backup/before_upgrade_to_4.6.dmp openacs-dev -ls -al /web/service0/database-backup/before_upgrade_to_4.6.dmp -exitFile tree with CVS.�If you are already using CVS, you probably don't +
su - service0 +pg_dump -f /web/service0/database-backup/before_upgrade_to_4.6.dmp openacs-dev +ls -al /web/service0/database-backup/before_upgrade_to_4.6.dmp +exitFile tree with CVS.�If you are already using CVS, you probably don't need to do anything to back up your data. Just make sure that your current work is checked into the system. You can then roll back based on date - note the current system time, down to the minute. For maximum safety, you can apply a tag to your current - files. Note that, if you did the CVS options in this document, the /web/service0/etc directory is not included in cvs and you may want to add it.
[root@localhost root]# su - service0 -[service0@localhost service0]$ cd /web/service0 -[service0@localhost service0]$ cvs commit -m "last-minute commits before upgrade to 4.6" + files. Note that, if you did the CVS options in this document, the /web/service0/etc directory is not included in cvs and you may want to add it.[root@localhost root]# su - service0 +[service0@localhost service0]$ cd /web/service0 +[service0@localhost service0]$ cvs commit -m "last-minute commits before upgrade to 4.6" cvs commit: Examining . cvs commit: Examining bin (many lines omitted) -[service0@localhost service0]$ cvs tag before_upgrade_to_4_6 +[service0@localhost service0]$ cvs tag before_upgrade_to_4_6 cvs server: Tagging bin T bin/acs-4-0-publish.sh T bin/ad-context-server.pl (many lines omitted) -[service0@localhost service0]$ exit +[service0@localhost service0]$ exit [root@localhost root]# -su - service0 -cd /web/service0 -cvs commit -m "last-minute commits before upgrade to 4.6" +su - service0 +cd /web/service0 +cvs commit -m "last-minute commits before upgrade to 4.6" cvs tag before_upgrade_to_4_6 -exitTo restore files from a cvs tag such as the one used above:
[root@localhost root]# su - service0 -[service0@localhost service0]$ cd /web/service0 -[service0@localhost service0]$ cvs up -r current -[service0@localhost service0]$ exit -su - service0 -cd /web/service0 -cvs up -r currentFile tree without CVS.�If you don't use cvs, you may want to back up the working directory. The simplest way is just to copy it.
[root@localhost root]# su - service0 -[service0@localhost service0]$ cp -r /web/service0 /web/service0-before-upgrade-to-4.6 -[service0@localhost service0]$ exit +exitTo restore files from a cvs tag such as the one used above:
[root@localhost root]# su - service0 +[service0@localhost service0]$ cd /web/service0 +[service0@localhost service0]$ cvs up -r current +[service0@localhost service0]$ exit +su - service0 +cd /web/service0 +cvs up -r currentFile tree without CVS.�If you don't use cvs, you may want to back up the working directory. The simplest way is just to copy it.
[root@localhost root]# su - service0 +[service0@localhost service0]$ cp -r /web/service0 /web/service0-before-upgrade-to-4.6 +[service0@localhost service0]$ exit [root@localhost root]# -su - service0 -cp -r /web/service0 /web/service0-before-upgrade-to-4.6 -exitTo restore the files, copy the directory back (do this while the service is stopped):
[root@localhost root]# su - service0 -[service0@localhost service0]$ mv /web/service0 /web/openacs-failed-upgrade -[service0@localhost service0]$ mv /web/service0-before-upgrade-to-4.6 /web/service0 -[service0@localhost service0]$ exit -[root@localhost root]#Database Rollback.�Restore the database to its backed-up state.
[root@localhost root]# su - service0 -[service0@localhost service0]$ svc -d /service/service0 -[service0@localhost service0]$ dropdb service0 +su - service0 +cp -r /web/service0 /web/service0-before-upgrade-to-4.6 +exitTo restore the files, copy the directory back (do this while the service is stopped):
[root@localhost root]# su - service0 +[service0@localhost service0]$ mv /web/service0 /web/openacs-failed-upgrade +[service0@localhost service0]$ mv /web/service0-before-upgrade-to-4.6 /web/service0 +[service0@localhost service0]$ exit +[root@localhost root]#Database Rollback.�Restore the database to its backed-up state.
[root@localhost root]# su - service0 +[service0@localhost service0]$ svc -d /service/service0 +[service0@localhost service0]$ dropdb service0 DROP DATABASE -[service0@localhost service0]$ createdb service0 +[service0@localhost service0]$ createdb service0 CREATE DATABASEPostGreSQL's dump command does not guarantee to back up all of the procedures and things in the right order for them to be reassembled. In practice, OpenACS users have found that rebuilding some of the common procedures before running the restore usually addresses this. -You will see a number of "already exists" errors when you run the -database restore; these can be ignored. This forum thread has more information.
[service0@localhost service0]$ psql -f /web/service0/packages/acs-kernel/sql/postgresql/postgresql.sql service0 -[service0@localhost service0]$ psql service0 < /backup/openacs/openacs_dev_before_upgrade_to_4.6.dmp -[service0@localhost service0]$ svc -u /service/service0 -[service0@localhost service0]$ exitAll commands for a database rollback: -su - service0 -svc -d /service/service0 -dropdb service0 -createdb service0 -psql -f /web/service0/packages/acs-kernel/sql/postgresql/postgresql.sql service0 -psql service0 < /web/service0/database-backup/before_upgrade_to_4.6.dmp -svc -u /service/service0 -exit
Here's a quick manual way to back up a reference install - +You will see a number of "already exists" errors when you run the +database restore; these can be ignored. This forum thread has more information.
[service0@localhost service0]$ psql -f /web/service0/packages/acs-kernel/sql/postgresql/postgresql.sql service0 +[service0@localhost service0]$ psql service0 < /backup/openacs/openacs_dev_before_upgrade_to_4.6.dmp +[service0@localhost service0]$ svc -u /service/service0 +[service0@localhost service0]$ exit
All commands for a database rollback:
+su - service0
+svc -d /service/service0
+dropdb service0
+createdb service0
+psql -f /web/service0/packages/acs-kernel/sql/postgresql/postgresql.sql service0
+psql service0 < /web/service0/database-backup/before_upgrade_to_4.6.dmp
+svc -u /service/service0
+exitHere's a quick manual way to back up a reference install - it should be replaced by an automated script within OpenACS. The command excludes the auto-generated - supervise directory, which is + supervise directory, which is unneccesary and has complicated permissions. Make sure that you are using the cron job to back up the database to a file in - /web/service0/database-backup - so that the tar command will include the database.
In the tar command,
c create a - new tar archive
p preserves permissions.
s preserves file sort order
j compresses the output with bz2.
The --exclude clauses skips some daemontools files that + /web/service0/database-backup + so that the tar command will include the database.
In the tar command,
c create a + new tar archive
p preserves permissions.
s preserves file sort order
j compresses the output with bz2.
The --exclude clauses skips some daemontools files that are owned by root and thus cannot be backed up by the service owner. These files are autogenerated and we don't - break anything by omitting them.
The --file clause + break anything by omitting them.
The --file clause specifies the name of the output file to be generated; we manually add the correct extensions.
The last clause, - /web/service0/, + /web/service0/, specifies the starting point for backup. Tar defaults to - recursive backup.
[root@yourserver root]# su - service0 -[service0@yourserver service0]$ tar -cpsj --exclude /web/service0/etc/daemontools/supervise --file /tmp/service0-backup.tar.bz2 /web/service0/ + recursive backup.
[root@yourserver root]# su - service0 +[service0@yourserver service0]$ tar -cpsj --exclude /web/service0/etc/daemontools/supervise --file /tmp/service0-backup.tar.bz2 /web/service0/ tar: Removing leading `/' from member names -[service0@yourserver service0]$
Backup can encompass all files in - /web/service0. For a development - server, putting the files in cvs, and backing up the database nightly, is sufficient. (It's important then to back up the cvs repository!)
Backing up the database consists of creating a file +[service0@yourserver service0]$
Backup can encompass all files in + /web/service0. For a development + server, putting the files in cvs, and backing up the database nightly, is sufficient. (It's important then to back up the cvs repository!)
Backing up the database consists of creating a file which is a picture of the database at a particular moment. Postgres can be backed up while running. A quick way to automate database backup is a cron job. This is not recommended for production and is not part of the Reference @@ -144,60 +143,60 @@ single nightly backup file which is then collected into a bigger backup file that includes the other parts of the service (web pages, content, code). To make a new file every - night, edit the crontab file for service0:
[service0@yourserver service0]$ export EDITOR=emacs;crontab -e
Add this line to the file. The numbers and stars at the beginning are cron columns that specify when the program should be run - in this case, whenever the minute is 0 and the hour is 1, i.e., 1:00 am every day.
0 1 * * * /usr/local/pgsql/bin/pg_dump -f /web/service0/database-backup/service0_$(date +%Y-%m-%d).dmp service0
If you plan to back up the whole /web/service0 directory, then it would be redundant to keep a history of database backups. In that case, set up the cron job to overwrite the previous backup each time:
0 1 * * * /usr/local/pgsql/bin/pg_dump -f /web/service0/database-backup/service0_nightly.dmp service0
On a test service, make sure that your backup-recovery process work. After backing up the database and file system, delete the service as detailed below and then recover it.
[root@yourserver root]# svc -d /service/service0 -[root@yourserver root]# mv /web/service0/ /web/service0.lost -[root@yourserver root]# rm /service/service0 + night, edit the crontab file for service0:[service0@yourserver service0]$ export EDITOR=emacs;crontab -eAdd this line to the file. The numbers and stars at the beginning are cron columns that specify when the program should be run - in this case, whenever the minute is 0 and the hour is 1, i.e., 1:00 am every day.
0 1 * * * /usr/local/pgsql/bin/pg_dump -f /web/service0/database-backup/service0_$(date +%Y-%m-%d).dmp service0If you plan to back up the whole /web/service0 directory, then it would be redundant to keep a history of database backups. In that case, set up the cron job to overwrite the previous backup each time:
0 1 * * * /usr/local/pgsql/bin/pg_dump -f /web/service0/database-backup/service0_nightly.dmp service0
On a test service, make sure that your backup-recovery process work. After backing up the database and file system, delete the service as detailed below and then recover it.
[root@yourserver root]# svc -d /service/service0 +[root@yourserver root]# mv /web/service0/ /web/service0.lost +[root@yourserver root]# rm /service/service0 rm: remove symbolic link `/service/service0'? y -[root@yourserver root]# ps -auxw | grep service0 +[root@yourserver root]# ps -auxw | grep service0 root 1496 0.0 0.0 1312 252 ? S 16:58 0:00 supervise service0 -[root@yourserver root]# kill 1496 -[root@yourserver root]# ps -auxw | grep service0 -[root@yourserver root]# su - postgres -[postgres@yourserver pgsql]$ dropdb service0 +[root@yourserver root]# kill 1496 +[root@yourserver root]# ps -auxw | grep service0 +[root@yourserver root]# su - postgres +[postgres@yourserver pgsql]$ dropdb service0 DROP DATABASE -[postgres@yourserver pgsql]$ dropuser service0 +[postgres@yourserver pgsql]$ dropuser service0 DROP USER -[postgres@yourserver pgsql]$ exit +[postgres@yourserver pgsql]$ exit logout -[root@yourserver root]#
Restore the operating system and required software. +[root@yourserver root]#
Restore the operating system and required software. You can do this with standard backup processes or by keeping copies of the install material (OS CDs, OpenACS - tarball and supporting software) and repeating the install guide.
Restore the OpenACS service. Assuming the user already exists, restore the database and files from backup and restore the daemontools link. (Because of a bug in Postgres backup-recovery, not all database objects are created in the correct order. To compensate, pre-creating some objects usually work.)
[root@yourserver root]# su - postgres
-[postgres@yourserver pgsql]$ createuser service0
-Shall the new user be allowed to create databases? (y/n) y
-Shall the new user be allowed to create more new users? (y/n) y
+ tarball and supporting software) and repeating the install guide.Restore the OpenACS service. Assuming the user already exists, restore the database and files from backup and restore the daemontools link. (Because of a bug in Postgres backup-recovery, not all database objects are created in the correct order. To compensate, pre-creating some objects usually work.)
[root@yourserver root]# su - postgres +[postgres@yourserver pgsql]$ createuser service0 +Shall the new user be allowed to create databases? (y/n) y +Shall the new user be allowed to create more new users? (y/n) y CREATE USER -[postgres@yourserver pgsql]$ exit +[postgres@yourserver pgsql]$ exit logout -[root@yourserver root]# su - service0 -[service0@yourserver service0]$ cd /web -[service0@yourserver web]$ tar xjf /tmp/service0-backup.tar.bz2 -[service0@yourserver web]$ chmod -R 700 service0 -[service0@yourserver web]$ createdb service0 +[root@yourserver root]# su - service0 +[service0@yourserver service0]$ cd /web +[service0@yourserver web]$ tar xjf /tmp/service0-backup.tar.bz2 +[service0@yourserver web]$ chmod -R 700 service0 +[service0@yourserver web]$ createdb service0 CREATE DATABASE -[service0@yourserver web]$ psql -f /web/service0/packages/acs-kernel/sql/postgresql/postgresql.sql service0 +[service0@yourserver web]$ psql -f /web/service0/packages/acs-kernel/sql/postgresql/postgresql.sql service0 (many lines omitted) -[service0@yourserver web]$ psql service0 < /web/service0/database-backup/database-backup.dmp +[service0@yourserver web]$ psql service0 < /web/service0/database-backup/database-backup.dmp (many lines omitted) -[service0@yourserver web]$ exit -[root@yourserver root]# ln -s /web/service0/etc/daemontools /service/service0 -[root@yourserver root]# sleep 10 -[root@yourserver root]# svgroup web /service/service0 -[root@yourserver root]#
Earlier strategies, included here because this section - hasn't been fully updated yet.
Earlier strategies, included here because this section + hasn't been fully updated yet.
(This has not yet been updated to fit with the Reference install. To do so, edit the backup script to save the backup - file in /web/service0/database-backup). + file in /web/service0/database-backup). While you're working with Oracle, you should configure it to do automatic exports. An export is a separate backup copy of the database. This copy includes all of the database's state at the time that the export was initiated. If your database is corrupted, you can restore from one of these backups. You should do this step as - root. + root.
Download the backup script. Save the file export-oracle.txt as - /tmp/export-oracle.txt + /tmp/export-oracle.txt
Login as root. The following commands will install the export script:
@@ -207,18 +206,18 @@ root:~# chmod 700 /usr/sbin/export-oracle
Setup the export directory; this is the directory where backups will be stored. We recommend the directory - /ora8/m02/oracle-exports.
+ /ora8/m02/oracle-exports.root:~# mkdir /ora8/m02/oracle-exports root:~# chown oracle.dba /ora8/m02/oracle-exports root:~# chmod 770 /ora8/m02/oracle-exports
Now edit - /usr/sbin/export-oracle and - change the SERVICE_NAME and - DATABASE_PASSWORD fields to + /usr/sbin/export-oracle and + change the SERVICE_NAME and + DATABASE_PASSWORD fields to their correct values. If you want to use a directory other than - /ora8/m02/oracle-exports, you + /ora8/m02/oracle-exports, you also need to change the - exportdir setting. + exportdir setting.
Test the export procedure by running the command:
@@ -261,46 +260,46 @@ Export terminated successfully without warnings.
If you don't have any warnings, proceed to automate the backups.
Automating backups is accomplished using the UNIX - crontab facility.
- While still root, run the + crontab facility.
+ While still root, run the following command. You can replace the - EDITOR="emacs -nw" + EDITOR="emacs -nw" portion with whatever editor your prefer, such as - EDITOR=vi. + EDITOR=vi.
-root:~# export EDITOR="emacs -nw" +root:~# export EDITOR="emacs -nw" root:~# crontab -e
Now add the following line on a line by itself
0 23 * * * /usr/sbin/export-oracle
Save the file, exit the editor. Verify that the addition succeeded by checking the output of the following command.
root:~# crontab -l | grep export-oracle 0 23 * * * /usr/sbin/export-oracle root:~# exit -; Logout
If you see the line, go ahead and log out.
This is an alternate method to the crontab backup. Dowload this script - to /tmp. At the top of the script + to /tmp. At the top of the script are several variables that you'll need to customize:
- bak - location where you want + bak - location where you want local backups to be saved
- servername - name of your server + servername - name of your server (and database instance)
- ftp_user - username on your ftp + ftp_user - username on your ftp account
- ftp_password - password on your + ftp_password - password on your ftp account
- ftp_dir - path on the remote + ftp_dir - path on the remote server where your backups will be uploaded
- ftp_server - your ftp server + ftp_server - your ftp server
Next, we'll save this file to our server's - tcl directory so that it will be + tcl directory so that it will be loaded on startup. It will automatically be run every night at midnight. Note that this script only backs up the database - not the OpenACS scripts and file content.