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.
Insight system requirements depend mainly upon the number of Artifactory repositories.
By default, Insight stores one year of storage information, one year of metrics information, one year of events information (like garbage collection details), and one day of requests information.
Note
You can install and use Insight only if you use Artifactory 7.27.3 or later.
Insight will only display Xray charts if you have Xray version 3.33.3 or later. Upgrade Xray to version 3.33.3 to view the Xray charts.
Local file system is used to store information specific to the node. The main file that is used here is the mc.key which is used to encrypt the database content. This need to be synchronized between the nodes manually.
The following sizing information is provided based on the default configuration.
Number of Artifactory Repositories | Processor | Memory | Disk Space |
|---|---|---|---|
Up to 500 | 4 cores | 5 GB
| 120 GB
|
500 to 1500 | 4 cores | 8 GB
| 220 GB
|
1500 to 2500 | 4 cores | 14 GB
| 420 GB
|
2500+ | Contact JFrog Support for sizing requirements. | ||
Note
If you want to use Insight in a high availability configuration, you must have three or more odd number of nodes.
Product | Debian | Centos* | RHEL | Ubuntu | Windows Server | Helm Charts | SLES |
|---|---|---|---|---|---|---|---|
Insight | 10.x, 11.x | 7.x | 7.x, 8.x | 18.04, 20.04, 22.04 |  | 3.x | 12 SP5 |
Breaking Change Affecting RPM/Yum/Linux Archive Installations on Centos 7.x*
As part of our commitment to our customers to maintain the security and reliability of your JFrog Platform, from Artifactory version v7.43.x, JFrog Artifactory will officially run with JDK 17 and Tomcat 9.x on all installation types. Note that JDK 17 and Tomcat 9.x are not supported on all Centos 7.x versions.
CentOS 8.x Support
CentOS 8.x reached its end-of-life in December 2021. CentOS 8.x support for JFrog products has been deprecated by the end of June 2022.
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.
10.x
11.x
12.x
13.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:
Download Insight as per your required installer type (Linux Archive, Docker Compose, RPM, Debian).
Install Insight either as a single node installation, or high availability cluster.
Install third party dependencies (PostgreSQL and Elasticsearch databases, included in the archive)
Install Insight
Configure the service
Connection to Artifactory (
joinKeyandjfrogUrl)Additional optional configuration including changing default credentials for databases
Start the Service using the start scripts or OS service management.
Check the Service Log to check the status of the service.
Default Home Directory / $JFROG_HOME
The default Xray 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.