Before you proceed, see System Requirements for information on supported platforms, supported browsers, and other 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.
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.
The following table lists the supported platforms.
Installation on Kubernetes environments is through Helm Charts. Supported Helm version is Helm 3+.
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.
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.
Pipelines WWW (UI)
SSH access to the instance
Database (PostgreSQL) access
6379, 16379, 6380, 16380, 6381, 16381
In addition, review the Helm Chart requirements.
Helm Chart Requirements
For Helm Charts installations, JFrog services requires the following prerequisites.
JFrog validates compatibility with the core Kubernetes distribution. Since Kubernetes distribution vendors may apply additional logic or hardening (for example Rancher) JFrog Platform deployment with such platform vendors might not be fully supported.
Before you deploy Pipelines using Helm Chart, you need to deploy the NGINX Ingress Controller.
Pipelines requires Artifactory to be setup with a Kubernetes Ingress controller for all functionalities to work.
For more information, see Helm Charts for Advanced Users.
Add https://charts.jfrog.io to your Helm client.
helm repo add jfrog https://charts.jfrog.io
Update the repository.
helm repo update
To connect Pipelines to your Artifactory installation, you will need to use a Join Key. To provide a Join Key, jfrogUrl, and jfrogUrlUI to your Pipelines installation, retrieve the connection details of your Artifactory installation from the UI as shown below. For more information, see Viewing the Join Key.
pipelines: ## Artifactory URL - Mandatory ## If Artifactory and Pipelines are in same namespace, jfrogUrl is Artifactory service name, otherwise its external URL of Artifactory jfrogUrl: "" ## Artifactory UI URL - Optional ## This must be the external URL of Artifactory, for example: https://artifactory.example.com ## If you provide a value here, it overrides the JFrog Platform Custom URL. A custom URL is necessary for Pipelines to function. ##If JFrog Platform Custom URL does not exist,You must provide a value with the installation or configure the custom URL through UI after installation. jfrogUrlUI: "" ## Join Key to connect to Artifactory ## IMPORTANT: You should NOT use the example joinKey for a production deployment! joinKey: EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE ## Pipelines requires a unique master key ## You can generate one with the command: "openssl rand -hex 32" ## IMPORTANT: You should NOT use the example masterKey for a production deployment! masterKey: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
You can choose to set the Redis password in the
values.yamlfile and pass it with the installation by setting
redis.usePasswordset as true.
The following snippet shows the configuration.
redis: password: "password" usePassword: true
Get the Pipelines
helm chartto get the required configuration files.
helm fetch jfrog/pipelines --untar
Configure the installation by editing the local copies of the
values-ingress-passwords.yamlwith the required configuration values.
Edit the URLs in the
values-ingress.yamlfile (Artifactory URL, Ingress hosts, Ingress tls secrets).
Set the passwords
auth.passwordin the local copies.
Unlike other installations, Helm Chart configurations are made to the
values.yamland are then applied to the
Follow these steps to apply the configuration changes.
Make the changes to
Run the command.
helm upgrade --
pipelines --namespace pipelines -f values.yaml
kubectl create ns pipelines helm upgrade --install pipelines --namespace pipelines jfrog/pipelines -f pipelines/values-ingress.yaml -f pipelines/values-ingress-passwords.yaml
Access Pipelines from your browser at:
http://<jfrogUrl>/ui/, then go to the Pipelines tab in the Application module in the UI.
Check the status of your deployed helm releases.
helm status pipelines
For advanced installation options, see Helm Charts Installers for Advanced Users.