Platform EGO Developer Edition Readme, V 1.2.3

The downloaded DE contains both EGO and the EGO Software Developer Kit (SDK) for the selected operating system. You can install these components separately or together. To run the provided SDK samples, you must install EGO (see both the EGO SDK installation and EGO 1.2.3 installation sections).

  • For Java APIs, read the EGO Java SDK section.

  • For Web Services (Linux and Windows) or C APIs (Linux only), you need to install both the EGO 1.2.3 SDK and EGO 1.2.3.

Contents

Find the following release information:

Browser requirements for EGO


OS

Version

Supported browsers

Windows

2000 Server

2000 Advanced Server

Server 2003 Standard Edition

Server 2003Enterprise Edition

Server 2003 R2 Standard Edition

Server 2003 R2 Enterprise Edition

Internet Explorer 6

Internet Explorer 7

Firefox 1.5 and later

Windows

2000 Professional

XP Professional

Vista

Internet Explorer 6

Internet Explorer 7

Firefox 1.5 and later

Linux x86

Kernel 2.4.x compiled with glibc 2.2.x (Tested on RedHat Enterprise Linux AS 2.1, SuSE Linux Enterprise Server 8)

Kernel 2.4.x compiled with glibc 2.3.x (Tested on RedHat Enterprise Linux AS 3)

Kernel 2.6.x compiled with glibc 2.3.x (Tested on RedHat Enterprise Linux AS 4, SuSE Linux Enterprise Server 9)

Mozilla 1.7.13 and later

(Must upgrade Mozilla on older versions of Linux.)

Mozilla 1.7.x (RHEL 4 and 5)

Mozilla 1.4.x (RHEL 3)

Mozilla 0.9.x (RHAS 2.1)

Mozilla 1.6.x (SLES 9)

Mozilla 1.0.x (SLES 8)


Supported operating systems

EGO


Operating system

Linux kernel, glibc

Hardware architecture

Install package

Windows XP, 2003

n/a

Intel x86 32-bit

MSI

Windows 2000 (SP4+latest patches)

n/a

Intel x86 32-bit

MSI

RHEL 4, RHEL 5, SLES 9

Kernel 2.6, glibc 2.3

Intel x86 32-bit

RPM

RHEL 3

Kernel 2.4, glibc 2.3

Intel x86 32-bit

RPM

RHEL 2.1, SLES 8

Kernel 2.4, glibc 2.2

Intel x86 32-bit

RPM


EGO SDK


Windows

Linux

  • Windows 2000

  • Windows XP

  • SDK includes Java binding for the web service API.

  • If support is required for the C API for Windows, please speak to your Platform representative to obtain the required packages.

  • linux2.4-glibc2.2-x86

  • linux2.4-glibc2.3-x86

  • linux2.6-glibc2.3-x86

  • SDK includes Java binding for the web service API and native C API.


EGO Developer Edition 1.2.3 packages

EGO 1.2.3

Both Windows and Linux packages are provided for EGO 1.2.3. For Linux platforms, the required package-type depends if you are installing on a management host or compute host.

  • Windows msi file: ego1.2.3_win32.msi

  • Linux rpm files for management hosts:

    • ego-linux2.6-glibc2.3-x86-1.2.3-97008.rpm (kernel 2.6, glibc 2.3)

    • ego-linux2.4-glibc2.3-x86-1.2.3-97008.rpm (kernel 2.4, glibc 2.3)

    • ego-linux2.4-glibc2.2-x86-1.2.3-97008.rpm (kernel 2.4, glibc 2.2)

  • Linux rpm files for compute hosts:

    • egocomputehost-linux2.6-glibc2.3-x86-1.2.3-97008.rpm (kernel 2.6, glibc 2.3)

    • egocomputehost-linux2.4-glibc2.3-x86-1.2.3-97008.rpm (kernel 2.4, glibc 2.3)

    • egocomputehost-linux2.4-glibc2.2-x86-1.2.3-97008.rpm (kernel 2.4, glibc 2.2)

