Versions Compared

Old Version 39

changes.mady.by.user Unknown User (shawn)

Saved on

compared with

New Version Current

changes.mady.by.user Albert Rossi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Elf

...

Overview

...

is a robust container designed to support scripted applications.

Refer to the infrastructure diagram and interaction diagram for where it fits into our general workflow-management scheme.

Elf's native scripting language is Ogrescript, but it can be extended to run other kinds of scripts as well.

Downloads

Latest versions: ELF-latest.

Elf Javadocs can be accessed at: API scriptable applicatations.

Elf Core Goals

  1. Robust
    • Must not fail unexpectedly
    • Must not fail silently
    • Must be able to determine cause of failure
  2. Monitorable
    • Must report status information to listeners
    • Should report debug information to listeners
    • Should report progress information to listeners
    • Should standardize logging across scripting implementations
  3. Extensible
    • Should allow for user extensions to core functionality without recompilation
    Steerable Must be cancellable

Elf Core Functionality

Authentication Management

Individual sub-component may need to authenticate to services. The AuthenticationManager should provide provides an extensible mechanism for managing authentication tokens.

Event Management

Events (currently Progress, Status, and Debug Events) should have a centralized A centralized event-handling mechanism. Sub-components should have a means of adding listeners for specific types of events and should have as well as a standardized way to create and send events.

Identity Management

Components should be able to create an identity for their sub-components . The mechanism for determining the identity will be through this mechanism, which is also extensible.

Elf Container

Elf should support supports multiple types of containers.

Elf Core Components

ElfRuntime

This class is instantiated Instantiated and started by the Eclipse platform. It is responsible for instantiation, management of lifetime (configure, initialize, run), and management of status (calling Bootstrap.alive(), Bootstrap.failed(), Bootstrap.success()) of the Bootstrap object.

This object should does not throw any exceptions, and should handle but handles failures cleanly by returning the an appropriate exit code.

Bootstrap

The Bootstrap class is responsible Responsible for parsing the command line arguments, the set-up of the runtime environment, the configuration of ElfPlatform, and the instantiation and management of the Container. The configuration of this class should work works with little mandatory configuration and should fail fails cleanly if the Container container is missing or invalid.

ElfPlatform

ElfPlatform is the The globally accessible point of access to Elf-wide objects. The various managers (Authentication, Event, and Identity) are instantiated and configured by this class from a file determined by a command line argument ":

  • -bootstrap.properties <value>

...

  • .

The platform should provide provides default managers if nothing specific is requested.

Elf Runtime Environment

Elf should provide The platform provides a standard environment for running scriptable applications. The platform should provide scripted applications and a means of accessing these variables.

This environment consists of the following:

  • bootstrap.home – The directory in which the Bootstrap code will run.
    • The default location is defined by the system property

...

    • user.dir

...

    • This can be overridden by a property named

...

    • bootstrapHome

...

    • in the bootstrap properties file.
  • container.path – The location of the Container script.
    • The default location is a file named

...

    • elf-container.xml

...

    • in the current working directory.
    • This can be overridden by a property named

...

    • containerPath

...

    • in the bootstrap properties file.

Elf Platform Initialization

The ElfPlatform handles the instantiation and initialization of the components that are available Elf-wide.

Bootstrap Properties File

The bootstrap properties file is a A standard properties file.

Code Block
xml
xml
titlebootstrap.properties example
# ENVIRONMENT CONFIGURATION
containerPath=/Users/homearossi/shawn/elfStuff/elf-archive/elf-test/elf-container.xml
bootstrapHome#bootstrapHome=/tmp/run (defaults to .)

# EVENT MANAGEMENT
eventListener.tag=loggingListener
eventListenereventSender.loggingListener.log4jPropertiesFile0=tcp:/home/shawn/elfStuff/log4j.properties/tb1.ncsa.uiuc.edu:61616,ncsa.tools.jms.localevent.JMSLocalEventSender
eventReceiver.0=tcp://tb1.ncsa.uiuc.edu:61616,ncsa.tools.jms.localevent.JMSLocalEventReceiver
eventTopic.0=TROLL

