Difference between revisions of "Software Life Cycle: 4. Updating The Production Servers"

From WormBaseWiki
Jump to navigationJump to search
Line 88: Line 88:
  
 
''Posting a blog entry on blog.wormbase.org will cross-feed to our social media outlets as well as add a news item to the front page.''
 
''Posting a blog entry on blog.wormbase.org will cross-feed to our social media outlets as well as add a news item to the front page.''
 +
 +
 +
= Appendices =
 +
 +
== A. Minimizing Javascript and CSS ==
 +
 +
On the development server, install UglifyJS
 +
<pre>
 +
 +
# clone the repository
 +
mkdir -p /usr/local/wormbase/services/uglifyJS
 +
cd /usr/local/wormbase/services/uglifyJS
 +
git clone git://github.com/mishoo/UglifyJS.git
 +
 +
# make the module available to Node
 +
mkdir -p ~/.node_libraries/
 +
cd ~/.node_libraries/
 +
ln -s /where/you/wanna/put/it/UglifyJS/uglify-js.js
 +
 +
# and if you want the CLI script too:
 +
mkdir -p ~/bin
 +
cd ~/bin
 +
ln -s /where/you/wanna/put/it/UglifyJS/bin/uglifyjs
 +
  # (then add ~/bin to your $PATH if it's not there already)
 +
</pre>
  
  
  
 
[[Category:Developer documentation]]
 
[[Category:Developer documentation]]

Revision as of 14:09, 24 August 2011

Overview

This document describes the fourth and final stage of the WormBase software release cycle, moving new databases and software into production. New releases of the web app and associated databases are staged on the development server.

The scripts that mediate production release are maintained in the git website-admin repository.

Steps

Tag the software

For each major WS release, create a corresponding tag on HEAD in the git repository.

wb-dev> cd /usr/local/wormbase/website/staging
wb-dev> git pull
wb-dev> git tag -a -m "WSXXX" WSXXX HEAD
wb-dev> git push --tags

Check disk space on local and remote nodes

Purge a specific release from production nodes. This need to be run every release but is useful to periodically clear out old builds.

Remove build WSXXX, including acedb, mysql, and support DBs

wb-dev> admin/update/production/purge_old_releases.sh WSXXX

Remove build WSXXX from localhost (ie the dev server), including acedb, mysql, and support DBs

wb-dev> admin/update/production/purge_old_releases.sh WSXXX local

Put the production site into maintenance mode

TODO

Push Acedb to AceDB nodes

wb-dev> website-admin/update/production/steps/push_acedb.pl --method by_directory --release WSXXX

Push MySQL databases to MySQL nodes

Originally intended to be run as a cron job, it's less error prone to push databases out when they are ready to go.

wb-dev> website-admin/update/production/steps/push_mysql_databases.pl WSXXX

Push support databases to all nodes

wb-dev> website-admin/update/production/steps/push_support_databases.pl WSXXX

Deploy the web app

wb-dev> website-admin/update/production/deploy_webapp.sh WSXXX

Every push to production is

tied to a version of the database
tied to a major version of the webapp
tied to a revision corresponding to the number of commits since the last tag
         Date            # of commits since WS221 tag
         |                |
   WS221-2010.12.24-v0.02r0
   |                 |
   Acedb version           Major software version

The deployment script runs the following steps.

  1. gets the current major version of the webapp from lib/WormBase/Web.pm
  2. gets the number of commits for the source in wb-dev:website/staging since the last tag
  3. creates a VERSION.txt in the staging directory
  4. rsyncs the staging directory to local and remote web cluster nodes using version scheme above
  5. creates a symlink on remote nodes: /usr/local/wormbase/website/production -> WS221-2010.12.24-v0.02r0
  6. creates a software release on the FTP site, and symlinks current.tgz to it
  7. copies the staged code to wb-dev:/usr/local/wormbase/website/production" for easy reference
  8. Minimizes javascript and CSS via UglifyJS

Adjust symlinks

We use symlinks to point to the most current versions of the website and databases in both production and on the FTP site. These need to be adjusted prior to going live.

wb-dev> website-admin/update/production/adjust_symlinks.pl WSXXX

Restart services

Starman and AceDB need to be restarted on remote nodes.

wb-dev> website-admin/update/production/steps/restart_services.pl WSXXX

Restore the production site into maintenance mode

TODO

Post a blog entry announcing the new release

Posting a blog entry on blog.wormbase.org will cross-feed to our social media outlets as well as add a news item to the front page.


Appendices

A. Minimizing Javascript and CSS

On the development server, install UglifyJS


# clone the repository
mkdir -p /usr/local/wormbase/services/uglifyJS
cd /usr/local/wormbase/services/uglifyJS
git clone git://github.com/mishoo/UglifyJS.git

# make the module available to Node
mkdir -p ~/.node_libraries/
cd ~/.node_libraries/
ln -s /where/you/wanna/put/it/UglifyJS/uglify-js.js

# and if you want the CLI script too:
mkdir -p ~/bin
cd ~/bin
ln -s /where/you/wanna/put/it/UglifyJS/bin/uglifyjs
  # (then add ~/bin to your $PATH if it's not there already)