// $Id$

//////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2010 DOCOMO Communications Laboratories USA, Inc.
//
// DOCOMO Communication Laboratories USA, Inc. (DOCOMO USA Labs) licenses
// the GNU General Public License version 2 (GPL2) for the software
// disclosed herein. For terms and conditions under the GPL2, please
// refer to www.gnu.org.
//
// Date of Preparation: 11/09/2010
//
// IT Manager: Yas Naoi, DOCOMO USA Labs
// Contact   : naoi at docomolabs-usa.com
//
// DOCOMO USA Labs is under no obligation to maintain or support this
// software, and DOCOMO USA Labs is not responsible for any damage or
// loss experienced from using the software.
//
// Please contact the IT Manager at DOCOMO USA Labs for all issues
// related to the software.
//
//////////////////////////////////////////////////////////////////////////

BASIC INFO
==========

- This module is a sub-cloud system under Cloud module
- It provides almost all of Amazon EC2 functionalities
- Enable Amazon EC2 module (Requires Cloud module), then

  i)  Clouds | Amazon EC2 | Instaces -> Click - Refresh Page -
  ii) Clouds | Amazon EC2 | Images   -> Click - Refresh Page -

- You also need to Setup cron.php on Drupal for automatic update
  for the latest information on EC2.

SYSTEM REQUIREMENTS
===================
- 512MB Memory: If you use Amazon EC2 module, the running host of this
  system requires more than 512MB memory to download a list of images
 (because it's huge amount of data for listing).


LIMITATION
==========

- Only sigle region is supported (e.g. only east-1x Availability Zone)
- Some of features are not implemented


SSH CONSOLE SETUP
=================

- Change a constant value 'CLOUD_SEED' in ec2_lib_constants.inc to your 
  favorite keyword.
- The security is not considered in current implementation. Please be
  aware of your private key will pass through via the Internet if
  you deploy this system on the Internet.
- Go to Cloud | Amazon EC2 | SSH Keys and edit / update your private key
- If you input your private key through the above menu, the SSH console
  will not work.
- You need to get MindTerm from http://www.appgate.com/mindtermcontact
  and put mindterm.jar file into your <wwwroot> folder.  (e.g. /var/www/html)
- Launch an Amazon EC2 instance and make sure the instance is running. Then
  click 'console' icon or Console tab in Instance Detail page.
- You need to trust two Java Applets on both mindterm.jar and SSHKeyManager.jar
  by clicking 'Allow' or 'Yes' button in order to handle / transfer your
  private key.
- If you see the following error:

  e.g. Error when setting up authentication:
       C:\Users\<USERNAME>\Application Data\MindTerm\64656661756c74

  then that error message means you skipped SSHKeyManager.jar authentication.
  Please clear Java applet cache from Java control panel and re-launch your
  browser.


MOUDLE DEPENDENCY
=================

This module works with the following modules:

- Cloud
- Server Templates
- Amazon EC2 Library
- Amazon EC2 API
- AWS Common
- REST Client
 

DIRECTORY STRUCTURE FOR AWS MODULE FAMILY
=========================================

aws
  +-amazon_ec2              (This module: depends on ec2_api)(Amazon EC2 is part of AWS)
  x-amazon s3               (depends on s3_api              )(Amazon S3  is part of AWS)
  x-amazon_smpledb          (depends on simpledb_api        )(Amazon S3  is part of AWS)
  x-amazon_cloud_watch      (depends on cloud_watch_api     )(Amazon S3  is part of AWS)
  +-lib (Will be called by other EC2 API compatible clouds like Eucalyptus,  OpenStack nova and etc.)
    +-ec2 
      -- ec2_api.module (depends on aws_common) 
      -- ec2_lib.module (depends on ec2_api)
      -- EBS Volume wrapper (.inc)
      -- Elastic IP wrapper (.inc)
      -- Images wrapper (.inc)
      -- Instances wrapper (.inc)
      -- Register Image wrapper (.inc)
      -- Security Group wrapper (.inc)
      -- Snapshot wrapper (.inc)
      -- SSH Key (User Keys Management based on Permission) wrapper (.inc)
      -- ...
    x-s3
      -- ...
    x-sqs
      -- ...
    x-simpledb
      -- ...
    x-cloud_watch
      -- ...
  +-aws_common (depends on REST-Client)

x... NOTE: NOT IMPLEMENTED.  SHOWN ONLY AS A REFERENCE AND PROPOSED STRUCTURE SPEC.



CHANGE HISTORY
==============
2010/11/09 ver.0.7 released to reviewing process of drupal.org


End of README.txt