To update the HCL Compass
RESTful server APIs with the latest version, you must have the HCL Compass RESTful server APIs zip file. This
quick start guide shows you how to update or patch the HCL Compass RESTful server APIs in the HCL Compass Docker container.
Before you begin
Before you can upgrade the
HCL Compass RESTful server APIs, you must
first:
Procedure
-
Use the
docker volume
command to find the mountpoint of the you
created and attached to the hcl-compass container.
$ docker volume ls # List the volumes
$ docker volume inspect [volune_name] # To get volume Mountpoint folder location
-
Copy the new HCL Compass RESTful
server APIs zip file into the volume mountpoint folder.
$ cp ompass-rest-server-distribution-[version_number].zip /var/lib/docker/volumes/[volune_name]/_data/.
-
Start a
bash
shell in a Docker container and execute the
docker exec
command.
$ docker exec -it [container_name] /bin/bash
-
Optionally, backup the
logs
folder and the config
folder in the /compass-rest-server-distribution
folder.
cp -r /opt/hcl/compass/compass-rest-server-distribution/config /tmp/.
cp -r /opt/hcl/compass/compass-rest-server-distribution/logs /tmp/.
-
Move into the mounted volume folder
(
/opt/hcl/compass/compass-rest-server-distribution/logs
) inside the
container and unzip the RESTful server APIs zip file into the
/opt/hcl/compass
directory. Set the access permission to folders and
files under the /compass-rest-server-distribution
folder.
$ unzip -o compass-rest-server-distribution--[version_number].zip -d /opt/hcl/compass
$ chmod -R 777 /opt/hcl/compass/compass-rest-server-distribution/*
-
Stop the HCL Compass RESTful
server APIs instance.
$ cd /opt/hcl/compass/compass-rest-server-distribution/bin
$ PIDs=$(pgrep -a java | grep Dlogging.config | awk '{ print $1; }')
$ for val in $PIDs; do echo $val; kill -9 $val; done
-
Start the HCL Compass RESTful
server APIs instance.
$ cd /opt/hcl/compass/compass-rest-server-distribution/bin
$ export TZ="EST"
$ source /opt/hcl/compass/cq_setup.sh
$ nohup ./start.sh &
-
Ensure that the HCL Compass
RESTful server APIs instance version has been updated.
Enter http://localhost:8190/
in a browser to start HCL Compass. Login and click at the top right corner of the User Interface to see if the version has
been updated.