ucb_deployer 0.1.10 → 0.1.11

data/Manifest

@@ -1,7 +1,7 @@
 Manifest
 README.md
 Rakefile
-TODO.txt
+TODO.md
 bin/ucb_deploy
 lib/ucb_deployer.rb
 lib/ucb_deployer/confluence_deployer.rb

data/README.md

@@ -1,81 +1,164 @@
+UCB Deployer
+============
 
-= UCB Deployer
+UCB Deployer is gem to automate Confluence and JIRA deployments to Tomcat.
 
-UCB Deployer is gem to automate confluence and jira  deployments to Tomcat.
 
+Overview
+--------
 
-== Getting Started
+Deployments done with UCB Deployer will follow the following structure.
 
-=== Installation
-  gem install ucb_deployer
+The user performing the deployment will manually stop tomcat and then 
+excecute the ucb_deploy command:
 
+    ucb_deploy APP=<jira|confluence> VERSION=<version>
 
-=== Assumptions
+The *ucb_deploy* command will then do the following:
 
-==== Tomcat Setup
-We assume __Jira__ and __Confluence__ both have their own instance of tomcat (their own
-$CATALINA_BASE). For more information on this type of setup see:
+1. Display a user friendly maintenance page that should be picked up by Apache.
+2. Check out the application from SVN.
+3. Configure the application in preparation for the build.
+4. Build the application which results in a war file.
+5. Deploy the war file to tomcat.
 
-http://wikihub.berkeley.edu/x/RQAnAg
+The user doing the deployment will then have to manually start tomcat and 
+confirm success.  Once they have confirmed things are ok, they can then
+remove the maintenance file via the command:
 
-We also assume the following __config/__ file is setup for each app:
+    ucb_deploy remove_maintenance_file APP=<jira|confluence>
 
-$HOME/config/confluence/deploy.yml
-$HOME/config/jira/deploy.yml
+Woot!
 
-Where $HOME is the home directory of the user that will be doing the deployments:
-we are using a special user __app_relmgt__ for this purpose.
 
-==== JIRA: Move Jars into common/lib
-Make sure the following jars are in $CATALINA_BASE/lib
-* activation-1.0.2.jar
-* javamail-1.3.3.jar
-* postgresql-8.3-604.jdbc3.jar
+Installation
+------------
+
+    gem install ucb_deployer
+
+
+Assumptions
+-----------
+
+#### Tomcat Setup ####
+
+It is assumed that JIRA and Confluence each have their own unique Tomcat instance.
+For more information on this setup, see [Tomcat 6 Setup][1]
+[1]: http://wikihub.berkeley.edu/x/gABpAg "Tomcat 6 Setup"
+
+#### Application User Account Setup ####
+
+It is also assumed that a corresponding unix user has been created for both JIRA and 
+Confluence: this is referred to as the application user.  The Tomcat instance for
+JIRA/Confluence will run as this application user.
+
 
+#### Release Management User ####
 
+You should have some sort of *release management user* setup that can start/stop
+Tomcat for JIRA and Confluence (we use app_relmgt).  This user should have Read/Write 
+access to the Tomcat directories for JIRA and Confluence. Again, for more information 
+on this setup see: [Tomcat 6 Setup][1]
 
 
-=== Configuration
+General Configuration
+---------------------
 
-The deploy.yml files for __Jira__ and __Confluence__ both accept the following options:
+#### Layout/Directories ####
 
-* build_dir
-* deploy_dir
-* war_name
-* cas_service_url
-* cas_server_url
-* data_dir
-* svn_username            
-* svn_project_url
-* maintenance_file_dir
+The following directories and file need to be setup in the **app_relmgt** user's home 
+directory:
 
+    $HOME/config/
+            +
+            |-- jira/
+                   +
+                   |-- deploy.yml
+            |-- confluence/
+                   +
+                   |-- deploy.yml
 
-Assuming we had the following directories setup:
-  # where we deploy from
-  $HOME=/home/app_relmgt
+    $HOME/build/
+            +
+            |-- jira/
+                   +
+                   |-- deploy.yml
+            |-- confluence/
+                   +
+                   |-- deploy.yml
 
-  # where we run jira (confluence would have it's own dir: /var/lib/confluence)
-  $JIRA_HOME=/var/lib/jira
 
-  $HOME/build/jira/src
-  $HOME/build/jira/lib
+#### Configuration Options ####
 
