#!/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 #------------------------------------------------------------------------------ set -u # sdp_upgrade.sh # Upgrades the Perforce Helix Server Deployment Package (SDP). #============================================================================== # Declarations and Environment declare Version=1.0.3 declare ThisScript="${0##*/}" declare ThisUser= declare CmdArgs="$*" declare CmdLine="$0 $CmdArgs" declare -i ErrorCount=0 declare -i WarningCount=0 declare H1="==============================================================================" declare H2="------------------------------------------------------------------------------" declare Log="Unset" declare -i PreflightOnly=0 declare -i Debug=0 declare -i NoOp=1 declare SDPInstallRoot="/p4" declare SDPCommon="$SDPInstallRoot/common" declare SDPOwner= declare HxDepots= declare DownloadsDir= declare DownloadsDirNew= declare SDPTarball= declare SDPInstanceList= declare -a InstanceCfgFiles declare -i InstanceCfgFileCount declare TarRoot= declare TarRootCommon= declare TarRootConfig= declare TarRootCron= declare TarRootBinDir= declare TarRootInit= declare PreSDPUpgradeScript=/p4/common/site/upgrade/pre-sdp_upgrade.sh declare PreSDPUpgradeCmd= declare PostSDPUpgradeScript=/p4/common/site/upgrade/post-sdp_upgrade.sh declare PostSDPUpgradeCmd= declare SDPTarballURL="https://swarm.workshop.perforce.com/projects/perforce-software-sdp/download/downloads/sdp.Unix.tgz" # The SDPTargetMajorVersion is hard-coded by design. This is upgraded with every SDP major # version. The SDPTargetVersion includes the changelist number extracted from the SDP # 'Version' file which is updated by automation during the SDP release process. declare SDPTargetMajorVersion=2021.1 declare SDPTargetVersion= #============================================================================== # Local Functions # Note: This script does not use SDP library files, as its purpose is to # upgrade the SDP installation. function msg () { echo -e "$*"; } function dbg () { [[ "$Debug" -ne 0 ]] && msg "$*"; } function errmsg () { msg "\\nError: ${1:-Unknown Error}\\n"; ErrorCount+=1; } function warnmsg () { msg "\\nWarning: ${1:-Unknown Warning}\\n"; WarningCount+=1; } function bail () { errmsg "${1:-Unknown Error}"; exit "${2:-1}"; } #------------------------------------------------------------------------------ # This function takes as input an SDP version string, and returns a version # id of the form YYYY.N.CL, where YYYY is the year, N is an incrementing # release ID with a given year, and CL is a changelist identifier. The # YYYY.N together comprise the major version, often shortened to YY.N, e.g. # r20.1 for the 2020.1 release. # # The full SDP Version string looks something like this: # Rev. SDP/MultiArch/2019.3/26494 (2020/04/23). # # This function parses that full string and returns a value like: 2019.3.26494 function get_sdp_version_from_string () { dbg "CALL get_sdp_veresion_from_string($*)" local versionString="${1:-}" local version= version="20${versionString##*/20}" version="${version%% *}" version="${version/\//.}" [[ "$version" == "20" || "$version" == "200" ]] && version="Unknown" echo "$version" } #------------------------------------------------------------------------------ # Function: acquire_sdp () #------------------------------------------------------------------------------ function acquire_sdp () { dbg "CALL acquire_sdp($*)" true; # No-op placeholder. } #------------------------------------------------------------------------------ # Function: check_p4_vars_file () # # Determine if the SDP p4_vars file can be safely upgraded. #------------------------------------------------------------------------------ function check_p4_vars_file () { dbg "CALL check_p4_vars_file($*)" # See if SDP_P4_VARS_FORMAT is defined. local fileFormatVersion=0.5 } #------------------------------------------------------------------------------ # Function: check_instance_cfg_file () # # Determine if the SDP instance config file can be safely upgraded. # See if SDP_INSTANCE_VARS_FORMAT is defined. #------------------------------------------------------------------------------ function check_instance_cfg_file () { dbg "CALL check_instance_cfg_file($*)" local instanceCfgFile=${1:-UnsetSDPInstanceCfgFile} local fileFormatVersion=0.5 if [[ -r "$instanceCfgFile" ]]; then # Check for required parameters in the file. # #MAILTO #MAILFROM #P4USER #P4MASTER_ID #SSL_PREFIX #P4PORTNUM #P4MASTERHOST #P4MASTERPORT msg "Verified: This instance config file can be ugpraded: $instanceCfgFile" else errmsg "Missin SDP Instance config file: $instanceCfgFile" return 1 fi return 0 } #------------------------------------------------------------------------------ # Function: get_sdp_instances () # # Get the list of SDP instances after doing some preliminary sanity # checks. Sets global SDPInstanceList. function get_sdp_instances () { dbg "CALL get_sdp_instance($*)" local e= local instanceCfg= local instanceBinDir= SDPInstanceList= cd "$SDPInstallRoot" || \ bail "Could not cd to SDP Install Root dir: $SDPInstallRoot" # Start with elements (files/dirs/symlinks) under /p4. for e in *; do # Silently ignore expected elements under /p4. [[ "$e" =~ ^(common|sdp|ssl)$ ]] && continue # Warn about symlinks under /p4; there should not be any, only # directories. if [[ -L "$e" ]]; then warnmsg "Ignoring unexpected symlink $SDPInstallRoot/$e" continue fi # Consider only at directories under /p4; silently ignore files. if [[ -d "$e" ]]; then # For a directory under /p4 to be an SDP instance, there must # be corresponding instance configuration file to upgrade, # /p4/common/config/p4_N.vars. instanceCfg="$SDPInstallRoot/common/p4_${e}.vars" instanceBinDir="$SDPInstallRoot/${e}/bin" if [[ -r "$instanceCfg" ]]; then SDPInstanceList+=" $e" SDPInstanceCfgFile[$SDPInstanceCfgFileCount]="$instanceCfg" SDPInstanceCfgFileCount+=1 elif [[ -d "$instanceBinDir" ]]; then warnmsg "Found instance bin dir [$instanceBinDir] but no corresponding instance config file [$instanceCfgFile]. Assuming $SDPInstallRoot/$e is not a valid SDP instance directory." fi fi done # Trim leading space. # shellcheck disable=SC2116 SDPInstanceList=$(echo "$SDPInstanceList") if [[ -n "$SDPInstanceList" ]]; then msg "\\nList of SDP Instances: $SDPInstanceList" else warnmsg "\\nNo SDP instances detected under $SDPInstallRoot" fi } #------------------------------------------------------------------------------ # Function: do_preflight_checks () # # If preflight checks fail, further tests are aborted. Failure of the very # basic preflight checks is an indication that the SDP structure is in # need of repair. #------------------------------------------------------------------------------ function do_preflight_checks () { dbg "CALL do_preflight_checks()" local toolsList="awk date grep head id ls rsync sort tail tee" local cfgFile= msg "$H2\\nDoing preflight sanity checks." msg "Preflight Check: Ensuring these utils are in PATH: $toolsList" for tool in $toolsList; do CheckCount+=1 [[ -z "$(command -v "$tool")" ]] && \ errmsg "Tool '$tool' not in PATH." done # If basic tools aren't available, we don't even try to complete the # preflight checks, and return immediately. [[ $ErrorCount -eq 0 ]] || return 1 msg "Verified: Essential tools are in the PATH." msg "Preflight Check: cd $SDPCommon" if cd "$SDPCommon"; then cd "$OLDPWD" || bail "Failed to cd to $OLDPWD. Aborting." else errmsg "Could not cd to: $SDPCommon" return 1 fi msg "Verified: cd works to: $SDPCommon" msg "Preflight Check: Checking current user owns $SDPCommon" # shellcheck disable=SC2012 SDPOwner="$(ls -ld "$SDPCommon" | awk '{print $3}')" if [[ "$ThisUser" == "$SDPOwner" ]]; then msg "Verified: Current user [$ThisUser] owns $SDPCommon" else errmsg "Current user [$ThisUser] does not own $SDPCommon. This most likely means this script is running as the wrong user. It could also mean the $SDPCommon directory is not owned by the correct owner, which should be the OS account under which the p4d process runs." return 1 fi for cfgFile in "${SDPInstanceCfgFile[@]}"; do check_instance_cfg_file "$cfgFile" done HxDepots=$(cd /p4/common; d=$(pwd -P); echo ${d%/p4/common}) DownloadsDir="$HxDepots/downloads" DownloadsDirNew="$DownloadsDir/new" msg " HxDepots $HxDepots DownloadsDir= $DownloadsDir DownloadsDirNew= $DownloadsDirNew " return 0 } #------------------------------------------------------------------------------ # Function: run ($cmd, $desc, $showOutput) # # Runs a command, with optional description, showing command line to execute # and optionally also the output, and capturing and returning the exit code. # # Input: # $1 - Command and arguments to execute. Defaults to 'echo'. # $2 - Optional message to display describing what the command is doing. # $3 - Numeric flag to show output; '1' indicates to show output, 0 to # suppress it. #------------------------------------------------------------------------------ function run () { local cmd="${1:-echo}" local desc="${2:-}" local -i showOutput="${3:-1}" local -i exitCode= local cmdLog cmdLog="$(mktemp run.XXXXXXXXXXX.log)" [[ -n "$desc" ]] && msg "$desc" msg "Executing: $cmd" eval "$cmd" > "$cmdLog" 2>&1 exitCode=$? if [[ "$showOutput" -eq 1 ]]; then echo "EXIT_CODE: $exitCode" >> "$cmdLog" cat "$cmdLog" fi /bin/rm -f "$cmdLog" return "$exitCode" } #------------------------------------------------------------------------------ # Function: usage (required function) # # Input: # $1 - style, either -h (for short form) or -man (for man-page like format). # The default is -h. # # $2 - error message (optional). Specify this if usage() is called due to # user error, in which case the given message displayed first, followed by the # standard usage message (short or long depending on $1). If displaying an # error, usually $1 should be -h so that the longer usage message doesn't # obscure the error message. # # Sample Usage: # usage # usage -man # usage -h "Incorrect command line usage." # # This last example generates a usage error message followed by the short # '-h' usage summary. #------------------------------------------------------------------------------ function usage { declare style=${1:--h} declare errorMessage=${2:-Unset} if [[ $errorMessage != Unset ]]; then echo -e "\\n\\nUsage Error:\\n\\n$errorMessage\\n\\n" >&2 fi echo "USAGE for sdp_upgrade.sh v$Version: sdp_upgrade.sh [-y] [-L <log>|off] [-D] or sdp_upgrade.sh -h|-man " if [[ $style == -man ]]; then echo -e "DESCRIPTION: This script upgrades Perforce Helix Server Deployment Package (SDP) from SDP 2020.1 to the version included in the latest SDP version, SDP $SDPTargetMajorVersion. == Pre-Upgrade Planning == This script will upgrade the SDP if the pre-upgrade starting SDP version is SDP 2020.1 or later, including any/all patches of SDP 2020.1. If the current SDP version is older than 2020.1, it must first be upgraded to SDP 2020.1 using the SDP Legacy Upgrade Guide. For upgrading from pre-20.1 versions dating back to 2007, in-place or migration-style upgrades can be done. See: https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/doc/SDP_Legacy_Upgrades.Unix.html The SDP should always be upgraded to the latest version first before Helix Core binaries p4d/p4broker/p4p are upgraded using the SDP upgrade.sh script. Upgrading the SDP first ensures the version of the SDP you have is compatible with the latest versions of p4d/p4broker/p4p/p4, and will always be compatible with all supported versions of these Helix Core binaries. When this script is used, i.e. when the current SDP version is 2020.1 or newer, the SDP upgrade procedure does not require downtime for any running Perforce Helix services, such as p4d, p4broker, or p4p. This script is safe to run in environments where live p4d instances are running, and does not require p4d or other services to be stopped or upgraded. Upgrade of the SDP is cleanly separate from the upgrade the Helix Core binaries. The upgrade of the SDP can be done immediately prior to Helix Core upgrades, or many days prior. This script will upgrade the SDP on a single machine. If your Perforce Helix topology has multiple machines, the SDP can be upgraded on all machines in any order, as their is no cross-machine dependency requiring the SDP to be the same version. (The order of upgrade of Helix Core services and binaries such as p4d in global topologies with replicas and edge servers does matter, but is outside the scope of this script). Planning Recap: 1. The SDP can be upgraded without downtime when this script is used, i.e. when the SDP version is 2020.1 or later. 2. Upgrade SDP on all machines, in any order, before upgrading p4d and other Helix binaries. == Acquiring the SDP Package == This script is part of the SDP package (tarball). It can be run from an extracted tarball directory if the SDP tarball has already been downloaded and extracted. Acquiring the SDP tarball manually supports operation in environments that lack outbound internet acess. This individual script can also be downloaded independently and used to acquire the SDP tarball if outbound internet access over port 443 for HTTPS is available. If the SDP tarball is extracted manually, it should be extracted such that the 'sdp' directory appears as <HxDepots>/downloads/new/sdp, where is <HxDepots> defaults to /hxdepots. To determine the value for <HxDepots> at your site, run this command on your server machine: bash -c \"{ cd /p4/common; d=\$(pwd -P); echo \${d%/p4/common}; }\" == Preflight Checks == Prior to upgrading, preflight checks are performed to ensure the upgrade can be completed successfully. If the preflight checks fail, the upgrade will not start. Preflight Checks: Check 1: The existing SDP version is verified to be SDP 2020.1+. Check 2: The existing verify_sdp.sh script in the current, pre- upgrade SDP is executed as part of its preflight checks. This executes many detailed checks to ensure the SDP is healthy prior to the upgrade. Check 3: The /p4/common/bin/p4_vars is checked to confirm that it can be upgraded. Check 4: All /p4/common/config/p4_N.vars files are checked to confirm they can be upgraded. == Upgrade Processing == Step 1: Acquire new SDP. If this script is executed from an extracted SDP tarball, nothing is done for this step. This script determines if it executed from an unpacked SDP tarball by checking if this exists in the appropriate post-extraction directory. Otherwise, the SDP tarball is acquired from this URL with a 'curl' command: $SDPTarballURL After acquiring the SDP tarball, it is extracted to the same location as it would have been done with manual acquisition. That is, it is extracted such that the 'sdp' directory at the root of the tarball appears in a structure such as: /hxdepots/new/sdp Step 2: Backup The existing SDP /p4/common structure is backed up to /hxdepots/p4/sdp/common.bak.<YYYY-MM-DD>. Step 3: Generate the SDP Environment File Regenerate the SDP general environment file, /p4/common/bin/p4_vars. The template is /p4/common/config/p4_vars.template. Step 4: Generate the SDP Instance Files Regenerate the SDP instance environment files for all instances based on the new template. The template is /p4/common/config/instance_vars.template. For Steps 3 and 4, the re-generation logic will preserve current settings. If upgrading from SDP r20.1, any custom logic that exist below the '### MAKE LOCAL CHANGES HERE' tag will be split it separate files. Custom logic in p4_vars will be moved to /p4/common/site/config/p4_vars.local. Custom logic in p4_N.vars files will be moved to /p4/common/site/config/p4_N.vars.local. Note: Despite these changes, the mechanism for loading the SDP shell environment remains unchanged since 2007, so it looks like: \$ source /p4/common/bin/p4_vars N Changes to the right-side of assignments for specific are preserved for all defined SDP settings. For p4_vars, preserved settings are: - OSUSER - KEEPLOGS - KEEPCKPS - KEEPJNLS For instance_vars files, preserved settings are: - MAILTO - MAILFROM - P4USER - P4MASTER_ID - SSL_PREFIX - P4PORTNUM - P4BROKERPORTNUM - P4MASTERHOST - P4MASTERHOST - PROXY_TARGET - PROXY_PORT - P4DTG_CFG - SNAPSHOT_SCRIPT - SDP_ALWAYS_LOGIN - SDP_AUTOMATION_USERS - SDP_MAX_START_DELAY_P4D - SDP_MAX_START_DELAY_P4BROKER - SDP_MAX_START_DELAY_P4P - SDP_MAX_STOP_DELAY_P4D - SDP_MAX_STOP_DELAY_P4BROKER - SDP_MAX_STOP_DELAY_P4P - VERIFY_SDP_SKIP_TEST_LIST - The 'umask' setting. - KEEPLOGS (if set) - KEEPCKPS (if set) - KEEPJNLS (if set) Note that the above list excludes any values that are calculated. Step 5: Remove Deprecated Files Deprecated files will be purged from the SDP structure. The list of files to be cleaned are listed in this file: /p4/common/sdp_upgrade/deprecated_files.txt Paths listed in this file are relative to the '/p4' directory (or more accurately the SDP Install Root directory, which is always '/p4' except in SDP test production environments). == Post-Upgrade Processing == This script provide guidance on any post-processing steps. This may include upgrades to crontabs. OPTIONS: -y Specify the '-y' option to confirm that the SDP upgrade should be done. By default, this script operates in No-Op mode, meaning no actions that affect data or structures are taken. Instead, commands that would be run are displayed. This mode can be educational, showing various steps that will occur during an actual upgrade. -p Specify '-p' to halt processing after preflight checks are complete, and before actual processing starts. By default, processing starts immediately upon successful completion of preflight checks. -L <log> Specify the log file to use. The default is /tmp/sdp_upgrade.<timestamp>.log The special value 'off' disables logging to a file. This cannot be specified if '-y' is used. -d Enable debugging verbosity. -D Set extreme debugging verbosity. HELP OPTIONS: -h Display short help message -man Display man-style help message FILES AND DIRECTORIES: Name: SDPCommon Path: /p4/common Notes: This sdp_upgrade.sh script updates files in and under this folder. Name: HxDepots Default Path: /hxdepots Notes: The folder containing versioned files, checkpoints, and numbered journals, and the SDP itself. This is commonly a mount point. Name: DownloadsDir Default Path: /hxdepots/downloads Name: SDPInstallRoot Path: /p4 EXAMPLES: Example 1: Prelight check only: sdp_upgrade.sh -p Example 2: Preview mode: sdp_upgrade.sh Example 3: Live operation: sdp_upgrade.sh -y LOGGING: This script generates a log file, /tmp/sdp_upgrade.<timestamp>.log by default. See the '-L' option above. CUSTOM PRE- AND POST- UPGRADE AUTOMATION HOOKS: This script can execute custom pre- and post- upgrade scripts. This can be useful to incorporate site-specifc elements of an SDP upgrade. If the file /p4/common/site/upgrade/pre-sdp_upgrade.sh exists and is executable, it will be executed as a pre-upgrade script. If the file /p4/common/site/upgrade/post-sdp_upgrade.sh exists and is executable, it will be executed as a post-ugprade script. Pre- and post- upgrade scripts are passed the '-y' flag to confirm actual processing is to be done. Custom scripts are expected to operate in preview mode by default, taking no actions that affect data (just as this script behaves). If this sdp_upgrade.sh script is given the '-y' flag, that option is passed to the custom script as well, indicating active processing should occur. Pre- and post- upgrade scripts are expected to exit with a zero exit code to indicate success, and non-zero to indicate failure. The custom pre-upgrade script is executed after standard preflight checks complete successfully. If the '-I' flag is used to ignore the status of preflight checks, the custom pre-upgrade script is executed regardless of the status of preflight checks. Preflight checks are executed before actual upgrade processing commences. If a custom pre-upgrade script indicates a failure, the overall upgrade process aborts. The post-upgrade custom script is executed after the main SDP upgrade is successful. Success or failure of pre- and post- upgrade scripts is repored in the log. These scripts do not require independent logging, as all standard and error output is captured in the log of this sdp_upgrade.sh script. TIP: Be sure to fully test custom scripts in a test environment before incorporating them into an upgrade on production systems. EXIT CODES: An exit code of 0 indicates no errors were encountered during the upgrade. A non-zero exit code indicates the upgrade was aborted or failed. " fi exit 1 } #------------------------------------------------------------------------------ # Function: terminate function terminate { # Disable signal trapping. trap - EXIT SIGINT SIGTERM [[ "$Log" == "off" ]] || msg "\\nLog is: $Log\\n${H1}\\n" # With the trap removed, exit. exit "$ErrorCount" } #============================================================================== # Command Line Processing declare -i shiftArgs=0 set +u while [[ $# -gt 0 ]]; do case $1 in (-h) usage -h;; (-p) PreflightOnly=1;; (-n) NoOp=1;; (-man) usage -man;; (-L) Log="$2"; shiftArgs=1;; (-d) Debug=1;; (-D) Debug=1; set -x;; # Debug; use 'set -x' mode. (-*) usage -h "Unknown command line option ($1).";; (*) export SDP_INSTANCE=$1;; esac # Shift (modify $#) the appropriate number of times. shift; while [[ $shiftArgs -gt 0 ]]; do [[ $# -eq 0 ]] && usage -h "Incorrect number of arguments." shiftArgs=$shiftArgs-1 shift done done set -u #============================================================================== # Command Line Verification [[ "$Log" == "off" && "$NoOp" -eq 0 ]] && \ usage -h "Disabling logging with '-L off' is not with '-y'." #============================================================================== # Main Program trap terminate EXIT SIGINT SIGTERM [[ "$Log" == "Unset" ]] && Log="/tmp/sdp_upgrade.$(date +'%Y%m%d-%H%M').log" if [[ "$Log" != "off" ]]; then [[ -e "$Log" ]] && bail "Log file already exists: $Log\\nAborting.\\n" if ! touch "$Log"; then BadLog="$Log" Log="off" bail "Couldn't touch log file [$BadLog]. Aborting." fi # Redirect stdout and stderr to a log file. exec > >(tee "$Log") exec 2>&1 msg "${H1}\\nLog is: $Log" fi ThisUser="$(id -n -u)" msg "$ThisScript v$Version Starting SDP upgrade as $ThisUser@${HOSTNAME%%.*} at $(date +'%a %Y-%m-%d %H:%M:%S %Z') with this command line:\\n$CmdLine" msg "\\nIf you have any questions about the output from this script, contact support@perforce.com." if do_preflight_checks; then msg "\\nAll preflight checks were successful." if [[ "$PreflightOnly" -eq 1 ]]; then msg "\\nExiting early after successful preflight checks due to '-p'." exit 0 fi else bail "Aborting due to failed preflight checks. The current SDP remains unchanged." fi msg "${H2}\\nUpgrading SDP." if [[ "$ErrorCount" -eq 0 && "$WarningCount" -eq 0 ]]; then msg "\\n${H1}\\n\\nSDP Upgrade Completed OK." elif [[ "$ErrorCount" -eq 0 ]]; then msg "\\n${H1}\\n\\nSDP Upgrade Completed with no errors and $WarningCount warnings." else msg "\\n${H1}\\n\\nSDP Upgrade FAILED, with $ErrorCount errors and $WarningCount warnings. Review the output above." fi # See the terminate() function, which is really where this script exits. exit "$ErrorCount"
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#53 | 31209 | C. Thomas Tyler | Fixed cosmetic typo. | ||
#52 | 31182 | C. Thomas Tyler |
Adapted opt_perforce_sdp_backup service to work with SELinux in enforcing mode. Added logic from sdp_upgrade.sh that installs SDP the backup service into install_sdp.sh. With this adjustment, the service now specifies the "on disk" location of the file; no symlinks are allowed in the absolute path to the script (to keep SELinux happy). For clarity, 'User=root' was added to the systemd service file for the backup utility. |
||
#51 | 31178 | C. Thomas Tyler | Tweaked error message in sdp_upgrade.sh; non-functional change. | ||
#50 | 31082 | C. Thomas Tyler |
Fixed bug with sdp_upgrade.sh munging values during upgrade for P4USER, etc. Fixed SDP-1183. |
||
#49 | 31050 | C. Thomas Tyler |
Added script to back SDP OS Package Structure. Modified sdp_upgrade.sh to install a systemd oneshot service to call this script if operating on a system using the SDP OS Package Structure (i.e. a systemd where /opt/perforce/helix-sdp exists). |
||
#48 | 31048 | C. Thomas Tyler | Adjustment to create `/opt/perforce/helix-sdp/backup` directory. | ||
#47 | 31045 | C. Thomas Tyler |
Terminology change; now referring to two structures as "SDP Classic Structure" and "SDP OS Package Structure". |
||
#46 | 31033 | C. Thomas Tyler | sdp_upgrade.sh: Refined logic extracting old values during upgrades. | ||
#45 | 31010 | C. Thomas Tyler |
Fixed issue where values containing equal signs (e.g. PROXY_V_FLAGS using '-v name=value' settings) resulted in a bad substitution. |
||
#44 | 31000 | C. Thomas Tyler | Added SDP_ROOT setting for future usage. | ||
#43 | 30984 | C. Thomas Tyler |
Enhanced sdp_upgrade.sh to work with both the new Package Structure /opt/perforce/helix-sdp and the legacy SDP structure when doing upgrades of /p4/common and /p4/sdp. If the Package Structure is already used, this will continue using it. If the legacy strucutre is in use, it will continue using that. As the helix-sdp package is not yet available, the Package Structure will exist only if the new install_sdp.sh script was used for the install (or if the customer is one of a few early adopters of the new structure). This version, to be released with SDP 2024.2, will NOT migrate from the legacy structure to the Package structure. Doing so requires running as root; that change is targeted for release in SDP 2025.1. Also removed the dependency on perl from sdp_upgrade.sh. Addressed suggestions from newer version of ShellCheck. #review-30985 |
||
#42 | 30924 | C. Thomas Tyler |
Fixed an obscure "one day a month" bug that caused sdp_upgrade.sh to fail to detect the SDP version from the version file if released on the 20th of any given month. |
||
#41 | 30911 | C. Thomas Tyler | Adjusted format of generated files in sdp_ugprade.sh for release. | ||
#40 | 30509 | C. Thomas Tyler |
Tweaked proxy handling to generate a cleaner command line (as seen in ps -ef), eliminating null or duplicate values for proxy.monitor.level setting. This change makes p4d_base more robust even inf the instance vars settings are slightly misconfigured, e.g. a null value for PROXY_MON_LEVEL. #review-30510 |
||
#39 | 30508 | C. Thomas Tyler |
sdp_upgrade.sh did not preserve PROXY_PORT setting. Fixed. |
||
#38 | 30382 | C. Thomas Tyler | Updated SDP_INSTANCE_VARS_FORMAT version to 1.12. | ||
#37 | 30223 | C. Thomas Tyler |
Changed so 'p4d -cshow' calls in SDP shell environment mechanism use a copy of db.config to avoid issues with database locking. #review-30224 |
||
#36 | 29945 | C. Thomas Tyler | Bumped format of instance vars file. | ||
#35 | 29746 | C. Thomas Tyler |
Moved proxy '-e 3072' flag from p4p_base to Instance Vars file so it can be changed on a per-instance basis. It is now part of the def'n of PROXY_V_FLAGS. Moved PROXY_MON_LEVEL from p4_vars to Instance Vars file so it can be changed on a per-instance basis. Updated format settings in sdp_upgrade.sh, and added PROXY_MON_LEVEL to list of user settings to be preserved during SDP upgrades. #review-29747 |
||
#34 | 29609 | C. Thomas Tyler | Updated data format tags per SDP relesae process docs. | ||
#33 | 29491 | C. Thomas Tyler | Fixed bug where SDP ugprade disabled parallel checkpoints. | ||
#32 | 29420 | C. Thomas Tyler |
For parallel checkpoints, provide a way to specify '-N' parallel threads. #review-29421 |
||
#31 | 29396 | C. Thomas Tyler |
Doc improvements to SDP Instance Vars file re: MAILTO/MAILFROM settings. Tweaked Shellcheck SC<NNNN> tags to re-achieve shellcheck compliance. #review-29397 @daniel_ferrara |
||
#30 | 29355 | C. Thomas Tyler |
Added 'perl' as a required utility, capturing the fact that a dependency on perl now exists. |
||
#29 | 29243 | C. Thomas Tyler |
Fixed issue with sdp_upgrade.sh where extraction of values with a '=' in the value were not extracted correctly. For example, the p4_N.vars file could contain a value like so: export PROXY_V_FLAGS="-v net.autotune=1" This was parsed with: cut -d '=' -f 2, returning incomplete text: -v net.autotune (sans the "=1" on the right side). The fix was done by changing, in some places: cut -d '=' -f 2 with a more robust expression: perl -pe 's|^.*?=||g' In some cases where the value to the right of the '=' was reliably simple, e.g. for something like SDP_INSTANCE_VARS_FORMAT=1.5, the simpler 'cut' expression was left in place. The perl expression is used in places where the right-side of the assignment could possibly be a more complex value, possibly including an '=' sign. Note: sed was explored, but Perl was ultimately selected as the 'sed' regular expressions, even extended ones with '-E', do not support lazy regex macthing, as needed for this expression. |
||
#28 | 29232 | C. Thomas Tyler |
Added regression test for new parallel checkpoint feature. #review-29220 |
||
#27 | 29116 | C. Thomas Tyler | Fixed value for P4MASTERHOST on broker-only or proxy-only hosts. | ||
#26 | 29083 | C. Thomas Tyler |
Fixed truncation of custom site/config files if sdp_ugprade.sh is run multiple times. #review-29084 |
||
#25 | 29081 | C. Thomas Tyler |
Reduced an arbitrary 999999999999 lines in 'grep -A' calls to 9999999. This fixes an issue on older OS's where the grep with the larger number of 9's fails. #review-29082 |
||
#24 | 28918 | C. Thomas Tyler |
sdp_ugprade.sh v1.6.6: * Doc changes only; no functional change. * Fixed doc issue where docs generated with '-man' on a non-SDP machine have bogus content. * Added doc content re: upgrade of SDP with NFS sharing of HxDepots. * Enhanced content in SDP Upgrade Planning section. * Fixed typos in docs. #review-28919 |
||
#23 | 28900 | C. Thomas Tyler |
Fixed issue where sdp_upgrade.sh could go interactive if perms on certain files are not as expected. |
||
#22 | 28771 | C. Thomas Tyler |
Changed email address for Perforce Support. #review-28772 @amo @robert_cowham |
||
#21 | 28569 | C. Thomas Tyler |
Fixed an issue where some preflight failures could be ignored, changing return code for do_preflight_checks() from 0 to "$ErrorCount". Also, changes in behavior to undocumented '-I' flag: If '-I' is specified, the ErrorCount is reset to zero after preflight checks, so we don't get a FAILURE indication if the upgrade succeeded despite ignored warnings. This also allows custom post-processing scripts to execute upon successful completion of an upgrade with ignored warnings. Any new errors subsequent to preflight checks will result in a FAILURE message. #review-28570 |
||
#20 | 28568 | C. Thomas Tyler |
Corrected grammer in an error message. Non-functional change. |
||
#19 | 28567 | C. Thomas Tyler |
Fixed a typo; executee -> execute. Non-functional change. |
||
#18 | 28355 | C. Thomas Tyler |
Corrected custom logic extraction issues found during code review/testing. #review-28356 |
||
#17 | 28343 | C. Thomas Tyler |
Added documented-but-missing logic for extracting custom logic from SDP shell environment files. #review-28344 |
||
#16 | 28341 | C. Thomas Tyler | Bumped version for last change. | ||
#15 | 28340 | Andy Boutte | small documentation enhancements in sdp_upgrade.sh | ||
#14 | 28273 | C. Thomas Tyler | Corrected quotes display in an error message. | ||
#13 | 28251 | C. Thomas Tyler | Tweak to clarify that successful preview upgrades didn't do the real upgrade. | ||
#12 | 28249 | C. Thomas Tyler | Corrected substittuion for admin P4USER value. | ||
#11 | 28247 | C. Thomas Tyler |
Corrected detection of P4MASTERHOST setting. Fixed issue with substitutions occuring in comments, impacting readability of config files. Added step to backup /p4/sdp. Added step to update /p4/sdp. |
||
#10 | 28235 | C. Thomas Tyler | Completed implementation of custom pre- and post- upgrade hooks. | ||
#9 | 28234 | C. Thomas Tyler |
sdp_upgrade.sh v1.3.3: * Removed command line verification restraint for '-p' due to preview mode being default. * Changed default log directory from /tmp to ~ (home directory). * Silence a warning about /p4/metrics (part of P4Prometheus) being ignored. * If errors and/or warnings occur, display a 'grep' command that can be used to list them. * Enhanced error message for failure mode where the SDP upgrade fails due to failure to backup /p4/common, e.g. due to root-owned files. * Corrected message related to deprecated file removal. |
||
#8 | 28231 | C. Thomas Tyler |
sdp_upgrade.sh v1.3.0: * Added check that old SDP version is 2020.1+. * Added old and new SDP version in output. * Enhanced substitution logic to prevent unintened substitutions. * Added 'umask' preservation per the spec. |
||
#7 | 28223 | C. Thomas Tyler | Doc correction; non-functional change. | ||
#6 | 28214 | C. Thomas Tyler | sdp_ugprade.sh v1.2.0: QA-enablement version. | ||
#5 | 28197 | C. Thomas Tyler | Partially functional version of sdp_upgrade.sh, with doc updates. | ||
#4 | 28177 | C. Thomas Tyler | Incremental SDP upgrade work. | ||
#3 | 28173 | C. Thomas Tyler | WIP checkin. | ||
#2 | 28140 | C. Thomas Tyler |
Refined sdp_upgrade.sh; this is still a non-functional work in progress version, with expanded documentation. Added file format version settings into p4_vars template and instance-specific p4_vars files. |
||
#1 | 27960 | C. Thomas Tyler |
Added sdp_upgrade.sh script. This is a doc-only version with no functionality. |