p4broker_base #3

  • //
  • guest/
  • robert_cowham/
  • perforce/
  • sdp/
  • Server/
  • Unix/
  • p4/
  • common/
  • bin/
  • p4broker_base
  • View
  • Commits
  • Open Download .zip Download (3 KB)
#!/bin/bash
#==============================================================================
# Copyright and license info is available in the LICENSE file included with
# the Server Deployment Package (SDP), and also available online:
# https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/LICENSE
#------------------------------------------------------------------------------

# Helix Broker base init script

# Do nothing unless $SDP_INSTANCE is defined.
export SDP_INSTANCE=${1:-Unset}

if [[ $SDP_INSTANCE == Unset ]]; then
   echo -e "\nError: The SDP_INSTANCE is not defined.\n."
   exit 1
fi

# Load SDP controlled shell environment.
source /p4/common/bin/p4_vars "$SDP_INSTANCE"
if [[ $? -ne 0 ]]; then
   echo -e "\nError: Failed to load SDP environment for instance $SDP_INSTANCE.\n"
   exit 1
fi

source $P4CBIN/ps_functions.sh
if [[ $? -ne 0 ]]; then
   echo -e "\nError: Failed to load SDP ps_functions.sh lib.\n"
   exit 1
fi

if [[ $(id -u) -eq 0 ]]; then
   exec su - $OSUSER -c "$0 $*"
elif [[ $(id -u -n) != $OSUSER ]]; then
   echo "$0 can only be run by root or $OSUSER"
   exit 1
fi

if [[ ! -x $P4BROKERBIN ]]; then
   echo -e "\nError: $P4BROKERBIN is not executable."
   exit 2;
fi

declare OpMode=${2:-usage}
declare ConfigTag=${3:-default}
declare ConfigTagList=
declare -i ExitStatus=0

if [[ "$ConfigTag" == all ]]; then
   ConfigTagList="default $(cd ${P4CCFG}; ls ${P4SERVER}.broker.*.cfg 2>/dev/null | cut -d '.' -f 3)"
   ConfigTagList=$(echo $ConfigTagList)
else
   ConfigTagList=$ConfigTag
fi

for tag in $ConfigTagList; do
   if [[ $tag == default ]]; then
      if [[ -r /p4/common/config/${P4SERVER}.broker.${HOSTNAME%%.*}.cfg ]]; then
         export P4BROKERCFG=${P4CCFG}/${P4SERVER}.broker.${HOSTNAME%%.*}.cfg
      else
         export P4BROKERCFG=${P4CCFG}/${P4SERVER}.broker.cfg
      fi
   else
      export P4BROKERCFG=${P4CCFG}/${P4SERVER}.broker.${tag}.cfg
   fi

   if [[ ! -r "$P4BROKERCFG" ]]; then
      echo -e "\nError: Missing broker config file $P4BROKERCFG.\n"
      ExitStatus=1
      continue
   fi

   case "$OpMode" in
      start)
         echo "Starting ${P4BROKERBIN} ($tag config) using ${P4BROKERCFG}."
         ${P4BROKERBIN} -d -c ${P4BROKERCFG}
      ;;

      status)
         p4broker_pids=$(get_pids "$P4BROKERCFG")
         if [[ -n "$p4broker_pids" ]]; then
            echo "${P4BROKERBIN} ($tag config) is running as pids: $p4broker_pids."
            ExitStatus=0
         else
            echo "${P4BROKERBIN} ($tag config) is NOT running."
            ExitStatus=1
         fi
      ;;

      stop)
         p4broker_pids=$(get_pids "$P4BROKERCFG")

         if [[ -n "$p4broker_pids" ]]; then
            while [[ -n "$p4broker_pids" ]]; do
               echo "Shutting down ${P4BROKERBIN} ($tag config) pids $p4broker_pids."
               kill $p4broker_pids 2>&1 | $GREP -v -i "No such"
               sleep 1
               p4broker_pids=$(get_pids "$P4BROKERCFG")
            done
            echo "${P4BROKERBIN} ($tag config) stopped."
            ExitStatus=0
         else
            echo "${P4BROKERBIN} ($tag config) was NOT running."
            ExitStatus=1
         fi
      ;;
      restart)
         $0 $SDP_INSTANCE stop $tag
         $0 $SDP_INSTANCE start $tag
      ;;
      *)
         echo -e "\nUsage: $0 SDP_INSTANCE {start|stop|status|restart} [<ConfigTag>|all]\n"
         ExitStatus=1
      ;;
   esac
