// $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
==========

- Provides common functionalites for cloud management.
- Cloud module is a heart of cloud package.  This requires at least one
  "cloud support module" such as Amazon EC2 module, OpenStack XCP or
  and so on.

SYSTEM REQUIREMENTS
===================
- PHP 5.2 or Higher
- MySQL 5.1 or Higher
- Drupal 6.x
- 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).


DIRECTORY STRUCTURE
===================

cloud
  +-audit_activity  (depends on cloud                  )(Part of Cloud)
  +-alerts          (depends on cloud                  )(Part of Cloud)
  x-auto_scaling    (depends on cloud                  )(Part of Cloud)
  +-billing         (depends on pricing                )(Part of Cloud)
  x-cluster         (depends on cloud, server_templates)(Part of Cloud)
  x-failover        (depends on cloud                  )(Part of Cloud)
  x-inputs          (depends on cloud                  )(Part of Cloud)
  +-pricing         (depends on cloud                  )(Part of Cloud)
  x-scaling_manager (depends on cloud                  )(Part of Cloud)
  x-scripting       (depends on cloud, server_templates)(Part of Cloud)
  +-server_templates(depends on cloud                  )(Part of Cloud)

x... Not released yet.


hook_* FOR SUBSIDIARY MODULES
=============================

- hook_cloud_set_info()
- hook_server_template()
- hook_get_all_instances()

* Example for Sub Cloud Family
  e.g. Amazon EC2, XCP, OpenStack nova and so on...

function hook_cloud_set_info() {
  return array(
    'cloud_name'         => 'generic_cloud_context', // Used for cloud ID
    'cloud_display_name' => 'Generic Cloud'        , // Uuser for display name in menu, etc. 
    'instance_types'     => array(
    )
  );
}

function hook_server_template($op, $params = array())

  $form = array( // make some form);
  return $form;
}

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


End of README.txt