[IlabServiceBrokerDeployment.htm - uqlpayne 22 Aug 2013]
The GlassFish Server Open Source Edition 4.0 is installed and running.
The UQ-iLab-ServiceBroker-Java GitHub repository has been downloaded as a ZIP file from:
https://github.com/uqlpayne/UQ-iLab-ServiceBroker-Java
The IlabServiceBroker Database has been created and configured (see IlabServiceBrokerDatabase.pdf).
The ExperimentStorage Database has been created and configured (see ExperimentStorageDatabase.pdf).
The folder D:\iLabs has been created for the IlabServiceBroker project and ExperimentStorage project application files.
Run the GlassFish Server Administration Console by entering the following URL in a web browser.
http://localhost:4848/
If prompted, log in to the Administration Console.
There are two web applications that need to be deployed to the GlassFish Server.
Packaged File: | UQ-iLab-ServiceBroker-Java/Builds/iLabServiceBroker.war |
Local Folder: | D:\iLabs\iLabServiceBroker |
Context Path: | /iLabServiceBroker |
Packaged File: | UQ-iLab-ServiceBroker-Java/Builds/ExperimentStorage.war |
Local Folder: | D:\iLabs\ExperimentStorage |
Context Path: | /ExperimentStorage |
Create the folder iLabServiceBroker in the folder D:\iLabs so that the folder D:\iLabs\iLabServiceBroker exists.
Extract the web archive file Builds/iLabServiceBroker.war to the folder D:\iLabs\iLabServiceBroker.
Go to the GlassFish Server Administration Console. In the Common Tasks panel, click on Applications.
In the Applications panel, click the Deploy... button.
In the Deploy Applications or Modules panel, select Local Packaged File or
Directory That Is Accessible from GlassFish Server and enter D:\iLabs\iLabServiceBroker
in the field.
Alternatively, click the Browse Folders... button to select the folder.
For Type: select Web Application from the dropdown list. More fields are then displayed.
For Context Root: enter iLabServiceBroker
in the field.
Also for Application Name: enter iLabServiceBroker
in the field.
Leave the other fields with their default values.
Click the OK button to deploy the application.
Create the folder ExperimentStorage in the folder D:\iLabs so that the folder D:\iLabs\ExperimentStorage exists.
Extract the web archive file Builds/ExperimentStorage.war to the folder D:\iLabs\ExperimentStorage.
Go to the GlassFish Server Administration Console. In the Applications panel, click the Deploy... button.
In the Deploy Applications or Modules panel, select Local Packaged File or
Directory That Is Accessible from GlassFish Server and enter D:\iLabs\ExperimentStorage
in the field.
Alternatively, click the Browse Folders... button to select the folder.
For Type: select Web Application from the dropdown list. More fields are then displayed.
For Context Root: enter ExperimentStorage
in the field.
Also for Application Name: enter ExperimentStorage
in the field.
Leave the other fields with their default values.
Click the OK button to deploy the application.
Launch the IlabServiceBroker client by entering the following URL in a web browser:
http://localhost:8080/iLabServiceBroker/
The web page displays the IlabServiceBroker login. This is sufficent to show that the IlabServiceBroker application has been deployed correctly. At this point in time, the IlabServiceBroker service has not been invoked.
Log in to the IlabServiceBroker with the following username and password:
Username: |
superuser
|
Password: |
ilab
|
The menu provides some items to configure the IlabServiceBroker.
Self Registration - Configure the IlabServiceBroker by specifying the name, guid, service URL and email address.
My Account - Specify the IlabServiceBroker Superuser's account information.
Logout - Log out of the IlabServiceBroker.
Select the My Account menu item.
Change the Contact Email to your email address or some other appropriate email address.
Change the Password to something else especially if the IlabServiceBroker is deployed on a networked server.
Click the Update button to save the changes.
Select the Self Registration menu item.
A message is displayed stating that the IlabServiceBroker has not been registered yet. That's because the Service Guid and Service Passkey fields are empty and cannot be prefilled.
Click the Create button adjacent to the Service Guid field to create a new guid.
Click the Create button adjacent to the Service Passkey field to create a new passkey.
Change the Service Email to your email address or some other appropriate email address. This is the IlabServiceBroker's email address and not the IlabServiceBroker Superuser's email address although they could be the same.
Leave the Service Name, Service Url and Client Url fields with their default values.
Click the Save button to save the changes.
Click the Test button to get the IlabServiceBroker status. This makes a web service call to the specified Service Url. If the service is accessible, a message is displayed stating that the service is online and a version number is shown.
After successfully completing the self registration, the Manage ... item appears in the menu.
Hover the mouse over the Manage ... menu item to display a popup menu.
Select the Users menu item.
Select Experiments from the dropdown list under Select a Group: and click the adjacent Select button.
Now select testuser from the dropdown list under Select a User: and click the adjacent Select button. Information about the user testuser is displayed.
Change the Contact Email to your email address or some other appropriate email address.
Click the Update button to save the changes.
Select the Groups menu item from the Manage ... popup menu.
Select Experiments from the dropdown list under Select a Group: and click the adjacent Select button.
Information about the group Experiments is displayed.
No changes need to be made.
Launch the ExperimentStorage client by entering the following URL in a web browser:
http://localhost:8080/ExperimentStorage/
The web page displays the ExperimentStorage login. This is sufficent to show that the ExperimentStorage application has been deployed correctly. At this point in time, the ExperimentStorage service has not been invoked.
Log in to the ExperimentStorage with the following username and password:
Username: |
manager
|
Password: |
ilab
|
The menu provides some items to configure the ExperimentStorage.
Self Registration - Configure the ExperimentStorage by specifying the name, guid, service URL and email address.
Services - Information about the iLab services registered with the ExperimentStorage.
My Account - Specify the ExperimentStorage Manager's account information.
Logout - Log out of the ExperimentStorage.
Select the My Account menu item.
Change the Contact Email to your email address or some other appropriate email address.
Change the Password to something else especially if the ExperimentStorage is deployed on a networked server.
Click the Update button to save the changes.
Select the Self Registration menu item.
A message is displayed stating that the ExperimentStorage has not been registered yet. That's because the Service Guid and Service Passkey fields are empty and cannot be prefilled.
Click the Create button adjacent to the Service Guid field to create a new guid.
Click the Create button adjacent to the Service Passkey field to create a new passkey.
Change the Service Email to your email address or some other appropriate email address. This is the ExperimentStorage's email address and not the ExperimentStorage Manager's email address although they could be the same.
Leave the Service Name, Service Url and Client Url fields with their default values.
Click the Save button to save the changes.
Click the Test button to get the ExperimentStorage status. This makes a web service call to the specified Service Url. If the service is accessible, a message is displayed stating that the service is online and a version number is shown.
If you are logged out of the IlabServiceBroker, log in again as superuser.
Select the Services menu item from the Manage ... popup menu.
Copy the Service Url from the ExperimentStorage Self Registration web page and paste it into the Service Url field of the IlabServiceBroker Manage Services web page.
Also, copy the Service Passkey from the ExperimentStorage Self Registration web page and paste it into the Service Passkey field of the IlabServiceBroker Manage Services web page.
Click the Register button to register the ExperimentStorage service with the IlabServiceBroker.
A message should be displayed stating that the service was registered successfully.
The UQ-iLab-BatchLabServer-Java GitHub repository provides projects for the Template and Radioactivity Batch LabServers and LabClients. Adding information to the IlabServiceBroker database will enable an IlabServiceBroker user to run Template and Radioactivity experiments. SQL scripts have been provided to add information directly to the database and avoid entering the information in manually.
The Template and Radioactivity projects are provided in the UQ-iLab-BatchLabServer-Java GitHub repository. If these projects have not been deployed yet, see Documents/GettingStarted.pdf of the UQ-iLab-BatchLabServer-Java GitHub repository.
In the Object browser panel, under Databases, click IlabServiceBroker and then click the Execute arbitrary SQL queries toolbar button to open a Query window.
Check that the IlabServiceBroker database is selected in the dropdown list. If not, query execution will fail.
For each of the following SQL scripts in the UQ-iLab-ServiceBroker-Java/Database/PostgreSQL folder, execute the query by selecting Query->Execute from the menu.
If you are logged out of the IlabServiceBroker, log in again as superuser.
Select the Lab Clients menu item from the Manage ... popup menu.
Select Radioactivity JLC from the dropdown list under Select a LabClient: and click the adjacent Select button. Information about the LabClient Radioactivity JLC is displayed.
Also view the LabClient information for Radioactivity JLCR and Template JLC and compare the differences.
No changes need to be made.
Select the Batch LabServers menu item from the Manage ... popup menu.
Select Radioactivity JLS from the dropdown list under Select a LabServer: and click the adjacent Select button. Information about the Batch LabServer Radioactivity JLS is displayed.
Also view the Batch LabServer information for Template JLS and compare the differences.
No changes need to be made.
The Template LabServer needs to be informed that the IlabServiceBroker will require access to run experiments.
Launch the Template LabServer client by entering the following URL in a web browser:
http://localhost:8080/TemplateLabServer/
Log in to the Template LabServer with the following username and password:
Username: |
manager
|
Password: |
ilab
|
Select the ServiceBrokers menu item.
Copy the Service Name from the IlabServiceBroker Self Registration web page and paste it into the ServiceBroker Name field of the Template LabServer Manage ServiceBrokers web page.
Copy the Service Guid from the IlabServiceBroker Self Registration web page and paste it into the ServiceBroker Guid field of the Template LabServer Manage ServiceBrokers web page.
Check the Allow Access checkbox.
Copy the Service Url from the IlabServiceBroker Self Registration web page and paste it into the Service Url field of the Template LabServer Manage ServiceBrokers web page.
Leave the Incoming Passkey field blank.
Go to the IlabServiceBroker and select the Batch LabServers menu item from the Manage ... popup menu.
Select Template JLS from the dropdown list under Select a LabServer: and click the adjacent Select button.
Copy the Outgoing Passkey from the IlabServiceBroker Manage Batch LabServers web page and paste it into the Outgoing Passkey field of the Template LabServer Manage ServiceBrokers web page.
Click the Save button to save the changes.
Log out of the Template LabServer.
The Radioactivity LabServer needs to be informed that the IlabServiceBroker will require access to run experiments.
Launch the Radioactivity LabServer client by entering the following URL in a web browser:
http://localhost:8080/RadioactivityLabServer/
Log in to the Radioactivity LabServer with the following username and password:
Username: |
manager
|
Password: |
ilab
|
Select the ServiceBrokers menu item.
Copy the Service Name from the IlabServiceBroker Self Registration web page and paste it into the ServiceBroker Name field of the Radioactivity LabServer Manage ServiceBrokers web page.
Copy the Service Guid from the IlabServiceBroker Self Registration web page and paste it into the ServiceBroker Guid field of the Radioactivity LabServer Manage ServiceBrokers web page.
Check the Allow Access checkbox.
Copy the Service Url from the IlabServiceBroker Self Registration web page and paste it into the Service Url field of the Radioactivity LabServer Manage ServiceBrokers web page.
Leave the Incoming Passkey field blank.
Go to the IlabServiceBroker and select the Batch LabServers menu item from the Manage ... popup menu.
Select Radioactivity JLS from the dropdown list under Select a LabServer: and click the adjacent Select button.
Copy the Outgoing Passkey from the IlabServiceBroker Manage Batch LabServers web page and paste it into the Outgoing Passkey field of the Radioactivity LabServer Manage ServiceBrokers web page.
Click the Save button to save the changes.
Log out of the Radioactivity LabServer.
Launch the IlabServiceBroker client by entering the following URL in a web browser:
http://localhost:8080/iLabServiceBroker/
Log in to the IlabServiceBroker with the following username and password:
Username: |
testuser
|
Password: |
ilab
|
The menu provides some items available to the user.
My Groups - Select an available group for running experiments.
My Account - Specify the user's account information.
Logout - Log out of the IlabServiceBroker.
The My Groups web page is displayed by default.
This web page is also displayed when the My Account menu item is selected.
Click on the Experiments hyperlink to choose one of the experiment LabClients to launch.
The My Labs web page is displayed by default.
The menu changes to provide some additional items available to the user.
My Labs - Select an available LabClient to run an experiment.
My Experiments - View experiment data of previously run experiments.
Click on the Template JLC hyperlink from the My Labs web page to choose the Template LabClient for running the Template experiment.
The My Labs web page changes to show a summary about the Template LabClient.
Click the Launch button to launch the Template LabClient.
A new web browser tab or window opens displaying the Template LabClient.
The Template Project Deployment tutorial (see TemplateProjectDeployment.pdf) in the UQ-iLab-BatchLabServer-Java GitHub repository provides the necessary information to run the experiment.
When the experiment has been run and the results retrieved, select the Experiments menu item of the IlabServiceBroker.
The My Experiments web page is displayed. Select the experiment that was just run in the listbox under Select an Experiment: and click the Select button. A summary of the experiment information is displayed.
Click the Records button to display the XML formatted records that are stored on ExperimentStorage.
The experiment results are best viewed in the LabClient rather than the way they are displayed here.
Close the Template LabClient web page.
Select the My Labs menu item of the IlabServiceBroker.
Click on the Radioactivity JLC hyperlink from the My Labs web page to choose the Radioactivity LabClient for running the Radioactivity experiment.
The My Labs web page changes to show a summary about the Radioactivity LabClient.
Click the Launch button to launch the Radioactivity LabClient.
A new web browser tab or window opens displaying the Radioactivity LabClient.
The Radioactivity Project Deployment tutorial (see RadioactivityProjectDeployment.pdf) in the UQ-iLab-BatchLabServer-Java GitHub repository provides the necessary information to run the experiment.
When finished running Radioactivity experiments, close the Radioactivity LabClient web page.
Log out of the IlabServiceBroker.
If the IlabServiceBroker is on a network and being accessed from another computer, then the Loader Script for each LabClient needs to be changed.
Change localhost:8080
to the computer's Url. For example, machine.your.domain:8080
and the Loader Script for the Template LabClient becomes:
http://machine.your.domain:8080/TemplateLabClient/LabClient.do?serviceUrl=http://machine.your.domain:8080/iLabServiceBroker/iLabServiceBrokerService&labServerId=2CD01113C51C4ca997B059531CD9469D
That's it.