Enhanced Studio Pack on AWS

The Enhanced Studio Pack contains all the tools you need to do world-class development in a single, pre-configured environment. Use these instructions to deploy everything you need with the infrastructure required to support large projects, big files, and all your team members.

FAQ RESOURCES

Helix Core Version Control

Helix Swarm Code Review

icon-products-hansoft-simple

Hansoft Project Management

Perforce Windows Workstations

Define Your AWS Environment

  1. To deploy your Enhanced Studio Pack on AWS, click on the template link (you will receive one after signing up).
  2. Create or log into your AWS account.
  3. In the AWS CloudFormation Stack Deployment interface, you will see a list of parameters that define how your Perforce environment will be set up. Before you start editing parameters to create your stack, choose your region.

    By default, N. Virginia is selected. This template supports all regions except opt-in regions, China regions, and GovCloud regions. 

    We recommend selecting a region closest to your end users or a region that meets your compliance/security needs.
Quick Create Stack

Then define your parameters:

Stack Name

  1. Create a name following your organizations standard naming convention. If you don't have a standard convention, we recommend making the name easy to recognize. For example, perforce-${environment}-${team/department}
  2. If you deploy multiple instances of the Perforce Enhanced Studio Pack in the same region, create unique names for each. For example: production, team a, or team b. CloudFormation Stack names must be unique within an AWS region. If you get the error "Stack [XYZ] already exists," double check that your chosen stack name is unique.

VPC Network Configuration

Your VPC contains all the network settings that give you access to use your Perforce Helix Core software in the cloud.

  1. To start, you must whitelist at least one IP address. We recommend using the public IP address of the machine you are using to set up the stack on AWS.
  2. Replace 1.1.1.1 with your IPv4 address. Find your IP address >>
  3. /32 will remain unless there is a continuous block of IP addresses that need to be whitelisted. You can always add and delete IP addresses after you deploy.

Perforce Helix Core Server Configuration

Define how you want the Helix Core server to be setup. Certain admin actions will require SSH access, for example operating system updates, Helix Core updates, reviewing logs, or expanding volume size. Daily use will not require SSH.

  1. To set up SSH, select an existing key or create a new one from your EC2 dashboard.
  2. The remaining fields in this section are optional. Once you are using the tool, you can adjust these at any time.
  3. If you know how much data you are using today, you may consider adjusting your Depot Volume Size to 1.5x your current data usage.

Hansoft Configuration (Optional)

  1. To use the Perforce project management tool, select ‘True.’
  2. Hansoft will be deployed to your AWS environment on its own server. We do not recommend adjusting resource defaults for initial setup.

Not sure you will use Hansoft right away? Deploy now and stop the Hansoft server until you are ready to start using. This will reduce your cloud operating costs.

Virtualized Windows Workstation Configuration (Optional)

The virtual Windows workstation contains all the Perforce clients — Helix Sync, Helix Visual Client (P4V) — pre-configured. It also contains additional 3rd party tools and other powerful resources.

Instance size and your use of the software on the work station will influence the cost of the server needed to support it.

  1. To use a pre-configured Windows Workstation, select ‘True’
  2. Select Resources:
    • Instance type supported is EC2 G3 Instance Class. GPU prices will vary.
    • Root volume size is highly dependent on your use case. How much data will you check out? How much hard drive space do you want? How much data will be stored?  

Helix Swarm Configuration (Optional)

  1. To use Helix Swarm — the Helix Core code review tool — select ‘True.’
  2. Helix Swarm will be deployed to your AWS environment on its own server. We do not recommend adjusting resource defaults for initial setup.

Other Parameters

The Environment parameter is used in both resource naming and the tag on all resources.

Environment default is “prod.” We do not recommend changing this name. But it can be done if your needs require it.

Create Your Stack

Once you have defined all parameters:

  1. Check the two boxes for AWS CloudFormation Capabilities.
    Other parameters
  2. Click Create Stack.
  3. Click on the Stack Info tab and wait for the Status to change to CREATE_COMPLETE.  Once the deployment is complete proceed to the next section, Find Your Deployment Outputs.
  4. Enhanced Studio Pack - Stack Info
  5. Estimate your monthly expense with the AWS calculator.

