Installation instructions for AstroGrid FileStore component

Preparation

You'll need to have a suitable tomcat installation in which to deploy the FileStore component. See Deploying tomcat for more.

It's best to install the FileStore into a completely fresh tomcat (one that has no AstroGrid components installed in it at the moment). If you've done a trial AGINAB deployment, sometimes the "maven CLEANTOMCAT" cleanup command doesn't clean out all the AGINAB webapps from tomcat so it's worth checking in the tomcat manager and manually undeploying any AG webapps that are left behind. See the general installation notes for more on AGINAB and AGINAB cleanup.

You do NOT need to install AGINAB into the tomcat(s) in which you are installing FileStore, either manually or using the auto-installer. Doing so (probably) won't break anything, but it may make it harder to debug configuration/connection problems with your FileStore component.

---

Installing FileStore with the java-based installer

First of all, you need to download the relevant jar file:

http://www.astrogrid.org/maven/org.astrogrid/jars/astrogrid-filestore-installer-0.9-b003fs.jar

GUI installation

You can double click on the jar file (in windows), or run it from the command line with

  java -jar (installer).jar

Text-only installation

If you're running on a machine with no graphical environment then

  java -jar (installer).jar -c

will run it text-only.

Installation parameters

The installation process will prompt you to supply certain parameters, e.g.:

FileStore repository - the toplevel directory where the running FileStore will keep all the data files it is storing. This should have a large amount of free space.

"context path on the webserver" - default of /astrogrid-filestore should be fine, unless you're trying to install multiple FileStores in one tomcat (not recommended), in which case each one will need a different context path (e.g. /astrogrid-filestore001, /astrogrid-filestore002)

"Authority under which this FileStore is/will be registered" - your Authority ID (contact KonaAndrews if you don't know what this is, and/or take a look at the Authority ID notes.)

"registry key for this filestore" - its unique name amongst the FileStores being managed by you under your Authority ID (e.g. filestore001). You can choose this; something containing the word "filestore" is helpful! Making the context path and the registry key the same is probably sensible.

"the URL of your registry" - this is the registry that manages your Authority ID; contact KonaAndrews if you don't know what this is, and/or take a look at the Authority ID notes.

Known issues

A couple of known problems:

1) Reinstallation of the webapp is unreliable. It seems Tomcat doesn't clean up properly following an uninstall. AFAIK this only affects Windows -- JohnTaylor - 23 Mar 2005 It's better for the moment to use the tomcat manager to uninstall by hand, then use the installer to install.

2) When running in text-only mode you'll get a NullPointerException^? at the end of the process. Don't worry - it doesn't affect the install.

---

Installing FileStore manually

Step 1. Download the FileStore war :

http://www.astrogrid.org/maven/org.astrogrid/wars/astrogrid-filestore-1.0-b000fs.war (md5)

You will need to deploy this WAR file into your tomcat installation, either by using the tomcat manager or by copying the WAR into the tomcat webapps directory and restarting tomcat.

To get a user-friendly installation endpoint name in tomcat, I recommend renaming the war to something that doesn't include the version number - e.g. astrogrid-filestore.war. (Tomcat will deploy the WAR with a context path based on the WAR's name).

Step 2. Follow the installation instructions:

http://www.astrogrid.org/maven/docs/HEAD/filestore/multiproject/astrogrid-filestore/service-install.html

When it comes to actually registering your component in registry that manages your authority ID, you'll need to visit the endpoint page for that registry (e.g. http://galahad.star.le.ac.uk:8081/astrogrid-registry for the main registry on galahad.)

To register the FileStore, choose "Enter resource" from the "Register" section of the registry main page left-hand menu. This will bring up a form in which to paste the registration XML data supplied in the FileStore installation instructions (don't forget to customise the necessary bits of XML to match your own installation!).

Please contact KonaAndrews if you're uncertain about what IVORN (service.ivorn) value to use in installing your FileStore. Essentially it takes the form ivo://[authorityID]/[registrykey] where [authorityID] and [registryKey] are your authority ID and the unique name of this installation in the registry. See the notes about authority ID and registry key in the java-based installation section above for more details.

-- KonaAndrews - 14 Mar 2005