p4login #3

  • //
  • guest/
  • russell_jackson/
  • sdp/
  • Server/
  • Unix/
  • p4/
  • common/
  • bin/
  • p4login
  • View
  • Commits
  • Open Download .zip Download (142 B)
#!/bin/bash
$P4BIN -p $P4PORT -u $P4USER login -a < /p4/common/config/.p4passwd.${P4SERVER}.admin > /p4/${SDP_INSTANCE}/logs/p4login.log 2>&1
# Change User Description Committed
#3 22981 Russell C. Jackson (Rusty) Made files writeable so they are easier to update once on the server.
#2 22757 Russell C. Jackson (Rusty) Added P4SVRPORT to use to make the server listen on just the port number.

Changed P4PORT to include the hostname to eliminate a bug where the ticket is not
issued by the master as it should be when rpl.forward.login is set up.

Created a p4login_master and updated appropriate scripts to use it. This actually
isn't necessary with the change to include the hostname in P4PORT since the ticket
will be valid on all servers in the group, but this covers configurations that aren't
using rpl.forward.login.
#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/bin/p4login
#14 20855 C. Thomas Tyler Fixed quoting bug in p4login.
#13 20774 C. Thomas Tyler p4login: Minor fix to use $P4BIN rather than raw 'p4'.
 This impacted
only 'p4 set P4TICKETS' output, but is otherwise a non-functional
change.
#12 20749 C. Thomas Tyler Approved and committed, but I believe that the shared data setting is always set to false on the master and we should look at fixing that in another change.

Enhanced p4login again.

Improvements:
Default behavior with no arguments gives the desired results.
For example, if run on a master, we login on the super user P4USER to
P4PORT.  If run on a replica/edge and auth.id is set, we login P4USER
to the P4TARGET port of the replica.

All other login functionality, such as logging in the replication
service user on a replica, logging in supplemental automation users,
is now accessed via new flags.

A usage message is now available via '-h' and '-man' options.  The
new synopsys is:
p4login [<instance>] [-p <port> | -service] [-automation] [-all]

The <instance> parameter is the only non-flag positional parameter,
and can be ommitted if SDP_INSTANCE is already defined (as is typical
when called by scripts).

With this change, several other scripts calling either the 'p4login'
script or 'p4 login' commands were normalized to call p4login as
appropriate given the new usage.

Reviewer Note:  Review p4login first, then other files.  Most changes
are in p4login.

In other scripts callling p4login, calls similar to:
$P4BIN -u $P4USER -p $P4PORT login < /path/to/pwd
are replaced with: $P4CBIN/p4login

In other scritps calling p4login, calls similar to:
$P4BIN -p $P4MASTERPORT login < /path/to/pwd
are replaced with: $P4CBIN/p4login -p $P4MASTERPORT

Note that, if auth.id is set, calling 'p4login' actually has the
same behavior as 'p4login -p $P4MASTERPORT', since p4login
called on a replica with auth.id set will just login to the master
port anyway.

Depending on intent, sometimes $P4BIN/p4login -service
is used.

== Misc Cleanup ==

In doing the cleanup:
* Fixed a hard-coding-to-instance-1 bug in broker_rotate.sh.
* Fixed an inconsistency in recreate_db_sync_replica.sh, where
it did just a regular login rather than a login -a as done in other
places for (for compatibility with some multi-interface NIC card
configs).

== p4login Call Normalization ==
Code cleanup was done to normalize calls to p4login, such that:
1) the call starts with $P4CBIN/p4login (not the hard-coded path),
and 2) logic to redirect sdtout/stderr to /dev/null was removed,
since it's not necessary with p4login.  (And if p4login ever
does generate any unwanted output, we only fix it in one place).

== Tweak to instance_vars.template ==
This change includes a tweak to set P4MASTERPORT dynamically
on a replica to ensure the value precisely matches P4TARGET
for the given replica.  This will reduce a source of problems
when SSL is used, as it is particularly sensitive to the precise
P4PORT values used, and will also help for environments which
have not yet set auth.id.  If the port cannot be determined
dynamically, we fall back to the old logic using the assigned
value.

== Tweak to SDP_ALWAYS_LOGIN behavior ==
This used to default to 1, now it defaults to 0.  At this
point we should no longer need to force logins, and in fact
doing so can get into a 'p4 login' hang situation with
auth.id set.  Best to avoid unnecessary logins if we
already have a valid ticket.  (I think the need to force a
login may have gone away with p4d patches).

== Obsolete Script ==
With this change, svclogin.sh is now obsolete.  All it was doing
was a few redundant 'p4 login' commands followed by a call to
p4login anyway.

== Testing ==
Our test suite doesn't fully cover this change, so additional
manual testing was done in the Battle School lab environment.
#11 20635 C. Thomas Tyler p4login changes:
* Fixed bug in attempted login count.
* Added '-s' flag to login only P4USER to P4PORT.  This is
  to make p4login more useful for cases where extraneous logins
  it now does (e.g. automation users) isn't desired.
* Enahnced in-code docs.
#10 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.
#9 20028 C. Thomas Tyler p4login v3.1.4:
* Avoids logging replication service user into local replica host,
as doing so breaks the login to the master.
* Does needed login of service user to P4AUTH server if P4AUTH is set.
* Clarity enhancements to log messages.
#8 19965 C. Thomas Tyler The Ultimate Perforce Login Script.

Enhanced p4login v3.1.0:
* If on a replica/edge server, logs in replication service users.
* Uses 'p4 login -a' for non-service type accounts, and 'p4 login 'for
  service type accounts.
* Accounts for auth.id, and behaves appropriately whether auth.id is set
  or not, e.g. doing an extra 'p4 login' as needed if auth.id isn't set.
* Logs in external automaiton users,  e.g. trigger or broker filter script
  users, if defined by the SDP_AUTOMATION_USERS setting in
  /p4/common/config/p4_<instance>.vars.
* Fixed bug where it broke if p4_vars wasn't sourced.  It now sources p4_vars.
* Logs whether actual 'p4 login' commands were needed and the number of logins
  done, along with other cosmetic logging enhancements.
* Added Version identifier.
#7 18209 Russell C. Jackson (Rusty) Added missing auto source of p4_vars to eliminate the need to use p4master_run.
Missed in early changes to support that behavior.
#6 16029 C. Thomas Tyler Routine merge to dev from main using:
p4 merge -b perforce_software-sdp-dev
#5 15605 C. Thomas Tyler Per review, Rusty noted a preference for the current behvaior, i.e.
always
doing a login if p4login is called.

This version introduces SDP_ALWAYS_LOGIN, which defaults to 1 (enabled),
which preserves the traditional 'always login each time the script is
run' behavior, while allowing the new 'login only if a ticket is not
available' behavior.  (An advantage of the traditional behavior is that
it fixes the case where a human admin does a 'p4 login' but forgets the
'-a' on a server a network card configuration setup such that 'p4 login -a'
is required).

Customers desiring the 'login only if required' can set SDP_ALWAYS_LOGIN=0
in p4_vars.

Also includes style improvements.

#review-15606
#4 15559 C. Thomas Tyler Enhancements to p4login:
* Enhanced handling for the cose where p4login is run with no environment defined.
* Now checks login status first, and only does a login if ticket expires in less than a month.
* Enhanced  auditability.
* Added comments.

#review-15560
#3 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.
#2 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.
#1 10638 C. Thomas Tyler Populate perforce_software-sdp-dev.
//guest/perforce_software/sdp/main/Server/Unix/p4/common/bin/p4login
#1 10148 C. Thomas Tyler Promoted the Perforce Server Deployment Package to The Workshop.