source: vlo/branches/vlo-3.0/UPGRADE @ 5065

Last change on this file since 5065 was 5065, checked in by Twan Goosen, 10 years ago

Added general upgrade instructions to UPGRADE

File size: 6.5 KB
Line 
1----------------------------
2General upgrade instructions
3----------------------------
4
5Quick overview of the upgrade steps (for details see DEPLOY-README)
6
7- Unpack the VLO distribution tarball
8
9- Go to the 'war' directory
10- Unzip the vlo-solr-#.##.war in a new 'solr' directory
11- Unzip the vlo-web-app-#.##.war in a new 'vlo' directory
12
13- In the 'config' directory, adjust VloConfig.xml as needed (make a backup first)
14- Make any further version specific adjustments as described in this document
15
16- Stop the Tomcat or at least the VLO web app and Solr applications
17- Replace the 'current' symlink with a link to location of the new VLO directory
18
19- If needed, flush the Solr index (by removing the data directory)
20- In 'bin', run the importer using the updated configuration file:
21    ./vlo_solr_importer.sh -c ../config/VloConfig.xml
22
23---------------------------
24Upgrading from 2.18 to 3.0
25---------------------------
26
27* In version 3.0, the context parameters for the VLO web application have changed, see
28the file META-INF/context.xml for examples. The following parameters are now being
29processed:     
30
31- eu.carlin.cmdi.vlo.config.location
32        Optional but recommended. Should point to the location of VloConfig.xml that
33        should be used. Replaces The previously available parameter 'externalConfig', which is
34        no longer supported.
35
36- eu.carlin.cmdi.vlo.solr.serverUrl
37        Optional. Configures the base URL of the SOLR instance to connect to.
38
39* New options have been added to the shared VLO configuration file VloConfig.xml
40(in vlo-3.0/config):
41
42- The 'length' attributes in list elements can be removed
43
44- The following elements should be added:
45
46        <!-- begin added in 3.0 -->
47
48        <collectionFacet>collection</collectionFacet>
49
50        <simpleSearchFacetFields>
51                <simpleSearchFacetField>language</simpleSearchFacetField>
52                <simpleSearchFacetField>resourceClass</simpleSearchFacetField>
53                <simpleSearchFacetField>genre</simpleSearchFacetField>
54                <simpleSearchFacetField>nationalProject</simpleSearchFacetField>
55        </simpleSearchFacetFields>
56
57        <!-- Fields shown in expanded search results on the search page -->
58        <searchResultFields>
59                <searchResultField>name</searchResultField>
60                <searchResultField>country</searchResultField>
61                <searchResultField>languages</searchResultField>
62                <searchResultField>modality</searchResultField>
63                <searchResultField>subject</searchResultField>
64                <searchResultField>genre</searchResultField>
65                <searchResultField>organisation</searchResultField>
66                <searchResultField>collection</searchResultField>
67                <searchResultField>nationalProject</searchResultField>
68        </searchResultFields>
69
70        <!-- Fields ignored in the record page -->
71        <ignoredFields>
72                <ignoredField>format</ignoredField>
73        </ignoredFields>
74
75        <!-- Fields shown as technical fields in the record page -->
76        <technicalFields>
77                <technicalField>id</technicalField>
78                <technicalField>dataProvider</technicalField>
79                <technicalField>metadataSource</technicalField>
80                <technicalField>_landingPageRef</technicalField>
81                <technicalField>_searchPageRef</technicalField>
82                <technicalField>_contentSearchRef</technicalField>
83                <technicalField>_lastSeen</technicalField>
84                <technicalField>_componentProfile</technicalField>
85        </technicalFields>
86
87        <!-- end added in 3.0 -->
88
89- The element 'facetfield' should be replaced with new values:
90
91        <!-- begin changed in 3.0 -->
92
93        <facetFields>
94                <facetField>language</facetField>
95                <facetField>resourceClass</facetField>
96                <facetField>continent</facetField>
97                <facetField>country</facetField>
98                <facetField>modality</facetField>
99                <facetField>genre</facetField>
100                <facetField>subject</facetField>
101                <facetField>organisation</facetField>
102                <facetField>nationalProject</facetField>
103                <facetField>format</facetField>
104                <facetField>keywords</facetField>
105                <facetField>dataProvider</facetField>
106        </facetFields>
107
108        <!-- end changed in 3.0 -->
109
110* The location of the Solr index data directory is now governed through a java system
111property 'solr.data.dir'. Add the following to ${catalina.home}/bin/setenv.sh:
112
113        export JAVA_OPTS="$JAVA_OPTS -Dsolr.data.dir=/lat/webapps/vlo/solr/data-beta"
114
115Substitute the directory with the actual desired location of the index data. The
116parent directory has to exist and should be writable by the Tomcat user.
117
118---------------------------
119Upgrading from 2.17 to 2.18
120---------------------------
121
122* In version 2.18 of the VLO, the URL mapping has been changed. To prevent
123existing references and bookmarks from breaking, add rewrite rules to the
124HTTP server to achieve the following mappings:
125
126[TODO: Define actual mod_rewrite rules and document here]
127
128- {vlobase}/?wicket:bookmarkablePage=:eu.clarin.cmdi.vlo.pages.ShowResultPage&docId={docId}
129        -> {vlobase}/record?docId={docId}
130
131- {vlobase}/?wicket:bookmarkablePage=:eu.clarin.cmdi.vlo.pages.ShowAllFacetValuesPage&selectedFacet={facet}
132        -> {vlobase}/values/{facet}
133
134In both case all additional GET parameters SHOULD be kept.
135
136Next to the URL mapping, the XML parameter file has undergone some changes:
137
138    <!-- Sets the maximum number of page instances which will be stored in the application scoped second level cache for faster retrieval -->
139    <pagesInApplicationCache>40</pagesInApplicationCache>
140   
141    <!-- Sets the maximum size (in KILOBYTES) of the File where page instances per session are stored. -->
142    <sessionCacheSize>10000</sessionCacheSize>
143
144Has been added to tune the Wicket page cache. The first parameter allows you
145to set the size of the application wide cache holding pages. The second parameter
146denotes the size of the cache (in kilobytes) associated with a session. The values
147listed above are the Wicket defaults.
148
149Other changes in the parameter file:
150- maxFileSize and use MaxFileSize have been integrated into one parameter:
151 
152  maxFileSize
153
154  If equal to 0, no upper limit to the size of metadata input files will be
155  applied.
156
157- maxDaysToLife has been renamed into maxDaysInSolr
158
159- VloHomeLink has been renamed into homeUrl
160
161- helpUrl has been added; a link to a help page.
162
163- The facetConceptsFile parameter, referencing the facetConcepts.xml file,
164  has been added also. This is part of the effort of making parameterised
165  instantiation of the VLO possible.
166
167- Also, the facetOverviewLength parameter has been added. This parameter controls
168  the listing of facets on the search page.
169
170- Similar to 'useMaxFileSize' the expectReverseProxy parameter has been removed
171
172Finally,
173
174    <cqlEndpointFilter>http://cqlservlet.mpi.nl/</cqlEndpointFilter>
175   
176    <cqlEndpointAlternative>http://cqlservlet.mpi.nl/</cqlEndpointAlternative>
177
178add the possibility of creating a filter for endpoints.
Note: See TracBrowser for help on using the repository browser.