Helix Core Server Administrator Guide: Multi-Site Deployment (2019.2)

Background archive transfer for edge server submits

Users on edge servers might want to spend less time waiting for their submits to complete. Starting with 2019.1, it is possible to configure the replication environment so that:

  1. The edge server sends the metadata to the commit server.
  2. The user on the edge server sees the submit is complete and can resume work.
  3. In the background, the commit server pulls the archive files from the edge server.

Prior to 2019.1, the user on the edge server would need to wait for both the submitted archive files and the metadata to be transferred to the commit server.

To enable background archive transfer

Prerequisites

  • Ensure a service user is defined for the commit server and that this service user is logged into the ExternalAddress field of the server specification for all edge servers that will participate in background transfers.
  • If any of the participating edge servers are enabled for SSL/TSL security, ensure the service user on the commit server has established trust to the ExternalAddress field for those edge servers.

Steps

  1. Set the submit.allowbgtransfer configurable to 1 on ALL the servers .
  2. Set the lbr.autocompress configurable to 1 on ALL the servers .

Tell your users to manually issue the p4 submit -b command, where the -b option causes background transfer of the archive files.

Alternatively, to enable background archive transfer with the added convenience of p4 submit automatically functioning as p4 submit -b so that you users do not need to use the -b option:

  1. Set the submit.allowbgtransfer configurable to 1 on ALL the servers.
  2. Set the lbr.autocompress configurable to 1 on ALL the servers.
  3. Set the submit.autobgtransfer configurable to 1 on the EDGE servers.

Note

To recover a failed archive transfer, restart the transfer by using the p4 pull -u -t target command, where target represents the ExternalAddress of the EDGE server where the submit occurred that caused the failed transfer.

For details on background file content transfers, including errors due to failed transfers, see the output of p4 pull -l against the commit server.