JFrog Partner Integrations

Supported Partner Integrations

JFrog Artifactory

JFrog Container Registry

Deploying Artifactory Using Partner Integrations

The following Artifactory deployment types are described:

• Amazon AWS Container Marketplace

• Google GCP GKE Kubernetes App

• Microsoft Azure Arm Template
• Rancher Catalog Helm Chart
• Red Hat Certified UBI Docker Image
• Red Hat Certified OpenShift Operator

Amazon AWS Container Marketplace

The AWS Container Marketplace offers an alternative Docker image to the official JFrog Artifactory Docker image. The Marketplace image is identical to the official JFrog Artifactory Docker image with the only difference being that the Marketplace image does not start up with the default credentials (admin:password). The end-user must set or get the first time password.

Prerequisites

• An active AWS subscription
• An Artifactory Pro (or higher) license
• Docker (or service capable of deploying Docker images)

To set up the JFrog Artifactory in AWS Container Marketplace:

1. Subscribe to the listing.
2. Navigate to Continue to configuration | Continue to Launch | View container image details.
3. Follow the instructions to log in and perform a pull of the image.
4. Configure the image similarly to the way you would configure the official JFrog Docker image (with the only difference being the image name).
5. Run the image and get or set the first time password.

Setting the Password for the First Time

Amazon AWS Container Marketplace does not allow default passwords. As such, you need to provide a password during container initialization or one will be randomly generated. 

To set the first time initialization password for the 'admin' user, pass the environment variable ARTIFACTORY_PASSWORD with the desired password. For example:

docker run ... --env ARTIFACTORY_PASSWORD=my-new-password <image-url>

If no initialization password is provided, one will be generated and printed to the logs. To get the randomly generated password, you can do so by looking at the first few lines of the Docker container logs as displayed in the following example.

docker logs <container-id> | head -n 10
INFO: Since ARTIFACTORY_PASSWORD environment is not set. We are generating our own random password.
Generated ARTIFACTORY_PASSWORD is Ieqo868W99SBY5cqzx

Upgrading Artifactory in the AWS Container Marketplace

To upgrade, refer to the official Docker to Docker upgrade procedure, whereby only the image name/source differs.

Google GCP GKE Kubernetes App

The Google GCP GKE Kubernetes App allows Google's GCP users the ability to deploy a high availability instance of JFrog Artifactory with the click of a few buttons. This deployment is supported for GCP's GKE and via Anthos (for Hybrid/On-Prem) GKE. 

Prerequisites

• Active GCP subscription
• Artifactory Enterprise Licenses (2+)
• A domain name with corresponding SSL Certificate (optional but strongly recommended for production)

To deploy the Artifactory using the Google GCP GKE Kubernetes App:

1. Go to the JFrog Artifactory Enterprise listing.
2. Click Configure and select the target Project in which to deploy.
3. Select the cluster you wish to deploy to or create a new one.
4. Fill out the details, making sure to change the master key (and recording it).
5. Click Deploy and wait for the application to be deployed.
6. Follow the instructions on the right hand side of the App to get the public IP.
7. Provide the license via the UI or REST API.

Upgrading Artifactory in the Google GCP GKE Kubernetes App

To upgrade, you need to manually edit the workloads:

1. Go to the GKE workloads page, select the Project in which the the app is deployed.
2. Find and select the master workload: <app-name>-artifactory-ha-primary master.
3. Change the YAML from gcr.io/cloud-marketplace/jfrog/jfrog-gke:<existing version>  to gcr.io/cloud-marketplace/jfrog/jfrog-gke:<new version>  in all locations (no need to change the annotations). You have the option to:
   1. Select the JFrog GKE registry from a list of all versions.
   2. It is also possible to change the image to pull directly from JFrog, where images are updated at a more regular interval. In this case, use docker.bintray.io/jfrog/artifactory-pro:<new version>.
