Author: channa Date: Fri Aug 8 05:49:42 2008 New Revision: 20614 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=20614
Log: Adding the migration guide draft. Added: trunk/mashup/java/xdocs/images/migration_result.png (contents, props changed) trunk/mashup/java/xdocs/migrationguide.html Added: trunk/mashup/java/xdocs/images/migration_result.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/migration_result.png?pathrev=20614 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/migrationguide.html URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/migrationguide.html?pathrev=20614 ============================================================================== --- (empty file) +++ trunk/mashup/java/xdocs/migrationguide.html Fri Aug 8 05:49:42 2008 @@ -0,0 +1,171 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <!-- + ~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> + <meta http-equiv="content-type" content=""> + <title>Data Services</title> + <link href="css/mashup-docs.css" rel="stylesheet" type="text/css" + media="all"> +</head> + +<body style="direction: ltr;"> + +<div id="main-content"> +<h1>Server Migration</h1> + +<p>This document describes how you can migrate from an older version of the +Mashup Server to a newer version. Steps for reverting to a previous version +have not been tested or documented.</p> + +<p>In all migrations, please make sure that you either backup the existing +mashup server installation or leave the installation's database and script +directories intact until you verify that the migration to the newer version +has been completed successfully.</p> + +<h1>Upgrading to a Point Release within the Same Version</h1> +Migrating from a Mashup Server 1.0 installation to a 1.0.1 or 1.0.2 or from a +1.5 to a 1.5.1 simply requires the copying of database and scripts folders +across to the new installation. The steps to be followed are: +<ol> + <li>Shut down your existing Mashup Server instance.</li> + <li>Backup your database and scripts directories, by copying them to a + separate location. Both directories can be found in the installation root + of your mashup server.</li> + <li>Extract the binary distribution of the new version of the mashup server + in a different location. Leave the old installation untouched, so that + you can revert to the previous version at any point if you wish to do + so.</li> + <li>Delete the contents of the 'database' and 'scripts' directories of the + new installation.</li> + <li>Copy the contents of the 'database' and 'scripts' directories of the + old installation into the now empty 'database' and 'scripts' directories + of the new installation.</li> + <li>Start the new server. You will not be requested to provision the new + installation as the previously created admin account will be active on + the new server. </li> +</ol> + +<h1>Upgrading from a 1.0.x installation to a 1.5.x Installation</h1> + +<p>Migrating a 1.0 installation of the Mashup Server to a 1.5 requires that +data be exported from the older version of the Mashup Server and imported +into the new version. The steps below describe how the migration tools can be +setup and used to perform the data migration.</p> + +<h2>Step 1 - Exporting Data from the 1.0 installation</h2> + +<h3>Getting the Migration Tool</h3> + +<p>User, Mashup and Activity information is extracted saved into the Mashup +Home directory by the 'MigrationTool' java class. The source code for this +class can be downloaded, included in the 1.0.x source and built into a +mashup-core java archive, or a wso2mashup-core-1.0.x.jar with the migration +tool included can be downloaded. In either case the jar file should be copied +into the MASHUP_HOME/lib directory. Along with this, the migrate.jsp page, +which invokes the migration tool, needs to be downloaded and saved in the +'/lib/tomcat/webapps/ROOT' directory.</p> + +<h3>Running the Migration Tool</h3> + +<p>Start up the server, once you have copied the jar file and JSP into the +relevant directories.</p> + +<p>Call the migration tool by accessing the [Mashup Server URL]/migrate.jsp +page. If you access the mashup server at https://localhost:7443/, you can +start the serialization by accessing https://localhost:7443/migrate.jsp on +your browser.</p> + +<p>When the migration completes, the followiing page will be displayed, +indicating the location of the exported data files.</p> + +<p><img alt="Migration Output" src="images/migration_result.png" width="900" +height="145"></p> + +<p>The migrated_metadata.xml contains serialized user information and +metadata for all mashups including tags, comments and ratings entered by all +users.</p> + +<p></p> + +<h2>Step 2 - Setting up the New Mashup Server</h2> + +<h3>Installation</h3> +Install version 1.5.x of the WSO2 Mashup Server in a separate location, +making sure the previous version of the Mashup Server is shut down but not +uninstalled. Do not start the new server yet. + +<h3>Setting up the Migration Initializer</h3> + +<p>The 'Migrationinitializer' java class re-creates the users registered in +the old instance of the Mashup Server in the new instance and also restores +the user profile and mashup metadata. The source code for this class can be +downloaded, included in the 1.5.x source and built into a mashup-core java +archive, or a wso2mashup-core-1.5.x.jar with the migration tool included can +be downloaded. In either case the jar file should be copied into the +MASHUP_HOME/lib directory. For the initializer to locate the old instance of +the Mashup Server's user database, the old_database_settings.xml file also +needs to be downloaded, copied into the MASHUP_HOME\conf directory and +updated with the location of the Old Mashup Server's WSAS database. Finally, +the import.jsp page, which invokes the migration initializer, needs to be +downloaded and saved in the '/lib/tomcat/webapps/ROOT' directory.</p> + +<h3>Metadata Migration</h3> + +<p>Copy across the user script directories including all contents, from the +MASHUP_HOME\scripts directory of the older server to the MASHUP_HOME\scripts +directory of the new server. Dd not copy across the system and samples user's +script directories as you will lose updated scripts shipped with the new +version of the server.</p> + +<p>Copy across the the migrated_metadata.xml file from the MASHUP_HOME +directory of the old Mashup Server to the MASHUP_HOME directory of the new +installation.</p> + +<p>Start the Mashup Server. The users will be re-created and the mashups will +be deployed.</p> + +<p>Call the import.jsp by accessing the [Mashup Server URL]/import.jsp page. +If you access the mashup server at https://localhost:7443/, you can start the +import process by accessing https://localhost:7443/migrate.jsp on your +browser.</p> + +<h3>Provisioning</h3> + +<p>The typical provisioning of the server, including the setup of the +administrator ID, can be completed now. Please refer to the installation +guide for details on provisioning.</p> + +<h3>Log Migration (Optional)</h3> + +<p>The activity logs exported from the old instance of the mashup server can +be restored if required. If this step is not completed, you will have an +upgraded Mashup Server with all mashups, user profiles and service metadata +intact, but with no activity history. To restore activity logs, shut down the +Mashup Server, connect to the Registry database of the mashup server, located +at MASHUP_HOME//database/WSO2REGISTRY_DB, using a database management tool* +that supports Embedded Derby, and execute the migrated_logs.sql file which +will initialize the logs table and insert the migrated log entries.</p> + +<p>*You can use the free ij tool that ships with the derby downloadable +distribution available at http://db.apache.org/derby/</p> +</div> + +<div id="main-content1"> +<p>© 2007-2008 WSO2 Inc.</p> +</div> +</body> +</html> _______________________________________________ Mashup-dev mailing list [email protected] http://mailman.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
