| 1 | UPDATING THE COMPONENT REGISTRY REST SERVICE AND FLEX UI |
|---|
| 2 | |
|---|
| 3 | Procedure for updating |
|---|
| 4 | ---------------------- |
|---|
| 5 | |
|---|
| 6 | - When upgrading to a new version of the ComponentRegistry, check if there are |
|---|
| 7 | updates to the schema of the PostgreSQL database. These will be named |
|---|
| 8 | upgrade-x.yy.sql, e.g. upgrade-1.10.sql for version 1.10. |
|---|
| 9 | |
|---|
| 10 | - If the database needs upgrading, first make a backup (dump) of the existing |
|---|
| 11 | database. Stop the application before doing so |
|---|
| 12 | |
|---|
| 13 | - Execute the upgrade script. When upgrading over multiple minor versions, |
|---|
| 14 | execute the upgrade scripts incrementally |
|---|
| 15 | |
|---|
| 16 | - Make sure to grant all required rights (GRANT ALL unless specified |
|---|
| 17 | otherwise) to the component registry database user (usually compreg) on |
|---|
| 18 | any newly added tables, views, and sequences. |
|---|
| 19 | |
|---|
| 20 | - Then redeploy the WAR and start the application |
|---|
| 21 | |
|---|
| 22 | Version specific update instructions |
|---|
| 23 | ------------------------------------- |
|---|
| 24 | |
|---|
| 25 | === 1.15.0 === |
|---|
| 26 | |
|---|
| 27 | - Remove the context parameter eu.clarin.cmdi.componentregistry.jpaDialect from the global |
|---|
| 28 | context.xml or application context fragment, as it is now provided within the web.xml |
|---|
| 29 | of the application itself. |
|---|
| 30 | |
|---|
| 31 | === 1.14.5 === |
|---|
| 32 | |
|---|
| 33 | The context parameter eu.clarin.cmdi.componentregistry.isocatRestUrl has been replaced |
|---|
| 34 | with the new parameter eu.clarin.cmdi.componentregistry.ccrRestUrl. An example |
|---|
| 35 | configuration with the default value for the new parameter is: |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | <Parameter |
|---|
| 39 | name="eu.clarin.cmdi.componentregistry.ccrRestUrl" |
|---|
| 40 | value="https://openskos.meertens.knaw.nl/ccr/api/"/> |
|---|
| 41 | |
|---|
| 42 | === 1.14.2 === |
|---|
| 43 | |
|---|
| 44 | No additional steps required. |
|---|
| 45 | |
|---|
| 46 | === 1.14.1 === |
|---|
| 47 | |
|---|
| 48 | No additional steps required. |
|---|
| 49 | |
|---|
| 50 | === 1.14.0 === |
|---|
| 51 | |
|---|
| 52 | - Execute DB update script upgrade-1.14.sql |
|---|
| 53 | |
|---|
| 54 | - Add the following context parameter (default values given): |
|---|
| 55 | |
|---|
| 56 | <Parameter |
|---|
| 57 | name="eu.clarin.cmdi.componentregistry.jpaDialect" |
|---|
| 58 | value="org.hibernate.dialect.PostgreSQLDialect"/> |
|---|
| 59 | |
|---|
| 60 | - ComponentRegistry no longer provides its own JDBC driver jar. In case the Tomcat |
|---|
| 61 | container does NOT provide a suitable PostgreSQL JDBC driver yet: |
|---|
| 62 | |
|---|
| 63 | - Download a suitable version and deploy it as a provided library in the Tomcat |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | === 1.13 === |
|---|
| 67 | |
|---|
| 68 | - The following context fragment have been renamed, and should be updated |
|---|
| 69 | in the context fragment for the Component Registry: |
|---|
| 70 | |
|---|
| 71 | componentRegistryServiceRootUrl -> eu.clarin.cmdi.componentregistry.serviceRootUrl |
|---|
| 72 | componentRegistryAdminUsers -> eu.clarin.cmdi.componentregistry.adminUsers |
|---|
| 73 | |
|---|
| 74 | The results should look something like: |
|---|
| 75 | <Parameter |
|---|
| 76 | name="eu.clarin.cmdi.componentregistry.serviceRootUrl" |
|---|
| 77 | value="http://catalog.clarin.eu/ds/ComponentRegistry" /> |
|---|
| 78 | <Parameter |
|---|
| 79 | name="eu.clarin.cmdi.componentregistry.adminUsers" |
|---|
| 80 | value="admin1@clarin.eu admin2@clarin.eu" /> |
|---|
| 81 | |
|---|
| 82 | - The following should be added to the context fragment for the Component |
|---|
| 83 | Registry: |
|---|
| 84 | |
|---|
| 85 | <Parameter |
|---|
| 86 | name="eu.clarin.cmdi.componentregistry.documentationUrl" |
|---|
| 87 | value="http://www.clarin.eu/cmdi" /> |
|---|
| 88 | <Parameter |
|---|
| 89 | name="eu.clarin.cmdi.componentregistry.generalComponentSchemaUrl" |
|---|
| 90 | value="https://infra.clarin.eu/cmd/general-component-schema.xsd" /> |
|---|
| 91 | <Parameter |
|---|
| 92 | name="eu.clarin.cmdi.componentregistry.component2SchemaXslUrl" |
|---|
| 93 | value="https://infra.clarin.eu/cmd/xslt/comp2schema-v2/comp2schema.xsl" /> |
|---|
| 94 | <Parameter |
|---|
| 95 | name="eu.clarin.cmdi.componentregistry.componentSpecSchemaLocation" |
|---|
| 96 | value="http://www.clarin.eu/cmd https://infra.clarin.eu/cmd/general-component-schema.xsd" /> |
|---|
| 97 | <Parameter |
|---|
| 98 | name="eu.clarin.cmdi.componentregistry.isocatRestUrl" |
|---|
| 99 | value="https://catalog.clarin.eu/isocat/rest/" /> |
|---|
| 100 | |
|---|
| 101 | === 1.11 == |
|---|
| 102 | |
|---|
| 103 | - The following should be added to the context fragment for the Component |
|---|
| 104 | Registry: |
|---|
| 105 | <Parameter |
|---|
| 106 | name="componentRegistryAdminUsers" |
|---|
| 107 | value="space-separated-list-of-admin-eppns"/> |
|---|
| 108 | |
|---|
| 109 | - Added to database schema: |
|---|
| 110 | * comments |
|---|
| 111 | * comments_id_seq |
|---|
