Merge pull request #110 from bflad/release/v4.0

linc01n · linc01n · commit ec7ac260dd6a · 2015-07-08T11:47:27.000+08:00
Add DIY backup and Move pid file
diff --git a/README.md b/README.md
@@ -58,27 +58,57 @@ url | URL for Stash install | String | auto-detected (see attributes/default.rb)
 user | user to run Stash | String | stash
 version | Stash version to install | String | 3.10.2
 
-### Stash Backup Client Attributes
+### Stash Backup Attributes (Shared)
 
-These attributes are under the `node['stash']['backup_client']` namespace. Some of these attributes are overridden by `stash/stash` encrypted data bag (Hosted Chef) or data bag (Chef Solo), if it exists.
+These attributes are under the `node['stash']['backup']` namespace. Some of these attributes are overridden by `stash/stash` encrypted data bag (Hosted Chef) or data bag (Chef Solo), if it exists.
 
 Attribute | Description | Type | Default
 ----------|-------------|------|--------
 backup_path | Path for backups | String | /tmp
 baseurl | Stash base URL | String | `https://#{node['fqdn']}/`
-checksum | SHA256 checksum for Stash Backup Client install | String | auto-detected (see attributes/default.rb)
-install_path | location to install Stash Backup Client | String | /opt/atlassian-stash-backup-client
 password | Stash administrative user password | String | changeit