Find Your Deployment Outputs

Once your deployment is complete, you will see the status change to CREATE_COMPLETE.

Enhanced Studio Pack - Create Complete

Make sure you have the parent stack selected and click on the Outputs tab. In our example, the parent stack Name is Enhanced-Studio-Pack. 

If you navigated away from your deployment, the following screenshots show where to find your parent stack.

From the CloudFormation Main Page

  1. If you are on the CloudFormation main page, find the Stack Name you selected in the Defining Your Environment Section.
  2. Click the Stack Name hyperlink.
    Enhanced Studio Pack - Stack Name Hyperlink

From the Stack Details Page

  1. If you are on the Stack Details page, find the Stack Name you selected in the Defining Your Environment Section in the list of Stacks.
  2. Select it.
    Enhanced Studio Pack - Environment Section

Please take note of the following key outputs:

  1. HelixCoreInstanceID
  2. P4CommitPublicIP
  3. PerforceWorkstationPublicIP
  4. PerforceWorkstationURL
  5. PerforceWindowsInstanceID

These will be used in future sections.

Enhanced Studio Pack - Key Outputs

Your Credentials

Refer to section Find Your Deployment Outputs for details on where to find these values.

Helix Core Credentials

Use the following connection details for connecting to Helix Core using Helix Visual Client (P4V) and the Helix Core Command-line (P4 CLI).

Server = ssl:<P4CommitPublicIP>:1666
User = perforce
Password = <HelixCoreInstanceID>

<P4CommitPublicIP> and <HelixCoreInstanceID> correspond to AWS CloudFormation outputs found in the Find Your Deployment Outputs section.

Example:
Server = ssl: 52.186.76.48:1666
User = perforce
Password = i-0d25def7ae812ce0a

Windows Workstation Credentials

Refer to section Find Your Deployment Outputs for details on where to find these values.

Username: perforce
Password: <PerforceWindowsInstanceID>

Example:
Username: perforce
Password: i-047de470411bc58bb

Access Your Helix Core Server Using Helix Visual Client (P4V)

  1. Download Helix Visual Client (P4V).
  2. Enter in the connection details on the Remote Server tab:
    Server = ssl:<P4CommitPublicIP>:1666
    User = perforce
    Password = <HelixCoreInstanceID>
  3. Click OK.
  4. Establish connection by clicking the checkbox “Trust this fingerprint” and click Connect.
  5. In the displayed password prompt, enter the password for the perforce user, which defaults to <HelixCoreInstanceID> output value.
    P4V: Open Connection
    P4V: Trust Fingerprint
    P4V: Enter Password
  6. For more information, see the P4V User Guide.

Note: If you are connecting from the Perforce Windows Workstation substitute <P4CommitPublicIP> with <P4CommitPrivateIP>.

Access Your Helix Core Server Using Helix Sync

  1. Download Helix Sync.
  2. Enter in the connection details:
    Server = ssl:<P4CommitPublicIP>:1666
    Username: perforce
    Password = <HelixCoreInstanceID>
  3. Click Connect.
    Helix Sync: Login Screen
  4. For more information, see the Helix Sync User Guide.

Note: If you are connecting from the Perforce Windows Workstation substitute <P4CommitPublicIP> with <P4CommitPrivateIP>.

 

Access Your Helix Core Server Using Helix Swarm

  1. Open your browser.
  2. Navigate to http://<SwarmPublicIP>
  3. Login using the following details:
    Username: perforce
    Password: <P4CommitInstanceID>
  4. Click Log in.
  5. For more information, see the Helix Swarm User Guide.

Note: If you are connecting from the Perforce Windows Workstation substitute <SwarmPublicIP> with <SwarmPrivateIP>.

Connect to Hansoft

  1. Download the Hansoft client.
  2. Open the Hansoft Client.
  3. Login using the following details:
    Hansoft Server: < HansoftPublicIP>
    Port: 50256
  4. Click Connect.
  5. For more information, see the Hansoft User Guide.
  6. To connect to the Hansoft server using the Hansoft Server Administrator application, no username is required. The password is the output value of <HansoftInstanceID>.

