## Functions
create(order) ⇒ Cluster

Create HPC cluster on cloud.

destroy(opt) ⇒ boolean

Destroy cluster which was created by create().

list(opt) ⇒ Object

Destroy cluster which was created by create().

increase(opt) ⇒ boolean

Increase child node in the cluster.

decrease(opt) ⇒ boolean

Decrease child node in the cluster.

suspend(opt) ⇒ boolean

Suspend all nodes in the cluster.

resume(opt) ⇒ boolean

Resume all nodes in the cluster.

## Typedefs
order : object
host : object
cluster : object
## create(order) ⇒ Cluster Create HPC cluster on cloud. **Kind**: global function **Returns**: Cluster - - Cluster object which is just created. | Param | Type | Description | | --- | --- | --- | | order | Order | Order object for the cluster to build. | ## destroy(opt) ⇒ boolean Destroy cluster which was created by create(). **Kind**: global function **Returns**: boolean - True if all instance is successfully destried. | Param | Type | | --- | --- | | opt | Object | ## list(opt) ⇒ Object Destroy cluster which was created by create(). **Kind**: global function **Returns**: Object - List of instances created by abc4. | Param | Type | | --- | --- | | opt | Object | ## increase(opt) ⇒ boolean Increase child node in the cluster. **Kind**: global function **Returns**: boolean - True if child node is successfully increased. | Param | Type | | --- | --- | | opt | Object | ## decrease(opt) ⇒ boolean Decrease child node in the cluster. **Kind**: global function **Returns**: boolean - True if child node is successfully decreased. | Param | Type | | --- | --- | | opt | Object | ## suspend(opt) ⇒ boolean Suspend all nodes in the cluster. **Kind**: global function **Returns**: boolean - True if all instance is successfully suspended. | Param | Type | | --- | --- | | opt | Object | ## resume(opt) ⇒ boolean Resume all nodes in the cluster. **Kind**: global function **Returns**: boolean - True if all instance is successfully resumed. | Param | Type | | --- | --- | | opt | Object | ## order : object **Kind**: global typedef **Properties** | Name | Type | Description | | --- | --- | --- | | provider | string | cloud provider | | numNodes | number | number of nodes | | os | string | operating system | | rootVolume | number | root storage volume in GB | | shareStorage | boolean | if true, head node's storage is shared via NFSv4 | | headOnlyParam | object | additional parameters only for head node. this value is passed to underlying cloud SDK(e.g. aws-sdk) | | publicKey | string | public key which will be stored in head node | | id | string | id for cloud provider (e.g. access key for AWS) | | pw | string | pw for cloud provider (e.g. secret access key for AWS) | | batch | string | batch system's name | | runJobOnBatchServer | boolean | run jobs on batch server(head node) or not (default true) | | batchSetupScript | Array.<string> | array of commands to be issued after batch server setup | | packages | Array.<string> | array of package names to be installed | | mpi | string | MPI library | | compiler | string | compiler | | playbook | string | playbook which will be run after cluster is up | | debug | function | debug output function | | info | function | info output function | ## host : object **Kind**: global typedef **Properties** | Name | Type | Description | | --- | --- | --- | | publicNetwork.hostname | string | hostname in public network | | publicNetwork.IP | string | IP address in public network | | privateNetwork.hostname | string | hostname in private network | | privateNetwork.IP | string | IP address in private network | ## cluster : object **Kind**: global typedef **Properties** | Name | Type | Description | | --- | --- | --- | | user | string | username at head node | | clusterID | string | unique string for cluster | | privateKey | string | private key to login to head node. if publicKey is specified in order object, this property is undefined. | | headNodes | [Array.<host>](#host) | ip, hostname of head node in public and private network. | | childNodes | [Array.<host>](#host) | ip, hostname of child nodes in private network. | | id | string | specified value in order | | pw | string | specified value in order |