#------------------------------------------------------------------------------ # Instance specific variables are set or calculated in this file. This file # is not intended to be sourced directly. It is sourced when the main SDP # environment file, /p4/common/bin/p4_vars, is sourced. This p4_N.vars file # is sourced as in the following example, where N is teh SDP instance name, # with a value of 1 by default: # # source /p4/common/bin/p4_vars N # # A line like the above can optionally be added in the ~/.bashrc file # of the perforce user on the Linux system. This is recommended so that # the SDP Environment is loaded properly during initial login. # #------------------------------------------------------------------------------ # When editing values in this file keep in mind the following: # # * Do not change values for which the comments say 'DO NOT CHANGE'. # * Do not add code or logic of any kind. # * Limit changes strictly to change the right-side of assignments (i.e. text # to the right of the '=' sign). # * Be careful not to introduce whitespace characters on either side of # the '=' sign. # # If custom logic is needed, e.g. to add host-specific behaviors or configure # multipe active brokers with different ports, add that custom logic in custom # local files that appear in the /p4/common/site directory. Files in the # 'site' directory will not be not affected by SDP upgrades. Also, files in the # 'site' directory are inherently custom and not officially supported by # Perforce Technical Support. # # If needed, custom logic goes into these files: # * /p4/common/site/config/p4_vars.local - Global/Common # * /p4/common/site/config/p4_N.vars.local - Instance-specifc (N=instance). # # This file contains comments of the form: # shellcheck disable=SCNNNN. # DO NOT CHANGE OR MOVE THESE COMMENT LINES. #------------------------------------------------------------------------------ # Disable shellcheck requirement for shebang line, as this file is sourced # in (from p4_vars) rather than executed as a script. # shellcheck disable=SC2148 #------------------------------------------------------------------------------ # shellcheck disable=SC2034 # SDP_INSTANCE_VARS_FORMAT defines the version of the format of this file, # used when the SDP is upgraded. DO NOT CHANGE SDP_INSTANCE_VARS_FORMAT. SDP_INSTANCE_VARS_FORMAT=1.11 # This file is processed by mkdirs.sh to update REPL_* values as appropriate. # It can subsequently be edited if required. # Various scripts send email to $MAILTO. This can contain comma-delimited list # of email addresses (no spaces). The addresses specified here are generally # those of individual Perforce Helix administrators, and/or to an email # distribution list of administrators. export MAILTO=REPL_MAILTO # Specify the email address from which emails are sent in $MAILFROM. # This must be exactly one email address. The value typically looks something # like P4Admin@example.com. # NOTE: Many modern email services, such as Office365 and Google Workspaces, # may require that the domain name in the email address from which emails are # sent be the correct domain for your company. For example, if your company's # domain for email is example.com, the email server may require that any emails # sent from that domain also end in @example.com. export MAILFROM=REPL_MAILFROM # This is the P4USER that is the super user. This user must have a unlimited # ticket valid on the master Perforce Helix server machine. export P4USER=REPL_ADMINUSER # Service user definition. DO NOT CHANGE P4SERVICEUSER. export P4SERVICEUSER=svc_${SERVERID} # P4MASTER_ID is server.id of Master for this instance export P4MASTER_ID=REPL_MASTER_ID # If this instance uses SSL, set SSL_PREFIX to ssl:, ssl4:, ssl6:, # ssl46:, or ssl64:. See: https://portal.perforce.com/s/article/1180 # The trailing colon is required. export SSL_PREFIX=REPL_SSLPREFIX # Set the numeric portion of the P4PORT value used for p4d. export P4PORTNUM=REPL_P4PORT # This P4PORT value is calculated. DO NOT CHANGE P4PORT. export P4PORT=${SSL_PREFIX}${P4PORTNUM} # Set the value for P4BROKERPORT to Unset if the broker is not # used. export P4BROKERPORTNUM=REPL_P4BROKERPORT # This is the broker port. To test broker connections, you # can use a command like: p4 -p $P4BROKERPORT info # DO NOT CHANGE P4BROKERPORT. export P4BROKERPORT=${SSL_PREFIX}${P4BROKERPORTNUM} # These $P4D_FLAGS show when using 'ps' to scan the process table. # Other environment variables and 'p4 configure' settings can affect # p4d even if not listed on the command line. # DO NOT CHANGE P4D_FLAGS. export P4D_FLAGS="-p $P4PORT -r $P4ROOT -J $P4JOURNAL -L $P4LOG -q -d --pid-file" # Default values of the following - may be overwritten below # P4MASTERHOST=DNS Name (or IP address) of the commit server # for this instance. If DNS is not available, /etc/hosts # entries may be used to simulate DNS. export P4MASTERHOST=REPL_P4MASTERHOST # The P4MASTERPORT is the P4PORT value of the commit server, used # by replicas, proxies, and standalone brokers. This incorporates # teh DNS name of the commit server. # DO NOT CHANGE P4MASTERPORT. export P4MASTERPORT=${SSL_PREFIX}${P4MASTERHOST}:${P4PORTNUM} # P4REPLICA is calculated. DO NOT CHANGE P4REPLICA. export P4REPLICA=FALSE # SHAREDDATA defaults FALSE, but is set to TRUE on replica servers that share their /hxdepots # volume with their P4TARGET server - as per lbr.replication configurable # DO NOT CHANGE SHAREDDATA. export SHAREDDATA=FALSE # SERVERID is defined in /p4/N/root/server.id. DO NOT CHANGE SERVERID. if [[ -n "$SERVERID" && "$SERVERID" != "$P4MASTER_ID" ]]; then export P4REPLICA=TRUE TmpP4ROOT= if [[ -f "$P4ROOT/db.config" && ! -f "$P4ROOT/P4ROOT_not_usable.txt" ]]; then TmpP4ROOT=$(mktemp -d "$P4TMP/tmp.p4root.XXXXXX") cp "$P4ROOT/db.config" "$TmpP4ROOT/." # Use egrep because it works where we need it to. Shellcheck suggests # using 'grep -E' instead. # shellcheck disable=SC2196 targetServerPort=$("$P4DBIN" -r "$TmpP4ROOT" -cshow | egrep "^$SERVERID: P4TARGET = ") targetServerPort=${targetServerPort##* = } # Use 'echo' w/o quotes to remove leading/trailing whitespace. # shellcheck disable=SC2116 disable=SC2086 targetServerPort=$(echo $targetServerPort) else targetServerPort= fi if [[ -n "$targetServerPort" ]]; then export P4MASTERPORT="$targetServerPort" if [[ "$targetServerPort" == *":"* ]]; then # strip off any trailing ':.....' element (e.g., ':1666') export P4MASTERHOST="${targetServerPort%:*}" # if P4TARGET includes ssl, also need to strip off ssl: from front export P4MASTERHOST="${P4MASTERHOST#*:}" fi fi repStyle="readonly" if [[ -f "$P4ROOT/db.config" && ! -f "$P4ROOT/P4ROOT_not_usable.txt" ]]; then repStyle=$("$P4DBIN" -r "$P4ROOT" -cshow|"$GREP" "^$SERVERID: lbr.replication = ") repStyle=${repStyle##* = } # Use 'echo' w/o quotes to remove leading/trailing whitespace. # shellcheck disable=SC2116 disable=SC2086 repStyle=$(echo $repStyle) fi if [[ $repStyle == "shared" ]]; then # Used by p4verify.sh among others export SHAREDDATA=TRUE fi [[ -n "$TmpP4ROOT" ]] && rm -rf "$TmpP4ROOT/" fi # Proxy settings export PROXY_TARGET=${SSL_PREFIX}${P4MASTERHOST}:${P4BROKERPORTNUM} export PROXY_PORT=${SSL_PREFIX}$((P4BROKERPORTNUM+1)) # Set Proxy monitoring level to 3 in order to monitor all traffic for all operations export PROXY_MON_LEVEL=3 export PROXY_V_FLAGS="-e 3072 -v proxy.monitor.level=${PROXY_MON_LEVEL:-3} -v net.autotune=1" # P4DTG Settings: export P4DTG_CFG=$P4SERVER # If SNAPSHOT_SCRIPT is defined and set to the path of an executable # script, daily_checkpoint.sh will call the referenced scrip after # checkpoints are created. It is expected that the called custom script # will create a snapshot or perform some other backup activity. # The logic below allows for the called SNAPSHOT_SCRIPT to run only # on the master server. # # A sample script to enable snapshots on an AWS master # server is provided as: /p4/common/cloud/aws/bin/snapshot.sh # if [[ -n "$SERVERID" && "$SERVERID" == "$P4MASTER_ID" ]]; then # This snapshot script is exectued only on the master server. export SNAPSHOT_SCRIPT= else # Leave this value empty. export SNAPSHOT_SCRIPT= fi # Set VERIFY_SDP_SKIP_TEST_LIST as an alternative to passing in a lists of tests # using the '-skip' flag to the verify_sdp.sh script. The command line flag to # the script is more appropriate if a test is to be skipped temporarily, while # setting the VERIFY_SDP_SKIP_TEST_LIST variable is better for making a permanent # exception (e.g. skipping crontab checks if some other scheduler is used). # # The value is a comma-delimited list of tests to skip, as defined in the # documentation for verify_sdp.sh. For more info, run: verify_sdp.sh -man export VERIFY_SDP_SKIP_TEST_LIST= export SDP_ALWAYS_LOGIN=0 # The SDP_MAX_START_DELAY_* settings are numeric values that define the maximum # number of second to wait for services to start before considering the startup # a failure in various SDP scripts. Successful start is indicated by being # responsive to a 'p4 info' command and the appropriate port for each service. export SDP_MAX_START_DELAY_P4D=120 export SDP_MAX_START_DELAY_P4BROKER=60 export SDP_MAX_START_DELAY_P4P=60 # The SDP_MAX_STOP_DELAY_* settings are numeric values that define the maximum # number of second to wait for services to stop before considering the shutdown # a failure in various SDP scripts. Successful stop is indicated by removal of # the server.pid file for p4d, and lack of active pids for p4broker/p4p. These # values are typically never used. Note that 'p4d' does not have a max delay. export SDP_MAX_STOP_DELAY_P4BROKER=600 export SDP_MAX_STOP_DELAY_P4P=600 # Set SDP_AUTOMATION_USERS to a comma-delimited list of Perforce user accounts # to login when the 'p4login' script is used with the '-automation' flag. This # will normally be a list of users that operate trigger scripts, such as the # 'swarm' user if Helix Swarm is used. Typically such users will have long-term # tickets. For more info, run: p4login -man export SDP_AUTOMATION_USERS="swarm" # Set DO_PARALLEL_CHECKPOINTS=0 to disable parallel checkpoints. # # Set DO_PARALLEL_CHECKPOINTS=N to enable parallel checkpoints, where N # is a positive integer indicating the number of parallel threads to use. # As a special case, setting DO_PARALLEL_CHECKPOINTS=1 is the same as # setting DO_PARALLEL_CHECKPOINTS=4. The N value is passed to the p4d # with the '-N' parameter when doing checkpoint create, dump, and # replay options with 'p4d -jcp', 'p4d -jdp', and 'p4d -jrp', # respetively. # # If parallel checkpoints are enabled: # * The live_checkpoint.sh will create live checkpoints using 'p4d -jcp', and # replay using 'p4d -jrp'. # * The daily_checkpoint.sh will create offline checkpoints using 'p4d -jdp', # and replay using 'p4d -jrp'. # * The recover_offline_db.sh will look for checkpoint directories rather # than singular checkpoint files, and replay with 'p4d -jrp'. # * The refresh_P4ROOT_from_offline_db.sh replays using 'p4d -jrp'. # # The db.checkpoint.threads configurable is ignored with the scripts, as # the '-N' parameter overrides configurable. # # Parallel checkpoints became available in p4d 2022.2. This setting is # ignored if the server version is lower than that. export DO_PARALLEL_CHECKPOINTS=0 umask 0026 #------------------------------------------------------------------------------ # Custom Local Changes #------------------------------------------------------------------------------ # Any instance-specific local customizations should appear in the file sourced # below in the /p4/common/site structure, which contains site-specific that # are not part of the SDP package. if [[ -d "/p4/common/site/config/$P4SERVER.vars.local.d" ]]; then # shellcheck disable=SC1090 for f in /p4/common/site/config/$P4SERVER.vars.local.d/*; do source $f; done fi if [[ -r "/p4/common/site/config/$P4SERVER.vars.local" ]]; then # shellcheck disable=SC1090 source "/p4/common/site/config/$P4SERVER.vars.local" fi
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#38 | 30915 | C. Thomas Tyler |
Released SDP 2024.1.30913 (2024/11/20). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#37 | 30388 | C. Thomas Tyler |
Released SDP 2024.1.30385 (2024/06/11). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#36 | 30297 | C. Thomas Tyler |
Released SDP 2023.2.30295 (2024/05/08). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#35 | 29954 | C. Thomas Tyler |
Released SDP 2023.1.29949 (2023/12/01). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#34 | 29891 | C. Thomas Tyler |
Released SDP 2023.1.29699 (2023/07/11). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#33 | 29612 | C. Thomas Tyler |
Released SDP 2023.1.29610 (2023/05/25). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#32 | 29443 | C. Thomas Tyler |
Released SDP 2022.2.29441 (2023/02/27). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#31 | 29401 | C. Thomas Tyler |
Released SDP 2022.2.29399 (2023/02/06). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#30 | 29252 | C. Thomas Tyler |
Released SDP 2022.2.29250 (2022/12/08). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#29 | 29143 | C. Thomas Tyler |
Released SDP 2022.1.29141 (2022/10/29). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#28 | 28651 | C. Thomas Tyler |
Released SDP 2021.2.28649 (2022/03/03). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#27 | 28412 | C. Thomas Tyler |
Released SDP 2021.2.28410 (2021/11/24). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#26 | 28259 | C. Thomas Tyler |
Released SDP 2021.1.28253 (2021/11/13). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#25 | 28240 | C. Thomas Tyler |
Released SDP 2021.1.28238 (2021/11/12). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#24 | 27761 | C. Thomas Tyler |
Released SDP 2020.1.27759 (2021/05/07). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#23 | 27527 | C. Thomas Tyler |
Released SDP 2020.1.27524 (2021/02/26). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#22 | 27331 | C. Thomas Tyler |
Released SDP 2020.1.27325 (2021/01/29). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#21 | 26403 | C. Thomas Tyler |
Released SDP 2019.3.26400 (2020/03/28). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#20 | 25245 | C. Thomas Tyler |
Released SDP 2019.1.25238 (2019/03/02). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#19 | 22950 | akwan | Provide an override for difference between proxy listening port and target port | ||
#18 | 22685 | Russell C. Jackson (Rusty) | Update main with current changes from dev. | ||
#17 | 22185 | C. Thomas Tyler |
Released SDP 2017.2.22177 (2017/05/17). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#16 | 20921 | Russell C. Jackson (Rusty) | Fix that Adrian shelved on Main for ssl: issue. | ||
#15 | 20767 | C. Thomas Tyler |
Released SDP 2016.2.20755 (2016/09/29). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#14 | 20481 | C. Thomas Tyler |
Released SDP 2016.1.20460. Copy Up using 'p4 copy -r -b perforce_software-sdp-dev', with selective removal of changes related to work-in-progress files. |
||
#13 | 20390 | C. Thomas Tyler |
Released SDP 2016.1.20387. Copy Up using 'p4 copy -r -b perforce_software-sdp-dev', with selective removal of changes related to work-in-progress files. |
||
#12 | 20353 | C. Thomas Tyler |
Released SDP 2016.1.20348. Copy Up using 'p4 copy -r -b perforce_software-sdp-dev', with selective removal of changes related to work-in-progress changes. |
||
#11 | 20050 | C. Thomas Tyler |
Released: 2016.1.20028 (2016/08/03). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#10 | 19414 | C. Thomas Tyler | Released SDP/MultiArch/2016.1/19410 (2016/05/17). | ||
#9 | 18961 | C. Thomas Tyler | Released: SDP/MultiArch/2016.1/18958 (2016/04/08). | ||
#8 | 16260 | Russell C. Jackson (Rusty) |
Added P4DPORT to allow the server to start without using the HOSTIP. P4PORT still includes the HOSTIP in order to avoid issues with rpl.forward.login not working with localhost. |
||
#7 | 16259 | Russell C. Jackson (Rusty) |
Created P4MASTERPORT in instance_vars to simplify logins to the master server in the other scripts. Changed other scripts to use P4MASTERPORT Added clean up of statejcopy and checkpoints.rep directory to weekly_sync_replica so that it properly resets a replica that is using journalcopy. Moved umask to instance_vars since it wasn't being picked up when running things via crontab Removed P4REPLICANAME from instance_vars since it wasn't being used anymore. Added HOSTIP to mkdirs and to the P4PORT setting in instance vars so the server starts on a specific IP address rather than all on the server. This avoids a bug where rpl.forward.login doesn't work when logging in via localhost. |
||
#6 | 14073 | Russell C. Jackson (Rusty) |
Backed out changes that moved variables to p4_vars. The variables are intended to be in instance vars to keep everything about a particular instance in one location. It was confusing for people to see a setting in p4_vars and not understand that setting was being overridden in the instance vars. There shouldn't be any overlap between p4_vars and instance vars anymore. Also, server.id is not optional. It must exist. It is how you control whether the instance is a master or a replica. It is not set by the scripts anymore because that was also confusing people. They would try to change the role of a server by changing server.id and we previously would just overwrite their changes. Now, the SDP just reads the server.id so that the user has control over it. That doesn't confuse them since that is how our docs tells them to change a server's role. |
||
#5 | 14045 | Robert Cowham |
Move some stuff from instance_vars to p4_vars (or at least for defaults). Clarify user messages. |
||
#4 | 13908 | C. Thomas Tyler | Pushing SDP 2015.1.13906. | ||
#3 | 12443 | Russell C. Jackson (Rusty) | Added missing proxy variables that were lost in the SDP rebuild. | ||
#2 | 11919 | Russell C. Jackson (Rusty) |
Added a SERVERID variable to p4_vars and updated backup_functions to use it. Changed the location and the names of the config files so that they could live in /p4/common/config (You're welcome Tom). The files names are: p4_$INSTANCE.vars p4_$INSTANCE.p4review.cfg p4_$INSTANCE.vars will now set P4REPLICA to FALSE if SERVERID matches MASTERNAME, otherwise it is TRUE. This change means that a user must change server.id now in order to change the role of the server rather than changing the instance vars file. This makes more sense to a user that is reading the admin guide about server.id rather than overwriting the file based on a setting that isn't in the admin guide. Change mkdirs to reflect all of the above changes. |
||
#1 | 11524 | Russell C. Jackson (Rusty) | Released updated version of the SDP from Dev. | ||
//guest/perforce_software/sdp/dev/Server/Unix/p4/common/config/instance_vars.template | |||||
#3 | 11523 | Russell C. Jackson (Rusty) |
Modified P4BROKERPORTNUM to just be the port number and added P4BROKERPORT to instance_vars to be consistent with P4PORT. Also makes it easier to modify p4review.py to use P4BROKERPORT rather than P4PORT for the subject line when needed. |
||
#2 | 11490 | Russell C. Jackson (Rusty) |
Added SSL_PREFIX back and P4MASTERPORTNUM in order to support the sync_replica.sh and weekly_sync_replica.sh scripts. |
||
#1 | 11477 | Russell C. Jackson (Rusty) |
Updated to use /usr/bin/env python Added workshop header. Changed cfg to config. |
||
//guest/perforce_software/sdp/dev/Server/Unix/p4/common/cfg/instance_vars.template | |||||
#1 | 11466 | Russell C. Jackson (Rusty) |
Initial work to simplify p4_vars and remove cluster stuff. Testing of named instances surfaced some bugs that are in prod sdp, now fixed in dev. Added three triggers from RCJ SDP Moved p4review.cfg into the new /p4/common/cfg to go along with the instance_vars files. mkdirs.sh now generates an instance_p4review.cfg as well. Removed incremental p4verify to clean up a bit. It didn't support replicas and was really never used. All port settings now live in <instance>_vars file. You set what you want the ports to be in mkdirs.sh. There is no more fancy logic to try to guess what the port should be. You set it, and that is what it is. Remaining to do is to updated scripts to not need p4master_run. Saved that work for later since this is tested and works. |