4. Scale the deployment down to zero, then back to 1.
5. Save the change and wait for the primary node to come up in the new version.
6. After the primary node is on the new version, repeat the same process of changing the image for the secondary workload: <app-name>artifactory-ha-member.
7. Scale the deployment down to zero, then back to previous member count (typically 2).
8. Verify all the nodes are now in the correct version of the UI | Administration | Monitoring | Service Status.

Microsoft Azure ARM Template

The Microsoft Azure ARM Template allows Microsoft Azure users the ability to deploy a high availability instance of JFrog Artifactory with the click of a few buttons. The ARM template is built in conjunction with Azure engineers to ensure best practices during deployment.

Prerequisites

• An active Azure subscription
• Spare vCPUs available in your region in Azure
• Artifactory Enterprise Licenses (2+)
• A domain name with corresponding SSL Certificate

To deploy the JFrog Artifactory Microsoft Azure ARM Template:

1. Go to the JFrog Artifactory Enterprise listing.
2. Click GET IT NOW and then Continue | Create.
3. In the Basics tab, fill out the Subscription, Resources Group and Region.
4. In the VM Credentials tab, fill out the username and password that will be used in case you need to SSH into the machines created by this template.
5. In the Artifactory Cluster settings tab fill out these settings:
   1. If you update the machine size, make sure to also update the JVM parameters (the max JVM heap should be 1/2-3/4 of the total machine memory). 
   2. You will need to have enough Virtual machine vCPU quotas. If you don’t have enough vCPUs, create a support request to Azure to increase the quota or reduce the machine size.
6. In the Database Configuration tab provide the details for the database that will be used.
7. In Storage Options, select the STANDARD_LRS. 
8. Finally Review | Create.
9. When the process has completed, click Outputs to view the FQDN (Fully Qualified Domain Name), which can be used to access UI.

Rancher Catalog Helm Chart

The Rancher Catalog Helm Chart allows Rancher users the ability to deploy a high availability instance of JFrog Artifactory with the click of a few buttons. The chart is available via the official Rancher Charts and can be deployed to any cluster managed via Rancher.

Prerequisites

• Rancher 2.x+
• A Kubernetes cluster under Rancher management
• Artifactory Enterprise Licenses (2+)

To deploy the JFrog Artifactory Rancher Helm Chart:

1. From the UI, go to Apps | Launch.
2. Search for or select artifactory-ha from the catalog.
3. Fill out the name select the target project.
4. Under the SERVICES AND LOAD BALANCING, configure how you choose to expose the web application.
5. Under the ARTIFACTORY STORAGE, set Enable Persistent Storage for Artifactory to True and configure your preferred filestore method:
   • File-system: Write to a locally mounted volume.
   • NFS: A shared/mounter NFS for all the nodes.
   • Google Storage: Write to Google Cloud Storage. You must set this up before and provide the details to access it here.
   • AWS S3: Write to AWS S3. You must set this up in advance and provide the access details here.
6. Under the DATABASE SETTINGS, set Enable PostgreSQL and Enable Persistent Storage for PostgreSQL to True.
7. (Optional) Click Show Advanced Configuration to set settings such as CPU/Memory and to change the master key.
8. Click Launch.

Red Hat Certified UBI Docker Image

The Red Hat Certified UBI Docker Image is an alternative to the official JFrog Artifactory Docker image. It swaps out the underlying image operating system and replaces it with Red Hat's UBI. The image has other minor modifications to meet Red Hat certification but behaves and can be used in the same way as the official JFrog Artifactory Docker image. 

Prerequisites

• An active Red Hat subscription
• Artifactory Pro (or higher) license
• Docker/OpenShift (or service capable of deploying Docker images)

To use the JFrog Artifactory Red Hat Certified UBI Docker Image, you have two options:

• Existing Red Hat users can pull it directly from the Red Hat Catalog.
• You can build the image yourself, potentially changing the Operating System to the full Red Hat 8 installation:
  • JFrog Artifactory 7
  • JFrog Artifactory 6

