Debian
Debian installation instructions for package based installs, either automatically using apt-get or manually with pre-downloaded deb packages.
The Perforce IPLM platform can be installed via packages or via the Appliance Installation. The Appliance Installation method deploys an already configured VM into the customer Hypervisor. See the Perforce Appliance Installation page for more details.
The package installation method for Perforce IPLM on Debian uses .deb packages installed using apt-get. The instructions below are listed at the top of each of the following subsections. In case apt-get installation is not available at the customer site the manual .deb installation process is outlined.
The Pi Command Line Client (IPLM CLI can also be installed via a self-extracting tarball (the ".run" file) to enable installation in an NFS mounted centralized tools location. See the PiClient Self-Extracting Archive page for details.
The IPLM CLI client can also be installed with the scripted Client installation method, which sets up VersIC, PiExtras, and the necessary environment setup in a single step. See the Client-Only Tutorial Installation for Perforce.
Setting Up the Repo
Install the Perforce Debian package repo.
1. Add the latest Certs.
apt-get install ca-certificates
2. Add the Perforce Debian package source.
echo "deb https://mdx.jfrog.io/mdx/debian/ jessie production" >>/etc/apt/sources.list
3. Get the Perforce apt key.
wget -O - https://mdx.jfrog.io/mdx/mdx-generic/mdx@methodics.com.gpg.key | apt-key add -
4. Update apt.
apt-get update
Note: Package apt-transport-https might need to be installed first
Metrics Installation
Metrics installation can be skipped if you are not going to monitor Perforce IPLM metrics. More information on Metrics can be found on the Perforce IPLM Metrics page.
The Metrics package is installed as a standard Linux package using the 'apt-get' package manager on Debian systems.
1. (Optional) Skip this step if Perforce Debian package repo is set up already. 1.1 Add the latest Certs. apt-get install ca-certificates 1.2 Add the methodics apt source. echo "deb https://mdx.jfrog.io/mdx/debian/ jessie production" >>/etc/apt/sources.list 1.3 Get the methodics apt key. wget -O - https://mdx.jfrog.io/mdx/mdx-generic/mdx@methodics.com.gpg.key | apt-key add - 1.4 Update apt. apt-get update Note: Package apt-transport-https might need to be installed first 2. Install Metrics package. 2.1 Update apt. apt-get update 2.2 Install Metrics. apt-get install mdx-metrics -y 2.3 Start Prometheus and Grafana services. service mdx-metrics-prometheus start service mdx-metrics-grafana start 2.4 If using IPLM Cache, start the Node and StatsD Exporters. service mdx-metrics-node-exporter start service mdx-metrics-statsd-exporter start
Metrics Upgrade
1. Upgrade Metrics Debian package
apt-get update; apt-get install mdx-metrics -y
2. Restart Prometheus and Grafana services.
service mdx-metrics-prometheus start
service mdx-metrics-grafana start
3. If using IPLM Cache, restart the Node and StatsD Exporters.
service mdx-metrics-node-exporter restart
service mdx-metrics-statsd-exporter restart
Metrics Manual Install
1. Download the required package.
1.1 Browse to https://mdx.jfrog.io/mdx/debian/pool/production/ and download,
<mdx-metrics>1.2 Download dependencies
wget https://mdx.jfrog.io/mdx/mdx-generic/grafana/mdx-grafana-bin-6.1.6.tgz
wget https://mdx.jfrog.io/mdx/mdx-generic/jmx-exporter/mdx-jmx-exporter-0.11.0.tgz
wget https://mdx.jfrog.io/mdx/mdx-generic/prometheus/mdx-node-exporter-bin-0.17.0.tgz
wget https://mdx.jfrog.io/mdx/mdx-generic/prometheus/mdx-prometheus-bin-2.9.2.tgz
wget https://mdx.jfrog.io/mdx/mdx-generic/prometheus/mdx-statsd-exporter-bin-0.11.2.tgz
**Transfer the package to the target machine**
2. Install dependencies
mkdir -p /usr/share/mdx/metrics
cd /usr/share/mdx/metrics
tar xf <path to mdx-grafana-bin-6.1.6.tgz> tar xf <path to mdx-jmx-exporter-0.11.0.tgz> tar xf <path to mdx-node-exporter-bin-0.17.0.tgz> tar xf <path to mdx-prometheus-bin-2.9.2.tgz> tar xf <path to mdx-statsd-exporter-bin-0.11.2.tgz>3. On the target machine install the package.
dpkg -i <mdx-metrics>4. Start the Prometheus and Grafana services and the Node and StatsD Exporters, as above.
IPLM Server Installation
Perforce IPLM server is installed as a standard Linux package using 'apt-get' package manager on Debian systems.
Install Java
Java-8 JRE is required to run IPLM Server. In order to help troubleshooting problems that might be related with IPLM Server, Java-8 JDK is recommended.
Both Oracle Java and OpenJDK are supported.
Please refer to instructions on Oracle website for installation of Oracle JDK/JRE.
Below are the instructions for OpenJDK installation.
1. Install openjdk-8-jdk, if it's not installed already
1.1 dpkg -l openjdk-8-jdk
$ dpkg -l openjdk-8-jdk
Desired=Unknown/Install/Remove/Purge/Hold
| Status=Not/Inst/Conf-files/Unpacked/halF-conf/Half-inst/trig-aWait/Trig-pend
|/ Err?=(none)/Reinst-required (Status,Err: uppercase=bad)
||/ Name Version Architecture Description
+++-===================================-======================-======================-============================================================================
ii openjdk-8-jdk:amd64 8u171-b11-1~bpo8+1 amd64 OpenJDK Development Kit (JDK)
$
1.2 If the above command doesn't show any openjdk-8-jdk package, install it as root.
Please note that the steps for Debian 8 and Debian 9 are a bit different.
1.2.1 For Debian 9,
$ cat /etc/debian_version
9.8
$
$ su -
# apt-get update
...
# apt-get install openjdk-8-jdk
...
# exit
$
1.2.2 For Debian 8,
$ cat /etc/debian_version
8.2
$
$ su -
# echo "deb http://archive.debian.org/debian/ jessie-backports main non-free contrib" > /etc/apt/sources.list.d/debian8-archive.list
# echo 'Acquire::Check-Valid-Until no;' > /etc/apt/apt.conf.d/99no-check-valid-until
# apt-get update
...
# apt-get -t jessie-backports install openjdk-8-jdk
...
# exit
$
1.3 Run "dpkg -l openjdk-8-jdk" again to verify the package is installed
2. Configure OpenJDK 8 as default java program.
This is mostly required in Debian 8 system because the default OpenJDK package in Debian 8 is openjdk-7.
2.1 su -
# update-java-alternatives --list
java-1.7.0-openjdk-amd64 1071 /usr/lib/jvm/java-1.7.0-openjdk-amd64
java-1.8.0-openjdk-amd64 1069 /usr/lib/jvm/java-1.8.0-openjdk-amd64
#
# update-java-alternatives --set java-1.8.0-openjdk-amd64
#
3. Verify Java program version
3.1 Run "java -version" and verify it's 'openjdk version "1.8.0_xxx"'.
3.2 Run "javac -version" and verify version number is same.
Install 3.0 IPLM Server packages
Instructions in this section install IPLM Server for the latest Pi v3 release. If a 2.x version of IPLM Server is installed already, please refer to the section of "Upgrade 2.x IPLM Server to 3.0 IPLM Server" below for upgrade instructions.
1. (Optional) Skip this step if Perforce Debian package repo is set up already. 1.1 Add the latest Certs. apt-get install ca-certificates 1.2 Add the methodics apt source. echo "deb https://mdx.jfrog.io/mdx/debian/ jessie production" >>/etc/apt/sources.list 1.3 Get the methodics apt key. wget -O - https://mdx.jfrog.io/mdx/mdx-generic/mdx@methodics.com.gpg.key | apt-key add - 1.4 Update apt. apt-get update Note: Package apt-transport-https might need to be installed first 2. Install IPLM Server debian packages. 2.1 As root, run: apt-get install mdx-piserver -y Note: For 3.0 and later IPLM Server releases, Neo4j is installed automatically when mdx-piserver package is installed. The behavior of Neo4j installation can be controlled with MDX_PISERVER_NEO4J_INSTALL environmental variable. The following command uses neo4j-enterprise-3.5.3 tarball that is pre-downloaded, MDX_PISERVER_NEO4J_INSTALL=<full path of Neo4j tarball> apt-get install mdx-piserver -y The following command skips installation of Neo4j and only installs files for IPLM Server, MDX_PISERVER_NEO4J_INSTALL=0 apt-get install mdx-piserver -y 2.2 (Optional) Configure Java executable for Piserver vi /etc/mdx/piserver # configure javaexe option with full path of preferred Java executable Note: If the system default Java program is the preferred Java executable, no need to configure javaexe option. 2.3 As root, reboot the system and have all the services started automatically, or run: service neo4j start; service piserver start Note: Neo4j log files are under /var/log/neo4j/ and Piserver log files are under /var/log/mdx-piserver/. 2.4 To start IPLM Server automatically after reboot, run: systemctl enable neo4j; systemctl enable piserver 2.5 If you failed to enable neo4j with systemctl, try the following: 2.5.1 Edit: /etc/systemd/system/piserver.service 2.5.2 Append neo4j.service to both lines of Wants and After.
HA Neo4j Cluster Installations
Note that if you have a clustered installation you will need to update the mdx-piserver-neo4j-plugin on each Neo4j node, and then restart Neo4j on each Neo4j Node. See Perforce IPLM HA with HAProxy and Neo4j cluster for additional information.
Upgrade IPLM Server 2.x to IPLM Server 3.0
For Pi v3 release, mdx-piserver-tools, mdx-piserver-conf and mdx-piserver-core packages are obsoleted. To upgrade IPLM Server 2.x to IPLM Server 3.0, the mdx-piserver-tools, mdx-piserver-conf, mdx-piserver-core and mdx-piserver packages need to be manually removed and the new 3.0 mdx-piserver package needs to be installed.
1. Stop IPLM Server service if it's running. service neo4j stop service piserver stop Note: to ensure IPLM Server and Neo4j daemons are stopped, run "ps aux | grep java" and make sure related java processes do not exist. 2. (Optional) Save Neo4j folders. cp -a /usr/share/mdx/neo4j /usr/share/mdx/neo4j.bak cp -a /var/lib/neo4j /var/lib/neo4j.bak 3. Backup IPLM Server config file. cp -a /etc/mdx/piserver.conf /etc/mdx/piserver.conf.bak cp -a /etc/mdx/piserver.yml /etc/mdx/piserver.yml.bak 4. Remove 2.x piserver packages. dpkg -P mdx-piserver mdx-piserver-tools mdx-piserver-conf mdx-piserver-core 5. (Optional) Copy back the saved Neo4j folders if the Neo4j folders are saved above in step 2. cp -a /usr/share/mdx/neo4j.bak /usr/share/mdx/neo4j cp -a /var/lib/neo4j.bak /var/lib/neo4j 6. Install 3.0 mdx-piserver package. apt-get install -y mdx-piserver 7. Review and modify IPLM Server config files as needed. # vi /etc/mdx/piserver.conf # vi /etc/mdx/piserver.yml 8. Start IPLM Server service service neo4j start service piserver start
Install 2.x IPLM Server packages
This section applies to fresh install of 2.x IPLM Server. If an older version of 2.x IPLM Server is installed already, please refer to the section of "2.x IPLM Server Upgrade" below for upgrade instructions.
1. (Optional) Skip this step if Perforce Debian package repo is set up already. 1.1 Add the latest Certs. apt-get install ca-certificates 1.2 Add the methodics apt source. echo "deb https://mdx.jfrog.io/mdx/debian/ jessie production" >>/etc/apt/sources.list 1.3 Get the methodics apt key. wget -O - https://mdx.jfrog.io/mdx/mdx-generic/mdx@methodics.com.gpg.key | apt-key add - 1.4 Update apt. apt-get update Note: Package apt-transport-https might need to be installed first 2. Install tools for running IPLM Server 2.1 Java-8 JRE should be pre-installed before installing Piserver. OpenJDK-8 JRE is the preferred Java run-time for IPLM Server 2.33.0 and later versions. But Oracle JRE should continue to work. 2.2 As root, run: apt-get update 2.3 As root, run: apt-get install mdx-piserver-tools=2.36.3-20.12.10.16.13.25 -y 2.4 As root, run: /usr/share/mdx/products/piserver/bin/install-deps.sh Note: Without any arguments, the install-deps.sh script does not install any Java run-time. It only downloads and installs Neo4j. The install-deps.sh script also supports two options, "--java <JRE tarball>" and "--neo4j <Neo4j tarball>". The options allow user to specify a local JRE/Neo4j tarball for installation. 3. Install IPLM Server debian packages. 3.1 As root, run: apt-get install mdx-piserver=2.36.3-20.12.10.16.13.25 -y 3.2 (Optional) Configure Java executable for Piserver vi /etc/mdx/piserver # configure javaexe option with full path of preferred Java executable Note: If the system default Java program is the preferred Java executable, no need to configure javaexe option. 3.3 As root, reboot the system and have all the services started automatically, or run: service neo4j start; service piserver start Note: Neo4j log files are under /var/log/neo4j/ and Piserver log files are under /var/log/mdx-piserver/. 3.4 To start IPLM Server automatically after reboot, run: systemctl enable neo4j; systemctl enable piserver
2.x IPLM Server Upgrade
The instructions below apply to IPLM Server upgrade to a newer version of 2.x IPLM Server.
1. Install IPLM Server Debian packages. apt-get update; apt-get install mdx-piserver=<new 2.x version and timestamp> -y 2. Restart IPLM Server daemons. service neo4j restart; systemctl restart piserver
IPLM Server Property Configuration File
For Pi 3.0 and later releases, /etc/mdx/piserver.yml is the only IPLM Server property file. IPLM Server service doesn't use /etc/mdx/piserver.properties file any more.
Note: The /etc/mdx/piserver.yml property file has been adopted since Pi 2.35.0 release. For 2.35.0 and later 2.x releases, IPLM Server creates /etc/mdx/piserver.yml property file using the settings in /etc/mdx/piserver.properties file. After IPLM Server gets started for the first time, the new configuration file /etc/mdx/piserver.yml is created. File /etc/mdx/piserver.yml is in YAML format. Further IPLM Server configuration changes can be done in either of /etc/mdx/piserver.properties and /etc/mdx/piserver.yml. IPLM Serverwill use the configuration file that has newer timestamp. If /etc/mdx/piserver.properties is newer, it will be converted and overwrite /etc/mdx/piserver.yml. If /etc/mdx/piserver.yml is newer, it will be used directly by IPLM Server.
IPLM Server Manual Install
1. Download the required packages.
1.1 Browse to https://mdx.jfrog.io/mdx/debian/pool/production/ and download,
<mdx-piserver> <mdx-piserver-conf> (2.x releases only)
<mdx-piserver-core> (2.x releases only)
<mdx-piserver-tools> (2.x releases only)
Note: package versions should be consistent
1.2 Download Neo4j tarball.
wget https://mdx.jfrog.io/artifactory/mdx-generic/neo4j/enterprise/neo4j-enterprise-3.5.35-unix.tar.gz
**Transfer these packages to the target IPLM Server machine**
2. For manual install of 2.x releases,
2.1 install mdx-piserver-tools.
dpkg -i <mdx-piserver-tools>2.2 Install IPLM Server dependencies.
/usr/share/mdx/products/piserver/bin/install-deps.sh --neo4j <full path to neo4j-enterprise-3.5.35-unix.tar.gz>
2.3 Insta IPLM Server packages.
dpkg -i <mdx-piserver> <mdx-piserver-conf> <mdx-piserver-core>
3. For manual install of 3.x releases,
3.1 If the target system has the old 2.x IPLM Server packages installed, please refer to the section "Upgrade IPLM Server 2.x to IPLM Server 3.0" above and use dpkg command to install the mdx-piserver package.
3.2 Install IPLM Server.
MDX_PISERVER_NEO4J_INSTALL=<full path neo4j-enterprise-3.5.35-unix.tar.gz> dpkg -i <mdx-piserver> Note: If Neo4j is not to be installed, use the command below.
MDX_PISERVER_NEO4J_INSTALL=0 dpkg -i <mdx-piserver>
IPLM Client installation
Perforce IPLM client can be installed as a standard Linux package using 'apt-get' package manager on Debian systems.
1. (Optional) Skip this step if Perforce Debian package repo is set up already. 1.1 Add the latest Certs. apt-get install ca-certificates 1.2 Add the methodics apt source. echo "deb https://mdx.jfrog.io/mdx/debian/ jessie production" >>/etc/apt/sources.list 1.3 Get the methodics apt key. wget -O - https://mdx.jfrog.io/mdx/mdx-generic/mdx@methodics.com.gpg.key | apt-key add - 1.4 Update apt. apt-get update Note: Package apt-transport-https might need to be installed first 2. Install IPLM CLI Debian packages. 2.1 Update apt. apt-get update 2.2 Install IPLM Client. apt-get install mdx-picli -y
IPLM Client Upgrade
1. Upgrade IPLM Client Debian packages.
apt-get update; apt-get install mdx-picli -y
IPLM Client Manual Install
1. Download the required packages.
1.1 Browse to https://mdx.jfrog.io/mdx/debian/pool/production/ and download,
<mdx-picli> <mdx-picli-lib>
**Transfer these packages to the target IPLM Client machine**
2. On the target machine install the client packages.
dpkg -i <mdx-picli> <mdx-picli-lib>
IPLM Web Installation
1. (Optional) Skip this step if Perforce Debian package repo is set up already. 1.1 Add the latest Certs. apt-get install ca-certificates 1.2 Add the methodics apt source. echo "deb https://mdx.jfrog.io/mdx/debian/ jessie production" >>/etc/apt/sources.list 1.3 Get the methodics apt key. wget -O - https://mdx.jfrog.io/mdx/mdx-generic/mdx@methodics.com.gpg.key | apt-key add - 1.4 Update apt. apt-get update Note: Package apt-transport-https might need to be installed first 2. Install IPLM Web. 2.1 Update apt apt-get update 2.2 Install IPLM Web. apt-get install mdx-piweb -y
IPLM Web upgrade
1. Upgrade IPLM Web Debian packages.
apt-get update; apt-get install mdx-piweb -y
IPLM Web Manual Install
1. Download the required packages.
1.1 Browse to https://mdx.jfrog.io/mdx/debian/pool/production/ and download,
<mdx-piweb> <mdx-piweb-lib>
**Transfer these packages to the target IPLM Server machine**
2. On the target machine install the IPLM Web packages.
2.1 dpkg -i <mdx-piweb> <mdx-piweb-lib>
Note: nodejs and npm are now included in mdx-piweb-lib
IPLM Web Document Installation
Install IPLM Web as noted above
Then, as root, run
apt-get update; apt-get install mdx-piweb-doc -y
IPLM WebDocument Upgrade
Upgrade IPLM Web Document Debian packages.
apt-get update; apt-get install mdx-piweb-doc -y
IPLM Web Manual Install
1. Download the required packages.
1.1 Browse to https://mdx.jfrog.io/mdx/debian/pool/production/ and download,
<mdx-piweb-doc>
**Transfer these packages to the target IPLM Server machine**
2. On the target machine install the IPLM Web document package.
2.1 dpkg -i <mdx-piweb-doc>
PiExtras Installation
1. (Optional) Skip this step if Perforce Debian package repo is set up already.
1.1 Add the latest Certs.
apt-get install ca-certificates
1.2 Add the methodics apt source.
echo "deb https://mdx.jfrog.io/mdx/debian/ jessie production" >>/etc/apt/sources.list
1.3 Get the methodics apt key.
wget -O - https://mdx.jfrog.io/mdx/mdx-generic/mdx@methodics.com.gpg.key | apt-key add -
1.4 Update apt.
apt-get update
Note: Package apt-transport-https might need to be installed first
2. Install mdx-piextras.
2.1 Update apt.
apt-get update
2.2 Install mdx-piextras.
apt-get install mdx-piextras -y
PiExtras upgrade
1. Upgrade PiExtras Debian package
apt-get update; apt-get install mdx-piextras -y
PiExtras manual install
1. Download the required package.
1.1 Browse to https://mdx.jfrog.io/mdx/debian/pool/production/ and download,
<mdx-piextras>**Transfer the package to the target IPLM Server machine**
2. On the target machine install the mdx-piextras package.
dpkg -i <mdx-piextras>
IPLM Cache installation
IPLM Cache requires a dedicated server for production deployments. IPLM Cache is I/O intensive and should be hosted on a separate server from IPLM Server and IPLM Web.
1. (Optional) Skip this step if Perforce Debian package repo is set up already. 1.1 Add the latest Certs. apt-get install ca-certificates 1.2 Add the methodics apt source. echo "deb https://mdx.jfrog.io/mdx/debian/ jessie production" >>/etc/apt/sources.list 1.3 Get the methodics apt key. wget -O - https://mdx.jfrog.io/mdx/mdx-generic/mdx@methodics.com.gpg.key | apt-key add - 1.4 Update apt. apt-get update Note: Package apt-transport-https might need to be installed first 2. Install mdx-picache. 2.1 Install backend server packages. apt-get install mdx-backend-redis mdx-backend-mongodb -y 2.2 Install IPLM Cache packages. apt-get install mdx-picache -y 2.3 Review/Update IPLM Cache settings in /etc/mdx/picache.conf 2.3.1 "root" configuration option defines the location IPLM Cache will use to populate IPVs on disk, and needs to be defined. The "root" directory path needs to be created before starting the IPLM Cache server. 2.3.2 If "worker-user" is defined, make sure the user has the write permission to the "root" path. If "worker-user" is not defined, make sure user "mdxadmin" has the write permission to the "root" path. Note: The "root" path typically points to a folder exported from filer. If so, please make sure the mount options allow "worker-user" or "mdxadmin" to write to it. Typically, the "root" path is owned by "worker-user" or "mdxadmin" to avoid any permission problem. 2.3.3 "dm-program" needs to point to valid p4 executable 2.4 Start IPLM Cache daemons. service mdx-backend-redis start service mdx-backend-mongodb start service picache start 2.5 To staIPLM Server automatically after reboot, run: systemctl enable mdx-backend-redis systemctl enable mdx-backend-mongodb systemctl enable picache
IPLM Cache Upgrade
1. Upgrade IPLM Cache Debian packages
apt-get update; apt-get install mdx-picache -y
IPLM CacheManual Install
1. Download the required package.
1.1 Browse to https://mdx.jfrog.io/mdx/debian/pool/production/ and download,
<mdx-picache> <mdx-picache-lib> <mdx-backend-redis> <mdx-backend-mongodb>
**Transfer the packages to the target IPLM Server machine**
2. On the target machine install the packages.
dpkg -i <mdx-picache> <mdx-picache-lib> <mdx-backend-redis> <mdx-backend-mongodb>
PiForce installation
1. (Optional) Skip this step if Perforce Debian package repo is set up already.
1.1 Add the latest Certs.
apt-get install ca-certificates
1.2 Add the methodics apt source.
echo "deb https://mdx.jfrog.io/mdx/debian/ jessie production" >>/etc/apt/sources.list
1.3 Get the methodics apt key.
wget -O - https://mdx.jfrog.io/mdx/mdx-generic/mdx@methodics.com.gpg.key | apt-key add -
1.4 Update apt.
apt-get update
Note: Package apt-transport-https might need to be installed first
2. Install mdx-piforce.
2.1 Install PiForce package
apt-get install mdx-piforce -y
2.2 Review/update PiForce configuration file
vi /etc/mdx/piforce.yml
Note: Please make sure that there's a space after the configuration name(and colon) and before its value and the value is on the same line of the configuration name. For example, "uri: p4java://localhost:1666" Note: When using p4javassl in the uri, run the following commands to trust the server fingerprint,
su - mdxadmin
p4 -p ssl:<p4 server host>:<p4 server port> trust
2.3 Start/stop PiForce daemon
service piforce start
service piforce status
service piforce stop
PiForce Upgrade
1. Upgrade PiForce Debian package
apt-get update
apt-get install mdx-piforce -y
PiForce Manual Install
1. Download the required package.
1.1 Browse to https://mdx.jfrog.io/mdx/debian/pool/production/ and download,
<mdx-piforce>**Transfer the package to the target machine**
2. On the target machine install the mdx-piforce package.
dpkg -i <mdx-piforce>