-Our __deploy.yml__ file would look like so:
+* **build_dir**            : *directory where build will be performed*
+* **deploy_dir**           : *directory to deploy the war file to*
+* **war_name**             : *name to use for the war file*
+* **cas_server_url**       : *url of CAS Server*
+* **cas_service_url**      : *url to redirect to after CAS auth succeeds*
+* **data_dir**             : *directory to be used by confluecne or jira for storing local data*
+* **svn_username**         : *username to be used to connect to svn*       
+* **svn_project_url**      : *location of confluence/jira release in svn*
+* **maintenance_file_dir** : *location where maintenance file should be written to*
 
-  build_dir: /home/app_relmgt/build
-  deploy_dir: /var/lib/jira/tomcat5/webapps
-  war_name: ROOT
-  cas_server_url: http://cas-server.berkeley.edu
-  cas_service_url: https://wikihub.berkeley.edu
-  data_dir: /var/lib/jira/data
-  svn_username: app_relmgt
-  svn_project_url: svn.berkeley.edu/svn/ist-svn/berkeley/projects/ist/as/webapps/jira_archives/tags
-  maintenance_file_dir: /path/to/maintenance/dir
+##### Sample Configuration For JIRA #####
 
+Assuming we had the above directories setup in ($HOME=/home/app_relmgt), the
+deploy.yml file for jira would look like so:
 
-== Usage
-  ucb_deploy APP=jira VERSION=x.x.x
+    build_dir: /home/app_relmgt/build
+    deploy_dir: /home/app_jira/tomcat6/webapps
+    war_name: ROOT
+    cas_server_url: http://cas-server.berkeley.edu
+    cas_service_url: https://wikihub.berkeley.edu
+    data_dir: /home/app_jira/app_data
+    svn_username: app_relmgt
+    svn_project_url: svn.berkeley.edu/svn/ist-svn/berkeley/projects/ist/as/webapps/jira_archives/tags
+    maintenance_file_dir: /var/www/html/jira/
+    
 
-or
+Confluence Configuration
+------------------------
+
+#### Setup Container Jars ####
+Before deploying confluence, you need to make sure the following jar files exist in
+ **$CATALINA_BASE/lib** for Confluence's Tomcat instance:
+
+* postgresql-8.4-701.jdbc3.jar
+* javamail-1.3.2.jar
+* activation-1.0.2.jar
+
+
+JIRA Configuration
+------------------
+
+#### Setup Container Jars ####
+Before deploying JIRA, you need to make sure the following jar files exist in 
+**$CATALINA_BASE/lib** for JIRA's Tomcat instance:
+
+* activation-1.0.2.jar
+* xapool-1.3.1.jar
+* ots-jts_1.0.jar
+* mail-1.4.1.jar
+* postgresql-8.4-701.jdbc3.jar
+* jta-1.0.1.jar
+* jotm-jrmp_stubs-1.4.3.jar
+* jotm-iiop_stubs-1.4.3.jar
+* log4j-1.2.7.jar
+* objectweb-datasource-1.4.3.jar
+* commons-logging-1.0.4.jar
+* carol-properties.jar
+* carol-1.5.2.jar
+* jonas_timer-1.4.3.jar
+* jotm-1.4.3.jar
+
+
+Usage
+-----
+    # Either of these will deploy the appication
+    ucb_deploy APP=<confluence|jira> VERSION=x.x.x
+    ucb_deploy deploy APP=<confluence|jira> VERSION=x.x.x
+
+For more options:
+
+    ucb_deploy -T
 
-  deploy APP=confluence VERSION=x.x.x

data/Rakefile

@@ -4,13 +4,13 @@ require 'echoe'
 require 'spec/rake/spectask'
 
 
-Echoe.new('ucb_deployer', '0.1.10') do |p|
+Echoe.new('ucb_deployer', '0.1.11') do |p|
   p.description    = "Tool for deploying Confluence/JIRA war files to tomcat"
   p.url            = "http://ucbrb.rubyforge.org"
   p.author         = "Steven Hansen"
   p.email          = "runner@berkeley.edu"
   p.project        = "ucbrb"
-  p.rdoc_pattern   = "README.md", "lib/**/**"
+  p.rdoc_pattern   = "README.md", "lib/**/**", "TODO.md"
 end
  
 desc "Run RSpec tests"

data/TODO.md

@@ -0,0 +1,7 @@
+* Add "clean" task to remove previous build dirs, files, etc
+* Add "init" task to automatically create build/ and config/ directories
+* Don't needlessly download source from svn everytime.  If source for requested 
+  version has already been pulled down to the filesystem, reuse it.
+* For commands like display_maintenance_file and remove_maintenance_file, you should 
+  not need to pass int the VERSION option
+

