You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 30 Next »

[N.B.: I'm in the middle of a rewrite and this is a work in progress.   --amb 3jan2008]

Contents:

  1. Prepration
  2. Code Build and Release
  3. Deploying Static HTML

PREPARATION 

ARE YOU DOING A RELEASE?
Before deploying anything, confirm that you won't interrupt anyone else's work:

  • For all releases, check in on jabber chat thalia-talk .
  • For QA releases, also check in with QA testers in thalia-QA .
  • For production releases,  email asst@mit.edu as well as thalia-ops@mit.edu (preferably with the same message, so both will see any replies) about the scheduled down time ahead of time so they will not be alarmed when the nagios service shows a Thalia failure.
  • Write the release notes! The release notes contain a list of what changed in this release: new features, bug fixes, underlying changes like an Alfresco upgrade, etc.  Release notes have three purposes: they give QA specific information about what to test, they remind you what changed in the release long after you've forgotten, and they're the raw material for the email that gets sent to users.  If you don't know what changed, it's probably a bad idea to do a release. Include the link to the knownissues page in the release notes.
  • Update the knownissues page at svn+ssh://svn.mit.edu/zest/thalia/website/Trunk/help/.  Remove resolved issues and add new issues. This page needs to be manually uploaded as part of the release process; see below about Deploying Static HTML.

BEFORE STARTING:

  1. Make sure all developers have checked in their code.
  2. For releases, make sure everyone has resolved their fixed bugs so the release notes are accurate.
  3. Make sure you have no uncommitted code hanging around in your local working copy, if that's what you're using for the build. ("svn status")

CODE BUILD AND RELEASE

Thalia code has two pieces: the IME back end, which is a Java .war file, and the .swf front end, which is written in OpenLazlo. The .swf front-end is built into the IME's .war file, although it's actually a distinct build and may be a separate .war file at some point in the future.

GENERAL DEPENDENCIES

To build either part of thalia, you need the following tools which you may already have (and which are already installed on isda-build1):

  • Java: we use the Java version 1.6 JDK; there are a wide variety of packagings if you don't already have it; ask the net about this one. Make sure your JAVA_HOME environment variable is set correctly. (On isda-build1, set JAVA_HOME=/usr/java/jdk1.6.0.)
  • Subversion: if "svn --version" results in "command not found", you need subversion. Again, packagings vary; your operating system may be able to get it for you, or download from http://subversion.tigris.org.
  • maven: if "mvn -version" results in "command not found", you need to download the latest version of maven (currently 2.0.7) from http://maven.apache.org/download.html and install it locally, making sure to add maven's bin directory to your path.
  • Repository access: if "svn ls svn+ssh://svn.mit.edu/zest/thalia" doesn't do something useful, you can't check out the code; you need to be in the zest-cvs moira group to access the repository.
  • For the UI build only: if "lzc --help" doesn't give you useful help information for the OpenLaszlo compiler, you need to install version 4.0.2 from http://www.openlaszlo.org; this is hairy enough that it's been split off into its own wiki page: OpenLaszlo.

BUILD PREPARATION

  1. Check out the Thalia code: 
    svn checkout svn+ssh://username@svn.mit.edu/zest/thalia
  2. For a release, create the release branch:
    svn cp ime/Trunk/thalia ime/Branches/thalia<version>-sprint<num>

FRONT END
BACK END

  1. For a release, create the release branch:
    svn cp ime/Trunk/thalia ime/Branches/thalia<version>-sprint<num>
  2. Make a clean build of the .war file:
    cd thalia/ime/Branches/thalia<ver>-sprint<num>
    mvn clean package -Denv=prod1
    This will create or update the target directory and add the file ROOT.war .  Please note that the Thalia maven build has multiple profiles:
    • The default profile is the development profile on thalia-dev.mit.edu.
    • If you want to choose the test profile, use -Denv=test1 or -Denv=test2 (when packaging, test1 and test2 are exactly the same. When deploying, test1 deploys to isda-thalia2 and test2 deploys to isda-thalia11).
    • If you want to choose the production profile, use -Denv=prod1 or -Denv=prod2 (when packaging, prod1 and prod2 are exactly the same. When deploying, prod1 deploys to isda-thalia5 and prod2 deploys to isda-thalia8).
    • Part of the profile definition is in ime\Trunk\thalia\pom.xml under the profiles section; it specifies which servers to deploy to in each environment. Part of the profile definition is in thalia\ime\Trunk\thalia\src\main\filters*.properties files; it specifies the alfresco server address/port and alfresco passwords for user and admin. To change the development environment, edit dev.properties. To change the test environment, edit test.properites. To change the prodution environment, edit prod.properties.
  1. If you're doing a release and the build completed without error, commit the branch. 
    svn commit
  2. Deploy the war:
    a.  Check that it's ok to deploy.  Start in the thalia-talk chat  .  If deploying to QA, check in with the QA contractor in thalia-qa . If deploying to production, you will already have emailed asst@mit.edu about the scheduled down time ahead of time so they will not be alarmed when the nagios service fails on Thalia. 

    6.  There are two ways to deploy: one through the web, and one via maven.  Do one of the following:

    DEPLOY WITH MAVEN 
    a. To specify tomcat authentication info in Maven, add the following line in settings.xml in $M2_HOME/conf/settings.xml  . Username and password are for the tomcat manager. Ask if you don't have that information. 
    Maven settings are in the maven directory in conf/settings.xml. deploymentserver is used for release to the development cluster. testserver* is used for release to the test cluster. prodserver* is used for release to the production cluster.

        <server>
          <id>deploymentserver</id>
          <username>username</username>
          <password>password</password>
        </server>
        <server>
          <id>testserver1</id>
          <username>username</username>
          <password>password</password>
        </server>
        <server>
           <id>testserver2</id>
           <username>username</username>
           <password>password</password>
        </server>
       <server>
          <id>prodserver1</id>
          <username>username</username>
          <password>password</password> 
       </server>
       <server>
          <id>prodserver2</id>
          <username>username</username>
          <password>password</password>
       </server>

    c. Deploy with Maven:

    mvn tomcat:undeploy
    mvn tomcat:deploy

    This should also work:

    mvn clean tomcat:deploy
    By default this will undeploy and deploy thalia on the development server.
    To deploy to QA:
     mvn tomcat:undeploy -Denv=test1
     mvn clean tomcat:deploy -Denv=test1
     mvn tomcat:undeploy -Denv=test2
     mvn clean tomcat:deploy -Denv=test2
    To deploy to production:
     mvn tomcat:undeploy -Denv=prod1
     mvn clean tomcat:deploy -Denv=prod1
     mvn tomcat:undeploy -Denv=prod2
     mvn clean tomcat:deploy -Denv=prod2

    DEPLOY BY WEB PAGE:

There are usually two front ends per environment. You must repeat these steps on each server. Visit the tomcat manager page for each front end server. See the Thalia environments list for hostnames.

a. Download the freshly built ROOT.war from isda-build1  to your local machine.

b. Open the Tomcat server manager for each front end in a web browser.  ( http://hostname/manager/html/upload&nbsp; )

c. Undeploy the root instance, /.   .

d. Further down the page, upload ROOT.war . 

7. For all deployment methods:  Do a smoke test to confirm Thalia came back up. Brian Childs suggests:

  • the page comes up in your browser
  • it recognizes you as logged in
  • you can create a library
  • you can do a bulk upload
  • you can create an album
  • you can create a slideshow 

DEPLOYING  HELP HTML PAGES

Html pages are kept in svn at svn+ssh://svn.mit.edu/zest/thalia/website/ . Html is divided into Branches and Trunk, like code, because the help changes with product versions.

To deploy static html pages,  navigate to the Branches subdirectory for the current Thalia version and sprint.

Static html is deployed from svn+ssh://svn.mit.edu/zest/thalia/website//help to /home/apache-tomcat-5.5.23/webapps/help  .    You may either copy the files with svn directly to the target machine, or make a fresh copy on your local machine and scp it over.

The entire help directory may be copied, as it is always the up to date Branched version, or only newly updated files if you have a list.

Don't deploy  the top-level files in svn+ssh://svn.mit.edu/zest/thalia/website/ . I believe most of them are out of date, and the directory is due for a cleanup after Thalia 1.0 sprint 4 . [jriley]

  • No labels