Before you proceed, see System Requirements for information on supported platforms, supported browsers, and other requirements.
In addition, review the Helm Chart requirements.
Helm Chart Requirements
For Helm Charts installations, JFrog services requires the following prerequisites.
Kubernetes 1.19+ (for installation instructions, see Kubernetes installation)
Kubernetes cluster with:
Dynamic storage provisioning enabled
Default StorageClass set to persistent storage
Kubectl installed and set up to use the cluster
Helm v3 installed
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.
Important
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.yaml
file and pass it with the installation by settingredis.usePassword
set as true.The following snippet shows the configuration.
redis: password: "password" usePassword: true
Get the Pipelines
helm chart
to get the required configuration files.helm fetch jfrog/pipelines --untar
Configure the installation by editing the local copies of the
values-ingress.yaml
and
values-ingress-passwords.yaml
with the required configuration values.Edit the URLs in the
values-ingress.yaml
file (Artifactory URL, Ingress hosts, Ingress tls secrets).Set the passwords
uiUserPassword
,postgresqlPassword
andauth.password
in the local copies.Set the
masterKey
andjoinKey
in thevalues-ingress-passwords.yaml
.Unlike other installations, Helm Chart configurations are made to the
values.yaml
and are then applied to thesystem.yaml
.Follow these steps to apply the configuration changes.
Make the changes to
values.yaml.
Run the command.
helm upgrade --
install
pipelines --namespace pipelines -f values.yaml
Install Pipelines.
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
Note
For advanced installation options, see Helm Charts Installers for Advanced Users.