Upgrading JFrog Catalog

Docker Compose

Starting from Xray Version 3.131.x Valkey has been added as a cache service in Catalog. You will have to install or upgrade it separately before upgrading Catalog if it is required. JFrog Xray, JFrog Catalog and JFrog Valkey are packaged in a single tarball. You will find the Valkey folder for the latest release version when you extract the Xray tarball. Please find instructions for Valkey here.

Stop the Valkey service ( if installed ) from the existing package

cd jfrog-valkey-compose
docker-compose -p valkey -f docker-compose-valkey.yaml down

Stop the service from the existing package

cd jfrog-catalog<version>-compose
docker-compose -p catalog down

Download the new installer package.
Extract the contents of the new compressed archive and go to the extracted folder.
```
cd jfrog-catalog-<version>-compose
```
Copy the contents of the .env file in the installation to the newly created .env file in this archive without copying the versions, as this will affect the upgrade.
Run the installer script and follow the instructions.
./config.sh

Native (RPM/DEB)

Stop the service from the existing service.
```
systemctl stop catalog.service
```
Download the new installer package.
Extract the contents of the new compressed archive and go to the extracted folder.
```
cd jfrog-catalog-<version>-deb/rpm
```
Run the installer script and follow the instructions.
```
./install.sh
```

Before starting up Catalog, add cache section to the system.yaml of Catalog with Valkey password:

shared:
  cache:
    enabled: true
    connectionString: redis://localhost:6379
    parameters: mode=single;password=<VALKEY_PASSWORD>
    defaultKeyExpirationSecs: 3600
    maxWarmupKeys: 1000
    warmupPoolSize: 10
    warmupDBMaxOpenConns: 10
    warmupDBMaxIdleConns: 5
    invalidationPoolSize: 5
    invalidationIntervalSecs: 60

Start the Catalog service:
```
systemctl start catalog.service
```

Linux Archive

Stop catalog (catalog.sh start or systemctl stop catalog.service )
Download the newer tar file and extract it.

Replace the existing $JFROG_HOME/catalog/app with the new app folder.

# Export variables to simplify commands
export JFROG_HOME=/opt/jfrog
export JF_NEW_VERSION=/opt/jfrog/jfrog-catalog-<version>-linux
# Remove app
rm -rf $JFROG_HOME/catalog/app
# Copy new app
cp -fr $JF_NEW_VERSION/app $JFROG_HOME/xray/
# Remove extracted new version
rm -rf $JF_NEW_VERSION

Before starting up Catalog, add cache section to the system.yaml of catalog with Valkey password:

shared:
  cache:
    enabled: true
    connectionString: redis://localhost:6379
    parameters: mode=single;password=<VALKEY_PASSWORD>
    defaultKeyExpirationSecs: 3600
    maxWarmupKeys: 1000
    warmupPoolSize: 10
    warmupDBMaxOpenConns: 10
    warmupDBMaxIdleConns: 5
    invalidationPoolSize: 5
    invalidationIntervalSecs: 60

Start Catalog.