Preflight Check
Run diagnosticUtil inspect (system|connectivity|database|all) to validate your environment before installation.
The diagnosticUtil utility checks whether your VM or bare metal server meets the minimum requirements before installing JFrog products. Its inspect command performs pre-installation and environment checks, confirming your system meets the requirements for running JFrog products.
You can download the diagnosticUtil Utility from here.
After downloading, rename the binary with:
mv diagnostics-<os>-<arch> diagnosticUtilinspect Command
inspect CommandThe inspect command lets you individually verify System, Connectivity, or Database configurations, or run All checks in a single execution. This utility helps identify potential issues before they affect your Artifactory deployment.
./diagnosticUtil inspect <subcommand> <options>The following are the subcommands:
system: Performs system-level environment checks.connectivity: Verifies the required network connectivity and port availability.database: Validates the database connectivity.all: Runs all the above checks in a single command.
System
The system sub-command checks the following:
- CPU, memory, and storage requirements of the selected product.
- Operating system's and Linux distribution's compatibility.
- Access to the custom install directory.
- Fetch disk IOPS information.
For example, to run a system check, run the following command:
./diagnosticUtil inspect system --installType=vm --product=artifactorySystem Check Options
The following table provides information about the system check options:
| Options | Description | Default |
|---|---|---|
--installDirectory | Specifies the directory where the product is installed. | /var/opt/jfrog |
--product | Specifies the product (artifactory|xray|distribution) whose prerequisites are checked. | artifactory |
Connectivity
The connectivity sub-command checks the following:
- Availability of required ports for the selected product.
- Network connectivity to external URLs needed by JFrog products.
For example, to run a network connectivity check, run the following command:
./diagnosticUtil inspect connectivity --product=xrayConnectivity Check Options
The following table provides information about the network connectivity options:
| Options | Description | Default |
|---|---|---|
--product | Specifies the product (artifactory|xray|distribution) whose prerequisites are checked. | artifactory |
--downloadDns | Specifies the DNS endpoint used for downloading product binaries. | releases.jfrog.io |
Database
The database sub-command checks the connectivity to the database using the provided credentials.
For example, to run a database connectivity check, run the following command:
./diagnosticUtil inspect database --databaseUsername=dbuser --databasePassword=dbpass --databaseUrl=”jdbc:postgresql://localhost:5432/mydb”Database Check Options
The following table provides information about the database connectivity options:
Options | Description | Default |
|---|---|---|
| Specifies the database username. | Required |
| Specifies the database password. | Required |
| Specifies the JDBC-style database URL used for database connectivity checks. Note: Only basic JDBC URL formats are supported. URLs containing additional parameters, options, or complex structures are not supported. For example, | Required |
| Specifies the database type.
|
|
All
The all sub-command executes all of the above checks (system, connectivity, and database) in a single command.
For example, to run all checks in a single command:
./diagnosticUtil inspect all --installDirectory=”/tmp/opt/jfrog” --product=artifactory --databaseUsername=admin --databasePassword=pass --databaseUrl=”jdbc:postgresql://localhost:5432/artdb”Updated 24 days ago