For either method, configure and use the image the same way you would for the official JFrog Docker image (with the only difference being the image name).

Upgrading JFrog Artifactory using the Red Hat Certified UBI Docker Image

To upgrade, follow the official Docker to Docker upgrade procedure, only the image name/source should be different.

Red Hat Certified OpenShift Operator

The Red Hat Certified OpenShift Operator allows OpenShift users the ability to deploy a high availability instance of JFrog Artifactory to their OpenShift clusters. 

Prerequisites

• Active OpenShift 4 subscription
• Artifactory Enterprise Licenses (2+)
• Docker (or service capable of deploying Docker images)

To deploy the JFrog Artifactory using Red Hat Certified OpenShift Operator:

1. An external DB is required. The operator will not deploy a DB but will require you to specify the configuration values to connect to it.
2. Go to the OperatorHub in an Openshift 4.x cluster console.
3. Search for JFrog and click JFrog Artifactory Enterprise Operator to install.
4. Go to the Installed Operators. 
5. Wait for the JFrog Artifactory Enterprise Operator to complete the installation.
6. Open the Operator and click on the provided API: Artifactory HA.
7. Click Create New Instance and provide the following parameters for your DB configuration:

   • DATABASE_TYPE

   • DATABASE_DRIVER

   • DATABASE_URL

   • DATABASE_USER

   • DATABASE_PASSWORD

8. Click Create for Artifactory Enterprise to deploy into OpenShift and connect to the DB you specified in step 6.

Deploying JFrog Container Registry Using Partner Integrations

The following JFrog Container Registry Partner integrations are:

• Amazon AWS Container Marketplace
• Google GCP GKE Kubernetes App
• Microsoft Azure ARM Template
• Rancher Catalog Helm Chart

Amazon AWS Container Marketplace

The AWS Container Marketplace offers an alternative Docker image to the official JFrog Container Registry Docker image. The Marketplace image is identical to the official JFrog Artifactory Docker image with the only difference being that the Marketplace image does not start up with the default credentials (admin:password). The end user must set or get the first time password.

Prerequisites

• An active AWS subscription.
• Docker (or service capable of deploying Docker images).

To deploy the JFrog Container Registry in the AWS Container Marketplace listing:

1. Subscribe to the listing
2. Navigate to Continue to Configuration | Continue to Launch | View container image details.
3. Follow the instructions to log in and perform a pull of the image.
4. Follow the included instructions for using it using Docker or Helm.

Setting the Password for the First Time

Amazon AWS Container Marketplace does not allow default passwords. As such, one must be provided during container initialization or one will be randomly generated. 

To set the first time initialization password for the 'admin' user, pass the environment variable ARTIFACTORY-PASSWORD with the desired password. For example:

docker run ... --env ARTIFACTORY-PASSWORD=my-new-password <image-url>

If no initialization password is provided, one will be generated and printed to a file in the container. To get the randomly generated password, you can print the contents of the file.

docker exec -it <container-id> cat /var/opt/jfrog/artifactory/generated-pass.txt

Upgrading JFrog Container Registry in the AWS Container Marketplace listing

To upgrade, follow the official Docker to Docker upgrade procedure, only the image name/source should be different.

Google GCP GKE Kubernetes App

The Google GCP GKE Kubernetes App allows Google's GCP users the ability to deploy a JFrog Container Registry with the click of a few buttons. This deployment is possible both in GCP's GKE and via Anthos (for Hybrid/On-Prem) GKE. 

Prerequisites

• An active GCP subscription.
• A domain name with a corresponding SSL Certificate (optional but strongly recommended for production).

To deploy the JFrog Container Registry using Google GCP GKE Kubernetes App:

