p4_vars #12

  • //
  • guest/
  • russell_jackson/
  • sdp/
  • Server/
  • Unix/
  • p4/
  • common/
  • bin/
  • p4_vars
  • View
  • Commits
  • Open Download .zip Download (5 KB)
#==============================================================================
# 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
#------------------------------------------------------------------------------

# Save SHELLOPTS
_shellopts=$SHELLOPTS

# Trap unbound (undefined) varialbes, treating them as an error.
set -u

# Defaulting to Perforce for backwards compatiability with old instances vars that do not have this setting.
export OSUSER=perforce

#Defaulting the RSYNCUSER to the OSUSER. You can override it in /p4/common/bin/p4_$instance.vars
export RSYNCUSER=$OSUSER

export AWK=awk
export CUT=cut
export DF="df -h"
export GREP=grep
export ID=id
export SDPMAIL=mail
export PS=ps

# Which perforce instance are we configuring? Defaults to 1.
export SDP_INSTANCE=${1:-1}

# The P4INSTANCE variable is deprecated, and is maintained here for backward
# compatibility.  The SDP_INSTANCE variable should be referenced instead, as
# P4INSTANCE may go away in a future release.
export P4INSTANCE=$SDP_INSTANCE
export P4SERVER="p4_${SDP_INSTANCE}"
export P4SSLDIR=/p4/ssl
export P4HOME="/p4/${SDP_INSTANCE}"
export TMP=${P4HOME}/tmp
export P4TMP=${P4HOME}/tmp

# Explicitly unset environment variables that affect p4d server if they
# are defined at startup, excluding those that are always defined in this
# file, like P4ROOT, P4PORT, P4lOG, and P4JOURNAL.  This prevents cross-
# instance shell environment contamination if p4_vars is sourced multiple
# times for different instances.
unset P4AUTH P4CHANGE P4DEBUG P4AUDIT P4TARGET

export P4ROOT=${P4HOME}/root
export P4JOURNAL=${P4HOME}/logs/journal
export P4CONFIG=${P4HOME}/.p4config
export P4TICKETS=${P4HOME}/.p4tickets
export P4TRUST=${P4HOME}/.p4trust
export P4ENVIRO=/dev/null/.p4enviro
export DEPOTS=${P4HOME}/depots
export LOGS=${P4HOME}/logs
export P4LOG=${LOGS}/log
export P4CBIN=/p4/common/bin
export P4CCFG=/p4/common/config
export PYHOME=/p4/common/python
export PATH=$P4HOME/bin:$P4CBIN:$PYHOME/bin:.:$PATH
export CHECKPOINTS=${P4HOME}/checkpoints
export JOURNALS=${P4HOME}/journals.rotated

if [[ -r ${P4ROOT}/server.id ]]; then
   export SERVERID=$(cat ${P4ROOT}/server.id)
else
   export SERVERID="server.id_not_found"
fi

if [[ -r ${P4ROOT}/sdp_server_type.txt ]]; then
   export SERVER_TYPE=$(cat ${P4ROOT}/sdp_server_type.txt)
else
   export SERVER_TYPE=default
   echo "${P4ROOT}/sdp_server_type.txt MISSING!"
fi

# P4Proxy Settings
export P4PCACHE=$P4HOME/cache

# Set Proxy monitoring level to 3 in order to monitor all traffic for all operations

export PROXY_MON_LEVEL=3

# Set KEEPCKPS to the number of checkpoint & journal files and their
# corresponding log files to keep.  Checkpoints and their log file are
# numbered with the same journal counter number.  Checkpoints/journals
# and their logs are removed when daily_checkpoint.sh, live_checkpoint.sh,
# or recreate_db_checkpoint.sh are run.
#  Set KEEPCKPS=0 to avoid automated cleanup of checkpoints and logs.
export KEEPCKPS=7

# KEEPJNLS allows you to keep a different number of journals than checkpoints
# in case you rotate the journal more frequently than you run checkpoints.
export KEEPJNLS=112

# Set KEEPLOGS to the number of server logs to keep, counting back from
# the most recent.  Server logs are numbered with their corresponding
# journal counter number, since server logs are rotated when checkpoint
# logs are rotated.  Keep in mind that if scripts are set to run
# more than once per day, this will not correspond to the number
# of days, just the number of iterations of script calls.
# KEEPLOGS affects all log files other than checkpoint logs, which are
# governed by KEEPCKPS.
# Set KEEPLOGS=0 to avoid automated cleanup of old server logs.
export KEEPLOGS=48

# Don't change this; change or comment the above as needed
export P4BIN=${P4HOME}/bin/p4_${SDP_INSTANCE}
export P4DBIN=${P4HOME}/bin/p4d_${SDP_INSTANCE}
export P4PBIN=${P4HOME}/bin/p4p_${SDP_INSTANCE}
export P4BROKERBIN=${P4HOME}/bin/p4broker_${SDP_INSTANCE}
export P4DTGBIN=${P4HOME}/bin/p4dtg_${SDP_INSTANCE}