data/ucb_deployer.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ucb_deployer}
-  s.version = "0.1.10"
+  s.version = "0.1.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Steven Hansen"]
@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   s.description = %q{Tool for deploying Confluence/JIRA war files to tomcat}
   s.email = %q{runner@berkeley.edu}
   s.executables = ["ucb_deploy"]
-  s.extra_rdoc_files = ["README.md", "lib/ucb_deployer.rb", "lib/ucb_deployer/confluence_deployer.rb", "lib/ucb_deployer/deployer.rb", "lib/ucb_deployer/jira_deployer.rb"]
-  s.files = ["Manifest", "README.md", "Rakefile", "TODO.txt", "bin/ucb_deploy", "lib/ucb_deployer.rb", "lib/ucb_deployer/confluence_deployer.rb", "lib/ucb_deployer/deployer.rb", "lib/ucb_deployer/jira_deployer.rb", "resources/confluence_cas_web.xml", "resources/jira_cas_web.xml", "resources/soulwing-casclient-0.5.3.jar", "spec/fixtures/confluence/bad_deploy.yml", "spec/fixtures/confluence/confluence-init.properties", "spec/fixtures/confluence/deploy.yml", "spec/fixtures/confluence/seraph-config.xml", "spec/fixtures/confluence/web.xml", "spec/fixtures/jira/bad_deploy.yml", "spec/fixtures/jira/deploy.yml", "spec/fixtures/jira/entityengine.xml", "spec/fixtures/jira/seraph-config.xml", "spec/fixtures/jira/web.xml", "spec/spec_helper.rb", "spec/ucb_deployer/confluence_deployer_spec.rb", "spec/ucb_deployer/jira_deployer_spec.rb", "spec/ucb_deployer/ucb_deployer_spec.rb", "ucb_deployer.gemspec"]
+  s.extra_rdoc_files = ["README.md", "TODO.md", "lib/ucb_deployer.rb", "lib/ucb_deployer/confluence_deployer.rb", "lib/ucb_deployer/deployer.rb", "lib/ucb_deployer/jira_deployer.rb"]
+  s.files = ["Manifest", "README.md", "Rakefile", "TODO.md", "bin/ucb_deploy", "lib/ucb_deployer.rb", "lib/ucb_deployer/confluence_deployer.rb", "lib/ucb_deployer/deployer.rb", "lib/ucb_deployer/jira_deployer.rb", "resources/confluence_cas_web.xml", "resources/jira_cas_web.xml", "resources/soulwing-casclient-0.5.3.jar", "spec/fixtures/confluence/bad_deploy.yml", "spec/fixtures/confluence/confluence-init.properties", "spec/fixtures/confluence/deploy.yml", "spec/fixtures/confluence/seraph-config.xml", "spec/fixtures/confluence/web.xml", "spec/fixtures/jira/bad_deploy.yml", "spec/fixtures/jira/deploy.yml", "spec/fixtures/jira/entityengine.xml", "spec/fixtures/jira/seraph-config.xml", "spec/fixtures/jira/web.xml", "spec/spec_helper.rb", "spec/ucb_deployer/confluence_deployer_spec.rb", "spec/ucb_deployer/jira_deployer_spec.rb", "spec/ucb_deployer/ucb_deployer_spec.rb", "ucb_deployer.gemspec"]
   s.homepage = %q{http://ucbrb.rubyforge.org}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ucb_deployer", "--main", "README.md"]
   s.require_paths = ["lib"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ucb_deployer
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 1
-  - 10
-  version: 0.1.10
+  - 11
+  version: 0.1.11
 platform: ruby
 authors: 
 - Steven Hansen
@@ -27,6 +27,7 @@ extensions: []
 
 extra_rdoc_files: 
 - README.md
+- TODO.md
 - lib/ucb_deployer.rb
 - lib/ucb_deployer/confluence_deployer.rb
 - lib/ucb_deployer/deployer.rb
@@ -35,7 +36,7 @@ files:
 - Manifest
 - README.md
 - Rakefile
-- TODO.txt
+- TODO.md
 - bin/ucb_deploy
 - lib/ucb_deployer.rb
 - lib/ucb_deployer/confluence_deployer.rb

data/TODO.txt

@@ -1,7 +0,0 @@
-* add "clean" task to remove previous build dirs, files, etc
-
-* Don't needlessly download source from svn everytime.  If source for requested version has
-already been pulled down to the filesystem, reuse it.
-
-* Confluence should have mail.jar and activation.jar removed from webapps/ROOT/WEB-INF/lib
-