EGO SDK 1.2.3

  • Windows file: egoDE-win32-1.2.3-97008.zip

  • Linux files:
    • egoDE-linux2.6-glibc2.3-x86-1.2.3-97008.tar (kernel 2.6, glibc 2.3)

    • egoDE-linux2.4-glibc2.3-x86-1.2.3-97008.tar (kernel 2.4, glibc 2.3)

    • egoDE-linux2.4-glibc2.2-x86-1.2.3-97008.tar (kernel 2.4, glibc 2.2)

The EGO SDK 1.2.3 Linux package contains the Web Service and C API plug-ins. It also contains the Platform EGO Developer’s Guide for using the SDK.

EGO Java SDK

All Platforms:
  • ego_java_sdk.tar.gz

EGO 1.2.3 installation

Definitions

This document uses EGO_TOP to describe the top-level EGO directory (where EGO is installed). %EGO_CONFDIR% (Windows) or $EGO_CONFDIR (Unix) is an environment variable and is used when the document is describing where configuration files can be found. When you have enabled failover, this directory differs from EGO_TOP.

Installation documents

Refer to appropriate EGO 1.2.3 installation documents (found on the EGO FTP site) for details on planning and installing a cluster.

Note that a single host is sufficient for running samples 1 through 4. However, samples 5 through 7 require a minimum of two hosts to be installed in the cluster.

Helpful commands:

  • To check if your cluster is running, run egosh ego info.

  • To confirm that the web server and the web service gateway (for SDK access) are running, run egosh service list.

Configuring the web service gateway

The EGO web service gateway supports the following optional configuration parameters: The parameters can be defined in $EGO_CONFDIR/kernel/conf/wsg.conf on Linuxor %EGO_CONFDIR%\kernel\conf\wsg.conf on Windows.

  • WSG_PORT: The web service gateway listening port, default 9090.

  • WSG_SSL: Security option for communication between web service gateway and its client. Default is NO.

  • WSG_LOGDIR: Logging directory for web service gateway to save the log file. Default location relative to the installation directory is EGO_TOP/eservice/wsg/log on Linuxor EGO_TOP\eservice\wsg\log on Windows.

  • WSG_DEBUG_DETAIL: By default, EGO web service gateway will run as a daemon. When the debug is turned on (value is set to 1), it will run in console mode and log all messages to stderr.

EGO SDK 1.2.3 installation

Prerequisites

  • JDK 1.5 (This is bundled in the EGO 1.2.3 RPM, EGO_TOP/jre)

  • Eclipse 3.2 or higher, with the following plug-ins:
    • EMF SDK 2.2.2 or higher: http://download.eclipse.org/callisto/releases (under Models and Model Development)

    • C/C++ Development Tools (CDT) 3.1.2: http://download.eclipse.org/callisto/releases (under C/C++ Development)

    Eclipse can be downloaded from http://www.eclipse.org/downloads. The required plug-ins can be added from the Callisto Discovery update site. Add the plug-ins by following these steps:

  1. Start Eclipse.

  2. From the Help menu, select Software Updates and then Find and Install.

  3. In the Install/Update dialog box, click Search for new features to install. Click Next.

  4. In the Install dialog box, click New Remote Site.

  5. In the New Update Site dialog box, type the name Callisto Discovery Site, enter the URL http://download.eclipse.org/callisto/releases, and then click OK.

  6. In the Install dialog box, select callistor and then Finish.

  7. In the Update Site Mirrors dialog box, select the mirror for your download.

  8. In the Update dialog box, select from the following plug-ins and then click Next and Finish:
    • EMF: Under Models and Model Development

    • CDT: Under C/C++ Development

EGO SDK 1.2.3 installation steps

  1. Download and uncompress or unzip the EGO SDK 1.2.3 from the Platform Computing FTP site.

  2. Start Eclipse and perform the following steps to add the EGO plug-in:
    1. From Help, select Software Updates and then Find and Install.

    2. In the Install/Update dialog box, click Search for new features to install. Click Next.

    3. In the Install dialog box, click New Archive Site.

    4. Navigate to the location of the saved Platform update site jar file and click OK and then Finish.

      • Windows: com.platform.ego.updatesite.nt-x86.zip.

      • Unix: Select the appropriate file based on your Linux version. For example: com.platform.ego.updatesite.linux2.6-glibc2.3-x86.