# Define *_VERSION values.  These will look like "2014.1.899321"
# or "2015.1_BETA.903064".  For example, to specify behavior specific
# to 2014.1 or later P4D, test with [[ "$P4D_VERSION" > "2014.1" ]].
# That expression will be true 2014.1 and any subsequent release.  Since
# the values contain the patch number, all releases of "2014.1.*" will
# be greater than the string "2014.1", so "greater than or equal to" is
# implied.
[[ -x $P4BIN ]] && export P4_VERSION=$($P4BIN -V|$GREP ^Rev.|$CUT -d '/' -f 3).$($P4BIN -V|$GREP ^Rev.|$CUT -d '/' -f 4|$CUT -d ' ' -f 1)
[[ -x $P4DBIN ]] && export P4D_VERSION=$($P4DBIN -V 2>/dev/null|$GREP ^Rev.|$CUT -d '/' -f 3).$($P4DBIN -V 2>/dev/null|$GREP ^Rev.|$CUT -d '/' -f 4|$CUT -d ' ' -f 1)
# Set version values for optional executables.
[[ -x $P4PBIN ]] && export P4P_VERSION=$($P4PBIN -V|$GREP ^Rev.|$CUT -d '/' -f 3).$($P4PBIN -V|$GREP ^Rev.|$CUT -d '/' -f 4|$CUT -d ' ' -f 1)
[[ -x $P4BROKERBIN ]] && export P4BROKER_VERSION=$($P4BROKERBIN -V|$GREP ^Rev.|$CUT -d '/' -f 3).$($P4BROKERBIN -V|$GREP ^Rev.|$CUT -d '/' -f 4|$CUT -d ' ' -f 1)

# Sets instance specific vars.  Last so that the caller sees the error.
if [ -f "/p4/common/config/${P4SERVER}.vars" ] ; then
   . /p4/common/config/${P4SERVER}.vars
fi

# if 'nounset' was not in SHELLOPTS when we started, call set +u
if [[ $_shellopts != *nounset* ]]; then
    set +u
fi
# Change User Description Committed
#12 29965 Russell C. Jackson (Rusty) Changes to directories, commands and journalPrefix to implement new process to keep journal rotation to the same volume as the logs volume, but to still move journals to the checkpoints directory so they get backed up.
Also compresses journals to save space.
#11 29394 Russell C. Jackson (Rusty) Increased keep journals to 14 days with a journal rotation at 8 times per day.
#10 29377 Russell C. Jackson (Rusty) Changed KEEPLOGS to match KEEPJNLS
#9 29328 Russell C. Jackson (Rusty) Increased number of journals to keep
#8 29177 Russell C. Jackson (Rusty) Changed unknown SERVERID from hostname to server.id_not_found.
#7 29158 Russell C. Jackson (Rusty) Increated KEEPJNLS to 36.
#6 27870 Russell C. Jackson (Rusty) Added warning when sdp_server_type.txt is missing.
#5 25261 Russell C. Jackson (Rusty) Increase number of logs to keep to 28.
#4 25073 Russell C. Jackson (Rusty) Added check for cache_clean_skip.txt and increased the number of journals to keep to allow for extra rotation.
#3 24154 Russell C. Jackson (Rusty) Added +x to a few files.
#2 23680 Russell C. Jackson (Rusty) New script to copy over shelved files that verify -t schedules incorrectly.
Defaulted RSYNCUSER to OSUSER to eliminate the need to check to see if RSYNCUSER is set.
#1 23519 Russell C. Jackson (Rusty) Moved OSUSER to instance_vars.template so that p4_vars would be standard and all instances,
and could be moved to /p4/common/bin. Adjusted other files to account for this change.
//guest/russell_jackson/sdp/Server/Unix/p4/common/config/p4_vars.template
#5 23269 Russell C. Jackson (Rusty) Updated so that edge servers and replicas of edge server in a shareddata environment use a unique checkpoints folder.
Otherwise, everything is still just checkpoints to maintain compatability.
#4 23247 Russell C. Jackson (Rusty) Modified the checkpoints folder to include an extension of the master or edge server.id
to support sharing the data volume between a master and a workspace edge server in the same
data center.

Updated recover_edge to use variables appropriately and fixed a bug in the naming of the
checkpoint file.
#3 22845 Russell C. Jackson (Rusty) Fix path and Web variable
#2 22838 Russell C. Jackson (Rusty) More SDP clean up/simplification.
#1 22693 Russell C. Jackson (Rusty) Branched a Unix only version of the SDP.
Removed extra items to create a cleaner tree.
Moved a few items around to make more sense without Windows in the mix.
//guest/perforce_software/sdp/dev/Server/Unix/p4/common/config/p4_vars.template
#23 22595 C. Thomas Tyler Fixed to prefer our self-contained SDP Perl in /p4/common/perl
(if installed) over any local installation.  This avoids issues
where P4Perl fails to work due to interaction with a local and
incompatible Perl version (e.g. some old 5.8 version).
#22 22341 C. Thomas Tyler Provided default value for SERVERID on hosts w/o server.id file.

