...

...

...

Apache CloudStack Wiki: Info on developing and contributing to Apache CloudStack

...

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 Environment

Building with Maven

Setting up a CloudStack development environment on Mac OSX

Setting up Cloudstack dev environment on Windows

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

DevCloud: Standalone development environment

CloudStack Packages and Dependencies

Debug Mode Management Server

Building

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

Grab the source code:
git clonehttps://git-wip-us.apache.org/repos/asf/incubator-cloudstack.gitgit pull -v # Have your master updated

To build CloudStack :
$ ant clean-all build-allType to deploy mgt server :
$ ant  deploy-serverType to deploy database :
$ ant deploydbType to run mgt server:
$ ant debugTo 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)

. If you see something wrong, edit it. If you have new information, please add it. Or to put it another way: edit boldly. It's a wiki - any changes can be reverted if necessary.

To get the CloudStack source, use:

git clone https://git-wip-us.apache.org/repos/asf/cloudstack.git

• 101 - Basics This is the intro page to developing for CloudStack.
• Coding Conventions Coding Styles for CloudStack.
• Contributing as a non-committer This page will explain how to get started on CloudStack development without direct commit access.
• Bylaws which govern how we work. 
• CloudStack Git Repo Web front-end for the CloudStack Git Repo.
• CloudStack Tutorials This section is dedicated to guides on configuring CloudStack within your environment.
• Design This section contains the design specs written for CloudStack
• Troubleshooting Troubleshooting techniques and solutions

Mailing Lists

We do most of our discussion and work on the Apache CloudStack mailing lists. Specifically, developer discussions happen on the cloudstack-dev mailing list. If you're looking for user support, the cloudstack-users list is the best place to go. (You may be tempted to send mails to both lists looking for help. Avoid that temptation. It's much better etiquette to direct emails to one list only, and to use the appropriate lists.) For guidelines on participating on the mailing list, see Mailing List Guidelines.

Please note that all of the lists are high-volume.

• To join the cloudstack-dev mailing list send an email to dev-subscribe@cloudstack.apache.org. The archives can be found on mail-archives.apache.org.
• To join the cloudstack-users mailing list send an email to users-subscribe@cloudstack.apache.org. The archives can be found on mail-archives.apache.org.
• To join the cloudstack-commits mailing list send an email to commits-subscribe@cloudstack.apache.org. The archives can be found on mail-archives.apache.org.
• 中文用户可以参加CloudStack的中文用户邮件列表。请寄封电邮给 users-cn-subscribe@cloudstack.apache.org.
• To join the cloudstack-marketing mailing list send an email to marketing-subscribe@cloudstack.apache.org. The archives can be found on mail-archives.apache.org.

Before posing questions to the mailing lists ensure that you have looked through the archives. A very searchable archive of all the cloudstack mailing lists is available at markmail

Marketing and Promoting CloudStack

Spread the word on how awesome CloudStack is. Below are the proposed open plans to gain visibility. By promoting CloudStack you can help to show the world that there is a "real", stable, user friendly, easy to use, feature-full production ready cloud platform.

• Plan of Actions
• Join Us
• User Blogs