Apache CloudStack: How to Contribute

This is the home of the Apache Cloudstack (incubating) space. Feel free to edit this page.

TODO: Fix link urls/migrated from wiki.cloudstack.org

IRC

http://www.cloudstack.org/irc.html

CloudStack community managers: David Nalley (ke4qqq), Mark Hinkle (mrhinkle)

#cloudstack on irc.freenode.net

Clients: Freenode Webchat, screen+irssi, XChat, Adium

Weekly development meetings happen in #cloudstack-meeting, logs and minutes are available here

Mailing Lists

http://www.cloudstack.org/mailing-lists.html

To subscribe, send an empty email to ML with '-subscribe' before @incubator.apache.org

Development: cloudstack-dev@inbubator.apache.org (Archives here: http://mail-archives.apache.org/mod_mbox/incubator-cloudstack-dev/)

Commits: cloudstack-commits@incubator.apache.org (Archives here: http://mail-archives.apache.org/mod_mbox/incubator-cloudstack-commits/)

Users: cloudstack-users@incubator.apache.org (Archives here: http://mail-archives.apache.org/mod_mbox/incubator-cloudstack-users/)

Discuss

http://www.cloudstack.org/discuss/

http://www.cloudstack.org/forum

Development

Getting Started

Apache Cloud Stack Run Book

Apache CloudStack Docs

101 - Basics

Cloud Computing Glossary

Videos

CloudStack YouTube Channel

Citrix TV Cloudstack Videos

Vimeo Xen Channel

Videos by Xen.org Community Manager

Releases

4.0

Wiki

Apache CloudStack Wiki

http://wiki.cloudstack.org (old)

Community Development

CloudStack Roadmap

Documentation Plans

Coding Conventions

Git: Working with CloudStack code

Git Good Practices for commiters and contributors

Git Workflow

Patch submission: Review Board (if your review gets shipped, remember to close the review)

How To Work With CloudStack Documentation

The link below gives a good overview of git jargon and its usage.

Distributed Development suggestion: http://nvie.com/posts/a-successful-git-branching-model/

CloudStack's Future Architecture

CloudStack Maintainers Guide

Design Documentation

Design Document Template

Design Documents

Development

Setting up a CloudStack dev environment on Windows

Setting up a CloudStack development environment on Mac OS X

Setting up on Linux: Refer to INSTALL.txt in the root directory of the source code

Building with Maven

DevCloud: Standalone development environment

CloudStack Packages and Dependencies

Debug Mode Management Server

Building

Get dependencies: Java, Maven 3.0+, Ant, Tomcat (use 6.0.33, problems with latest version), MySQL, gcc, python, git

Grab the source code:

$ git clone https://git-wip-us.apache.org/repos/asf/incubator-cloudstack.git
$ git pull -v # Have your master updated

To build CloudStack, checkout: Building with Maven

$ mvn -P deps
$ ant clean-all build-all
$ ant deploy-server
$ ant deploydb
$ ant debug

To access your CloudStack Management Server, open in your browser: (localhost or IP/domain-name of your management server)
http://localhost:8080/client/

Testing

Marvin - Python CloudStack API testclient

How to write JUnit tests?

$ ant run-simulator (setup and run the cloudstack management server using a simulated hypervisor)

$ ant run-marvin -Dmarvin.config=<json.deployment.config> (deploy and configure the above server with the config specified)

ASF CS 4.0 Release - Test Plan for 4.0 release

Troubleshooting

SSVM troubleshooting / template download issues.

Tips

Supported Hypervisors

Xen (various versions)

KVM

VMWare

Bare-metal

Oracle VM (OVM)

Hyper-V?