After installing the EGO plug-in, you can find further documentation about using it by navigating to Help > Help Contents > EGO Developer Documentation.

EGO SDK 1.2.3 sample programs

Note that a single host is sufficient for running samples 1 through 4. However, samples 5 through 7 require a minimum of two hosts to be installed in the cluster.

Java samples (requires JDK 5.0)

  • Sample 1: Connects to the EGO web service gateway to get information on resources in the EGO cluster.

  • Sample 2: Registers a client and unregisters it.

  • Sample 3: Allocates a resource and starts an activity on it.

  • Sample 4: Monitors load on a resource with an activity running on it.

  • Sample 5: Starts multiple activities on a resource, monitors load and adjusts resources based on load.

  • Sample 6: Illustrates the use of the EGO service controller API to start a service.

  • Sample 7: Illustrates the use of the EGO service director API.

To run the Java samples, see their main methods for the arguments needed. All of them need the URL for the web service gateway as the first argument. If it is running on the master host at the default port, then the URL would be http://masterhostname:9090/. Samples 2-7 all take a port number as the second argument. This is where they run the notification service. You can use 9091 if it is unused on your machine. The third and fourth arguments are the name and description of the client that wishes to register with EGO. For example you can use “Test” and “Testing EGO”.

C samples

  • Sample 1: Connects to the EGO cluster and finds cluster information and information on the resources in the cluster.

  • Sample 2: Registers with EGO cluster, requests a resource and starts a container on the resource. It explicitly reads messages synchronously from the EGO cluster.

  • Sample 3: Same as sample 2 but uses asynchronous callbacks from the cluster.

  • Sample 4: Requests multiple resources and starts activities on them.

  • Sample 5: Extends sample 4 by monitoring the activities started by the client and dynamically flexes the resources based on load.

  • Sample 6: Illustrates the use of the EGO service controller API to start a service.

  • Sample 7: Illustrates the use of the EGO service director API.

EGO Java SDK

  • Platform EGO Java SDK 1.2.3 installation (Windows)
  • Platform EGO Java SDK 1.2.3 installation (Linux)
  • Platform EGO Java SDK 1.2.3 sample programs

Platform EGO Java SDK 1.2.3 installation (Windows)

JDK 5.0 (This is bundled in the Platform EGO 1.2.3 msi file)

The procedure to install the Java SDK is described below.

  1. Download the Platform EGO Java SDK 1.2.3 from the Platform Computing FTP site.
  2. Unzip ego_java_sdk.tar.gz to the ego_java_sdk directory. For example, C:\ego_java_sdk.
  3. Add all jar files in the ego_java_sdk\1.2\lib directory to Java CLASSPATH. For example, set CLASSPATH=c:\ego_java_sdk\1.2\lib\egoapi.jar.

Platform EGO Java SDK 1.2.3 installation (Linux)

JDK 5.0 (This is bundled in the Platform EGO 1.2.3 RPM, EGO_TOP/jre)

The procedure to install the Java SDK is described below.

  1. Download the Platform EGO Java SDK 1.2.3 from the Platform Computing FTP site.
  2. Untar ego_java_sdk.tar.gz to the ego_java_sdk directory, i.e., /tmp.
  3. Add all jar files in the ego_java_sdk/1.2/lib directory to Java CLASSPATH.

Platform EGO Java SDK 1.2.3 sample programs

Note that a single host is sufficient for running the first four samples. However, the last two samples (ResourceSample and ServiceSample) require a minimum of two hosts to be installed in the cluster.

Java samples (requires JDK 5.0)

  • ClusterSample: Connects to the Platform EGO web service gateway to get information on resources in the Platform EGO cluster.

  • ClientSample: Registers a client and unregisters it.

  • AllocateSample: Allocates a resource and starts an activity on it.

  • ActivitySample: Monitors load on a resource with an activity running on it.

  • ResourceSample: Starts multiple activities on a resource, monitors load and adjusts resources based on load.

  • ServiceSample: Illustrates the use of the Platform EGO service controller API to start a service