1. Go to the JFrog Container Registry listing.
2. Click Configure and select the Project to where you wish to deploy.
3. Select the cluster you wish to deploy to or create a new cluster.
4. Fill out the details, and make sure to change the master key (and recording it).
5. Click Deploy and wait for the application to be deployed.
6. Follow the instructions on the right hand side of the App to get the public IP.

Upgrading JFrog Container Registry using Google GCP GKE Kubernetes App

To upgrade, you will need to manually edit the workloads. 

1. Go to the GKE workloads page and select the Project in which the App is deployed.
2. Find the JFrog Container Registry workload: <app-name>-artifactory.
3. Change the YAML from gcr.io/cloud-marketplace/jfrog/jfrogcr:<existing version>  to gcr.io/cloud-marketplace/jfrog/jfrogcr:<new version>  in all locations (no need to change the annotations)
   1. Select the JFrog Container Registry registry from a list of versions.
   2. The version may also use a SHA instead of a version tag: gcr.io/cloud-marketplace/jfrog/jfrogcr@sha256:<sha>.
   3. It is also possible to change the image to pull directly from JFrog, where images are updated at a more regular interval. In this case, use 'docker.bintray.io/jfrog/artifactory-jcr:<new version>'
4. Scale the deployment down to zero, then back to 1.
5. Save the change and wait for the node to come up in the new version.
6. Verify the new version in the bottom left corner of the UI.

Microsoft Azure ARM Template

The Microsoft Azure ARM Template allows Microsoft's Azure users the ability to deploy a JFrog Container Registry with the click of a few buttons. The ARM template is built in conjunction with Azure engineers to ensure best practices when deploying.

Prerequisites

• An active Azure subscription
• Spare vCPUs available in your region in Azure
• A domain name with corresponding SSL Certificate

To deploy the JFrog Container Registry Microsoft Azure ARM Template:

1. Go to the JFrog Container Registry listing
2. Click GET IT NOW | Continue | Create.
3. In the Basics tab, fill out the Subscription, Resources Group and Region.
4. In the VM Credentials tab, fill out the username and password that will be used in case you need to SSH into the machines created by this template.
5. In the Artifactory Cluster settings tab fill out these settings:
   1. If you update the machine size, make sure to also update the JVM parameters (the max JVM heap should be 1/2-3/4 of the total machine memory).
   2. You will need to have enough Virtual machine vCPU quotas. If you don’t have enough vCPUs, create a support request to Azure to increase the quota or reduce the machine size.
6. In the Database Configuration tab, provide the details for the database that will be used.
7. In Storage Options select the STANDARD_LRS. 
8. Finally click Review | Create.
9. When the process is completed, click Outputs to view the FQDN (Fully Qualified Domain Name), which can be used to access UI.

Rancher Catalog Helm Chart

The Rancher Catalog Helm Chart allows Rancher users the ability to deploy a JFrog Container Registry with the click of a few buttons. The chart is available via the official Rancher Charts and can be deployed to any cluster managed via Rancher.

Prerequisites

• Rancher 2.x+
• A Kubernetes cluster under Rancher management

To deploy the JFrog Container Registry Rancher Helm Chart:

1. In the UI, go to Apps | Launch.
2. Search for or select artifactory-jcr from the catalog.
3. Fill out the name select the target project.
4. Under the SERVICES AND LOAD BALANCING, configure how you with to expose the web application.
5. Under the ARTIFACTORY STORAGE, set Enable Persistent Storage for Artifactory to True and configure your preferred filestore:
   • File-system: Write to a locally mounted volume.
   • Google Storage: Write to Google Cloud Storage. You must set this up before and provide the details to access it here.
   • AWS S3: Write to AWS S3. You must set this up before and provide the details to access it here.
6. Under the DATABASE SETTINGS, set Enable PostgreSQL and set Enable Persistent Storage for PostgreSQL to True.
7. (Optional) Click on Show Advanced Configuration to configure the settings such as CPU/Memory and to change the master key.
8. Click Launch.