Preface

This book, Helix Versioning Engine Administrator Guide: Multi-Site Deployment (previously titled Distributing Perforce), is a guide intended for administrators responsible for installing, configuring, and maintaining multiple interconnected or replicated Perforce services. Administrators of sites that require only one instance of the Perforce service will likely find the Helix Versioning Engine Administrator Guide: Fundamentals sufficient.

This guide assumes familiarity with the material in the Helix Versioning Engine Administrator Guide: Fundamentals.

About this manual

This manual includes the following chapters:

Chapter Contents

“Introduction to Federated Services”

Describes the different types of Perforce servers and explains how you combine these to solve usability and performance issues. In addition, this chapter discusses the issues that affect service federation independently of the particular type of service used: issues like user authentication and communication among federated services. Subsequent chapters in this book describe each type of service in detail.

“Perforce Replication”

Explains how you work with server replicates to provide warm standby servers, to reduce load and downtime on the primary server, to provide support for build farms, or to forward write requests to a central server.

“Commit-edge Architecture”

Describes commit-edge architecture, which addresses the needs of geographically distributed work groups and offers significant performance advantages. Explains how you set up a commit-edge configuration, how you migrate from an existing installation, how you manage this configuration, how you use commit/edge triggers, and how you plan for disaster recovery.

“The Perforce Broker”

Explains how yo use the Perforce broker to implement local policies in your Perforce environment by redirecting server requests and by mediating between the client and other servers in your federated environment. Provides information about how you install, configure, and run the broker.

“Perforce Proxy”

Explains how you use a Perforce proxy to improve performance in a federated environment. Describes how you install and configure the proxy and how you use it to maximize performance.

Perforce Server (p4d) Reference

Provides reference information about the syntax and options of the p4d command used to create and configure a Perforce server.

What’s new in this guide for the 2016.2 update

This section provides a list of changes to this guide for the Helix Versioning Engine 2016.2 update release. For a list of all new functionality and major bug fixes in Helix Versioning Engine 2016.2, see http://www.perforce.com/perforce/r16.2/user/relnotes.txt.

Updates and corrections

Make p4 lock on an edge server take global locks on the commit server by default:: See Locking and unlocking files.

Helix documentation

The following table lists and describes key documents for Helix users, developers, and administrators. For complete information see the following:

http://www.perforce.com/documentation

For specific information about…​ See this documentation…​

Introduction to version control concepts and workflows; Helix architecture, and related products.

Introducing Helix

Using the command-line interface to perform software version management and codeline management; working with Helix streams; jobs, reporting, scripting, and more.

Helix Versioning Engine User Guide

Basic workflows using P4V, the cross-platform Helix desktop client.

P4V User Guide

Working with personal and shared servers and understanding the distributed versioning features of the Helix Versioning engine.

Using Helix for Distributed Versioning

p4 command line (reference).

P4 Command Reference, p4 help

Installing and administering the Helix versioning engine, including user management, security settings.

Helix Versioning Engine Administrator Guide: Fundamentals

Installing and configuring Helix servers (proxies, replicas, and edge servers) in a distributed environment.

Helix Versioning Engine Administrator Guide: Multi-site Deployment

Helix plug-ins and integrations.

IDEs: Using IDE Plug-ins
Defect trackers: Defect Tracking Gateway Guide
Others: online help from the Helix menu or web site

Developing custom Helix applications using the Helix C/C++ API.

C/C++ API User Guide

Working with Helix in Ruby, Perl, Python, and PHP.

APIs for Scripting

Syntax conventions

Helix documentation uses the following syntax conventions to describe command line syntax.

Notation Meaning

literal

Monospace font indicates a word or other notation that must be used in the command exactly as shown.

italics

Italics indicate a parameter for which you must supply specific information. For example, for a serverid parameter, you must supply the id of the server.

[-f]

Square brackets indicate that the enclosed elements are optional. Omit the brackets when you compose the command.

Elements that are not bracketed are required.

…​

Ellipses (…​) indicate that the preceding element can be repeated as often as needed.

element1 | element2

A vertical bar ( | ) indicates that either element1 or element2 is required.

Please give us feedback

We are interested in receiving opinions on this manual from our users. In particular, we’d like to hear from users who have never used Perforce before. Does this guide teach the topic well? Please let us know what you think; we can be reached at [email protected].

If you need assistance, or wish to provide feedback about any of our products, contact [email protected].