Change to ensure SERVERID always has a value, even when SDP is
used on SDP-managed machines with no 'p4d' (e.g. broker or
proxy boxes).  In those cases, the hostname is the default value.

This goes with change @22333.
#21 21808 C. Thomas Tyler Routine merge down to dev from main, picking up change from akwan:

update p4p_base to incorporate proxy monitoring and set default value in p4_vars
#20 21458 UnstoppableDrew Save SHELLOPTS and unset nounset if it wasn't set.
#19 20590 C. Thomas Tyler Added HMS_HOME setting, and added $HMS_HOME/scripts to PATH.
Also improved comment describing purpose of 'set -u'.
#18 20363 C. Thomas Tyler Removed references to legacy names for checkpoint scripts.
No functional changes.  Bypassing pre-commit code review.

#review-20364
#17 20170 Russell C. Jackson (Rusty) Moved password and users into the config directory to allow for instance specific
users and passwords. Ran into a case where two different teams were sharing the same
server hardware and needed this type of differentiation. Surprised that we haven't hit
this sooner.

Also defaulted mkdirs to use the numeric ports since this is the most common
installation.
#16 20020 C. Thomas Tyler Added safety feature to unset vars like P4AUTH that aren't always
set, to avoid cross-instance contamination if p4_vars is sourced
multiple times.
#15 19888 C. Thomas Tyler Defend against environment hijacking of P4ENVIRO and P4CONFIG.

Reviewers: Please see detailed discussion in job000548.
#14 19523 Russell C. Jackson (Rusty) Added a KEEPJNLS variable to allow you to keep more journals than checkpoints
in case you rotate the journal more frequently than you run checkpoints.
#13 18925 C. Thomas Tyler Enhanced p4_vars.template to support operating on an SDP-managed
host where no p4d process runs, such as a p4p (proxy) host, where
no /p4/n/root/server.id file exists.  The $SERVERID value will
be empty (but defined) in this case.

Enhanced to better support operating with replicas that share
/depotdata with their master servers, by making P4TRUST and
P4TICKETS values contain $SERVERID.

Moved SHAREDDATA from p4_vars to instance_vars, since it is not
inherently a global setting.  In sophisticated enterprise
environments, it can vary on a per-replica basis.  Adjusted
mkdirs.sh accordingly.
#12 18852 C. Thomas Tyler Enhanced P4DTG config to be more SDP-ified.
#11 18581 C. Thomas Tyler global_replica_status.sh v1.1.0:
* Moved sdp_hosts.cfg  config file to /p4/common/config, with optional
  override by speciffying P4CCFG variable.
* Changed recommended command line for crontab to suggest '-E'
  (always send emails) rather than '-e' (email on error only).
* Enhanced docs.

Added new P4CCFG setting to p4_vars.template, with value /p4/common/config.
#10 16029 C. Thomas Tyler Routine merge to dev from main using:
p4 merge -b perforce_software-sdp-dev
#9 15701 C. Thomas Tyler Routine merge down using 'p4 merge -b perforce_software-sdp-dev'.
#8 15375 adrian_waters Routine merge-down from main->dev
#7 14136 C. Thomas Tyler Routine merge down to dev from main for SDP
using perforce_software-sdp-dev.
#6 13934 C. Thomas Tyler Added settings for P4TRUST and P4ENVIRO to both Linux and Windows environments.
Removed '#!/bin/bash' line from to of p4_vars.tempate, as the generarted p4_vars
file is intended to be sourced rather than executed directly (and to avoid
starting an unnecessary subshell).

Also removed execute bit (undoing 'chmod +x') from p4_vars.template, just to
emphaisze its intended use.

#review-13935
#5 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.
#4 12923 C. Thomas Tyler Routine merge down from main to dev.
Resolved with 'p4 resolve -as', no merges or conflicts.
#3 12116 Russell C. Jackson (Rusty) Update dev from main.
#2 12028 C. Thomas Tyler Refreshed SDP dev branch, merging down from main.
#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/p4_vars.template
#1 11474 Russell C. Jackson (Rusty) Had to move the cfg directory to the metadata volume and link it under the instance
directory to provide the proper separation in a shared volume environment. The
 instance specific vars cannot be in a shared directory since they need to be different
 on each node using the shared volume.

 Since the files moved back to the instance directory, I changed the names back to:
   instance_vars
   p4review.cfg
 to keep things simple.

 Also moved p4_vars.template to SDP/Server/Unix/p4/common/cfg so that it doesn't get
 copied to the /p4/common/bin folder. Plus, it makes more sense for it to be in that
 directory in the SDP structure.
//guest/perforce_software/sdp/dev/Server/Unix/p4/common/bin/p4_vars.template
#4 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.
#3 10994 Robert Cowham Catchup 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/p4_vars.template
#1 10148 C. Thomas Tyler Promoted the Perforce Server Deployment Package to The Workshop.