# AUTHENTICATION MANAGER
authenticationManager#authenticationManager.tag=usernamePasswordAuthenicationproxyAuthenticationManager
authenticationManager#authenticationManager.usernamePasswordAuthenticationproxyAuthenticationManager.username=shawn
authenticationManager.usernamePasswordAuthentication.password=foobar
bjewett

# IDENTITY MANAGER
identityManager.tag=defaultIdentification
identityManager.defaultIdentification.baseId=httphttpg://tb1.ncsa.uiuc.edu:8080/ensemble/services/EnsembleBroker?eid=FooBar/12&wfname=IdealWrfNcar&nname=IdealWrf

Logging

Code Block
titlelog4j.properties

# Set root category priority to ERROR and its only appender to A1.
log4j.rootCategory=DEBUG, FA

# MAIN_CONSOLE
log4j.appender.MAIN_CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.MAIN_CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.MAIN_CONSOLE.layout.ConversionPattern=%-r - [%c{1}]:  %m%n

# MAIN_FILE
log4j.appender.MAIN_FILE=org.apache.log4j.FileAppender
log4j.appender.MAIN_FILE.File=${bootstrap.home}/main.log
log4j.appender.MAIN_FILE.Append=false
log4j.appender.MAIN_FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.MAIN_FILE.layout.ConversionPattern=%-r - [%c{1}]:  %m%n

 # FA is set to be a FileAppender.
log4j.appender.FA=org.apache.log4j.FileAppender
log4j.appender.FA.File=${bootstrap.home}/elf.log
log4j.appender.FA.Append=false
log4j.appender.FA.layout=org.apache.log4j.PatternLayout
log4j.appender.FA.layout.ConversionPattern=%-4r [%t] %-5p %C %x - %m%n

# CLASSES
log4j.logger.ncsa.tools.ogrescript.tasks.system.Echo=DEBUG, MAIN_CONSOLE, MAIN_FILE
log4j.logger.debug=DEBUG, MAIN_CONSOLE, MAIN_FILE

Get properties file here.

Running Elf

Elf requires both JAVA_HOME and ELF_HOME to be set. Elf looks for a container in the current directory, this can be overridden by a command-line argument -containerPath <path> or a properties in bootstrapProperties: containerPath. Elf also looks for bootstrapProperties in the current directory, this can be overridden by a command-line argument -bootstrapProperties <path>.

:8043/broker?level=DEBUG&groupId=local&node=TEST&user=arossi&workflow=Test
#identityManager.tag=executionServiceIdentityManager
#identityManager.executionServiceIdentityManager.baseId=httpg://tb1.ncsa.uiuc.edu:8043/broker?level=DEBUG&groupId=local&node=TEST&user=arossi&workflow=Test

Running Elf

Elf requires both JAVA_HOME and ELF_HOME environment variables to be set. Elf looks for a container in the current directory; this can be overridden by a command-line argument

  • -containerPath <path>

or a property in bootstrapProperties (containerPath).

Elf also looks for bootstrapProperties in the current directory; this can be overridden by a command-line argument

  • -bootstrapProperties <path>.

Thus:

  • ELF_HOME/elf
    OR
  • ELF_HOME/elf -containerPath /tmp/foo.xml
    OR
  • ELF_HOME/elf -bootstrapProperties /tmp/bootstrap.properties
    OR
    ELF_HOME/elf -bootstrapProperties /tmp/bootstrap.properties -containerPath /tmp/foo.xml

ELF Container Script Example

Code Block
xml
xml

