/
How to Create and Process a Deploy

How to Create and Process a Deploy

This topic explains how to create and process deploys. This is done in the following order:

  • Engineer: Create a deploy.

  • Engineer: Send the correct files to the system administrator.

  • System administrator: Process the delivered files.

  • System administrator: Perform a rollback if necessary.

See also Check Configuration Files for information about migrating configuration files from one version to another.

In This Topic



Create the Deploy

Create a settings.xml for the Target Environment

A deploy is always created with a specific target environment in mind. For example, a deploy can specifically be created for a test environment. For each target environment you need a separate settings.xml. For a test environment, copy the settings.xml to settings-test.xml and then adjust the properties in the settings-test.xml file. The typical properties you should check to ensure they are correct are:

  • Pathnames

  • Hostnames

  • Database properties

  • Usernames/passwords



Build the Deploy using Maven

After the properties have been set in the target environment, execute the following in a Command prompt:

mvn -s settings-test.xml -P build-deploy clean package assembly:assembly

A new folder with the name target is created which will contain two folders and one ZIP file.



Back to top



What to Deliver to the System Administrator

After the deploy has been built, a ZIP file is present in the target folder. The default name of the ZIP file is webmanager-webmanager-1.0-SNAPSHOT.zip. Send the following files to the system administrator of the target environment:

  1. webmanager-backend-webapp-1.0-SNAPSHOT.war (present in the root of the ZIP file);

  2. webmanager-static-webapp-1.0-SNAPSHOT.war (present in the root of the ZIP file);

  3. Gather all plugins into one new ZIP file.

  4. All plugins present in the edition-bundles directory of the unzipped archive.



Back to top



Process the Deploy

After receiving the files from the developer, the system engineer has to perform the following steps in order to process those files:

  1. Stop the web server (Tomcat, JBoss or WebSphere).

  2. To support a rollback, back up the following folders and files:

    1. /vol/www/tomcat-mywebsite/deploy/webmanager-backend-webapp-1.0-SNAPSHOT.war

    2. /vol/www/mywebsite/web-docs/wm/

  3. Create a backup of your relational database,

  4. Remove the content of the following folders:

    1. /vol/www/mywebsite/work/edition-bundles/

    2. /vol/www/mywebsite/work/osgi/*

    3. /vol/www/<tomcat-installation-dir>/work/*

    4. /vol/www/<tomcat-installation-dir>/temp/*

  5. Remove the directory /vol/www/tomcat-mywebsite/deploy/web.

  6. Copy webmanager-backend-webapp-1.0-SNAPSHOT.war to /vol/www/tomcat-mywebsite/deploy/.

  7. Unzip the webmanager-static-webapp-1.0-SNAPSHOT.war to /vol/www/mywebsite/web-docs/ (overwrite all).

  8. Copy all files from the edition-bundles directory to /vol/www/mywebsite/work/edition-bundles/.

  9. If one was delivered, unzip the plugin ZIP file to /vol/www/mywebsite/work/deploy (overwrite all).

  10. Restart the web server.



Back to top



How to Roll Back a Deploy