Sun Java logo     Previous      Contents      Index      Next     

Sun logo
Sun Java Communications Suite 5 Upgrade Guide 

Chapter 5
Upgrading Calendar Server

This chapter describes how to upgrade previous versions of Calendar Server to Sun Java System Calendar Server 6.3. The chapter provides an overview of upgrade considerations for the different upgrade paths. The chapter covers upgrades on both the Solaris and Linux operating systems:

Overview of Calendar Server Upgrades

This section describes the following general aspects of Calendar Server that impact upgrading to Communications Suite 5:

About Calendar Server 6.3

This version of Calendar Server represents a minor release with respect to Calendar Server 6.2 (Java Enterprise System 2005Q4). It includes several new features such as support for attachments and LDAP groups, but no major functionality changes.

Calendar Server, however, has an private interface change that affects upgrade: the format for data in the Calendar Server store has changed to a new format.

Calendar Server Upgrade Roadmap

Table 5-1 shows the supported Calendar Server upgrade paths to Communications Suite 5. The table applies to both Solaris and Linux operating systems.

Table 5-1  Upgrade Paths to Communications Suite 5: Sun Java System Calendar Server 6.3

Release

Calendar Server Version

General Approach

Java Enterprise System 2005Q4

Sun Java System Calendar Server 6.2 2005Q4

Direct upgrade:
Perform by applying patches.

Java Enterprise System 2005Q1

Sun Java System Calendar Server 6 2005Q1

Direct upgrade:
Perform by applying patches.

Java Enterprise System 2004Q2

Sun Java System Calendar Server 6 2004Q2

Direct upgrade:
Perform by applying patches.

Java Enterprise System 2003Q4

Sun ONE Calendar Server 6.0 (2003Q4)

Direct upgrade not certified:
But can be performed by applying patches.

Pre-dates Java Enterprise System releases

All previous versions

No direct upgrade.

Calendar Server Data

The following table shows the type of data that could be impacted by an upgrade of Calendar Server software.

Table 5-2  Calendar Server Data Usage

Type of Data

Location

Usage

Configuration data

/etc/cal-svr-base/cal/config/ics.conf

Configuration of Calendar Server

Dynamic application data

Calendar Server database:

/var/cal-svr-base/csdb

Store calendar entries on behalf of users.

Directory schema

Directory Server user/group directory

For user attributes needed to support end users

Calendar Server Upgrade Strategy

Your strategy for upgrading Calendar Server depends on the many considerations discussed in Chapter 1, "Planning for Upgrades": upgrade path, dependencies between Communications Suite components, selective upgrade versus upgrade all, multi-instance deployments, and so forth.

This section is to particularize that general discussion to Calendar Server by presenting issues that might influence your Calendar Server upgrade plan.

Compatibility Issues

Calendar Server 6.3 does not introduce any changes in public interfaces, and is therefore backwardly compatible with Calendar Server 6.2 (Java Enterprise System 2005Q4), however the format of data in the Calendar Server Store has changed in this release, impacting the upgrade procedure.

Calendar Server Dependencies

Calendar Server dependencies on other Communications Suite components can impact the procedure for upgrading and re-configuring Calendar Server software. Changes in Calendar Server interfaces or functions, for example, could require upgraded version of components upon which Calendar Server depends. The need to upgrade such components depends upon the specific upgrade path.

Calendar Server has dependencies on the following Communications Suite components:

Upgrading Calendar Server from Calendar Server 6.2 (Java Enterprise System 2005Q4)

This section includes information about upgrading Calendar Server from Calendar Server 6.2 (Java Enterprise System 2005Q4). The section covers the following topics:

Introduction

When upgrading to Calendar 6.3, consider the following aspects of the upgrade process:

Calendar Server 6.2 (Java Enterprise System 2005Q4) Upgrade

This section describes how to perform an upgrade of Calendar Server from Calendar Server 6.2 (Java Enterprise System 2005Q4) to Calendar Server 6.3 on both the Solaris and Linux platform. Where a topic depends on platform-specific procedures, the topic will indicate the operating system to which it applies. The section covers the following topics:

Pre-Upgrade Tasks

Before you upgrade Calendar Server you should perform the tasks described below.

Verify Current Version Information

You can verify the current version of Calendar Server using the following command:

Note: If the cscal command fails on the Solaris 10 platform, set the library path to null when running the command:

Upgrade Calendar Server Dependencies

It is generally recommended that all Communications Suite components on a computer system (and in a computing environment) be upgraded to Communications Suite 5. However, Calendar Server has a hard upgrade dependency only on Directory Preparation Tool. Upgrading of other Calendar Server 6.2 (Java Enterprise System 2005Q4) product components upon which Calendar Server depends is therefore optional.

