- If your Helix Server is version 2014.1 (or later), we recommend submitting the trigger script,
p4-bin/scripts/swarm-trigger.pl, to Helix Server and running it from the depot. The recommended depot location is//.swarm/triggers/swarm-trigger.pl, especially if you have already setup Comment attachments. - If your Helix Server is older than version 2014.1, or you prefer that the trigger file exist in the filesystem, you must copy the
p4-bin/scripts/swarm-trigger.plscript to the server hosting Helix Server. If your Helix Server deployment uses the commit-edge architecture, the script must also be copied to all edge servers, and it must exist in the same path on all servers.
If you are using the Swarm OVA, the full path to the trigger script within the OVA's filesystem is: /opt/perforce/swarm/p4-bin/scripts/swarm-trigger.pl
Configure the trigger.
You need to use the API token established in the Establish trigger token.
swarm-trigger.pl can be configured directly, but the preferred approach is to create a configuration file called swarm-trigger.conf. Using the configuration file greatly simplifies upgrades.
If you are using the Swarm triggers package described in Install and configure Swarm from a package, the configuration file is available at /opt/perforce/etc/swarm-trigger.conf, otherwise create swarm-trigger.conf in the same directory as swarm-trigger.pl.
- If you submitted the trigger script to the depot in the previous step, you should similarly submit the configuration file to the depot. The recommended depot location is
//.swarm/triggers/swarm-trigger.conf. - If you copied the trigger script to the commit server and all edge servers in the previous step, also copy the configuration file to the commit server and all edge servers, making sure that they exist in the same path on all servers.
The following is a sample of what your swarm-trigger.conf should contain:
# SWARM_HOST (required)
# Hostname of your Swarm instance, with leading "http://" or "https://".
SWARM_HOST="http://my-swarm-host"
# SWARM_TOKEN (required)
# The token used when talking to Swarm to offer some security. To obtain the
# value, log in to Swarm as a super user and select 'About Swarm' to see the
# token value.
SWARM_TOKEN="MY-UUID-STYLE-TOKEN"
# ADMIN_USER (optional) Do not use if the Workflow technology preview feature is enabled:
# For enforcing reviewed changes, optionally specify the normal Perforce user
# with admin privileges (to read keys); if not set, will use whatever Perforce
# user is set in environment.
ADMIN_USER=
# ADMIN_TICKET_FILE (optional) Do not use if the Workflow technology preview feature is enabled:
# For enforcing reviewed changes, optionally specify the location of the
# p4tickets file if different from the default ($HOME/.p4tickets).
# Ensure this user is a member of a group with an 'unlimited' or very long
# timeout; then, manually login as this user from the Perforce server machine to
# set the ticket.
ADMIN_TICKET_FILE=
# VERIFY_SSL (optional)
# If HTTPS is being used on the Swarm web server, then this controls whether
# the SSL certificate is validated or not. By default this is set to 1, which
# means any SSL certificates must be valid. If the web server is using a self
# signed certificate, then this must be set to 0.
VERIFY_SSL=1
Modify the swarm-trigger.conf configuration file to set the SWARM_HOST and the SWARM_TOKEN variables appropriately.
Windows only:
You may need to edit the trigger script to specify the full path to curl.exe if the HTTP::Tiny module is not installed.
Linux only:
swarm-trigger.pl looks for configuration in the following files. Variables defined in the later files will override the earlier defined variables of the same name:
- Variables set inside the
swarm-trigger.plscript itself /etc/perforce/swarm-trigger.conf/opt/perforce/etc/swarm-trigger.conf- The
swarm-trigger.conffile stored in the same directory asswarm-trigger.pl - Any file passed to the
swarm-trigger.plscript using the -c command line argument
Windows and Linux:
If you specify ADMIN_USER, the ticket contained in %USERPROFILE%/p4tickets.txt (Windows), $HOME/.p4tickets (Linux), or the optional ticket file specified with the ADMIN_TICKET_FILE must use the port that was used to start Helix Server. For example, if p4d is started with:
C:\> p4d -p my-helix-core-server:1666 ...
then the ticket for the admin user specified with ADMIN_USER should be established with:
C:\> p4 -p my-helix-core-server:1666 -u admin_userid login
If the ticket was established using the wrong port, the error message you encounter includes the port that the trigger is attempting to use:
'swarm.strict.1' validation failed: Invalid login credentials to [port] within this trigger script; please contact your administrator.
Linux only: Ensure that the script has execute permissions.
Skip this step if you have committed the script to the Helix Server.
$ chmod +x /path/to/swarm-trigger.pl
Verify that the trigger script executes correctly.
- For Windows:
- Run:
- C:\> perl "C:\path\to\swarm-trigger.pl" -t ping -v 0
- Use the full path to
perlif it is not available in your command path. - You should expect to see no output. If the trigger is misconfigured, such as using an invalid trigger token, you would see an error.
-
Warning
Only if using Curl:
Installation of the triggers may cause a security warning dialog to appear when
curl.exeexecutes:
If this occurs, the triggers hang, creating zombie Perl processes. Due to the way triggers are invoked by Helix Server, the dialog is normally not visible even though Windows is waiting on interaction.
To resolve this:
- Clear the Always ask before opening this file check box and click Run.
- Right-click
curl.exe, select Properties, and click Unblock.
- For Linux:
-
Important
Skip this step if you have committed the script to the Helix Server.
$ /path/to/swarm-trigger.pl -t ping -v 0- You should expect to see no output. If the trigger is misconfigured, such as using an invalid trigger token, you would see an error.
-
Note
Run the trigger script without any arguments to see additional usage information.
Update the Helix Server triggers table to run the trigger script.
- The
swarm.shelvedel shelve-deletetrigger line was added to Swarm in version 2018.1 and later. Add the swarm.shelvedel shelve-delete trigger line to the Helix Server trigger table if it is not already present. - Workflow technology preview feature: If the workflow technology preview feature is disabled these trigger lines must be commented out:
- The
swarm.enforce change-submit,swarm.strict change-content, andswarm.shelvesub shelve-submittrigger lines were added to support workflow for Swarm 2018.2 and later. If workflow is enabled, add theswarm.enforce change-submit,swarm.strict change-content, andswarm.shelvesub shelve-submittrigger lines to the Helix Server trigger table if they are not already present.
The trigger script can provide the list of trigger lines that should work, with little to no adjustment, by executing it with the -o option:
Windows
C:\> perl "C:\path\to\swarm-trigger.pl" -o
Linux
$ /path/to/swarm-trigger.pl -o
As a Helix Server user with super privileges, edit the Helix Server trigger table by running the p4 triggers command and add the following lines (including the initial tab character). Update the perl.exe, trigger script, and configuration file paths in each line below to reflect the actual paths on your Helix Server:
Windows and Linux:
Workflow technology preview feature disabled (default):
- The swarm.enforce.1, swarm.enforce.2, swarm.strict.1, and swarm.strict.2 trigger lines are commented out because they are optional. They require that the DEPOT_PATH1 and DEPOT_PATH2 values are configured appropriately.
- The first two lines configure the enforce feature, which rejects any submitted changes that are not tied to an approved review.
- The second two lines configure the strict feature, which rejects any submitted changes when the contents of the changelist do not match the contents of its associated approved review.
- If you need to apply enforce or strict to more depot paths, copy the lines and tweak the depot paths as necessary.
- The swarm.enforce, swarm.strict, and swarm.shelvesub triggers must be commented out when workflow is disabled.
Workflow technology preview feature enabled:
- The swarm.enforce, swarm.strict, and swarm.shelvesub triggers must be used and the #s must be removed when workflow is enabled.
- The swarm.enforce.1, swarm.enforce.2, swarm.strict.1, and swarm.strict.2 trigger lines must be commented out when workflow is enabled.
The %quote%c:\path\to\perl.exe%quote% entry is only required for Windows-hosted systems.
- If you have committed both the trigger script and the configuration file to the Helix Server:
swarm.job form-commit job "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t job -v %formname%" swarm.user form-commit user "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t user -v %formname%" swarm.userdel form-delete user "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t userdel -v %formname%" swarm.group form-commit group "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t group -v %formname%" swarm.groupdel form-delete group "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t groupdel -v %formname%" swarm.changesave form-save change "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t changesave -v %formname%" swarm.shelve shelve-commit //... "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t shelve -v %change%" swarm.commit change-commit //... "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t commit -v %change%" swarm.shelvedel shelve-delete //... "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t shelvedel -v %change% -w %client% -u %user% -d %quote%%clientcwd%%quote% -a %quote%%argsQuoted%%quote% -s %quote%%serverVersion%%quote%" # The following triggers are only used to prevent a commit without an approved review. # See the Swarm trigger documentation before enabling these. # They should be commented out if workflow is enabled. # swarm.enforce.1 change-submit //DEPOT_PATH1/... "%c:\path\to\perl.exe% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t enforce -v %change% -p %serverport%" # swarm.enforce.2 change-submit //DEPOT_PATH2/... "%c:\path\to\perl.exe% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t enforce -v %change% -p %serverport%" # swarm.strict.1 change-content //DEPOT_PATH1/... "%c:\path\to\perl.exe% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t strict -v %change% -p %serverport%" # swarm.strict.2 change-content //DEPOT_PATH2/... "%c:\path\to\perl.exe% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t strict -v %change% -p %serverport%" # The swarm.enforce, swarm.strict, and swarm.shelvesub triggers below must be used when the Workflow # technical preview feature is enabled. The enforce and strict triggers above must be commented out # if the Workflow feature is enabled. # swarm.enforce change-submit //... "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t checkenforced -v %change% -u %user%" # swarm.strict change-content //... "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t checkstrict -v %change% -u %user%" # swarm.shelvesub shelve-submit //... "%quote%c:\path\to\perl.exe%quote% %//.swarm/triggers/swarm-trigger.pl% -c %//.swarm/triggers/swarm-trigger.conf% -t checkshelve -v %change% -u %user%"
- If you have copied the trigger script and configuration file to common paths on all servers:
swarm.job form-commit job "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t job -v %formname%" swarm.user form-commit user "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t user -v %formname%" swarm.userdel form-delete user "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t userdel -v %formname%" swarm.group form-commit group "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t group -v %formname%" swarm.groupdel form-delete group "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t groupdel -v %formname%" swarm.changesave form-save change "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t changesave -v %formname%" swarm.shelve shelve-commit //... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t shelve -v %change%" swarm.commit change-commit //... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t commit -v %change%" swarm.shelvedel shelve-delete //... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t shelvedel -v %change% -w %client% -u %user% -d %quote%%clientcwd%%quote% -a %quote%%argsQuoted%%quote% -s %quote%%serverVersion%%quote%" # The following triggers are only used to prevent a commit without an approved review. # See the Swarm trigger documentation before enabling these. # They should be commented out if workflow is enabled. # swarm.enforce.1 change-submit //DEPOT_PATH1/... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t enforce -v %change% -p %serverport%" # swarm.enforce.2 change-submit //DEPOT_PATH2/... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t enforce -v %change% -p %serverport%" # swarm.strict.1 change-content //DEPOT_PATH1/... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t strict -v %change% -p %serverport%" # swarm.strict.2 change-content //DEPOT_PATH2/... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t strict -v %change% -p %serverport%" # The swarm.enforce, swarm.strict, and swarm.shelvesub triggers below must be used when the Workflow # technical preview feature is enabled. The enforce and strict triggers above must be commented out # if the Workflow feature is enabled. # swarm.enforce change-submit //... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t checkenforced -v %change% -u %user%" # swarm.strict change-content //... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t checkstrict -v %change% -u %user%" # swarm.shelvesub shelve-submit //... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t checkshelve -v %change% -u %user%"
-
Warning
Windows and Linux:
The use of
%quote%is not supported on 2010.2 servers (it is harmless though); if you are using this version, ensure that you do not have any spaces in the path toperl.exeor the script's path.ImportantWindows and Linux:
If your Helix Server has SSL enabled and is older than the 2014.1 release, the %serverport% trigger variable does not include the necessary transport indicator, which can cause the enforce and strict triggers to fail.
To solve this problem, add ssl: immediately before %serverport% in the trigger lines. For example:
# The following triggers are only used to prevent a commit without an approved review. # See the Swarm trigger documentation before enabling these. # They should be commented out if workflow is enabled. # swarm.enforce.1 change-submit //DEPOT_PATH1/... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t enforce -v %change% -p ssl:%serverport%" # swarm.enforce.2 change-submit //DEPOT_PATH2/... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t enforce -v %change% -p ssl:%serverport%" # swarm.strict.1 change-content //DEPOT_PATH1/... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t strict -v %change% -p ssl:%serverport%" # swarm.strict.2 change-content //DEPOT_PATH2/... "%quote%C:\path\to\perl.exe%quote% %quote%/path/to/swarm-trigger.pl%quote% -c %quote%/path/to/swarm-trigger.conf%quote% -t strict -v %change% -p ssl:%serverport%"
Configure the Helix Server to promote all shelved changes.
When this configurable is set, Swarm has access to all shelved changelists, which is a requirement for pre-commit reviews. When it is not set, users connected to an edge server must remember to use the -p option when shelving files to promote their shelves to the commit server when initiating a pre-commit review.
Windows:
C:\> p4 configure set dm.shelve.promote=1
Linux:
$ p4 configure set dm.shelve.promote=1
Optionally forward logins to the commit server.
If you intend to use P4V and its Swarm integration, you should consider forwarding logins to the commit server. See P4V Authentication for details.
- Optional: Hide Swarm storage from regular users, see Hiding Swarm storage from regular users.
- Optional: Handle exclusive locks, see Handling Exclusive Locks.
- Swarm package installation: Review the post-install configuration options to customize your Swarm installation, see Post-install configuration options.
- Swarm OVA installation: Review the post-install configuration options to customize your Swarm installation, see Post-install configuration options.
- Swarm tarball installation: Set up a recurring task to spawn workers, see Set up a recurring task to spawn workers.
