Execute CloudFormation-style templates on CloudStack
Clone or download

README.md

Stackmate - CloudFormation for CloudStack

A library designed to read CloudFormation templates and execute them on a CloudStack deployment. Supports AWS Cloudformation templates (namespace AWS::Cloudformation) as well as the CloudStack:: native namespace. Uses the ruote workflow engine, and embeds a modular Sinatra application for wait handles.

Unlike CloudFormation, it does not run as a web application. Instead it runs everything on the client side.

Stacktician embeds stackmate to run it as a web application.

For the AWS::CloudFormation namespace, only Basic Zone (aka EC2-Classic) is supported for now. For the CloudStack:: namespace, all virtual resources that can be created in CloudStack 4.2 are supported.

Follow:

Dependencies

stackmate uses Bundler to setup and maintain its environment. Before running stackmate for the first time you need to install Bundler (gem install bundler) and then run:

$ bundle install

Bundler will download all the required gems and install them for you.

Have a look at the Gemfile if you want to see the various dependencies.

Getting started quickly

Using the source

  • Get the source files using git
$ git clone http://github.com/chiradeep/stackmate.git
$ cd stackmate
  • Make sure every dependency is resolved.
$ bundle install
  • Find your API key and secret key and the url for CloudStack

For example

$ export APIKEY=upf7L-tvcHFCSYhKhw-45l9IfaKXNQSWf0nXyWye6eqOBpLT5TqN8XQGeuloV3LbSwD6zuucz22L233Nrqg2pg
$ export SECKEY=9iSsuImdUxU0oumHu0p11li4IoUtwcvrSHcU63ZHS_y-4Iz3w5xPROzyjZTUXkhI9E7dy0r3vejzgCmaQfI-yw
$ export URL="http://localhost:8080/client/api"
$ export WAIT_COND_URL_BASE="http://<my ip>:<some port>/"

Sample Templates

AWS samples

AWS samples are templates that use the AWS::CloudFormation namespace.

You need a couple of mappings from AWS ids to your CloudStack implementation:

$ cat local.yml 
---
service_offerings:
  m1.small: 1c8db272-f95a-406c-bce3-39192ce965fa
templates:
  ami-1b814f72: 3ea4563e-c7eb-11e2-b0ed-7f3baba63e45
zoneid: b3409835-02b0-4d21-bba4-1f659402117e

CloudStack Samples

CloudStack samples use the CloudStack namespace. These templates typically require the zone id, service offering id and template id as input parameters. These ids are passed directly to the stackmate command instead of being set in the local.yml file, see usage below.

Usage Example

  • Ensure you have a ssh keypair called 'Foo' (used in the template parameter below) for your account FIRST:
$ cloudmonkey
☁ Apache CloudStack 🐵 cloudmonkey 4.1.0-snapshot3. Type help or ? to list commands.

> create sshkeypair name='Foo'
  • Create a LAMP stack (AWS template)
bin/stackmate MYSTACK01   --template-file=templates/LAMP_Single_Instance.template -p "DBName=cloud;DBUserName=cloud;SSHLocation=75.75.75.0/24;DBUsername=cloud;DBPassword=cloud;DBRootPassword=cloud;KeyName=Foo"
  • Create a LAMP stack (CloudStack example)
bin/stackmate MYSTACK01 --template-file=templates/CloudStack/LAMP_Single_Instance_CloudStack.template -p "DBName=cloud;DBUserName=cloud;SSHLocation=0.0.0.0/24;DBUsername=cloud;DBPassword=cloud;DBRootPassword=cloud;KeyName=exoscale;zoneid=1128bd56-b4d9-4ac6-a7b9-c715b187ce11;templateid=35a37ccd-5bf6-4c5f-a9a1-1884f99e1fd3;serviceofferingid=b6cd1ff5-3a2f-4e9d-a4d1-8988c1191fe8"
  • If everything is successful, stackmate will hang after deploying the security groups and vms. You should see an output like this:
Your pre-signed URL is: http://localhost:4567/waitcondition/20130425-0706-kerujere-punopapa/WaitHandle
Try: curl -X PUT --data 'foo' http://localhost:4567/waitcondition/20130425-0706-kerujere-punopapa/WaitHandle

Executing the curl should unblock the wait handle. The idea of course is that the instance boots up, and reads its userdata and calls the same URL.

If you don't want the wait condition server to run, just use '-n'. Stackmate will not hang with this flag.

If you want to validate your template, you can use the --dry-run option. This will parse and validate the template and create an execution schedule.

CloudStack Metadata Support

The AWS CloudFormation (cfn) helper scripts (see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-helper-scripts-reference.html) have been ported to work in the CloudStack environment. In addition a Windows Service "the cloudworks agent" has been written to process <script> fragments passed in user-data so you can kick off the cfn scripts to process metadata from your templates and signal wait conditions back to Stackmate. The source for these can be downloaded from https://github.com/siwater/Cloudworks (there is a Visual Studio solution which will build a single MSI to install both the cloduworks agent and the cfn tools onto a Windows platform).

StackMate Appliance

If you don't fancy building Stackmate from source there is a pre-built Linux appliance (XVA format for XenServer) that you can download from https://citrix.sharefile.com/d/s18212b9c23945549 to get you started quickly. This contains pre-installed Stackmate and Stacktician, with a set of sample templates to get you started. Also contained in the distribution are the cloudworks MSI for installation on Windows images in CloudStack, and a document containing a step-by-step guide to using the appliance.

Extending StackMate to other APIs

StackMate allows you to define your own workflow participants that will be called based on the template namespace. For example, you can define a class Foo::Bar and use Foo::Bar as a "Type" in the template. The requirement is : (1) It should contain a class variable @@stackmate_participant set to true so as to register with StackMate (2) Foo::Bar should have Ruote::Participant as its ancestor (3) Foo::Bar should have a method named "consume_workitem" that defines actions to be taken when called with workitem.

Use --plugins to add plugins. This has undergone limited testing

TODO

  • Parallelize (with ruote concurrence) where possible
  • timeouts
  • embed in a web app ( Stacktician )

Feedback & bug reports

Feedback and bug reports are welcome on the mailing-list, or on the #cloudstack-dev IRC channel at Freenode.net.

License

(The MIT License)

Copyright (c) 2013 Citrix Systems

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

libraries used

Many thanks to the authors