Preflight Check

The diagnosticUtil Utility is used to check if your VM or bare metal server meets the minimum requirements before installing JFrog products. It provides a crucial inspect command that performs pre-installation and environment checks, ensuring 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> diagnosticUtil

inspect Command

The inspect command offers flexibility, allowing you to individually verify System, Connectivity, or Database configurations. Alternatively, you can run All checks in a single execution for a comprehensive assessment. This utility helps identify and address potential issues before they impact your Artifactory deployment, streamlining the installation process.

./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=artifactory

System Check Options

The following table provides information about the system check options:

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=xray

Connectivity Check Options

The following table provides information about the network connectivity options:

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:

All

The all sub-command executes all of the above checks (system, connectivity, and database) in a single command.

For example, to run all the above mentioned checks in a single command, run the following command:

./diagnosticUtil inspect all --installDirectory=”/tmp/opt/jfrog” --product=artifactory --databaseUsername=admin --databasePassword=pass --databaseUrl=”jdbc:postgresql://localhost:5432/artdb”