<elf>
   <configuration>
      <property xmlns:ncsa.updateable.id="submissionType" name="submissionType">
         <value xmlns:ncsa.updateable.id="value">interactive</value>
      </property>
      <property xmlns:ncsa.updateable.id="PWD" name="PWD" type="int" category="workdirEnvironment">
         <value xmlns:ncsa.updateable.id="value">4</value>
      </property>
      <property xmlns:ncsa.updateable.id="TG_CLUSTER_SCRATCH" name="TG_CLUSTER_SCRATCH" type="int" category="workdirEnvironment">
         <value xmlns:ncsa.updateable.id="value">1</value>
      </property>
      <property xmlns:ncsa.updateable.id="SCR" name="SCR" type="int" category="workdirEnvironment">
         <value xmlns:ncsa.updateable.id="value">2</value>
      </property>
      <property xmlns:ncsa.updateable.id="scr" name="scr" type="int" category="workdirEnvironment">
         <value xmlns:ncsa.updateable.id="value">3</value>
      </property>
      <property xmlns:ncsa.updateable.id="file-transfer-protocol" name="file-transfer-protocol">
         <value xmlns:ncsa.updateable.id="value">gridftp://gridftp-hg.ncsa.teragrid.org:2811</value>
      </property>
      <property xmlns:ncsa.updateable.id="ELF_HOME" name="ELF_HOME" category="environment">
         <value xmlns:ncsa.updateable.id="value">/home/ncsa/arossi/elf-latest</value>
      </property>
      <property xmlns:ncsa.updateable.id="TG_CLUSTER_PFS" name="TG_CLUSTER_PFS" type="int" category="workdirEnvironment">
         <value xmlns:ncsa.updateable.id="value">0</value>
      </property>
      <property xmlns:ncsa.updateable.id="JAVA_HOME" name="JAVA_HOME" category="environment">
         <value xmlns:ncsa.updateable.id="value">/usr/local/sunjava/j2sdk1.4.2_13</value>
      </property>
      <property xmlns:ncsa.updateable.id="USER_HOME" name="USER_HOME" category="environment">
         <value xmlns:ncsa.updateable.id="value">/home/ncsa/arossi</value>
      </property>
      <property xmlns:ncsa.updateable.id="service-job-name" name="service-job-name">
         <value xmlns:ncsa.updateable.id="value">MssGet_6012732530767072524</value>
      </property>
      <property xmlns:ncsa.updateable.id="X509_USER_PROXY" name="X509_USER_PROXY" category="environment">
         <value xmlns:ncsa.updateable.id="value">/home/ncsa/arossi/.proxy/x509up_MssGet_6012732530767072524</value>
      </property>
      <property xmlns:ncsa.updateable.id="HOST_NAME" name="HOST_NAME">
         <value xmlns:ncsa.updateable.id="value">tg-login.test</value>
      </property>
      <property xmlns:ncsa.updateable.id="SoftwareStackServiceUrl" name="SoftwareStackServiceUrl" type="java.lang.String">
         <value xmlns:ncsa.updateable.id="value">http://tb1.ncsa.uiuc.edu:8080/softwarestack/services/SoftwareStackRepository</value>
      </property>
   </configuration>
   <workdir />
   <serial-scripts separate-script-dirs="false">
      <ogrescript name="MY_LEAD_INTEGRATION_EXAMPLE">
         <set-system-property name="trebuchet.dir" value="${runtime.dir}" />
         <copy taskName="BULK_FILE_MOVE" target="mssftp://mss.ncsa.uiuc.edu/u/ac/arossi/NAM">
            <configuration>
               <property name="transferMode" value="gridftp-stream"/>
               <property name="target-active" value="true" type="boolean" />
               <property name="tcpBufferSize" value="2097152" type="int" />
            </configuration>
            <listener xmlns:absoluteTag="transfer-completed-listener" bulk="true" useSrc="false">
            </listener>
            <source base="file:/home/ncsa/arossi/elf-test">
               <include>*</include>
            </source>
         </copy>
         <copy taskName="BULK_FILE_MOVE" target="mssftp://mss.ncsa.uiuc.edu/u/ac/arossi/NAM2">
            <configuration>
               <property name="transferMode" value="gridftp-stream" />
               <property name="target-active" value="true" type="boolean" />
               <property name="tcpBufferSize" value="2097152" type="int" />
            </configuration>
            <listener xmlns:absoluteTag="transfer-completed-listener" bulk="true" metadataUpdateOnly="false" useSrc="true">
            </listener>
            <source base="file:/home/ncsa/arossi/elf-test">
               <include>*</include>
            </source>
         </copy>
         <ftp-chmod recursive="true" permissions="755" dir="mssftp://mss.ncsa.uiuc.edu/u/ac/arossi/NAM2" />
      </ogrescript>
   </serial-scripts>
</elf>

...