Skip to content

Command line functions

pingali edited this page Sep 13, 2010 · 8 revisions

PoolParty uses the git-style binaries to communicate with your cloud.

There are quite a few commands available already, but the list is continuously growing.

All the available commands can be listed with the commands


cloud -h

Noteable commands.

To launch your cloud:


cloud start

This command provisions the backend resources such as Amazon Instances, installs the recipes and keys. When the command returns, it will provide a list of resources and IP addresses corresponding to them.

If you have more than one cloud, you can specify with the -n switch, like so


cloud start -n app

If you do not specify a particular cloud, all the clouds specified in the clouds.rb file will be deployed.


cloud ssh (-n app) (-i <node-id>)

Instantiates the nodes and poolparty dependencies:


cloud bootstrap

When you change your cloud’s configuration, you can run


cloud configure

This command will transfer the cloud-specific recipes to the nodes and deploys them. This overwrites the existing configuration. If there are excess instances, then a subset of instances will be shutdown in order to be consistent with the specification.


cloud provision 

Provision bootstraps and configures the nodes.


cloud describe 

Shows the current configuration of the cloud (as specified in the clouds.rb). The command will not check against the actual state of the cloud when it is running.


cloud list 

Lists the deployed instances that are part of the cloud.


cloud expand
cloud contract 

Cloud expand and contract alters the number of instances in the clouds specified in clouds.rb. When the size of the cloud is increased, new instances are deployed. When the size decreases, instances are selected by PoolParty for termination. By default PoolParty selects the last deployed instance for termination.

To terminate your cloud:


cloud terminate [-n name] 

This command terminates all deployed instances. When a cloud name is specified, only that cloud is terminated. If no cloud is specified, all clouds are terminated.

Advanced.

If you are on osx, you can use this command to copy the master ip to your pasteboard


cloud osxcopy
Clone this wiki locally