done

exit $ExitStatus
# Change User Description Committed
#3 23205 Robert Cowham Merged all changes from dev to test
#2 20726 Robert Cowham Catch up from dev
#1 18586 Robert Cowham Branching using cowhamr.sdp.dev
//guest/perforce_software/sdp/dev/Server/Unix/p4/common/bin/p4broker_base
#6 16029 C. Thomas Tyler Routine merge to dev from main using:
p4 merge -b perforce_software-sdp-dev
#5 15778 C. Thomas Tyler Routine Merge Down to dev from main.
#4 13906 C. Thomas Tyler Normalized P4INSTANCE to SDP_INSTANCE to get Unix/Windows
implementations in sync.

Reasons:
1. Things that interact with SDP in both Unix and Windows
environments shoudn't have to account for this obscure
SDP difference between Unix and Windows.  (I came across
this doing CBD work).

2. The Windows and Unix scripts have different variable
names for defining the same concept, the SDP instance.
Unix uses P4INSTANCE, while Windows uses SDP_INSTANCE.

3. This instance tag, a data set identifier, is an SDP concept.
I prefer the SDP_INSTANCE name over P4INSTANCE, so I prpose
to normalize to SDP_INSTANCE.

4. The P4INSTANCE name makes it look like a setting that might be
recognized by the p4d itself, which it is not.  (There are other
such things such as P4SERVER that could perhaps be renamed as
a separate task; but I'm not sure we want to totally disallow
the P4 prefix for variable names. It looks too right to be wrong
in same cases, like P4BIN and P4DBIN.  That's a discussion for
another day, outside the scope of this task).

Meanwhile:
* Fixed a bug in the Windows 2013.3 upgrade script that
was referencing undefined P4INSTANCE, as the Windows
environment defined only SDP_INSTANCE.

* Had P4INSTANCE been removed completely, this change would
likely cause trouble for users doing updates for existing
SDP installations.  So, though it involves slight technical debt,
I opted to keep a redundant definition of P4INSTANCE
in p4_vars.template, with comments indicating SDP_INSTANCE should be
used in favor of P4INSTANCE, with a warning that P4INSTANCE
may go away in a future release.  This should avoid unnecessary
upgrade pain.

* In mkdirs.sh, the varialbe name was INSTANCE rather than
SDP_INSTANCE.  I changed that as well.  That required manual
change rather than sub/replace to avoid corrupting other similar
varialbe names (e.g.  MASTERINSTANCE).

This is a trivial change technically (a substitute/replace, plus
tweaks in p4_vars.template), but impacts many files.
#3 12169 Russell C. Jackson (Rusty) Updated copyright date to 2015

 Updated shell scripts to require an instance parameter to eliminate the need
 for calling p4master_run.    Python and Perl still need it since you have to set the
environment for them to run in.

 Incorporated comments from reviewers. Left the . instead of source as that seems
more common in the field and has the same functionality.
#2 11469 Russell C. Jackson (Rusty) Changed CFG to P4BROKERCFG and moved it to the p4broker init script.
 Changed get_pids to look for P4BROKERCFG rather than P4BROKERBIN so
 that it only kills the broker instances running the config specified
 by the init script.

 This change makes it easy to just copy the p4broker_instance_init script
 and change the config file name to be able to run more than one broker
 per instance of Perforce. Useful to have one ssl and one non ssl broker.
#1 10638 C. Thomas Tyler Populate perforce_software-sdp-dev.
//guest/perforce_software/sdp/main/Server/Unix/p4/common/bin/p4broker_base
#1 10148 C. Thomas Tyler Promoted the Perforce Server Deployment Package to The Workshop.