|
|
This document includes basic information about the different Java CoG Kit distributions in order to help you chose the one that is most suitable to your needs.
The material presented in this document can not be published, mirrored, electronically or otherwise reproduced without prior written consent. As you can link to this document, this should not pose much of a restriction.
The best way to read this document is with Adobe Acrobat Reader. Please make sure you configure Adobe Acrobat Reader appropriately so you can follow hyperlinks. This is the case if you follow the default installation. Acrobat Reader is available at http://www.adobe.com/products/acrobat/readermain.html. Because the hyperlinks are not available in the printed form of this manual and we support saving our environment we strongly discourage printing this document.
We recommend that you save this manual locally on your machine and use Acrobat Reader. This has the advantage that you do not lose your anchor points while switching back and forth between different hyperlinks. An HTML version of this manual is planed, but not available yet.
We have augmented the document with some comments at places where we found issues. Our intend is to address these issues in a future release. The comments are marked by the icon to do and the name of the person that will work on the removal of the issue.
Please be a team player and support us indirectly by registering with us or reporting your use of the Java CoG Kit. Although this software is free, we still need to justify to our funders the usefulness of the projects. If you want to help us with our efforts please take a few seconds to complete this information. We do not use this information for other purposes. If you have special needs or concerns please contact gregor@mcs.anl.gov. The registration form can filled out in a variety of formats. The online form can be found at
This form is available also as ASCII text at
which you can FAX to
Gregor von Laszewski, Fax: 630 252 1997
Originally, we distributed the Java CoG Kit as a single package called cog-jglobus. However, the distribution has grown and in order to prevent that a large number of packages need to be downloaded and installed on each client or server, we decided to divide the contents of the Java CoG Kit into separate modules and build a system that allows incremental deployment. Each part of the Java CoG Kit distribution is preceded by the keyword “cog” and its version number. Please note that the “.” between version numbers is replaced by an “_”. The base for the package names are
cog-4_1_2-<package>[-<version>].[bin∣src].[tar.gz—zip]
where <package> is the name of the package and <version> is an optional internal version number of the package. Hence, our packages are distributed in tar.gz or zip format.
To avoid large packages, we have bundled a number of correlated components in separate packages. The names of the packages correspond to the naming scheme mentioned earlier. To illustrate which components of the Java CoG Kit are associated with which packages we like that you spend a moment inspecting Figures 1 and 2.
The Java CoG Kit layered architecture provides a framework for developing Grid clients and servers. Hence, you will be able to access classes and methods not only including a convenient API focusing on elementary Grid functionality, but also the ability to formulate workflows through XML specifications, command line tools, and graphical user interfaces. The Java CoG Kit layers are conceptually organized as follows:
Although Figure 1 and 2 contain some additional components, they are not yet part of the Java CoG Kit. However, in future versions we anticipate you include for example also providers contributed by the community, such as the Unicore provider.
The distribution bundles as introduced in Figures 1 and 2 are available as .tar.gz or .zip, and as binary (bin) or source (src) distributions. The names of the bundles and their purpose are as follows:
Other CoG Kit bundles listed next are not yet distributed with GT3 and GT4.
However, you will see that the functionality of these bundles enhances the Grid experience significantly. Hence, it will be worthwhile for you to consider their benefits and use them appropriately.
Often we are asked why there are so many different GT3 versions. The answer is simple because various GT3 versions distribute different jar files but use internally the same name space. In order to avoid side effects between these different implementations, we redistribute them as part of our distribution strategy. In the Java CoG Kit GT3 common library you find the parts that are common amongst the three GT3 providers. To find more out about the GT3 compatibility, please consult the documentation at http://www.globus.org.
In case you inspect Figure 2 carefully, you may notice that we distribute at present the GT2 providers directly within our main distribution. This is due to the fact that this particular provider is at present time so popular and we wanted to avoid distributing it as separate provider bundle.
Now that you have an overview about what is available, you may ask which version is the right version for you?
We provide the following guide that will make your choice easier. Please note that we have two dimensions in order to assist you with the install decision. You need to decide if you would like an install from CVS, a source, or a binary install. You need also to decide if you like a full or a partial install.
Use the full distribution otherwise use the partial install.
Use the partial install or the full install if space and download speed is not of consideration
Use the distribution ending in “main”.
First, choose carefully which version of GT3 you want to use as there are some differences between them as explained earlier. Then download “main”, “common” bundles, and the provider followed by the appropriate version number.
We are not yet distributing our GT4 provider in the bundles or the CVS.
Please add the SSH provider. Make sure you also have “main”.
We have not yet integrated the UNICORE provider that was contributed to us by the community.
We have not yet integrated the gsiterm bundle.
We have not yet integrated the CoG Kit Grid certificate authority.
The matlab interfaces are only available via CVS. You can check them out as discussed in Section 8.
The Java CoG Kit LDAP browser is distributed through the following link: http://www-unix.mcs.anl.gov/~gawor/ldap/. Please note, that this component has a different license from the rest of the Globus Toolkit.
Once you have decided which version is most appropriate for you we recommend that you continue reading at the appropriate section. In case you have not yet made up your mind read the following sections carefully or consult your decision question while using our ticketing system at http://www.cogkit.org/bugzilla. Alternatively, you can send e-mal to gregor@mcs.anl.gov with the subject line “Question: CoG Kit, <question>, where question is a short summary of the question formulated in the e-mail body.
After registering and downloading the complete package [tar.gz][zip], unzip or untar in a directory of your choosing. Proceed by setting up the CoG Kit with the CoG Kit setup component.
A partial binary install is almost as easy to conduct. First, you have to be clear about which packages you need. You will always need the main package [tar.gz][zip]. However, you should only download and install providers that you need. After you have downloaded the needed packages you unpack them and start the setup as explained earlier. The list of packages currently available is as follows:
In any case, you will need:
Please add additional packages. In case you need a GT3 provider, you will also need the Common GT3 package:
After downloading the Java CoG Kit source package [tar.gz][zip], unpack it in a directory, then run
ant dist
in the cog directory and execute the setup.
The jglobus sources are also available as [tar.gz] and [zip] files.
In case you need the most up to date version of the Java CoG Kit, you can check this version out from the CVS. To do so you should follow these simple steps:
In case you are not interested in looking at the jglobus or the matlab interfaces, you do not have to check them out.
In case you need the most up to date version of the Java CoG Kit, you can check this version out from the CVS. To do so you should follow these simple steps:
In case you are not interested in looking at the jglobus or the matlab interfaces, you do not have to check them out.
To help the developers to inspect the code in the CVS directly, we refer to following table for hyperlinks to the appropriate contents.
In case you like to download the API documentation we have provided an additional package for you:
However we simply recommend to use our online API documentation at
Several applications from the Java CoG Kit 4_1_2 are available as Webstart applications as listed in Table 1. Additional experimental components are also available.
|
Once you have downloaded the Java CoG Kit, you can proceed to set up the Java CoG Kit. The setup step is conducted with a simple wizard that guides you through the configuration process. In case you like to use a Grid using GSI security, you should obtain a certificate that allows you to get access to this Grid. We recommend that you place the certificate and the public key for the certificate authority in the .globus directory in your home directory. The keys for the certificate authorities should be placed in .globus/certificates. We assume that you have started a terminal window and have changed to the directory the contains the release 4_1_2.
Now you can start the setup routine by launching it from your command line as follows. For Linux and Unix say
./bin/cog-setup
and for Windows
.
bin
cog-setup.bat
Naturally, you can make this even easier if you include the location of the cog_4_1_2/bin directory into your path environment variable. Additionally, you should set the variable COG_HOME to the directory that contains your release. Next, call the command cog-setup directly without worrying about having to cd to the bin directory.
You will then be walked through a number of easy to follow steps.
[1] G. von Laszewski, I. Foster, J. Gawor, and P. Lane, “A Java Commodity Grid Kit,” Concurrency and Computation: Practice and Experience, vol. 13, no. 8-9, pp. 643–662, 2001. [Online]. Available: http://www.mcs.anl.gov/~gregor/papers/vonLaszewski--cog-cpe-final.pdf
[2] “Java CoG Kit Wiki,” 2004. [Online]. Available: http://www.cogkit.org/wiki
[3] “Java CoG Kit Registration,” 2004. [Online]. Available: http://www.cogkit.org/register
Additional publications about the Java CoG Kit can be found as part of the vita of Gregor von Laszewski http://www-unix.mcs.anl.gov/~laszewsk/vita.pdf. Most documents are avalable online if you follow the links. In future we intend to provide this information without Gregors vita data.
If you need to cite the Java CoG Kit, please use [1].
| Short Title | Description | Format |
| Guide | A guide to help you finding out what guides have been written | [PDF] [HTML] |
| Install | A guide to the different ways of installing the Java CoG Kit | [PDF] [HTML] |
| Commands | A guide to the command line tools of the Java CoG Kit | [PDF] [HTML] |
| Workflow | A guide to the Gridant/Karajan Workflow | [PDF] [HTML] |
| Abstractions | A guide to the Java CoG Kit abstractions API | [PDF] [HTML] |
| JavaDoc | The Java API documentation to the Java CoG Kit | [HTML] |
| Coding | A guide to the Coding rules for the Java CoG Kit | [PDF] [HTML] |
| Overview | A future guide that will be an overview to the Java CoG Kit | [PDF] [HTML] |
More guides are under development. The following guides are not yet completed, but are listed here to help us improving these guides. Please, explore them and send us e-mail about improvement suggestions. If you like to contribute a guide yourself, please contact gregor@mcs.anl.gov.
| Short Title | Description | Format |
| MPI | A preliminary guide to execute MPI programs on the TeraGrid and alike | [PDF] [HTML] |
| Release Process | A preliminary guide to document the release process | [PDF] [HTML] |
| Guide | A preliminary guide to document writing guides | [PDF] [HTML] |
| Examples | A preliminary guide to examples alike | [PDF] [HTML] |
First time users of the Java CoG Kit should read the “Guide to Installing the Java CoG Kit” [PDF] [HTML]. We hope that you will find this guide useful to decide which bundles you need. For the more experienced user, we provide the following table.
The newest version of this document can be downloaded by the developers from
It is not allowed to reproduce this document or the source. This documentation is copyrighted and is not distributed under the CoG Kit license.
This guide is constantly improved and your input is highly appreciated. Please report suggestion, errors, changes, and new sections or chapters through our Bugzilla system at
http://www-unix.globus.org/cog/contact/bugs/
The Java CoG Kit project has been initiated and is managed by Gregor von Laszewski. To contact him, please use the information below.
Gregor von Laszewski
Argonne National Laboratory
Mathematics and Computer Science Division
9700 South Cass Avenue
Argonne, IL 60439
Phone:(630) 252 0472
Fax: (630) 252 1997
gregor@mcs.anl.gov
Contact, 14
Documentation
API, 10
Gridfaces, 3
Install
binary
full, 8
partial, 8
CVS
development, 10
release, 10
source, 9
Providers, 3
Registration, 2
Task management, 3
