#!/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 #------------------------------------------------------------------------------ # This script keeps Perforce Server Deployment Package (SDP) scripts in # sync on a set of SDP hosts (defined in sdp_hosts.cfg). # See usage() below (or run script with -man) for details. #============================================================================== # Declarations and Environment # Environment isolation. For stability and security reasons, prepend # Allow override of P4U_HOME, which is set only when testing P4U scripts. export P4U_HOME=${P4U_HOME:-/p4/common/bin} export P4U_LIB=${P4U_LIB:-/p4/common/lib} export P4U_ENV=$P4U_LIB/p4u_env.sh export P4U_LOG=Unset # PATH to include dirs where known-good scripts exist. # known/tested PATH and, by implication, executables on the PATH. export P4CBIN=${P4CBIN:-/p4/common/bin} export P4CCFG=${P4CCFG:-/p4/common/config} export PATH=$P4CBIN:$PATH:~/bin:. export P4CONFIG=${P4CONFIG:-.p4config} export P4ENVIRO=/dev/null/.p4enviro [[ -r "$P4U_ENV" ]] || { echo -e "\nError: Cannot load environment from: $P4U_ENV\n\n" exit 1 } declare BASH_LIBS=$P4U_ENV BASH_LIBS+=" $P4U_LIB/libcore.sh" BASH_LIBS+=" $P4U_LIB/libp4u.sh" BASH_LIBS+=" $P4CBIN/backup_functions.sh" for bash_lib in $BASH_LIBS; do source $bash_lib ||\ { echo -e "\nFATAL: Missing lib [$bash_lib]. Aborting.\n"; exit 1; } done declare Version=2.1.8 declare DirList= declare HostList= declare HostCfgFile= declare EnvFile=$P4U_HOME/p4_vars declare SDPInstance=${SDP_INSTANCE:-Unset} declare CronDir=/p4/common/etc/cron.d declare CronFile= declare StatusCmd= declare TmpFile= declare P4Bin=/p4/common/bin/p4_bin declare -i SilentMode=0 declare -i EmailAlways=0 declare -i EmailOnFailure=0 declare -i RemoveOldLogs=0 declare -i CheckCronFiles=0 declare -i DoStatusCheck=0 declare -i DoStatusMCheck=0 declare -i CronDefined export VERBOSITY=3 #============================================================================== # Local Functions #------------------------------------------------------------------------------ # Function: terminate function terminate { # Disable signal trapping. trap - EXIT SIGINT SIGTERM declare -i sendEmail=0 # Don't litter. cleanTrash vvmsg "$THISSCRIPT: EXITCODE: $OverallReturnStatus" # Stop logging. if [[ "${P4U_LOG}" != off ]]; then stoplog # Email. [[ $EmailAlways -eq 1 ]] && sendEmail=1 [[ $EmailOnFailure -eq 1 && $OverallReturnStatus -ne 0 ]] && sendEmail=1 if [[ $sendEmail -eq 1 ]]; then emailStatus="OK" [[ $OverallReturnStatus -ne 0 ]] && emailStatus="Error" local mail_sender_opt=$(get_mail_sender_opt) run "$SDPMAIL -s \"${HOSTNAME%%\.*} p4_$SDPInstance sdp_sync [$emailStatus]\" \$mail_sender_opt \$MAILTO < $P4U_LOG" fi fi # With the trap removed, exit. exit $OverallReturnStatus } #------------------------------------------------------------------------------ # Function: usage (required function) # # Input: # $1 - style, either -h (for short form) or -man (for man-page like format). #------------------------------------------------------------------------------ function usage { declare style=${1:--h} echo "USAGE for $THISSCRIPT v$Version: $THISSCRIPT [-H <host1>[,<host2>,...]] [-i <instance>] [-s] [-m] [-c] [-r] [-e|-E] [-L <log>] [-si] [-v<n>] [-n|-N] [-D] or $THISSCRIPT [-h|-man|-V] " if [[ $style == -man ]]; then echo -e " DESCRIPTION: This script keeps Perforce Server Deployment Package (SDP) scripts in sync on all SDP hosts, as defined by the SDP_SYNC_HOSTS setting in the $HostCfgFile file. Also, if used with the '-c' flag, verifies that versioned cron files match those on each system. This script is intended to be called by a cron job the master server. It then does ssh calls to the remaining SDP hosts. Each target host is expect to have a P4CONFIG file named /p4/.p4config.SDP that defines Perforce environment settings that point to Perforce workspaces that enable versioning of the SDP on that host. For pure read-only replicas, the P4PORT value in that P4CONFIG file must point to the master server. Forwarding replicas and Edge Servers can point P4PORT to the master server or locally. The worskpaces must be configured for each host. Typically they reference paths in the Perforce server that are common across all SDP servers, e.g. to populate the /p4/common/bin folder. Other paths are host-specific, like the /p4/<n>/bin folders that indicate which instances are active on the machine as well as which type of servers are active for each instance (p4d, p4p, p4broker, etc.). This depends on ssh keys being setup such that the Perforce login (as defined by OSUSER in $EnvFile) can ssh without a password to all SDP hosts. (To simplify failover, the backup servers should also be able to ssh to each other without a password; security implications should be considered here.) OPTIONS: -H <host1>[,<host2>,...] Specify a comma-delimited list of hosts to push to. By default, the SDP_SYNC_HOSTS value defined in the config file $HostCfgFile determines the list of hosts to push to. -i <n> Specify the SDP instance tag (e.g 1 for /p4/1, abc for /p4/abc) for the SDP instance that contains the SDP. The default is to use the \$SDP_INSTANCE variable if defined, or else '1'. -s Specify that a 'p4 status' check should be done in directories specified by the SDP_STATUS_DIRS variable defined in $HostCfgFile. -m Use with '-s' to specify that the '-m' flag to 'p4 status' should be used for a faster check (without MD5 digest comparison). If '-m' is specified without '-s', the '-s' is implied. -c Specifies that the crontab for the OSUSER ($OSUSER) on each machine should be compared against the the versioned cron file in: $CronDir In that directory, the cron files are named crontab.<user>.<hostname> The cron check is done for all hosts defined in the ALL_SDP_HOSTS setting in $HostCfgFile. -r Specify this option to remove old sdp_sync.*.log files. If this option is specified, log files named /p4/<n>/logs/sdp_sync.*.log (where '<n>' is the SDP instance name) that are older than the number of journal rotations indicated by the KEEPLOGS setting in $EnvFile are removed. The old log removal occurs only upon successful completion. -e Send email to MAILTO value defined in $EnvFile in event of failure only. -E Send email to MAILTO value defined in $EnvFile. -v<n> Set verbosity 1-5 (-v1 = quiet, -v5 = highest). -L <log> Specify the path to a log file, or the special value 'off' to disable logging. By default, all output (stdout and stderr) goes to a log file named sdp_sync.<datestame>.log in $LOGS. NOTE: This script is self-logging. That is, output displayed on the screen is simultaneously captured in the log file. Do not run this script with redirection operators like '> log' or '2>&1', and do not use 'tee.' -si Operate silently. All output (stdout and stderr) is redirected to the log only; no output appears on the terminal. This cannot be used with '-L off'. -n No-Op. Prints commands instead of running them. -N No-Op. Similar to '-n', but this command does execute the 'ssh' calls to get to the remote host, but then does 'p4 sync -n' rather than' 'p4 sync' on the remote host. -D Set extreme debugging verbosity. HELP OPTIONS: -h Display short help message -man Display man-style help message -V Dispay version info for this script and its libraries. FILES: The SDP environment file $EnvFile defines various SDP settings, and is used by several SDP scripts. The host config file $HostCfgFile defines the SDP_SYNC_HOSTS and other values. EXAMPLES: Recommended crontab usage for SDP Instance 1: $P4CBIN/$THISSCRIPT -i 1 -si -s -c -r -e < /dev/null > /dev/null 2>&1 The redirect to /dev/null is to avoid any output that would generate a duplicate email from cron. Output is not lost; it is written to a timestampped log file: $P4HOME/logs/sdp_sync.<timestamp>.log SEE ALSO: See this related script: $P4CBIN/global_replica_status.sh " fi exit 1 } #============================================================================== # Command Line Processing declare -i shiftArgs=0 set +u while [[ $# -gt 0 ]]; do case $1 in (-i) SDPInstance=$2; shiftArgs=1;; (-H) HostList=$2; shiftArgs=1;; (-r) RemoveOldLogs=1;; (-e) EmailOnFailure=1;; (-E) EmailAlways=1;; (-c) CheckCronFiles=1;; (-s) DoStatusCheck=1;; (-m) DoStatusCheck=1; DoStatusMCheck=1;; (-h) usage -h;; (-man) usage -man;; (-V) show_versions; exit 1;; (-v1) export VERBOSITY=1;; (-v2) export VERBOSITY=2;; (-v3) export VERBOSITY=3;; (-v4) export VERBOSITY=4;; (-v5) export VERBOSITY=5;; (-L) export P4U_LOG=$2; shiftArgs=1;; (-si) SilentMode=1;; (-n) export NO_OP=1;; (-N) export NO_OP=2;; (-D) set -x;; # Debug; use 'set -x' mode. (*) usageError "Unknown arg ($1).";; esac # Shift (modify $#) the appropriate number of times. shift; while [[ $shiftArgs -gt 0 ]]; do [[ $# -eq 0 ]] && usageError "Bad usage." shiftArgs=$shiftArgs-1 shift done done set -u #============================================================================== # Command Line Verification [[ $SilentMode -eq 1 && $P4U_LOG == off ]] && \ usageError "Cannot use '-si' with '-L off'." [[ $EmailOnFailure -eq 1 && $P4U_LOG == off ]] && \ usageError "Cannot use '-e' or '-E' with '-L off'." [[ $EmailAlways -eq 1 && $EmailOnFailure -eq 1 ]] && \ usageError "The '-e' and '-E' flags are mutually exclusive." [[ $SDPInstance == Unset ]] && \ bail "SDP Environment is not set, and no instance parameter was provided. Aborting." [[ $P4U_LOG == Unset ]] && export P4U_LOG="/p4/hms/logs/sdp_sync.$(date +'%Y%m%d-%H%M%S').log" #============================================================================== # Main Program trap terminate EXIT SIGINT SIGTERM declare -i OverallReturnStatus=0 if [[ "${P4U_LOG}" != off ]]; then touch ${P4U_LOG} || bail "Couldn't touch log file [${P4U_LOG}]." # Redirect stdout and stderr to a log file. if [[ $SilentMode -eq 0 ]]; then exec > >(tee ${P4U_LOG}) exec 2>&1 else exec >${P4U_LOG} exec 2>&1 fi initlog fi if [[ -r $P4CCFG/sdp_hosts.${SDPInstance}.cfg ]]; then HostCfgFile=$P4CCFG/sdp_hosts.${SDPInstance}.cfg else HostCfgFile=$P4CCFG/sdp_hosts.cfg fi if [[ -r "$HostCfgFile" ]]; then msg "Loading hosts data from $HostCfgFile." else bail "Missing host config file $HostCfgFile." fi source $HostCfgFile ||\ bail "Failed to load host configuration from $HostCfgFile. Aborting." if [[ -r "$EnvFile" ]]; then msg "Loading SDP Environment for instance SDPInstance using $EnvFile." else bail "Missing SDP Environment file $EnvFile." fi source $EnvFile "$SDPInstance" ||\ bail "Failed to load SDP Environment from $EnvFile. Aborting." export ALL_SDP_HOSTS=${ALL_SDP_HOSTS:-Unset} export SDP_REPLICA_HOSTS=${SDP_REPLICA_HOSTS:-Unset} export SDP_REMOTE_HOSTS=${SDP_REMOTE_HOSTS:-Unset} export SDP_SYNC_HOSTS=${SDP_SYNC_HOSTS:-Unset} export SDP_STATUS_DIRS=${SDP_STATUS_DIRS:-Unset} # If '-H <host1>[,<host2>,...]' was specified as a comma-separated list # on the command line, overide the SDP_SYNC_HOSTS value defined in # the host config file. [[ -n "$HostList" ]] && export SDP_SYNC_HOSTS="$(echo $HostList|tr ',' ' ')" [[ "$SDP_SYNC_HOSTS" == Unset ]] && \ bail "The SDP_SYNC_HOSTS variable is not defined in $HostCfgFile. Aborting." [[ "$ALL_SDP_HOSTS" == Unset && $CheckCronFiles -eq 1 ]] && \ bail "The ALL_SDP_HOSTS variable is not defined in $HostCfgFile, and '-c' is specified which requires it to be defined. Aborting." [[ "$SDP_STATUS_DIRS" == Unset && $DoStatusCheck -eq 1 ]] && \ bail "The SDP_STATUS_DIRS variable is not defined in $HostCfgFile, and '-s' or '-m' is specified which requires it to be defined. Aborting." # Just in case commas were used instead of spaces in the config file, translate them # to spaces here. TmpFile=/tmp/crontab.tmp.$$.$RANDOM GARBAGE+=" $TmpFile" for host in $(echo $SDP_SYNC_HOSTS|tr ',' ' '); do rrun $host "export P4CONFIG=/p4/.p4config.SDP\nexport P4ENVIRO=/dev/null/.p4enviro\n$P4Bin set\necho\n$P4Bin -s info -s\necho\n$P4Bin -s opened\n" "Checking for opened files in the SDP workspace on $host." if [[ $RCMDOUTPUT == *"File(s) not opened on this client."* ]]; then msg "Verified: No files are checked out in the SDP workspace on host $host." else warnmsg "Files are checked out (or login failed) in the SDP workspace on host $host." OverallReturnStatus=1 fi if [[ $NO_OP -eq 0 || $NO_OP -eq 1 ]]; then rrun $host "export P4CONFIG=/p4/.p4config.SDP\nexport P4ENVIRO=/dev/null/.p4enviro\n$P4Bin set\necho\n$P4Bin -s info -s\necho\n$P4Bin -s sync\n" "Syncing SDP workspace on $host." || OverallReturnStatus=1 else rrun $host "export P4CONFIG=/p4/.p4config.SDP\nexport P4ENVIRO=/tmp/tmp.p4enviro.$$.$RANDOM\n$P4Bin set\necho\n$P4Bin -s info -s\necho\n$P4Bin -s sync -n\n" "Checking to see if files need to be sync'd on host $host." 0 1 || OverallReturnStatus=1 fi if [[ $DoStatusCheck -eq 1 ]]; then if [[ $DoStatusMCheck -eq 1 ]]; then msg "${H}\nDoing 'p4 status -m' check in \$SDP_STATUS_DIRS: $SDP_STATUS_DIRS\n" else msg "${H}\nDoing 'p4 status' check in \$SDP_STATUS_DIRS: $SDP_STATUS_DIRS\n" fi DirList=$(echo $SDP_STATUS_DIRS|tr ',' ' ') for dir in $DirList; do StatusCmd="$P4Bin -s -d $dir status" [[ $DoStatusMCheck -eq 1 ]] && StatusCmd+=" -m" rrun $host "[[ ! -d $dir ]] && exit 0; export P4CONFIG=/p4/.p4config.SDP\nexport P4ENVIRO=/tmp/tmp.p4enviro.$$.RANDOM\n$P4Bin set\necho\n$StatusCmd" "Checking on $host with: $StatusCmd." if [[ $RCMDOUTPUT == *"No file(s) to reconcile"* ]]; then msg "Status reports clean for $host:$dir." else warnmsg "Status is not clean in $host:$dir." OverallReturnStatus=1 fi done fi done if [[ $CheckCronFiles -eq 1 ]]; then msg "${H}\nChecking crontab files in \$ALL_SDP_HOSTS: $ALL_SDP_HOSTS\n" for host in $(echo $ALL_SDP_HOSTS|tr ',' ' '); do CronFile=$CronDir/crontab.$OSUSER.$host msg "Checking crontab for user $OSUSER on host $host." ssh -q $host crontab -l > $TmpFile 2>&1 if [[ "$(cat $TmpFile)" == *"no crontab for "* ]]; then CronDefined=0 else CronDefined=1 fi if [[ $CronDefined -eq 1 ]]; then if [[ -e "$CronFile" ]]; then diff $CronFile $TmpFile > /dev/null 2>&1 if [[ $? -eq 0 ]]; then msg "Verified: Cron for user $OSUSER on host $host matches cron file [$CronFile]." else OverallReturnStatus=1 errmsg "Cron for user $OSUSER on host $host does NOT match cron file [$CronFile].\nDiffs:\n$(diff $CronFile $TmpFile)\n" fi else warnmsg "An active cron exists for $OSUSER on host $host, but the cron file is missing: $CronFile." OverallReturnStatus=1 fi else # Cron not defined. if [[ -e "$CronFile" ]]; then warnmsg "No active cron exists for $OSUSER on host $host, but cron file exists: $CronFile." OverallReturnStatus=1 else msg "Verified: No active cron exists for $OSUSER on host $host, and so no cron file exists." fi fi done fi if [[ $OverallReturnStatus -eq 0 ]]; then msg "${H}\nAll processing completed successfully.\n" if [[ $RemoveOldLogs -eq 1 ]]; then if [[ $NO_OP -eq 0 ]]; then msg "Cleanup: Removing $P4HOME/logs/sdp_sync.*.log files older than $KEEPLOGS days old (if any):" /bin/find $P4HOME/logs/ -name "sdp_sync.*.log" -mtime +$KEEPLOGS -print -exec /bin/rm -f {} \; else msg "NO_OP: Would remove $P4HOME/logs/sdp_sync.*.log files older than $KEEPLOGS days old (if any):" /bin/find $P4HOME/logs/ -name "sdp_sync.*.log" -mtime +$KEEPLOGS -print fi fi else msg "${H}\nProcessing completed, but with warnings or errors. Scan above output carefully.\n" fi # Illustrate using $SECONDS to display runtime of a script. msg "That took about $(($SECONDS/3600)) hours $(($SECONDS%3600/60)) minutes $(($SECONDS%60)) seconds.\n" # See the terminate() function, which is really where this script exits. exit $OverallReturnStatus
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#5 | 23205 | Robert Cowham | Merged all changes from dev to test | ||
#4 | 22477 | Robert Cowham | Bring latest dev changes into test | ||
#3 | 22142 | Robert Cowham | Merge in latest changes from Dev | ||
#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/sdp_sync.sh | |||||
#12 | 17259 | C. Thomas Tyler |
sdp_sync.sh v2.1.5: * Fixed bug detecting the case where there is a null crontab. |
||
#11 | 16784 | C. Thomas Tyler |
Routine Merge Down to dev from main using: p4 -s merge -n -b perforce_software-sdp-dev |
||
#10 | 16638 | C. Thomas Tyler |
Routine merge down to dev from main using: p4 merge -b perforce_software-sdp-dev |
||
#9 | 16563 | C. Thomas Tyler |
Routine Merge Down to dev from main using: p4 merge -b perforce_software-sdp-dev p4 resolve -as |
||
#8 | 16029 | C. Thomas Tyler |
Routine merge to dev from main using: p4 merge -b perforce_software-sdp-dev |
||
#7 | 15778 | C. Thomas Tyler | Routine Merge Down to dev from main. | ||
#6 | 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. |
||
#5 | 13904 | C. Thomas Tyler | Routine merge down to dev from main. | ||
#4 | 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. |
||
#3 | 12028 | C. Thomas Tyler | Refreshed SDP dev branch, merging down from main. | ||
#2 | 10867 | C. Thomas Tyler | Merge Down: Rereshed 'dev' from 'main'. | ||
#1 | 10638 | C. Thomas Tyler | Populate perforce_software-sdp-dev. | ||
//guest/perforce_software/sdp/main/Server/Unix/p4/common/bin/sdp_sync.sh | |||||
#1 | 10148 | C. Thomas Tyler | Promoted the Perforce Server Deployment Package to The Workshop. |