Difference between revisions of "Administrator Guide"

From GCube System
Jump to: navigation, search
Line 1: Line 1:
 +
 
 
This Guide covers the installation, configuration, and maintenance of gCore.
 
This Guide covers the installation, configuration, and maintenance of gCore.
  
Line 11: Line 12:
 
* [http://www.gnu.org/software/tar/tar.html GNU tar] to install gCore from archived distributions.
 
* [http://www.gnu.org/software/tar/tar.html GNU tar] to install gCore from archived distributions.
 
* [http://www.courtesan.com/sudo/ sudo] to execute shell commands with controlled super-user privileges.
 
* [http://www.courtesan.com/sudo/ sudo] to execute shell commands with controlled super-user privileges.
 +
 +
Running gCore in a secure infrastructure raises further prerequisites:
 +
 
* A [http://www.ntp.org/ ntp server] to synchronise your clock with other machines' for correct credential validation.  
 
* A [http://www.ntp.org/ ntp server] to synchronise your clock with other machines' for correct credential validation.  
* A static IP address for all but the simplest testing scenarios.
 
  
 +
Finally, at least static IP address (if not a DNS name) is needed for all but the simplest testing scenarios.
  
 
== Installation ==
 
== Installation ==
Line 20: Line 24:
  
 
In the first case, installing gCore is tantamount to [[Downloads |downloading]] it into a directory of choice, the ''gCore location''. In the second case, installing gCore is simply matter of expanding the downloaded archive into the the gCore location. In either case, proceed to the installation as a a non-privileged user with read and write permissions for the gCore location.  
 
In the first case, installing gCore is tantamount to [[Downloads |downloading]] it into a directory of choice, the ''gCore location''. In the second case, installing gCore is simply matter of expanding the downloaded archive into the the gCore location. In either case, proceed to the installation as a a non-privileged user with read and write permissions for the gCore location.  
 
== Configuration ==
 
  
 
At the end of the process, the gCore location should contain the following structure:
 
At the end of the process, the gCore location should contain the following structure:
  
 
<pre>
 
<pre>
|
 
 
|-bin
 
|-bin
 
|
 
|
Line 40: Line 41:
 
|
 
|
 
|-share
 
|-share
|   
 
 
</pre>
 
</pre>
  
Line 51: Line 51:
 
|-
 
|-
 
| '''config'''
 
| '''config'''
| configuration files
+
| gHN configuration files
 
|-
 
|-
 
| '''etc'''
 
| '''etc'''
| deployed service configuration files
+
| container and  deployed service configuration files
 
|-
 
|-
 
| '''lib'''
 
| '''lib'''
Line 63: Line 63:
 
|}
 
|}
  
 +
== Configuration ==
  
You should define an environment variables '''GLOBUS_LOCATION''' and point it to the installation directory. Assuming a bash shell:
+
Configuring the installation can be roughly divided in three steps: configuring the environment, the container, and the gHN associated with a running instance of the container.
  
export GLOBUS_LOCATION = <''gCore location''>
+
=== Configuring the environment ===
  
Adding $GLOBUS_LOCATION/bin to your PATH is also highly recommended:
+
Define an environment variable '''GLOBUS_LOCATION''' and point it to the installation directory. Assuming a bash shell:
  
export PATH = $PATH:$GLOBUS_LOCATION/bin
+
<pre>export GLOBUS_LOCATION = ...absolute path to your gCore location...</pre>
  
 +
Adding ''$GLOBUS_LOCATION/bin'' to your '''PATH''' environment variable is also highly recommended:
  
#configure ''${GLOBUS_LOCATION}/etc/globus_wsrf_core/server-config.wsdd'' by specifying the hostname as value of the logicalHost parameter
+
<pre>export PATH = $PATH:$GLOBUS_LOCATION/bin</pre>
 
   
 
   
<pre>
+
=== Configuring the Container ===
  
<deployment name="defaultServerConfig" xmlns="http://xml.apache.org/axis/wsdd/" xmlns:java="http://xml.apache.org/axis/wsdd/providers/java" xmlns:wsa="http:/
+
Specify the hostname of your machine as the value of ''logicalHost'' parameter in the container's configuration file ''$GLOBUS_LOCATION/etc/globus_wsrf_core/server-config.wsdd'':
/schemas.xmlsoap.org/ws/2004/03/addressing" xmlns:wsnt="http://docs.oasis-open.org/wsn/2004/06/wsn-WS-BaseNotification-1.2-draft-01.xsd" xmlns:wsrp="http://d
+
ocs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties-1.2-draft-01.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+
  
    <globalConfiguration>
+
<pre><parameter name="logicalHost" value="..yourhostname..."/></pre>
        <parameter name="logicalHost" value="localhost"/>
+
        [...]
+
=== Configuring the gHN ===
    <globalConfiguration>
+
</deployment>
+
  
</pre>
+
In the gHN's configuration file ''$GLOBUS_LOCATION/config/GHNConfig.xml'', override wherever appropriate the [[Default GHNConfig.xml |default values]] of the following properties:
  
To test it: start GHN  ''gcore-start-container -nosec'' (by default on 8080, otherwise start with ''-p <port>'')
+
{| class="wikitable" border="1"
 
+
|-
=== GHN Passport ===
+
| '''securityenabled'''
The main configuration file of gCore is ''$GLOBUS_LOCATION/config/GHNConfig.xml'':
+
| ''true'' if the gHN can operate in a secure infrastructure, ''false'' otherwise.
<pre>
+
|-
<?xml version="1.0" encoding="UTF-8"?>
+
| '''mode'''
<jndiConfig xmlns="http://wsrf.globus.org/jndi/config">
+
| in a ''development' mode, the gHN does not publish its own profile as well as those of the deployed Running Instances in the infrastructure. In a ''production'' mode, it does.  
    <global>
+
|-
 
+
| '''rootVO'''
                <environment
+
| the rootVO of the gHN.
                        name="securityenabled"
+
|-
                        value="true"
+
| '''defaultVO'''
                        type="java.lang.Boolean"
+
| the defaultVO of the gHN.
                        override="false" />
+
|-
                <environment
+
| '''infrastructure'''
                        name="mode"
+
| the infrastructure of the gHN.
                        value="development"
+
|-
                        type="java.lang.String"
+
| '''labels'''
                        override="false" />
+
| [missing]
                <environment
+
|-
                        name="rootVO"
+
| '''rootGHN'''
                        value="/gcube"
+
| [missing]
                        type="java.lang.String"
+
|-
                        override="false" />
+
| '''GHNtype'''
                <environment
+
| [missing]
                        name="defaultVO"
+
|-
                        value="/gcube/devsec"
+
| '''localProxy'''
                        type="java.lang.String"
+
| [missing]
                        override="false" />
+
|-
                <environment
+
| '''coordinates'''
                        name="infrastructure"
+
| A pair of comma-separated values for the latitude and longitude of the gHN. Coordinates for some popular locations are available [[gHN Coordinates|here]].
                        value="development"
+
|-
                        type="java.lang.String"
+
| '''country'''
                        override="false" />
+
| [missing]
                <environment
+
|-
                        name="labels"
+
| '''location'''
                        value="GHNLabels.xml"
+
| [missing]
                        type="java.lang.String"
+
|-
                        override="false" />
+
| '''updateInterval'''
                <environment
+
| [missing]
                        name="rootGHN"
+
|}
                        value="true"
+
                        type="java.lang.Boolean"
+
                        override="false" />
+
                <environment
+
                        name="GHNtype"
+
                        value="Dynamic"
+
                        type="java.lang.String"
+
                        override="false" />
+
                <environment
+
                        name="localProxy"
+
                        value="/home/globus/..."
+
                        type="java.lang.String"
+
                        override="false" />
+
                <environment
+
                        name="coordinates"
+
                        value="43.719627,10.421626"
+
                        type="java.lang.String"
+
                        override="false" />
+
                <environment
+
                        name="country"
+
                        value="it"
+
                        type="java.lang.String"
+
                        override="false" />
+
                <environment
+
                        name="location"
+
                        value="Pisa"
+
                        type="java.lang.String"
+
                        override="false" />
+
                <environment
+
                        name="updateInterval"
+
                        value="60"
+
                        type="java.lang.Long"
+
                        override="false" />
+
 
+
    </global>
+
</jndiConfig>
+
 
+
</pre>
+
 
+
 
+
## [[Prerequisites|Prerequisites]]
+
## [[SourceInstallation|Installing from Source]]
+
## [[BinaryInstallation|Installing from Binary]]
+
# [[Configuration|Configuration]]
+
## [[GTConfiguration|GT Configuration]]
+
## [[GHNConfiguration|gHN Configuration]]
+
## [[SecurityConfiguration|Security Configuration]]
+
# [[LaunchShutdown|Launch & Shutdown]]
+

Revision as of 13:07, 9 April 2008

  This Guide covers the installation, configuration, and maintenance of gCore.

Before you Begin

The following software is a prerequisite for the installation of gCore:

  • A platform compatible or made compatible with GT requirements.
  • J2SE 1.5.08 SDK or greater. Sun's reference implementation is recommended, but versions from IBM, HP, or BEA should work equally well.
  • Ant 1.6.5+ to build gCF sources or to develop services with it.
  • a SVN client to install gCore from the SVN repository.
  • GNU tar to install gCore from archived distributions.
  • sudo to execute shell commands with controlled super-user privileges.

Running gCore in a secure infrastructure raises further prerequisites:

  • A ntp server to synchronise your clock with other machines' for correct credential validation.

Finally, at least static IP address (if not a DNS name) is needed for all but the simplest testing scenarios.

Installation

gCore may be installed from a SVN repository, or else from pre-packaged archives.

In the first case, installing gCore is tantamount to downloading it into a directory of choice, the gCore location. In the second case, installing gCore is simply matter of expanding the downloaded archive into the the gCore location. In either case, proceed to the installation as a a non-privileged user with read and write permissions for the gCore location.

At the end of the process, the gCore location should contain the following structure:

|-bin
|
|-config
|
|-endorsed
|
|-etc
|
|-lib
|
|-libexec
|
|-share

Some folders are of immediate interest to administrators and developers alike:

bin executables
config gHN configuration files
etc container and deployed service configuration files
lib standard and deployed service libraries
share build tools, standard and deployed service interfaces/schemas

Configuration

Configuring the installation can be roughly divided in three steps: configuring the environment, the container, and the gHN associated with a running instance of the container.

Configuring the environment

Define an environment variable GLOBUS_LOCATION and point it to the installation directory. Assuming a bash shell:

export GLOBUS_LOCATION = ...absolute path to your gCore location...

Adding $GLOBUS_LOCATION/bin to your PATH environment variable is also highly recommended:

export PATH = $PATH:$GLOBUS_LOCATION/bin

Configuring the Container

Specify the hostname of your machine as the value of logicalHost parameter in the container's configuration file $GLOBUS_LOCATION/etc/globus_wsrf_core/server-config.wsdd:

<parameter name="logicalHost" value="..yourhostname..."/>

Configuring the gHN

In the gHN's configuration file $GLOBUS_LOCATION/config/GHNConfig.xml, override wherever appropriate the default values of the following properties:

securityenabled true if the gHN can operate in a secure infrastructure, false otherwise.
mode in a development' mode, the gHN does not publish its own profile as well as those of the deployed Running Instances in the infrastructure. In a production mode, it does.
rootVO the rootVO of the gHN.
defaultVO the defaultVO of the gHN.
infrastructure the infrastructure of the gHN.
labels [missing]
rootGHN [missing]
GHNtype [missing]
localProxy [missing]
coordinates A pair of comma-separated values for the latitude and longitude of the gHN. Coordinates for some popular locations are available here.
country [missing]
location [missing]
updateInterval [missing]