Installing Pipelines

JFrog Installation & Setup Documentation
ft:sourceType
Paligo

You can install and configure Pipelines on a single node and in a high availability cluster. For more information on high availability, see High Availability.

Before installing Pipelines 1.x, you must first install JFrog Artifactory 7.x. JFrog Pipelines requires a JFrog Artifactory instance with an Enterprise+ license.

Note

Use a dedicated server with no other software running to alleviate performance bottlenecks, avoid port conflicts, and avoid setting uncommon configurations.

To learn about the JFrog Platform Deployment, refer to System Architecture.

Admin Permissions for Installation

We recommend that you run the installation as a root user or provide sudo access to a non-root user.

You need to have admin permissions on the installation machine in the following cases.

  • Native installer - always requires admin permissions

  • Archive installer - requires admin permissions only during installation

  • Docker installer - does not require admin permissions

OpenSSL

Ensure that your environment has OpenSSL before you start the installation.

Run the following command to install OpenSSL.

Ubuntu

sudo apt-get install openssl

CentOS/RHEL

sudo yum install -y openssl

Before you proceed, see System Requirements for information on supported platforms, supported browsers, and other requirements.Private Distribution Network (PDN) System Requirements

Pipelines System Requirements

Pipelines makes use of the Artifactory filestore for performing storage functions such as step caching.

Operating Systems and Platform Support

The following table lists the supported operating systems and the versions.

Product

Debian

Centos*

RHEL

Ubuntu

Windows Server

SLES

Amazon Linux

Pipelines

7.x

7.x, 8.x, 9.x

18.04, 20.04, 22.04

Build nodes only

Amazon Linux 2023, Amazon Linux 2

Operating Systems - End of Support

As part of JFrog commitment to maintain the security and reliability of the JFrog Platform, from Q1-2024, JFrog Artifactory will officially run with Node.js 20.x on all installation types.

Node.js 20.x provided with Linux Archive/Debian/RPM installations (non-containerized distributions) is not supported on the following operating systems:

Hence, these operating systems are no longer supported for JFrog Artifactory.

Supported Platforms

The following table lists the supported platforms.

Product

x86-64

ARM64

Kubernetes

OpenShift

Pipelines

1.19+

Installation on Kubernetes environments is through Helm Charts. Supported Helm version is Helm 3+.

ARM64 Support

From version 7.41.4, Artifactory supports installation on ARM64 architecture through Helm and Docker installations. You must set up an external database as the Artifactory database since Artifactory does not support the bundled database with the ARM64 installation. Artifactory installation pulls the ARM64 image automatically when you run the Helm or Docker installation on the ARM64 platform.

ARM64 support is also available for Xray, Distribution, and Insight. ARM64 support is not available for Pipelines.

Database and Third-Party Applications in Pipelines

For a single node installation of Pipelines, the PostgreSQL database is by default installed on the same node as Pipelines. It may be optionally configured as an external database.

Pipelines HA requires an external database for common use by all HA nodes.

Pipelines supports the following versions of PostgreSQL.

  • 10.x

  • 11.x

  • 12.x

  • 13.x

Pipelines uses Redis 6.2.6 and bundles a Redis package along with the installer.

RabbitMQ 3.8 is installed as part of the Pipeline installation for every node In case of HA architecture, it uses queue mirroring between the different RabbitMQ nodes. You should not use any other external RabbitMQ instance.

Pipelines Network Ports

Pipelines uses the 8082 port and 30001 (30200 from Pipelines 1.0 to 1.10.0) by default for external communication.

Pipelines uses the following internal ports by default for communication with JFrog Platform microservices.

Microservice

Port

Pipelines API

8082

Pipelines WWW (UI)

30001

SSH access to the instance

22

Database (PostgreSQL) access

5432

RabbitMQ

30200

RabbitMQ Admin

30201

Vault

30100

Redis Cluster

6379, 16379, 6380, 16380, 6381, 16381

Installation Steps

The installation procedure involves the following main steps:

  1. Download Pipelines as per your required installer type (Linux Archive, RPM, Debian, Helm).

  2. Install Pipelines either as a single node installation, or high availability cluster.

    1. Install third-party dependencies (PostgreSQL and Elasticsearch databases, included in the archive)

    2. Install Pipelines

  3. Configure the service

    1. Connection to Artifactory (joinKey and jfrogUrl)

    2. Additional optional configuration including changing default credentials for databases

  4. Start the Service using the start scripts or OS service management.

  5. Check the Service Log to check the status of the service.

Default Home Directory / $JFROG_HOME

The default Xray home directory is defined according to the installation type. For additional details see the Product Directory Structure page.

$JFROG_HOME represents the JFrog root directory containing the deployed product.

Pipelines Single Node Installation

Choose one of the following methods for installing Pipelines in a single node.

Pipelines HA Installtion

You can also install Pipelines in HA mode. For more information, see Pipelines HA Installation