However, if you choose to upgrade all Calendar Server dependencies, they should be upgraded in the following order, all before you upgrade Calendar Server. You can skip any that might already have been upgraded.

  1. Shared Components.  Instructions for upgrading Communications Suite shared components are provided in Chapter 2, "Upgrading Communications Suite Shared Components".
  2. Directory Server.  Instructions for upgrading Directory Server are provided in the Java Enterprise System Upgrade Guide.
  3. Access Manager (optional).  Instructions for upgrading Access Manager are provided in the Java Enterprise System Upgrade Guide.
  4. Directory Preparation Tool.  Directory Preparation Tool needs to have been run against Directory Server before configuring Calendar Server. If Directory Preparation Tool has not already been run against Directory Server, upgrade Directory Preparation Tool to 5 and use it to modify and extend the schema of Directory Server. See the Chapter 3, "Directory Preparation Tool" for procedures.
  5. Messaging Server (optional).  Instructions for upgrading Messaging Server are provided in Chapter 4, "Upgrading Messaging Server".
Back Up Calendar Server Data

The Calendar Server upgrade to 6.3 involves a change in Calendar Server data format requiring 2005Q4 data to be migrated to the 6.3 format. As a safety precaution, you should shut down Calendar Server and back up your Calendar Server store, located at:

/var/cal-svr-base/csdb

Obtain Required Configuration Information and Passwords

No special information about your currently installed version is needed. However you will have to log in as superuser to perform the upgrade.

Upgrading Calendar Server 6.2 (2005Q4 - Solaris)

This section discusses considerations that impact the upgrade procedure for Calendar Server followed by a description of the procedure itself.

Upgrade Considerations (Solaris)

The upgrade of Calendar Server software to Communications Suite 5 takes into account the following considerations:

Upgrade Procedure (Solaris)

