Install and set up the Perforce Unified Compliance appliance

Perforce Unified Compliance is available as a virtual machine appliance, distributed as an OVA file and deployed to VMware. This topic covers the system requirements and the steps to install, configure, and access Perforce Unified Compliance.

Hardware requirements

The following minimum and recommended hardware specifications apply when you deploy the Perforce Unified Compliance virtual appliance:

Resource

Minimum

Recommended

vCPUs

16

32

RAM

64 GB

128 GB

Network

10 Gbps

25 Gbps

System disk

100 GB SSD

 

Data volume (/var/uc)

1 TB (size to workload)

 
The recommendations were benchmarked on an appliance handling ~100,000 EC2 inventory entities, ~100,800 Kubernetes resources, and 4–5 GB of raw cost CSVs across 18 months (~113 GiB uncompressed in application), transformed to ~14.7 GiB of final compressed cost data on the application storage disk.

The appliance requires Intel or AMD processors (ARM/Graviton is not supported) with enhanced networking and SSD storage.

Supported platforms

The Perforce Unified Compliance appliance is deployed as an OVA file to a VMware ESX environment and supports deployment with the following:

  • VMware ESX using an OVA file

  • VMware Cloud

  • VMware ESXi 7.0, 7.0 U1, 7.0 U2, 7.0 U3

  • VMware ESXi 8.0, 8.0 U1, 8.0 U2, 8.0 U3

Network connectivity requirements

The following inbound ports must be reachable on the appliance:

Protocol

Port

Use

TCP

22

SSH and SFTP connections to the appliance

TCP

443

HTTPS connections to the Perforce Unified Compliance user interface, identity provider, and setup console

The following outbound connections must be permitted from the appliance:

Protocol

Port

Use

TCP

443

HTTPS to cloud provider APIs for resource scanning, cost collection, and credential operations; AWS (*.amazonaws.com), Azure (management.azure.com, login.microsoftonline.com, *.blob.core.windows.net), and Google Cloud (*.googleapis.com); to GitHub (api.github.com, github.com) for repository access and pull-request generation; and to your external identity provider

TCP/UDP

53

DNS name resolution

UDP

123

NTP time synchronization (when an NTP server is configured)

Repository access for version-control integration is performed over HTTPS (port 443). The appliance does not require outbound SSH (port 22) for version-control operations.

Install the appliance

  1. Download the Perforce Unified Compliance OVA file using your license ID as the username and your PEA license ID as the password.

  2. Deploy the OVA to your VMware ESX environment.

  3. Power on the VM and use the VM console to wait for the appliance services to come online. This can take several minutes on first boot.

  4. When the appliance is reachable from a web browser over HTTPS (port 443), proceed to configure the appliance.

Configure the appliance

On first boot, configure the appliance through the UC Setup wizard. From a supported web browser, navigate to https://<appliance-fqdn>/server-setup/ and log in with the default credentials: username sysadmin, password sysadmin.

Complete the following wizard steps:

  1. Welcome: Review the steps the wizard will guide you through.

  2. Administrators: Set the email address and password for the system administrator account (sysadmin).

  3. Organization Details: Enter the Organization Name and Organization Short Name, then create the Perforce Unified Compliance administrator account. The administrator's full login is admin@<organization-short-name>. This is the account you use to log in to the Perforce Unified Compliance user interface.

  4. Time: Set the appliance time by configuring an NTP server, or by setting the date, time, and time zone manually.

  5. Network: Configure the network interfaces, default gateway, and DNS settings (appliance hostname and DNS domain).

  6. Network Security: Review or replace the appliance TLS certificates. Use the KeyStore for the appliance's inbound HTTPS certificate and the TrustStore for certificate authorities the appliance should trust for outbound connections.

  7. Storage: Enable the block storage devices used for appliance data.

  8. Summary: Review all configuration settings, then select Submit.

After you submit, the appliance applies the configuration and redirects to the Perforce Unified Compliance login page.

Access the appliance

After setup is complete, access the appliance from a supported web browser using the appliance FQDN over HTTPS:

Interface

URL

Perforce Unified Compliance user interface

https://<appliance-fqdn>/

Identity provider administration console

https://<appliance-fqdn>/idp/admin/

Appliance setup console

https://<appliance-fqdn>/server-setup/