Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: 1.21.2 bump

In eIn most cases, upgrading an existing instance of SHRINE is a relatively quick process. Exceptions to this rule include older versions of SHRINE that contained substantial changes to configuration files and other portions of the file structure. The instructions here specifically describe an upgrade path from SHRINE 1.20.1 to SHRINE 1.21.12. For instructions on upgrading to SHRINE 1.20.1, check the child pages underneath the "Archived Upgrade Instructions" section.

...

Next, we will retrieve the new SHRINE webapp from the HMS Sonatype Nexus server at http://repo.open.med.harvard.edu/nexus/content/groups/public/net/shrine/shrine-war/. Navigate to the folder for 1.21.12. From there, download shrine-war-1.21.12.war to the webapps/ directory of the Tomcat installation that SHRINE uses and rename it to shrine.war.

...

$ cd /opt/shrine/tomcat/webapps
$ wget --no-check-certificate https://repo.open.med.harvard.edu/nexus/content/groups/public/net/shrine/shrine-war/1.21.12/shrine-war-1.21.12.war -O shrine.war

Deploy New shrine-proxy.war

Like other SHRINE artifacts, the SHRINE proxy can be found on the HMS Sonatype Nexus server at https://repo.open.med.harvard.edu/nexus/content/groups/public/net/shrine/shrine-proxy/. Navigate to the folder for 1.21.12. From there, download shrine-proxy-1.21.12.war to the webapps/ directory of the Tomcat installation that SHRINE uses and rename it to shrine-proxy.war.

...

$ cd /opt/shrine/tomcat/webapps
$ wget --no-check-certificate https://repo.open.med.harvard.edu/nexus/content/groups/public/net/shrine/shrine-proxy/1.21.12/shrine-proxy-1.21.12.war -O shrine-proxy.war

Deploy New SHRINE Webclient

...

The SHRINE webclient can be found on the HMS Sonatype Nexus server at https://repo.open.med.harvard.edu/nexus/content/groups/public/net/shrine/shrine-webclient/. Navigate to the folder for 1.21.12. From there, download shrine-webclient-1.21.12-dist.zip to the webapps/ directory of the Tomcat installation that SHRINE uses and rename it to shrine-webclient.zip. Then, unzip the shrine-webclient.zip file.

...

$ cd /opt/shrine/tomcat/webapps
$ wget --no-check-certificate https://repo.open.med.harvard.edu/nexus/content/groups/public/net/shrine/shrine-webclient/1.21.12/shrine-webclient-1.21.12-dist.zip -O shrine-webclient.zip
$ unzip shrine-webclient.zip

...

Like other SHRINE artifacts, the SHRINE Dashboard can be found on the HMS Sonatype Nexus server at https://repo.open.med.harvard.edu/nexus/content/groups/public/net/shrine/dashboard-war/. Navigate to the folder for 1.21.12. From there, download dashboard-war-1.20.1.war to the webapps/ directory of the Tomcat installation that SHRINE uses and rename it to shrine-dashboard.war.

...

$ cd /opt/shrine/tomcat/webapps
$ wget --no-check-certificate https://repo.open.med.harvard.edu/nexus/content/groups/public/net/shrine/dashboard-war/1.21.12/dashboard-war-1.21.12.war -O shrine-dashboard.war

(Optional) For Users of Oracle or SQL Server

...

These SQL statements are for MySQL. If you are using Oracle or SQL Server, use either oracle.ddl or mssql.ddl instead: https://open.med.harvard.edu/stash/projects/SHRINE/repos/shrine/browse/qep/service/src/main/sql?at=refs%2Ftags%2F1.21.12

Modify shrine.conf

The default configuration has changed in SHRINE 1.21 to no longer create a hub unless explicitly asked to. This mirrors the most common installation scenario: a member site connecting to an already established hub. However, on the HMS network, every site is its own hub that broadcasts out to all other sites on its own.

...

This migration tool can be found on the HMS Sonatype Nexus server at https://repo.open.med.harvard.edu/nexus/content/groups/public/net/shrine/adapter-queries-to-qep/. Navigate to the folder for 1.21.12. From there, download adapter-queries-to-qep-1.21.12.zip to the /opt/shrine/ directory of your SHRINE server and rename it to adapter-queries-to-qep.zip. Then, unzip the adapter-queries-to-qep.zip file and navigate to the directory it creates.

...

$ cd /opt/shrine/
$ wget --no-check-certificate https://repo.open.med.harvard.edu/nexus/content/groups/public/net/shrine/adapter-queries-to-qep/1.21.12/adapter-queries-to-qep-1.21.12.zip -O adapter-queries-to-qep.zip
$ unzip adapter-queries-to-qep.zip
$ cd adapter-queries-to-qep-1.21.12/

After this, edit conf/adapter-queries-to-qep.conf. There are two major blocks to this conf file: adapter{} and queryEntryPoint{}adapter{} refers to the old shrine_query_history data source, which is where old previous query history will be pulled from. queryEntryPoint{} refers to the new qepAuditDB data source, which will be the migration destination. Both sections have the following configuration values, which mirror attributes in shrine.xml for their corresponding <Resource /> element:

...

It may take a few seconds for the page to load, but after it does load, log in with your SHRINE credentials (any user will do, regardless of role) and verify that the value for "SHRINE Version" is 1.2021.12. If it is still displaying an old version, repeat the instructions in the "Deploy New shrine.war" section, restart SHRINE, and try again.