The procedure documented below applies to Calendar Server on the computer where the upgrade is taking place.

  1. Obtain the required patches, based on Table 5-4.

    2. Patches can be downloaded to /tmp from: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access

  2. Log in as root or become superuser.

    3. su -

  3. Stop Calendar Server if it is running.

    4. cal-svr-base/cal/sbin/stop-cal

  4. If you have not already done so, upgrade shared component to Communications Suite 5.

    5. See Upgrade Calendar Server Dependencies.

  5. Apply the appropriate Calendar Server core and, if needed, localization patches in Table 5-4, in that order.

    6. patchadd patch_ID

  6. Confirm that the patch upgrades were successful:

    7. showrev -p | grep ics

    The output should return the versions of patch IDs applied in Step 5.

  7. Re-configure Calendar Server.

    8. cd cal-svr-base/sbin
    ./csconfigurator.sh -noconsole -nodisplay -novalidate

    The -noconsole -nodisplay -novalidate arguments pick up the existing Calendar Server 6.2 (Java Enterprise System 2005Q4) configuration values and perform the necessary re-configuration.

    If the Calendar Server 6.2 (Java Enterprise System 2005Q4) installation had been configured in non-hosted domain (legacy) mode, then the configurator gives the choice to either stay in that mode or switch to hosted domain mode, the default for Calendar Server 6.3. Switching to hosted domain mode is not reversible.

    The csconfigurator command is documented in the Calendar Server Administration Guide, http://docs.sun.com/doc/819-2433/6n4nlfjk2?a=view.

  8. Move Calendar Server data files to a temporary location.

    9. mkdir /var/cal-svr-base/old_csdb
    mv /var/cal-svr-base/csdb/* /var/cal-svr-base/old_csdb

    where old_csdb is a temporary location.

  9. Change permissions on the temporary location.

    10. chown -R icsuser:icsgroup /var/cal-svr-base/oldcsdb

  10. Migrate the Calendar Server 6.2 (Java Enterprise System 2005Q4) data using the csmigrate migration tool.

    11. cd cal-svr-base/cal/sbin
    ./csmigrate -l max /var/cal-svr-base/old_csddb /var/cal-svr-base/csdb

    The general syntax for csmigrate is as follows:

    csmigrate [-q] [-d] [-l min|max] [-b backup_dir] source_dbdir target_dbdir

    Command options and operands are documented in the following table.

    Table 5-5  csmigrate Command Options and Operands

    Option/Operand

    Description

    -q

    Specifies quiet mode, no print statements

    -d

    Specifies dry run mode, no new db written

    -l min|max

    Specifies log level. csmigrate creates the following log files:
    cal-svr-base/logs/csmigrate.log
    cal-svr-base/logs/csmigrateError.log

    -b backup_dir

    Specifies directory to which to back up the source database. The program works on te backed-up copy to prevent any damage to the source database. The default location is source_dbdir/backup.

    source_dbdir

    Directory where pre-migration database files are located

    target_dbdir

    Directory where post-migration files will be written

    If you choose an arbitrary target_dbdir rather than /var/cal-svr-base/csdb, then you have to change the value of the caldb.berkeleydb.homedir.path property in the Calendar Server configuration file to point to that location.

    Note: If the csmigrate command fails on the Solaris 10 platform, set the library path to null when running the command:

    LD_LIBRARY_PATH= ./csmigrate ...

  11. Restart the Calendar Server that was stopped in Step 3.

    12. cal-svr-base/cal/sbin/start-cal

Upgrading Calendar Server 6.2 (2005Q4 - Linux)

This section discusses considerations that impact the upgrade procedure for Calendar Server followed by a description of the procedure itself.

Upgrade Considerations (Linux)

The upgrade of Calendar Server software on the Linux platform takes into account the same considerations as on the Solaris platform (see Upgrade Considerations (Solaris)), except that the Linux upgrade patches differ from the Solaris patches.

The Calendar Server upgrade patches for Linux OS are shown in the following table:

Table 5-6  Patches1 to Upgrade Calendar Server on Linux 

Description

Patch ID and RPM names

Calendar Server core

121659-17

  • sun-calendar-core-6.3-11.9.i386.rpm
  • sun-calendar-api-6.3-11.9.i386.rpm

Calendar Server localization

117852-26

  • sun-calendar-core-<locale>-6.3-1.7.i386.rpm

1Patch revision numbers are the minimum required for upgrade to Communications Suite 5. If newer revisions become available, use the newer ones instead of those shown in the table.

Upgrade Procedure (Linux)

The procedure documented below applies to Calendar Server on the computer where the upgrade is taking place.

Caution

An upgrade from Calendar Server 6.2 (Java Enterprise System 2005Q4) Calendar Server 6.3 5 on Linux cannot be rolled back.

  1. Obtain the required patches using the patch numbers and RPM names from Table 5-6. Use this information to obtain the version numbers for the RPM.

    2. Patches can be downloaded to /tmp from: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access

  2. Log in as root or become superuser.

    3. su -

  3. Stop Calendar Server if it is running.

    4. cal-svr-base/sbin/stop-cal

  4. If you have not already done so, synchronize all shared component to Release 5.

    5. See Upgrade Calendar Server Dependencies.

  5. Apply the core and, if needed, localization RPMs for Calendar Server in Table 5-6, in that order.
    rpm -Fvh sun-calendar-core-6.2-10.7.i386.rpm
    rpm -Fvh sun-calendar-api-6.2-10.7.i386.rpm
    rpm -Fvh sun-calendar-core-l10n-6.2-10.3.i386.rpm
  6. Confirm that the patch upgrades were successful:

    7. rpm -qa | grep sun-calendar

    The new version numbers of the RPMs in Step 5 should be returned.

  7. Re-configure Calendar Server.

    8. cd cal-svr-base/sbin
    ./csconfigurator.sh -noconsole -nodisplay -novalidate

    The -noconsole -nodisplay -novalidate arguments pick up the existing Calendar Server 6.2 (Java Enterprise System 2005Q4) configuration values and perform the necessary reconfiguration.

    If the Calendar Server 6.2 (Java Enterprise System 2005Q4) Calendar Server installation had been configured in non-hosted domain (legacy) mode, then the configurator gives the choice to either stay in that mode or switch to hosted domain mode, the default for 6.3. Switching to hosted domain mode is not reversible.

    The csconfigurator command is documented in the Calendar Server Administration Guide, http://docs.sun.com/doc/819-2433/6n4nlfjk2?a=view.

  8. Move Calendar Server data files to a temporary location.

    9. mkdir /var/cal-svr-base/oldcsdb
    mv /var/cal-svr-base/csdb/* /var/cal-svr-base/oldcsdb

    where oldcsdb is a temporary location.

  9. Change permissions on the temporary location.

    10. chown -R icsuser:icsgroup //var/cal-svr-base/oldcsdb

  10. Migrate the Calendar Server 6.2 (Java Enterprise System 2005Q4) data using the csmigrate migration tool.

    11. cd cal-svr-base/sbin
    ./csmigrate -l max /var/cal-svr-base/old_csddb /var/cal-svr-base/csdb

    The general syntax for csmigrate is as follows:

    csmigrate [-q] [-d] [-l min|max] [-b backup_dir] source_dbdir target_dbdir

    Command options and operands are documented in the following table.

    Table 5-7  csmigrate Command Options and Operands

    Option/Operand

    Description

    -q

    Specifies quiet mode, no print statements

    -d

    Specifies dry run mode, no new db written

    -l min|max

    Specifies log level. csmigrate creates the following log files:
    cal-svr-base/logs/csmigrate.log
    cal-svr-base/logs/csmigrateError.log

    -b backup_dir

    Specifies directory to which to back up the source database. The program works on te backed-up copy to prevent any damage to the source database. The default location is source_dbdir/backup.

    source_dbdir

    Directory where pre-migration database files are located

    target_dbdir

    Directory where post-migration files will be written

    If you choose an arbitrary target_dbdir rather than /var/cal-svr-base/csdb, then you have to change the value of the caldb.berkeleydb.homedir.path property in the Calendar Server configuration file to point to that location.

  11. Restart the Calendar Server that was stopped in Step 3.

    12. cal-svr-base/sbin/start-cal

Verifying the Upgrade

You can verify the upgrade of Calendar Server by checking the version numbers of patches as described in Step 6 for Solaris platforms and Step 6 for Linux.

You can also use the following commands:

Solaris:
cal-svr-base/cal/sbin/cscal version

Linux:
cal-svr-base/sbin/cscal version

See Table 5-3 for version values.

Post-Upgrade Tasks

There are no post-upgrade tasks beyond the steps described in Upgrade Procedure (Solaris) and Upgrade Procedure (Linux).

Rolling Back the Upgrade (Solaris)

This section describes considerations that impact the upgrade rollback procedure for Calendar Server followed by the procedure itself.

Rollback Considerations (Solaris)

The procedure for rolling back the upgrade to 6.3 of Calendar Server is pretty much the reverse of the procedure for upgrading to 6.3.

Rollback Procedure (Solaris)
  1. Log in as root or become superuser.

    2. su -

  2. Stop Calendar Server.

    3. cal-svr-base/cal/sbin/stop-cal

  3. Remove the patches in Table 5-4.

    4. patchrm patch_ID

  4. Revert to the Calendar Server 6.2 (Java Enterprise System 2005Q4) database.

    5. Any new data added since the upgrade to 6.3 will be lost.

  5. Restart Calendar Server.

    6. cal-svr-base/cal/sbin/start-cal

Multiple Instance Upgrades

In some deployment architectures Calendar Server is deployed on multiple computer systems to provide for high availability. For example, you have the Calendar Server Store component running in a Sun Cluster environment to provide high availability.

For Calendar Server instances running in a cluster environment, those instances share the same configuration. You need to apply Calendar Server upgrade patches to each of the instances, and for a Calendar Server 6.2 (Java Enterprise System 2005Q4) to 6.3 upgrade there is no re-configuration required.

Upgrading Calendar Server from Calendar Server 6 (Java Enterprise System 2005Q1)

The procedure for upgrading Calendar Server 6 (Java Enterprise System 2005Q1) to 6.3 is the same as that for upgrading Calendar Server 6.2 (Java Enterprise System 2005Q4) to 6.3.

To upgrade Calendar Server 6 (Java Enterprise System 2005Q1) to 6.3, use the instructions in Upgrading Calendar Server from Calendar Server 6.2 (Java Enterprise System 2005Q4), except substitute Calendar Server 6 (Java Enterprise System 2005Q1) wherever 2005Q4 is referenced.

Upgrading from Calendar Server 6 (Java Enterprise System 2004Q2)

The procedure for upgrading Calendar Server 6 (Java Enterprise System 2004Q2) to 6.3 is very similar to that for upgrading Calendar Server 6.2 to 6.3, with the exception that the pre-upgrade tasks must include the synchronizing of all shared components (see Table 1-6) to 6.3 and upgrading all locally-resident product components upon which Calendar Server depends:

  1. Shared Components.  Instructions for updating Communications Suite shared components to 5 are provided in Chapter 2, "Upgrading Communications Suite Shared Components".
  2. Directory Server.  Directory Server rarely resides on the same computer as Messaging Server, however, instructions for upgrading Directory Server are provided in the Java Enterprise System Upgrade Guide.
  3. Access Manager (optional).  Instructions for upgrading Access Manager are provided in the Java Enterprise System Upgrade Guide.
  4. Directory Preparation Tool.   Directory Preparation Tool rarely resides on the same computer as Messaging Server, however, instructions for upgrading Directory Preparation Tool and running it against Directory Server are provided in the Chapter 3, "Directory Preparation Tool."

To upgrade Calendar Server 6 (Java Enterprise System 2004Q2 Calendar Server to 6.3, use the instructions in Upgrading Calendar Server from Calendar Server 6.2 (Java Enterprise System 2005Q4), except substitute 2004Q2 wherever Calendar Server 6.2 (Java Enterprise System 2005Q4) is referenced.

In addition, Calendar Server 6.2 (Java Enterprise System 2005Q4) to Calendar Server 6.3 upgrade requires the post-upgrade task of configuring Calendar Server hot backup, accomplished by adding hotbackup parameters to the Calendar Server ics.conf configuration file. The instructions for this post-upgrade re-configuration can be found at the following location: http://docs.sun.com/doc/819-2433/6n4nlfjnq?a=view



Previous      Contents      Index      Next     

Part No: 819-7561-10.   Copyright 2007 Sun Microsystems, Inc. All rights reserved.