bosh-gen 0.8.2 → 0.9.0

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%_nginx_rack/templates/bin/ctl_db_utils.sh.erb

@@ -0,0 +1,54 @@
+<% if properties.postgres %>
+PG_PACKAGE_DIR=/var/vcap/package/postgres
+function database_ready() {
+  DB_HOST='<%= properties.postgres.host %>'
+  DB_PORT='<%= properties.postgres.port || 5432 %>'
+  DB_USER='<%= properties.postgres.user %>'
+  DB_PASSWORD='<%= properties.postgres.password %>'
+  DB_NAME='<%= properties.postgres.database %>'
+  echo Testing postgresl: psql -d $DB_NAME -p $DB_PORT -U vcap -c "select 1;"
+  LD_LIBRARY_PATH=$PG_PACKAGE_DIR/lib $PG_PACKAGE_DIR/bin/psql -d $DB_NAME -p $DB_PORT -U $DB_USER -c "select 1;"
+}
+<% else %>
+# No database or SQLite database
+function database_ready() {
+  true
+}
+<% end %>
+
+function wait_for_database() {
+  while [[ ! database_ready ]]
+  do
+    echo "Waiting for database availability"
+    sleep 1;
+  done
+}
+
+# Look for known types of config files
+# and if found, symlink into target location
+# in application
+#
+# config/wp-config.php -> wp-config.php
+# config/database.yml  -> config/database.yml
+function link_sql_db_config() {
+  possible_job_config=(config/database.yml config/wp-config.php)
+  target_app_config=(config/database.yml wp-config.php)
+  list_size=${#possible_job_config[@]}
+  found_config='none'
+  for (( i = 0; i < $list_size; i++ )); do
+    job_config=${possible_job_config[i]}
+    app_config=${target_app_config[i]}
+    if [[ -f $JOB_DIR/${job_config} ]]
+    then
+      link_job_file_to_package ${job_config} ${app_config}
+      found_config=${app_config}
+    fi
+  done
+
+  if [[ "${found_config}" = "none" ]]
+  then
+    echo "ERROR: link_sql_db_config - job does not contain a supported db config file"
+    echo "Please add to job $JOB_NAME a template from: ${possible_job_config[@]}"
+    exit 1
+  fi
+}

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%_nginx_rack/templates/bin/ctl_nginx.sh.erb

@@ -0,0 +1,17 @@
+# Setup HTTP_PROXY, HTTPS_PROXY, NO_PROXY as necessary
+
+# https://github.com/pmirshad/cgit-on-nginx/wiki/Installing-cgit-with-nginx-on-Ubuntu-11.10
+<% if properties.env %>
+<% if properties.env.http_proxy %>
+export HTTP_PROXY='<%= properties.env.http_proxy %>'
+export http_proxy='<%= properties.env.http_proxy %>'
+<% end %>
+<% if properties.env.https_proxy %>
+export HTTPS_PROXY='<%= properties.env.https_proxy %>'
+export https_proxy='<%= properties.env.https_proxy %>'
+<% end %>
+<% if properties.env.no_proxy %>
+export NO_PROXY='<%= properties.env.no_proxy %>'
+export no_proxy='<%= properties.env.no_proxy %>'
+<% end %>
+<% end %>

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%_nginx_rack/templates/bin/ctl_redis_utils.sh.erb

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+REDIS='<%= properties.redis ? 1 : 0 %>'
+
+# Usage: link_redis_config yaml config/redis.yml
+function link_redis_config() {
+  format=$1         # e.g. yaml
+  target_file=${2:-config/redis.yml}    # e.g. config/redis.yml
+  if [[ "${format}" != "yaml" ]]
+  then
+    echo "ERROR: 'link_redis_config ${format}' is not supported. Only supported format: yaml"
+    exit 1
+  fi
+  if [[ "$REDIS" = '1' ]]
+  then
+    link_job_file_to_package ${app_config}
+  fi
+}

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%_nginx_rack/templates/bin/ctl_setup.sh.erb

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# Setup env vars and folders for the ctl script
+# This helps keep the ctl script as readable
+# as possible
+
+set -e # exit immediately if a simple command exits with a non-zero status
+set -u # report the usage of uninitialized variables
+
+export JOB_NAME='<%= name %>'
+export JOB_DIR=/var/vcap/jobs/$JOB_NAME
+chmod 755 $JOB_DIR # to access file via symlink
+
+# the package that contains the application code
+WEBAPP_PACKAGE='<%= properties.webapp && properties.webapp.package %>'
+WEBAPP_DIR=/var/vcap/packages/$WEBAPP_PACKAGE
+if [[ "$WEBAPP_PACKAGE" = '' ]]
+then
+  echo 'ERROR: $WEBAPP_PACKAGE not set before bin/ctl_setup.sh'
+  exit 1
+fi
+
+source $JOB_DIR/bin/ctl_utils.sh
+redirect_output $JOB_NAME
+
+export HOME=${HOME:-/home/vcap}
+
+# Add all packages' /bin & /sbin into $PATH
+for package_bin_dir in $(ls -d /var/vcap/packages/*/{,s}bin)
+do
+  export PATH=${package_bin_dir}:$PATH
+done
+
+# Setup log, run and tmp folders
+
+RUN_DIR=/var/vcap/sys/run/$JOB_NAME
+LOG_DIR=/var/vcap/sys/log/$JOB_NAME
+TMPDIR=/var/vcap/sys/tmp/$JOB_NAME
+for dir in $RUN_DIR $LOG_DIR $TMPDIR
+do
+  mkdir -p ${dir}
+  chown vcap:vcap ${dir}
+done
+
+export C_INCLUDE_PATH=/var/vcap/packages/mysqlclient/include/mysql:/var/vcap/packages/sqlite/include:/var/vcap/packages/libpq/include
+export LIBRARY_PATH=/var/vcap/packages/mysqlclient/lib/mysql:/var/vcap/packages/sqlite/lib:/var/vcap/packages/libpq/lib
+
+PIDFILE=$RUN_DIR/$JOB_NAME.pid

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%_nginx_rack/templates/bin/ctl_start.sh.erb

@@ -0,0 +1,59 @@
+#!/usr/bin/env bash
+
+# Either:
+#   properties:
+#     webapp:
+#       appstack: puma
+#       puma:
+#         threads:
+#           min: 0
+#           max: 16
+#
+# Or PHP-FPM:
+#   properties:
+#     webapp:
+#       appstack: php-fpm
+#
+# Or (default)
+#   properties:
+#     webapp:
+#       appstack: rackup
+#
+# Requires env variables:
+# * $WEBAPP_DIR
+# * $PIDFILE
+# * $PORT
+appstack='<%= properties.webapp && properties.webapp.appstack %>'
+
+echo "Launching $JOB_NAME within $WEBAPP_DIR with ${appstack}"
+wait_for_database
+
+if [[ "${appstack}" = "puma" ]]
+then
+  <% puma_threads = properties.webapp.puma && properties.webapp.puma.threads %>
+  MIN_THREADS=<%= (puma_threads && puma_threads.min) || 0 %>
+  MAX_THREADS=<%= (puma_threads && puma_threads.max) || 16 %>
+  exec bundle exec puma --pidfile $PIDFILE -p $PORT -t $MIN_THREADS:$MAX_THREADS \
+       >>$LOG_DIR/webapp.stdout.log \
+       2>>$LOG_DIR/webapp.stderr.log || exit 1
+
+elif [[ "${appstack}" = "rackup" ]]
+then
+  exec bundle exec rackup -D -P $PIDFILE -p $PORT \
+       >>$LOG_DIR/webapp.stdout.log \
+       2>>$LOG_DIR/webapp.stderr.log || exit 1
+
+elif [[ "${appstack}" = "phpfpm" || "${appstack}" = "php-fpm" ]]
+then
+  /var/vcap/packages/php5/sbin/php-fpm \
+    -c $JOB_DIR/etc/php.ini \
+    --fpm-config $JOB_DIR/etc/php-fpm.conf \
+    --pid $PIDFILE
+
+# else invalid appstack requested
+else
+  echo "ERROR: properties.webapp.appstack = ${appstack}. Valid values: puma, rackup"
+  exit 1
+fi
+
+chown vcap:vcap $PIDFILE

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%_nginx_rack/templates/bin/ctl_utils.sh

@@ -0,0 +1,148 @@
+# Helper functions used by ctl scripts
+
+# links a file (probably a config file) into a package
+# Example usage:
+# link_job_file_to_package config/redis.yml [config/redis.yml]
+# link_job_file_to_package config/wp-config.php wp-config.php
+link_job_file_to_package() {
+  source_job_file=$1
+  target_package_file=${2:-$source_job_file}
+
+  full_job_file=$JOB_DIR/${source_job_file}
+  full_package_file=$WEBAPP_DIR/${target_package_file}
+  echo link_job_file_to_package $full_job_file $full_package_file
+  if [[ ! -f ${full_job_file} ]]
+  then
+    echo "File to link ${full_job_file} does not exist"
+  else
+    # Create/recreate the symlink to current job file
+    # If another process is using the file, it won't be
+    # deleted, so don't attempt to create the symlink
+    echo "Linking ${source_job_file} -> ${full_package_file}"
+    mkdir -p $(dirname ${full_package_file})
+    ln -nfs ${full_job_file} ${full_package_file}
+  fi
+}
+
+
+# If loaded within monit ctl scripts then pipe output
+# If loaded from 'source ../utils.sh' then normal STDOUT
+redirect_output() {
+  SCRIPT=$1
+  mkdir -p /var/vcap/sys/log/monit
+  exec 1>> /var/vcap/sys/log/monit/$SCRIPT.log
+  exec 2>> /var/vcap/sys/log/monit/$SCRIPT.err.log
+}
+
+pid_guard() {
+  pidfile=$1
+  name=$2
+
+  if [ -f "$pidfile" ]; then
+    pid=$(head -1 "$pidfile")
+
+    if [ -n "$pid" ] && [ -e /proc/$pid ]; then
+      echo "$name is already running, please stop it first"
+      exit 1
+    fi
+
+    echo "Removing stale pidfile..."
+    rm $pidfile
+  fi
+}
+
+wait_pid() {
+  pid=$1
+  try_kill=$2
+  timeout=${3:-0}
+  force=${4:-0}
+  countdown=$(( $timeout * 10 ))
+
+  echo wait_pid $pid $try_kill $timeout $force $countdown
+  if [ -e /proc/$pid ]; then
+    if [ "$try_kill" = "1" ]; then
+      echo "Killing $pidfile: $pid "
+      kill $pid
+    fi
+    while [ -e /proc/$pid ]; do
+      sleep 0.1
+      [ "$countdown" != '0' -a $(( $countdown % 10 )) = '0' ] && echo -n .
+      if [ $timeout -gt 0 ]; then
+        if [ $countdown -eq 0 ]; then
+          if [ "$force" = "1" ]; then
+            echo -ne "\nKill timed out, using kill -9 on $pid... "
+            kill -9 $pid
+            sleep 0.5
+          fi
+          break
+        else
+          countdown=$(( $countdown - 1 ))
+        fi
+      fi
+    done
+    if [ -e /proc/$pid ]; then
+      echo "Timed Out"
+    else
+      echo "Stopped"
+    fi
+  else
+    echo "Process $pid is not running"
+    echo "Attempting to kill pid anyway..."
+    kill $pid
+  fi
+}
+
+wait_pidfile() {
+  pidfile=$1
+  try_kill=$2
+  timeout=${3:-0}
+  force=${4:-0}
+  countdown=$(( $timeout * 10 ))
+
+  if [ -f "$pidfile" ]; then
+    pid=$(head -1 "$pidfile")
+    if [ -z "$pid" ]; then
+      echo "Unable to get pid from $pidfile"
+      exit 1
+    fi
+
+    wait_pid $pid $try_kill $timeout $force
+
+    rm -f $pidfile
+  else
+    echo "Pidfile $pidfile doesn't exist"
+  fi
+}
+
+kill_and_wait() {
+  pidfile=$1
+  # Monit default timeout for start/stop is 30s
+  # Append 'with timeout {n} seconds' to monit start/stop program configs
+  timeout=${2:-25}
+  force=${3:-1}
+  if [[ -f ${pidfile} ]]
+  then
+    wait_pidfile $pidfile 1 $timeout $force
+  else
+    # TODO assume $1 is something to grep from 'ps ax'
+    pid="$(ps auwwx | grep "$1" | awk '{print $2}')"
+    wait_pid $pid 1 $timeout $force
+  fi
+}
+
+check_nfs_mount() {
+  opts=$1
+  exports=$2
+  mount_point=$3
+
+  if grep -qs $mount_point /proc/mounts; then
+    echo "Found NFS mount $mount_point"
+  else
+    echo "Mounting NFS..."
+    mount $opts $exports $mount_point
+    if [ $? != 0 ]; then
+      echo "Cannot mount NFS from $exports to $mount_point, exiting..."
+      exit 1
+    fi
+  fi
+}

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%_nginx_rack/templates/bin/monit_debugger

@@ -0,0 +1,13 @@
+#!/bin/sh
+# USAGE monit_debugger <label> command to run
+mkdir -p /var/vcap/sys/log/monit
+{
+  echo "MONIT-DEBUG date"
+  date
+  echo "MONIT-DEBUG env"
+  env
+  echo "MONIT-DEBUG $@"
+  $2 $3 $4 $5 $6 $7
+  R=$?
+  echo "MONIT-DEBUG exit code $R"
+} >/var/vcap/sys/log/monit/monit_debugger.$1.log 2>&1

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%_nginx_rack/templates/bin/nginx_ctl.tt

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+set -e # exit immediately if a simple command exits with a non-zero status
+set -u # report the usage of uninitialized variables
+
+# Setup env vars and folders for the webapp_ctl script
+source /var/vcap/jobs/<%= job_name %>/bin/ctl_setup.sh
+
+# Override ctl_setup.sh defaults:
+redirect_output 'nginx'
+PIDFILE=$RUN_DIR/nginx.pid
+
+case $1 in
+
+  start)
+    pid_guard $PIDFILE "nginx for $JOB_NAME"
+
+    echo $$ > $PIDFILE
+
+    for dir in $UPLOADS_DIR $STAGED_UPLOADS_DIR
+    do
+      mkdir -p ${dir}
+    done
+
+    exec /var/vcap/packages/nginx_next/sbin/nginx \
+         -c $JOB_DIR/config/nginx.conf \
+         >>$LOG_DIR/nginx.stdout.log \
+         2>>$LOG_DIR/nginx.stderr.log
+    ;;
+
+  stop)
+    echo "Stopping nginx"
+    kill_and_wait $PIDFILE
+    ;;
+
+  *)
+    echo "Usage: nginx_ctl {start|stop}"
+
+    ;;
+
+esac

data/lib/bosh/gen/generators/job_generator/templates/jobs/%job_name%_nginx_rack/templates/bin/rails_ctl_setup.sh.erb

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+# Sets up ctl script for a Rails/Rack application
+# * sets up $RAILS_ENV, $RACK_ENV
+# * specifically sets $BUNDLE_GEMFILE, if $WEBAPP_DIR set
+
+# Default properties:
+#
+#   properties:
+#     webapp:
+#       migrate: false
+#       migration_command: rake db:migrate
+
+migrate='<%= (properties.webapp && properties.webapp.migrate) || "false" %>'
+migration_command='<%= (properties.webapp && properties.webapp.migration_command) || "rake db:migrate" %>'
+
+export RAILS_ENV=production
+export RACK_ENV=${RAILS_ENV}
+if [[ "$WEBAPP_DIR" != '' ]]
+then
+  export BUNDLE_GEMFILE=$WEBAPP_DIR/Gemfile
+fi
+
+function run_migrations() {
+  if [[ "${migrate}" = "true" || "${migrate}" = "1" || "${migrate}" = "yes" ]]
+  then
+    wait_for_database
+
+    echo "Running migrations"
+    bundle exec ${migration_command} \
+      >>$LOG_DIR/db_migrate.stdout.log \
+      2>>$LOG_DIR/db_migrate.stderr.log
+    if [ $? != 0 ]; then
+      echo "Migrations failed"
+      exit 1
+    fi
+  else
+    echo "Skipping migrations"
+  fi
+}