JFrog Platform Helm Chart Installation Steps

Installing the JFrog Platform using the jfrog-platform Helm Chart will install the products in the following setup by default.

JFrog Artifactory
JFrog Xray/JFrog Insight/JFrog Distribution/JFrog Pipelines: Single Node

Add the https://charts.jfrog.io to your Helm client.
```
helm repo add jfrog https://charts.jfrog.io
```
Update the repository.
```
helm repo update
```

Install the chart with the release name jfrog-platform.

helm upgrade --install jfrog-platform --namespace jfrog-platform --create-namespace jfrog/jfrog-platform

Optional: Customize the Helm Chart installation to install one or more of the JFrog products.
The JFrog Platform Helm Chart provides the flexibility of enabling one or more of the JFrog additional products during the installation, which means that you can choose to install all of the products (Distribution, Insight, Pipelines, and Xray), or only some of them.
For example:
1. To enable Xray and Insight with Artifactory, you can create a custom-values.yaml with the following content and then pass it during installation.
```
xray:
  enabled: true
insight:
  enabled: true
distribution:
  enabled: false
pipelines:
  enabled: false
```
2. Run the installation.
```
helm upgrade --install jfrog-platform --namespace jfrog-platform --create-namespace jfrog/jfrog-platform  -f custom-values.yaml
```
3. You can configure each JFrog product separately with the following steps.
  1. View the main values.yaml file and copy the configurations that you wish to update into a custom-values.yaml file.
  2. Update the product configuration with custom values in the custom-values.yaml file.
    For the values not specified in the custom-value.yaml file, the default values in the original values.yaml of the chart are used.
  3. Run the upgrade command.
```
helm upgrade --install jfrog-platform --namespace jfrog-platform --create-namespace jfrog/jfrog-platform  -f custom-values.yaml
```
If you wish to enable Artifactory and disable all the other products, you can create a custom-values.yaml with the following content and then pass it during installation.
```
xray:
  enabled: false
insight:
  enabled: false
distribution:
  enabled: false
pipelines:
  enabled: false
```
For more specific product configuration information, see System YAML Configuration File.
Once the installation completes, you will be able to see the products that have been installed.
```
NOTES:
Congratulations. You have just deployed JFrog Platform Chart with the following products:
- artifactory
- xray
- insight
- distribution
- pipelines
```
Optionally, you can apply advanced configurations through the values.yaml file. Ensure that you provide the Artifactory values within the artifactory.artifactory section of the values.yaml and not the artifactory section of the values.yaml file.
```
artifactory:
  .
  .
  .
  database:
     .
    .
  mc:
    .
    .
  artifactory:
  	.
  	.
```
For more information on these advanced configurations, see Helm Charts for Advanced Users.

Connect to Artifactory.

It may take a few minutes for Artifactory's public IP to become available. Follow the instructions that are output by the install command above to get the Artifactory IP to access it. Below you will find a sample instruction of what to look for to pick the URL to reach Artifactory (in the following example, jfrog-platform is the release name and jfrog-platform is the namespace).

Congratulations. You have just deployed JFrog Artifactory.
1. Get the Artifactory URL by running these commands:
   NOTE: It may take a few minutes for the LoadBalancer IP to be available.
         You can watch the status of the service by running 'kubectl get svc --namespace jfrog-platform -w jfrog-platform-artifactory-nginx'
   export SERVICE_IP=$(kubectl get svc --namespace jfrog-platform jfrog-platform-artifactory-nginx -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
   echo http://$SERVICE_IP/
2. Open Artifactory in your browser
   Default credential for Artifactory:
   user: admin
   password: password

Install the JFrog Platform license using one of three methods: REST API, Artifactory UI, or a Kubernetes Secret. For more information, click the link below.
Add Licenses
To activate Artifactory HA, you must install an appropriate license as part of the installation. There are three ways to manage the license: via Artifactory UI, REST API, or a Kubernetes Secret.
Specify multiple licenses
Whether in the Artifactory UI, using the REST API or in the artifactory.cluster.license file, make sure that the licenses are separated by a newline.
The easiest and recommended way is by using Artifactory UI. Using the Kubernetes Secret or REST API is for advanced users and is better suited for automation.
Warning
You should use only one of these methods. Switching between them while a cluster is running might disable your Artifactory HA cluster.
You can add licenses via Install License API. Note that the REST API uses "\n" for the newlines in the licenses (this is currently recommended method).Install License
Once the primary cluster is running, open Artifactory UI and insert the license(s) in the UI. See HA installation and setup for more details.
Enter all of the licenses at once, with each license separated by a newline. If you add the licenses one at a time, you may get redirected to a node without a license and the UI will not load for that node.
Important
This method is relevant for initial deployment only. Once Artifactory is deployed, you should not keep passing these parameters, since the license is already persisted into Artifactory's storage (and they will be ignored). Updating the license should be done via Artifactory UI or REST API.
You can deploy the Artifactory license(s) as a Kubernetes Secret. You will need to prepare a text file with the license(s) written in it. If adding multiple licenses, they are added in the same file. Remember to addtwo new lines between eachlicense block.
Create the Kubernetes secret (assuming the local license file is 'art.lic').
kubectl create secret generic artifactory-cluster-license --from-file=./art.lic
Create a license-values.yaml.
artifactory: license: secret: artifactory-cluster-license dataKey: art.lic
Install with the license-values.yaml.
Run the following command for JFrog Platform.
helm upgrade --install jfrog-platform --namespace jfrog-platform --create-namespace jfrog/jfrog-platform -f license-values.yaml
Run the following command for Artifactory.
helm upgrade --install artifactory --set artifactory.license.secret=artifactory-cluster-license,artifactory.license.dataKey=artifactory.lic --namespace artifactory jfrog/artifactory
Create the Kubernetes Secret as Part of the Helm Release
Create a license-values.yaml.
artifactory: license: licenseKey: |- <LICENSE_KEY1> <LICENSE_KEY2> <LICENSE_KEY3>
Install with the license-values.yaml.
helm upgrade --install jfrog-platform --namespace jfrog-platform --create-namespace jfrog/jfrog-platform -f license-values.yaml
Note
This method is relevant for initial deployment only. Once Artifactory is deployed, you should not keep passing these parameters, since the license is already persisted into Artifactory's storage (and they will be ignored). Updating the license should be done via Artifactory UI or REST API.
If you want to keep managing the Artifactory license using the same method, you can use the copyOnEveryStartup example shown in the values.yaml file.
To access the logs, find the name of the pod using the following command.
```
kubectl --namespace <your namespace> get pods
```

To get the specific container logs, run the following command.

kubectl --namespace <your namespace> logs -f <name of the pod> -c <name of the container>

Customize the product configuration (optional) including database, Java Opts, and filestore.
Note
If you install Xray with the JFrog Platform charts, the RabbitMQ vhost is named "xray". If you install Xray with the standalone Xray helm Chart installation, "/" is set as the RabbitMQ vhost.

Specify multiple licenses

Warning

Important

Create the Kubernetes Secret as Part of the Helm Release

Note

Note