-url_base | URL base for Stash Backup Client install | String | http://downloads.atlassian.com/software/stash/downloads/stash-backup-distribution
+strategy | [Stash backup strategy](https://confluence.atlassian.com/display/STASH/Data+recovery+and+backups#Datarecoveryandbackups-TwowaystobackupStash): 'backup_client' or 'backup_diy' | String | backup_client
 user | Stash administrative user | String | admin
+
+### Stash Backup Client Attributes
+Documentation: [Using the Stash Backup Client](https://confluence.atlassian.com/display/STASH/Using+the+Stash+Backup+Client)
+
+These attributes are under the `node['stash']['backup_client']` namespace. Some of these attributes are overridden by `stash/stash` encrypted data bag (Hosted Chef) or data bag (Chef Solo), if it exists.
+
+Attribute | Description | Type | Default
+----------|-------------|------|--------
+checksum | SHA256 checksum for Stash Backup Client install | String | auto-detected (see attributes/default.rb)
+install_path | location to install Stash Backup Client | String | /opt/atlassian/stash-backup-client
+url_base | URL base for Stash Backup Client install | String | http://downloads.atlassian.com/software/stash/downloads/stash-backup-distribution
 version | Stash Backup Client version to install | String | 1.9.1
 
-### Stash Backup Client Cron Attributes
+### Stash DIY Backup Attributes
+Documentation: [Using Stash DIY Backup](https://confluence.atlassian.com/display/STASH/Using+Stash+DIY+Backup)
+
+These attributes are under the `node['stash']['backup_diy']` namespace. Some of these attributes are overridden by `stash/stash` encrypted data bag (Hosted Chef) or data bag (Chef Solo), if it exists.
 
-These attributes are under the `node['stash']['backup_client']['cron']` namespace. All of these attributes are overridden by `stash/stash` encrypted data bag (Hosted Chef) or data bag (Chef Solo), if it exists.
+Attribute | Description | Type | Default
+----------|-------------|------|--------
+backup_archive_type | The way how to backup the stash home | String | tar
+backup_home_type | The way how to backup the stash home | String | rsync
+exclude_repos | List of repo IDs which should be excluded from the backup | List | []
+gpg_recipient | GPG recipient name (only if `['backup_archive_type]'` is `'tar-gpg'`) | String | ""
+install_path | location to place Stash DIY Backup scripts | String | /opt/atlassian/stash-diy-backup
+hipchat_room | HipChat room where notifications should be sent | String | ""
+hipchat_token | Authorization token for the HipChat server | String | ""
+hipchat_url | URL to the HipChat server for sending notifications | String | 'https://api.hipchat.com'
+repo_url | Git repository URL where Stash DIY Backup scripts are stored | String | https://bitbucket.org/atlassianlabs/atlassian-stash-diy-backup.git
+revision | Git revision (or a branch, or a tag) wich should be checked out | String | master
+temp_path | A temporary path where backup essentials should be placed before packing to the archive | String | /tmp/stash-backup-temp
+verbose | Should the script output be verbose or not | Boolean | true
+
+### Stash Backup Cron Attributes
+
+These attributes are under the `node['stash']['backup']['cron']` namespace. All of these attributes are overridden by `stash/stash` encrypted data bag (Hosted Chef) or data bag (Chef Solo), if it exists.
 
 Attribute | Description | Type | Default
 ----------|-------------|------|--------
+enable | Configure cron job to backup Stash periodically | Boolean | false
 day | Day of month | String | *
 hour | Hour of day | String | 0
 minute | Minute of hour | String | 0
diff --git a/attributes/default.rb b/attributes/default.rb
@@ -135,8 +135,20 @@
   default['stash']['apache2']['ssl']['key_file']         = '/etc/ssl/private/ssl-cert-snakeoil.key'
 end
 
-default['stash']['backup_client']['backup_path']  = '/tmp'
-default['stash']['backup_client']['baseurl']      = "https://#{node['fqdn']}/"
+default['stash']['backup']['strategy']  = 'backup_client'
+
+default['stash']['backup']['backup_path']  = '/tmp'
+default['stash']['backup']['baseurl']      = "https://#{node['fqdn']}/"
+default['stash']['backup']['password']     = 'changeit'
+default['stash']['backup']['user']         = 'admin'
+
+default['stash']['backup']['cron']['enable'] = false
+default['stash']['backup']['cron']['day'] = '*'
+default['stash']['backup']['cron']['hour'] = '0'
+default['stash']['backup']['cron']['minute'] = '0'
+default['stash']['backup']['cron']['month'] = '*'
+default['stash']['backup']['cron']['weekday'] = '*'
+
 default['stash']['backup_client']['install_path'] = node['stash']['install_path']
 default['stash']['backup_client']['password']     = 'changeit'
 default['stash']['backup_client']['user']         = 'admin'
@@ -177,11 +189,20 @@
 when '1.9.1' then '3cdad3393611d2c8d151c7d265ebd04764cbaba4a4d745a8b534dd9b8cf77d7b'
 end
 
-default['stash']['backup_client']['cron']['day'] = '*'
-default['stash']['backup_client']['cron']['hour'] = '0'
-default['stash']['backup_client']['cron']['minute'] = '0'
-default['stash']['backup_client']['cron']['month'] = '*'
-default['stash']['backup_client']['cron']['weekday'] = '*'
+default['stash']['backup_diy']['install_path'] = "#{node['stash']['install_path']}/stash-diy-backup"
+default['stash']['backup_diy']['repo_url']  = 'https://bitbucket.org/atlassianlabs/atlassian-stash-diy-backup.git'
+default['stash']['backup_diy']['revision'] = 'master'
+
+default['stash']['backup_diy']['backup_home_type'] = 'rsync'
+default['stash']['backup_diy']['backup_archive_type'] = 'tar'
+default['stash']['backup_diy']['exclude_repos'] = []
+default['stash']['backup_diy']['gpg_recipient'] = ''
+default['stash']['backup_diy']['temp_path'] = '/tmp/stash-backup-temp'
+default['stash']['backup_diy']['verbose'] = true
+
+default['stash']['backup_diy']['hipchat_url'] = 'https://api.hipchat.com'
+default['stash']['backup_diy']['hipchat_room'] = ''
+default['stash']['backup_diy']['hipchat_token'] = ''
 
 default['stash']['database']['type']     = 'mysql'
 default['stash']['database']['version']  = '5.6'
diff --git a/libraries/stash.rb b/libraries/stash.rb
@@ -44,6 +44,22 @@ def self.default_database_port(type)
           nil
         end
       end
+
+      def self.check_for_old_attributes!(node)
+        backup_attrs = %w(backup_path baseurl password user cron)
+        backup_attrs.each do |attr|
+          unless node['stash']['backup_client'][attr].nil?
+            node.default['stash']['backup_client'][attr] = node['stash']['backup'][attr]
+            Chef::Log.warn "node['stash']['backup_client']['#{attr}'] has been changed to node['stash']['backup']['#{attr}']"
+          end
+        end
+        Chef::Log.warn <<-EOH
+This renaming introduces the common approach for both of backup strategies:
+'backup_client' and 'backup_diy'. Attributes metioned above will be gracefully
+converted for you, but this warning and conversion will be removed in the next
+major release of the 'stash' cookbook.
+EOH
+      end
     end
   end
 end
diff --git a/metadata.rb b/metadata.rb
@@ -32,3 +32,4 @@
 depends 'mysql_connector'
 depends 'perl'
 depends 'postgresql'
+depends 'yum-epel'
diff --git a/recipes/backup_client.rb b/recipes/backup_client.rb
@@ -1,3 +1,4 @@
+Stash.check_for_old_attributes!(node)
 
 settings = Stash.settings(node)
 
@@ -17,10 +18,28 @@
 template "#{node['stash']['home_path']}/backup-config.properties" do
   source 'backup-config.properties.erb'
   owner node['stash']['user']
-  mode '0644'
-  variables :backup_client => settings['backup_client']
+  mode '0600'
+  variables :backup => settings['backup']
 end
 
 link "#{node['stash']['backup_client']['install_path']}/stash-backup-client/backup-config.properties" do
   to "#{node['stash']['home_path']}/backup-config.properties"
 end
+
+directory node['stash']['backup']['backup_path'] do
+  owner node['stash']['user']
+  mode '0750'
+  action :create
+  not_if { ::Dir.exist?(node['stash']['backup']['backup_path']) }
+end
+
+cron_d 'atlassian-stash-backup-client' do
+  hour settings['backup']['cron']['hour']
+  minute settings['backup']['cron']['minute']
+  day settings['backup']['cron']['day']
+  month settings['backup']['cron']['month']
+  weekday settings['backup']['cron']['weekday']
+  command "java -jar #{node['stash']['backup_client']['install_path']}/stash-backup-client/stash-backup-client.jar"
+  user node['stash']['user']
+  action(settings['backup']['cron']['enable'] ? :create : :delete)
+end
diff --git a/recipes/backup_client_cron.rb b/recipes/backup_client_cron.rb
@@ -1,12 +1,21 @@
+Stash.check_for_old_attributes!(node)
+
+Chef::Log.warn <<-EOH
+Recipe 'stash::backup_client_cron' is deprecated. Please, set attrite
+`node['stash']['backup']['crone']['enable'] = true` to configure crond to run
+Stash backup periodically. This recipe will be removed in the next major release
+of the 'stash' cookbook.
+EOH
 
 settings = Stash.settings(node)
 
 cron_d 'atlassian-stash-backup-client' do
-  hour settings['backup_client']['cron']['hour']
-  minute settings['backup_client']['cron']['minute']
-  day settings['backup_client']['cron']['day']
-  month settings['backup_client']['cron']['month']
-  weekday settings['backup_client']['cron']['weekday']
+  hour settings['backup']['cron']['hour']
+  minute settings['backup']['cron']['minute']
+  day settings['backup']['cron']['day']
+  month settings['backup']['cron']['month']
+  weekday settings['backup']['cron']['weekday']
   command "java -jar #{node['stash']['backup_client']['install_path']}/stash-backup-client/stash-backup-client.jar"
   user node['stash']['user']
+  action(settings['backup']['cron']['enable'] ? :create : :delete)
 end
diff --git a/recipes/backup_diy.rb b/recipes/backup_diy.rb
@@ -0,0 +1,52 @@
+Stash.check_for_old_attributes!(node)
+
+settings = Stash.settings(node)
+
+include_recipe 'yum-epel' if node['platform_family'] == 'rhel'
+
+package 'jq'
+package 'perl-Time-Piece' if node['platform_family'] == 'rhel'
+package 'rsync'
+
+directory node['stash']['backup_diy']['install_path'] do
+  owner node['stash']['user']
+  mode 00755
+  action :create
+  recursive true
+end
+
+git 'stash-diy-backup' do
+  repository node['stash']['backup_diy']['repo_url']
+  revision node['stash']['backup_diy']['revision']
+  destination node['stash']['backup_diy']['install_path']
+  user node['stash']['user']
+end
+
+template "#{node['stash']['backup_diy']['install_path']}/stash.diy-backup.vars.sh" do
+  source 'backup-diy-vars.sh.erb'
+  owner node['stash']['user']
+  mode '0600'
+  variables(
+    :backup => settings['backup'],
+    :backup_diy => settings['backup_diy'],
+    :database => settings['database']
+  )
+end
+
+directory node['stash']['backup']['backup_path'] do
+  owner node['stash']['user']
+  mode '0750'
+  action :create
+  not_if { ::Dir.exist?(node['stash']['backup']['backup_path']) }
+end
+
+cron_d 'atlassian-stash-diy-backup' do
+  hour settings['backup']['cron']['hour']
+  minute settings['backup']['cron']['minute']
+  day settings['backup']['cron']['day']
+  month settings['backup']['cron']['month']
+  weekday settings['backup']['cron']['weekday']
+  command "#{node['stash']['backup_diy']['install_path']}/stash.diy-backup.sh"
+  user node['stash']['user']
+  action(settings['backup']['cron']['enable'] ? :create : :delete)
+end
diff --git a/recipes/default.rb b/recipes/default.rb
@@ -15,4 +15,10 @@
 include_recipe 'stash::tomcat_configuration'
 include_recipe 'stash::apache2'
 include_recipe "stash::service_#{node['stash']['service_type']}"
-include_recipe 'stash::backup_client' if node['stash']['backup_client']['version']
+
+case node['stash']['backup']['strategy']
+when 'backup_client'
+  include_recipe 'stash::backup_client'
+when 'backup_diy'
+  include_recipe 'stash::backup_diy'
+end
diff --git a/recipes/tomcat_configuration.rb b/recipes/tomcat_configuration.rb
@@ -45,3 +45,10 @@
   mode '0644'
   notifies :restart, 'service[stash]', :delayed
 end
+
+directory '/var/run/stash' do
+  owner 'stash'
+  group 'stash'
+  mode '0755'
+  action :create
+end
diff --git a/templates/default/3.8+/setenv.sh.erb b/templates/default/3.8+/setenv.sh.erb
@@ -288,9 +288,9 @@ fi
 # set the location of the pid file
 if [ -z "$CATALINA_PID" ] ; then
     if [ -n "$CATALINA_BASE" ] ; then
-        CATALINA_PID="$CATALINA_BASE"/work/catalina.pid
+        CATALINA_PID=/var/run/stash/catalina.pid
     elif [ -n "$CATALINA_HOME" ] ; then
-        CATALINA_PID="$CATALINA_HOME"/work/catalina.pid
+        CATALINA_PID=/var/run/stash/catalina.pid
     fi
 fi
 export CATALINA_PID
diff --git a/templates/default/backup-config.properties.erb b/templates/default/backup-config.properties.erb
@@ -4,17 +4,17 @@
 # Defines the username of the Stash user with administrative privileges you wish to perform the backup.
 # If omitted here it will be taken from the Java system property of the same name if supplied to the backup client on
 # the command line. As a required value, backup will fail if it is not supplied through one of these mechanisms.
-stash.user=<%= @backup_client['user'] %>
+stash.user=<%= @backup['user'] %>
 
 # Defines the password of the Stash user with administrative privileges you wish to perform the backup.
 # If omitted here it will be taken from the Java system property of the same name if supplied on the command line
 # to the backup client. As a required value, backup will fail if it is not supplied through one of these mechanisms.
-stash.password=<%= @backup_client['password'] %>
+stash.password=<%= @backup['password'] %>
 
 # Defines base URL of the Stash instance you wish to back up. E.g. http://localhost:7990/stash or http://stashserver/
 # If omitted here it will be taken from the Java system property of the same name if supplied on the command line
 # to the backup client. As a required value, backup will fail if it is not supplied through one of these mechanisms.
-stash.baseUrl=<%= @backup_client['baseurl'] %>
+stash.baseUrl=<%= @backup['baseurl'] %>
 
 # Defines location of the home directory of the Stash instance you wish to back up.
 # If omitted here it will be taken from the STASH_HOME environment variable or the Java system property of the same name
@@ -24,4 +24,4 @@ stash.home=<%= node['stash']['home_path'] %>
 
 # Defines where the backup client will store its own files, such as backup archives.
 # If not specified, these files are stored beneath the working directory for the backup client.
-backup.home=<%= @backup_client['backup_path'] %>
+backup.home=<%= @backup['backup_path'] %>
diff --git a/templates/default/backup-diy-vars.sh.erb b/templates/default/backup-diy-vars.sh.erb
@@ -0,0 +1,75 @@
+#!/bin/bash
+
+#
+#  Dynamically generated by Chef on <%= node["fqdn"] %>
+#  Local modifications will be overwritten by Chef.
+#
+
+# Which database backup script to use (ex: mssql, postgresql, mysql)
+BACKUP_DATABASE_TYPE=<%= @database['type'] %>
+
+# Which filesystem backup script to use (ex: rsync)
+BACKUP_HOME_TYPE=<%= @backup_diy['backup_home_type'] %>
+
+# Which archive backup script to use (ex: tar, tar-gpg)
+BACKUP_ARCHIVE_TYPE=<%= @backup_diy['backup_archive_type'] %>
+
+# Used by the scripts for verbose logging. If not true only errors will be shown.
+STASH_VERBOSE_BACKUP=<%= @backup_diy['verbose'] ? 'TRUE' : 'FALSE' %>
+
+# The base url used to access this stash instance
+STASH_URL=<%= @backup['baseurl'] %>
+
+# The username and password for the user used to make backups (and have this permission)
+STASH_BACKUP_USER=<%= @backup['user'] %>
+STASH_BACKUP_PASS=<%= @backup['password'] %>
+
+# The name of the database used by this instance.
+STASH_DB=<%= @database['name'] %>
+# The path to stash home folder (with trailing /)
+STASH_HOME=<%= File.join(node['stash']['home_path'], "/") %>
+
+# OS level user and group information (typically: 'stash' for both)
+STASH_UID=<%= node['stash']['user'] %>
+STASH_GID=<%= node['stash']['user'] %>
+
+# The path to working folder for the backup
+STASH_BACKUP_ROOT=<%= @backup_diy['temp_path'] %>
+<% if @database['type'] == 'postgresql' %>
+STASH_BACKUP_DB=${STASH_BACKUP_ROOT}/stash-db/
+<% else %>
+STASH_BACKUP_DB=${STASH_BACKUP_ROOT}/stash-db.sql
+<% end %>
+STASH_BACKUP_HOME=${STASH_BACKUP_ROOT}/stash-home/
+
+# The path to where the backup archives are stored
+STASH_BACKUP_ARCHIVE_ROOT=<%= @backup['backup_path'] %>
+
+# List of repo IDs which should not be excluded from backup
+# It should be space separated: (2 5 88)
+STASH_BACKUP_EXCLUDE_REPOS=(<%= @backup_diy['exclude_repos'].join(" ") %>)
+
+<% case @database['type'] %>
+<% when "postgresql" %>
+# PostgreSQL options
+POSTGRES_HOST=<%= @database['host'] %>
+POSTGRES_USERNAME=postgres
+POSTGRES_PASSWORD=<%= node['postgresql']['password']['postgres'] %>
+POSTGRES_PORT=<%= @database['port'] %>
+<% when "mysql" %>
+# MySQL options
+MYSQL_HOST=<%= @database['host'] %>
+MYSQL_USERNAME=<%= @database['user'] %>
+MYSQL_PASSWORD=<%= @database['password'] %>
+MYSQL_BACKUP_OPTIONS=<%= @backup_diy['mysql_options'] || '' %>
+<% end %>
+
+# HipChat options
+HIPCHAT_URL=<%= @backup_diy['hipchat_url'] %>
+HIPCHAT_ROOM=<%= @backup_diy['hipchat_room'] %>
+HIPCHAT_TOKEN=<%= @backup_diy['hipchat_token'] %>
+
+<% if @backup_diy['backup_archive_type'] == 'tar-gpg' %>
+# Options for the tar-gpg archive type
+STASH_BACKUP_GPG_RECIPIENT=<%= @backup_diy['gpg_recipient'] %>
+<% end %>
diff --git a/templates/default/stash.init.erb b/templates/default/stash.init.erb