To run the Java samples, see their main methods for the arguments needed. All of them need the URL for the web service gateway as the first argument. If it is running on the master host at the default port, then the URL would be http://masterhostname:9090/.

Known issues

Debug always turned on for Web Services Gateway

In $EGO_CONFDIR/kernel/conf/wsg.conf, the parameter WSG_DEBUG_DETAIL is currently set to a value of 1 by default and means debug is turned on. When set to 0, debug is still turned on. The correct behavior is for the default to be set to 0, meaning the debug is turned off.

Using the Platform Management Console

The Platform Management Console is a tool for EGO administrators to monitor and manage the cluster. It supports both Internet Explorer and Mozilla Firefox, and can be used to perform the following activities:

  • Cluster configuration monitoring

  • Cluster health monitoring

  • User management

  • Resource distribution policy definition

  • Resource consumer definition

From the Console you can add new users or change passwords. Use the Console to manage EGO users, consumers, and resources.

Logon to Platform Management Console

You have set your environment on this host. You are logged into the operating system as egoadmin.

The Platform Management Console allows you to monitor, administer, and configure your cluster.

  1. If you do not already know the web server URL, run egosh client view.
    1. Look for the client name preceded by “GUIURL_1”.
    2. Look for the DESCRIPTION line beneath the client name to find the web server URL, and then copy it.

      For example: http://Host_W:8080/platform.

  2. Launch any web browser and enter the address of the web server URL.

    The format of the URL is always http://host_name:port_number/platform.

  3. Log on to the Platform Management Console for the first time by specifying
    • User Name: Admin

    • Password: Admin

    For security in a production environment, we strongly recommend that you change the password of the Admin account.

Using the EGO CLI

In addition to the Platform Management Console, the EGO command line interface (CLI) is also used to manage the cluster. Using egosh commands, you can start and stop EGO daemons or services. Monitoring functionality is also provided.

For a description of various egosh commands, run egosh help or see the Platform EGO Reference guide. Like other shells, egosh can be used to execute a single command or used as a shell. For example:

command prompt>egosh help

or

command prompt>egosh

egosh> help

Documentation

The Platform EGO™ documentation set is available from the EGO Knowledge Center, installed with your package and accessible from the Platform Management Console. It is also available from ftp.platform.com, in the /docs directory. It includes the following documents:

  • Planning and Installing your Cluster (Windows or Linux version): Plan your installation, install a production cluster with a Windows or Linux master host, and grow the cluster to include management hosts and compute hosts.

  • Installing a Single-Host Cluster (Windows or Linux version): Deploy, configure, and test software on a single-host Windows or Linux cluster. Learn how to reconfigure and migrate to a production cluster.

  • Administering and Using Platform EGO: Manage the cluster by controlling hosts, creating user accounts, and adding administrators and users. Manage resources by building a consumer tree, creating consumers, creating resource groups, and configuring a resource distribution plan. Find information about log files and events, services and daemons, and general EGO concepts. Follow four scenarios to learn key concepts and steps involved in creating resource groups, building a consumer tree, adding a new service to the cluster, and creating resource plans.

  • Platform EGO Reference: Comprehensive reference to EGO commands, daemons, events, and environment variables.

  • Platform EGO Developers Guide: A developer's resource for understanding and working with system services, APIs, web service components, WSDLs and schemas. Learn how to create client projects. Find tutorials on getting started with C client and Java client.

  • Platform EGO C API Reference: Covers all the EGO functions, data structures, pre-processor directives, and enumerations that are available to the C application developer.

  • Platform EGO Java API Reference: Covers all the Platform EGO details of all the class/interface methods and fields available to the Java application developer.

  • Platform EGO Web Services WSDL Reference: Provides details about available Web Service operations including input arguments and responses.

  • Platform EGO Web Services XML Schema Reference: Describes the elements and associated data types used in the WSDLs. Schema diagrams support the descriptions.