Overview
This page provides tips to solve common problems that users have encountered.
JFrog Platform
The following structure is common across all JFrog products.
Folder/File Name | Description |
---|---|
bin | Contains helper scripts for installer. |
third-party | Contains third party software. |
<product> | Product specific bundles (for non Docker Compose installers) |
templates | Docker Compose templates (only for Docker Compose installers). |
install.sh | Main installer script (for non Docker Compose installers). |
config.sh | Main configure script (only for Docker Compose installers). |
readme.md | Read me file providing the package details. |
Depending on the installer type:
RPM / Debian Installers: Set the data directory path in the variable
JF_PRODUCT_VAR
to the customized data folder and start the services. Set the system environment variable to point to a custom location in your system's environment variables files. See Ubuntu System environment variables.Archive Installer: By default, the data directory is set to the
unzip-location/var
. You can symlink this directory to any folder you want.Docker Compose Installer: Set the
JF_ROOT_DATA_DIR
variable in the.env
file that comes packaged with the installer.
It is recommended to run a health check on the specific JFrog product Router node, which is connected to all the node's microservices. This will provide you with the latest health information for the node.
For example, Artifactory's Health Check REST API.
GET /router/api/v1/system/health
Each microservice has its own service log. However, it is recommended to start your debugging process by using the console.log
, which is a collection of all service logs of all products in a node. Learn More >
JFrog Artifactory, Mission Control and Distribution are bundled with Java 11. To customize the Java run time, configure the shared.extraJavaOpts
in the system.yaml
.
The default ports used by each JFrog Product can be modified in the Product system.yaml
file.
For example, to set Artifactory to run on a different port (and not on the default 8081 port), perform the following:
- Open the Artifactory
$JFROG_HOME/artifactory/var/etc/system.yaml
file. Add or edit the new port key under the artifactory section.
artifactory: port: <your new port, for ex: 8089>
system.full-template.yaml
Examples for all the different configuration values, including application ports are available in the $JFROG_HOME/<product>/var/etc/system.full-template.yaml
file.
Artifactory
From version 6.2, Artifactory offers different alternatives for session management between the Artifactory HA members when accessing one of the members.
The way to manage sessions is controlled via the artifactory.map.provider.type
property (in the $JFROG_HOME/artifactory/var/etc/artifactory/artifactory.system.properties
file) which can take the following values:
db | (default) Sessions are managed by the database |
distributed | Sessions are managed by Hazelcast |
jvm | Sessions are managed by the JVM |
If sessions are configured to be managed by the database, Artifactory will also schedule a cron job to cleanup old sessions.
The cron expression to trigger the sessions can be configured using the artifactory.db.session.cleanup.cron
property in the $JFROG_HOME/artifactory/var/etc/artifactory
/artifactory.system.properties
file.
During installation, this cron expression is set with a default value that triggers the cleanup at a set minute (determined randomly) past each hour.
From version 6.0.0, the new database locking mechanism adds its own connection pool (defaults to the value of the pool.max.active
value).
However, you may need to adjust your database connection limit to accept more connections. For example, if your database is set to accept up to 100 connections from each node, you may consider increasing the limit to 200 concurrent connections per-node, to accommodate the full utilization of the locking connection pool. Your database should accept the number of configured connections per-node multiplied by the number of the nodes in the cluster.
Access Service
Symptoms | During startup, Artifactory fails to start and an error is thrown: java.lang.IllegalStateException: Provided private key and latest private key fingerprints mismatch. |
Cause | Artifactory tries to validate and compare access keys' fingerprint that reside on Artifactory's database and the local file system. If the keys do not match, the exception above will be thrown along with the mismatching fingerprint IDs. |
Resolution | Follow the steps below to make sure that all instances in your circle of trust have the same private key and root certificate: Key rotation will invalidate any issued access tokens The procedure below will create new key pairs which in turn will invalidate any existing Access Tokens.
|
Access Tokens
Symptoms | Authentication with an access token doesn't work with an error that says "Token validation failed". |
Cause | The implementation of access tokens was changed in Artifactory 5.4. The change is backwards compatible, so tokens created with earlier versions of Artifactory can be authenticated in the new version, however the reverse is not true. Tokens created in versions 5.4 or later cannot be authenticated by versions earlier than 5.4. |
Resolution | Either upgrade your older Artifactory instances, or make sure you only create access tokens with the older instances |
High Availability
Xray
To adjust the active node name and IP on the secondary node after a HA installation, it is recommended to re-run the installation wrapper script. Alternatively, manually modify the following files:
RPM/Debian Installation |
|
---|---|
Docker Compose Installation |
|
Mission Control
Installation
Cause | Disk which is storing Elasticsearch data has exceeded 95 % storage |
Resolution | 1. Stop the services 2. Clear space on disk used to store elasticsearch data 3. Start the services 4. Change elasticsearch indices setting to RW (read-write), curl -u<username>:<password> -XPUT -H "Content-Type: application/json" http://localhost:9200/_all/_settings -d '{"index.blocks.read_only_allow_delete": null}' Default username and password for internal elasticsearch is admin. |
Debug Log configuration
Cause | From version 4.x the logback.xml has a different way to enable debug logging. |
Resolution | To configure the Mission Control log for debug logging:
Changes made to the logging configuration are reloaded within several seconds without requiring a restart. |
Insight Trends Not Displaying
Cause | Incorrect Elasticsearch indices used. |
Resolution |
|
Pipelines
Installation
Symptoms | When running Pipelines install, you receive the following message: # Setting platform config ################################################## Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running? |
Cause | The Docker service is not running. This can be verified by running |
Resolution | Restart the Docker service: $ systemctl stop docker $ systemctl start docker OR $ systemctl restart docker OR $ service docker restart OR $ service docker stop $ service docker start |
Node initialization
Symptoms | check_win_containers_enabled : Windows Containers must be enabled. Please install the feature, restart this machine and run this script again. |
Cause | The node does not have containers enabled. |
Resolution | Enable containers for Windows. Run the following in PowerShell with elevated privileges and then restart the machine. > Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All > Enable-WindowsOptionalFeature -Online -FeatureName Containers -All |
Symptoms | When initializing a new node, an error in the output states that |
Cause | NodeJS is installed, but misconfigured. The error most likely occurred because it was not found in the path. |
Resolution | Uninstall NodeJS and allow the build node initialization to reinstall. If NodeJS was originally installed as part of node initialization, the following commands should work. On Ubuntu, CentOS, or RHEL $ sudo rm -rf /usr/local/bin/node $ sudo rm -rf /usr/local/lib/node_modules/npm/ On Windows > choco uninstall nodejs |