Note: If you are connecting from the Perforce Windows Workstation substitute <HansoftPublicIP> with <HansoftPrivateIP>.

Connect to Windows Workstation

After you have completed deployment, you can connect to your Windows Workstation via NiceDCV browser, NiceDCV Client, or RDP.

Review the benefits of using NiceDCV over RDP.

Review instructions below.

NiceDVC Browser

  1. Using the steps in the section Find Your Deployment Outputs, click on the PerforceWorkstationURL value.
  2. Enter your Perforce Workstation Credentials:
    Username: perforce
    Password: <PerforceWorkstationInstanceID>

<PerforceWorkstationIntanceID> is the value from the CloudFormation output.

NiceDVC Client

  1. Download the NiceDCV client.
  2. Open NiceDCV client.
  3. To enter the server, you will connect to — value of the PerforceWorkstationPublicIP. Click Connect. Note: You can find the workstation server information on the Outputs tab of the Parent Stack in CloudFormation.
  4. Enter your Perforce Workstation Credentials.
    Username: perforce
    Password: Value for PerforceWorkstationInstanceID (located in the Outputs tab of the parent stack in CloudFormation)

RDP

  1. Open your RDP tool of choice.
  2. To enter the server, you will connect to – value of the PerforceWorkstationPublicIP. Click Connect. Note: You can find the workstation server information on the Outputs tab of the Parent Stack in CloudFormation.
  3. Enter your Perforce Workstation Credentials
    Username: perforce
    Password: Value for PerforceWorkstationInstanceID (located in the Outputs tab of the parent stack in CloudFormation)

Access Helix Visual Client via Windows Workstation

  1. When accessing your workstation for the first time, some post deployment configuration will be launched. Wait for this to complete before proceeding.
    Add P4V to Windows: Post Deployment Config.
  2. After the PowerShell configuration is complete, a Helix Core authenticate dialog box will display. The password to authenticate to Helix Core is the value from the HelixCoreInstanceID output found in the CloudFormation Parent Stack Outputs tab.
    Add P4V to Windows: Authentication
  3. Open Helix Visual Client (P4V) from the desktop icon. In the Open Connection dialog, leave the defaults. Click Okay.

Update Firewall Rules to Allow Additional Users

If you have users who will connect to Perforce from a different IP address than the one used to deploy, you will need to update your firewall rules to grant them access.

Review the AWS documentation for updating Security Group rules.

Follow these steps for getting to your Security Group.

  1. Navigate to the EC2 console.
  2. Select your Helix Core instance.
  3. Select the Security tab.
  4. Open the Security Group.
  5. From this page you can update/remove/add new whitelist entries by click on the “Edit inbound rules” button.
  6. Review your changes. Then click Save rules.

The table below provides the port number for each product the user may need access to:

Product

Service Type

Port Number

Helix Core

TCP

1666

Helix Swarm

HTTP

80

Hansoft

TCP

52560

Windows Workstation

TCP

3389

Authenticating to the Helix Core Operating System

Username: centos
Server: <P4CommitPublicIP>

Example command:
ssh [email protected]

Now you are logged in as the centos user. To perform any Helix Core administration task, switch to the perforce user and log into Helix Core with the following commands:

sudo su - perforce
p4login -v 1

You are now logged into Helix Core (P4D) as the perforce user. You have the P4 CLI binaries in your $PATH

To perform OS administration, you can become root with the following command:

sudo -s

Need Support?

Support can be reached by emailing: [email protected]

When emailing support, please include details about your Helix Core server configuration.

  1. Go into Helix Visual Client P4V.
  2. Click Help.
  3. Click System Info.
  4. Copy and paste the contents of System Info into your email to support.
Screenshot of P4V interface with information needed for emailing support.

Want Help Setting Up Perforce?

Contact our professional services team to talk to experts. They can optimize your Helix Core servers for top performance.

Launch Single Instance

Installing just Helix Core? 

Read More Docs

Get step-by-step instructions.