CloudBees SDK

Installing the CloudBees SDK

The SDK provides command line tools for your workstation to make use of the CloudBees Platform fast and light. Download here.

Prerequisites

Java 6 or greater must be installed and the java command must be available on the PATH (verify by running: java -version)

Download and configure the CloudBees SDK

Download the CloudBees SDK and unzip it into a directory on your machine (we'll refer to as BEES_HOME from now on)

To run the CloudBees command line tools, you need to set the BEES_HOME environment variable, and add BEES_HOME to your PATH environment variable.

The first time you run the bees command, you will be prompted to enter your CloudBees email address and password, your API keys will then be cached in your USER_HOME/.bees/bees.config file so that you won't need to enter them for any of the commands. 

Installation for OSX and Linux

Open a command-line console (launch the Terminal application on OSX) and then download SDK zip file and install unzip it into a directory.

Add the bees variables to your OS-X/linux command line environment by adding the following lines to your /.bash_profile or /.profile file (you may need to create this file)

Refresh your terminal's bash session by executing

Alternate Installation for OSX

If you have the homebrew package manager, then simply run

Installation for Windows

On Windows, you can open a predefined Bees Console window by double clicking on the BEES_HOME\Bees Console icon. Please avoid a path with spaces in it in your installation directory ! (eg don't use Program Files if you can avoid it). 

Running behind a proxy

If you are running the SDK commands on a machine that is behind a proxy, you may receive "Connection timed out" errors. The SDK supports a full set of proxy parameters:

• --proxyHost <arg>       API server proxy host
• --proxyPassword <arg>   API server proxy password
• --proxyPort <arg>       API server proxy port
• --proxyUser <arg>       API server proxy user name

Verify your installation

Verify this is running properly by executing the "bees help" command

CloudBees application service commands

The CloudBees SDK includes a set of commands for managing the  RUN@Cloud Application Service and can be used to perform most operations  that you can do via the web console.  Having these  commands available  in the SDK makes it easier to integrate CloudBees  operations into your  local development workflow and any build automation  for your web  application projects.

All of the application commands can be invoked using the following syntax.

app:deploy

Deploy a new version of an application using a WAR archive file

[parameters] are defined as name=value pairs.

For example to set the JVM MaxPermSize add the parameter: jvmPermSize=size  where size is in MB (see JVM PermGen Space).

NOTE: config parameters will be available to the application as system properties in Tomcat and JBoss containers.

Deploying WAR files

When deploying WAR files, you will need to place any CloudBees-specific configuration rules in WEB-INF/cloudbees-web.xml file.  Here is a rough example of a cloudbees-web.xml file that declares a Managed MySQL datasource.

app:delete

Delete an application

app:info

Returns the basic information about an application (such as its URLs and active/sleeping state)

app:list

Returns the list of applications available to your account

app:restart

Restarts all deployed instances of an application

app:tail (tail a log in real time)

Establishes a persistent connection to an application log so that you   can see new messages as they are written to the logs. This is  provides  a "cloud-friendly" replacement for the ubiquitous "tail"  command many  developers use to monitor/debug application log files.

app:update

Update an application parameters and restart the application

Parameters:
containerType             : tomcat or jboss
jvmPermSize                : jvmPermSize in MB (see  JVM PermGen Space article)
securityMode               : set to "private" to enable basic authentication access to the application, set to "public" to
                                      disable basic authentication

stickySession               : true or false (see Session AffinitySession Affinity)

app:resource:list

To list resources in your account (all apps, databases, session stores, SSL details etc) 

bees app:resource:list -a ACCOUNT

CloudBees database service commands

The SDK includes a set of commands for managing the  MySQL Database Service.

db:create

Create a new MySQL database

db:delete

Delete a MySQL database

db:info

Returns information about connecting to a database

db:list

Returns a list of all the databases associated with your account

db:set

Change your database password

db:snapshot:list

List database snapshots

db:snapshot:create

Create a database snapshot

db:snapshot:delete

Delete a database snapshot

db:snapshot:deploy

Deploy a database snapshot

Project commands

CloudBees project commands are only available for applications generated using the Bees wizard (on the web), built using the CloudBees SDK style.

Create application

Create a new web application using one of the predefined CloudBees application templates

Run application

Launch a local version of the CloudBees environment to run your application (runs on port 8080)

If you'd like to attach to your running application with a debugger (such as Eclipse), you can use the beesd command instead, which will initialize the JVM process to support remote debuggers.

Running an existing WAR

Alternatively, if you have an existing WAR file created via your own build process, you can use the app:run command to launch a local CloudBees server to run the WAR.

Deploy application

Deploy the web application to the cloud

If the specified appid does not exist, a new application environment will be created using this ID. If the appid already exists, and you have permission to update the application, the new application package will be published, and the existing application environment will be re-deployed to use the new package.

Note: If you accidentally overwrite an existing application or just want to rollback to the previous version, you can use the deployment history panel in the web-based application console to re-deploy a previous version of the application

Clean application

Removes all files generated by the compile and package commands

Compile application

Compiles all application source files

Get application

Downloads the remote application and installs it to run locally. This command is only valid if the deployed application has a source package associated with it.

Configuration parameters commands

External configuration parameters can be defined for application and account with the bees:set|unset|update commands.

See the Configuration Parameters article for a complete list of commands.