Installing Insight

JFrog Installation & Setup Documentation

Content Type
Installation & Setup
ft:sourceType
Paligo

Subscription Information

This feature is supported on the Self-Hosted platform, with an Enterprise+ license.

You can install and configure JFrog Insight, single node and high availability. For additional information on high availability, see high availability

Before installing Insight 1.x, you must first install JFrog Artifactory 7.x.

Warning

You must install or upgrade to Artifactory 7.27.3 or later, if you want to install Insight. For previous versions, install and use Mission Control.

Do not install Insight if you have standalone Mission Control service running. Run the migration steps before you install Insight. For more information, see Migrating from Mission Control to Insight.

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

Warning

Insight requires the Mission Control microservice to be running on Artifactory. If you use a standalone Mission Control service, migrate to Mission Control microservice before you proceed with Insight installation. For more information, see Migrating Platform Deployments and License Buckets.

Before you proceed, see System Requirements for information on supported platforms, supported browsers, and other requirements.

Operating Systems and Platform Support

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

Product

Debian

RHEL

Ubuntu

Windows Server

Amazon Linux

Insight

10.x, 11.x

8.x, 9.x

20.04, 22.04

Amazon Linux 2023

Operating Systems - End of Support

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

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 will no longer supported from Artifactory version 7.77.3.

Supported Platforms

The following table lists the supported platforms.

Product

x86-64

ARM64

Kubernetes

OpenShift

Insight

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, Pipelines (in Helm installation), and Insight. ARM64 support is not available for Distribution.

Database and Third-Party Applications in Insight

A database is required, which is fundamental to management of Insight and is also used to store cluster wide configuration files. Currently PostgreSQL is supported, and any change to configuration requires restarting all Insight nodes for changes to take effect.

Insight supports the following versions of PostgreSQL.

  • 15.x

  • 13.x

  • 12.x

An Elasticsearch database is required to store the data from which Insight generates trends and charts.

Insight supports the following versions of Elasticsearch.

  • 7.17.1 (for Insight 1.11.3 and later)

  • 7.16.2 (for Insight 1.5.0 to 1.10.2)

  • 7.15.1 (for Insight 1.2.3 to 1.30)

  • 7.14.1 (for Insight 1.0.1 to 1.1.3)

Insight Network Ports

Insight uses the 8082 port by default for external communication.

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

  • 8080 for the Insight Server

  • 8082, 8046, 8047, and 8049 for the Router

  • 8087 for Insights

  • 5432 for PostgreSQL (if you use the bundled Postgres database)

  • 9200 for Elasticsearch (if you use the bundled Elasticsearch)

Installation Steps

The installation procedure involves the following main steps:

  1. Download Insight as per your required installer type (Linux Archive, Docker Compose, RPM, Debian).

  2. Install Insight 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 Insight

  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 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.

Insight Single Node Installation

The following installation methods are supported:

  • Interactive Script (recommended)

  • Linux Archive

  • Manual RPM

  • Manual Debian

  • Helm

Insight HA Installation

The following describes how to set up an Insight HA cluster with more than one node. For more information about HA, see System Architecture.

The following installation methods are supported.

  • Interactive Script

  • Linux Archive

  • Helm

Prerequisites

All nodes within the same Insight HA installation must be running the same Artifactory version.

Warning

For an Insight HA cluster to work correctly, you must have at least three nodes in the cluster.

Database

Insight HA requires an external PostgreSQL database. Make sure to install it before proceeding to install the first node. There are several ways to setup PostgreSQL for redundancy. Including: HA, Load Balancing, and Replication. For more information, see the PostgreSQL documentation

Network

  • All the Insight HA components (Insight cluster nodes, database server and Elasticsearch) must be within the same fast LAN.

  • All the HA nodes must communicate with each other through dedicated TCP ports.