CheatSheet for setting up CloudStack Dev environment on Windows
Step 1) Install Cygwin.
Cygwin will give you a unix like bash shell for your windows.
To install Cygwin, you download and run the setup.
- The install option will download, cache, and install the packages that you have selected.
- The selection of default packages to install is inadequate, because development and common editors are not included.
- Under 'Develop', select git for 'Install'. Or set the whole 'Develop' category to install. This takes more time, but it is simpler.\
- Under 'Editors', select vim or emacs depending on which you expect to be available from the Cygwin command line.
- Unfortunately, the download can be slow depending on the mirror you select (~30 min or more).
- Set unnecessary package categories to 'Uninstall', e.g. KDE and Games.\
- After completing the install, you can run it again. In that case, it will use the packages you last selected as the defaults.
NB: When you open a Cygwin shell, the Windows environment variables, including PATH, are imported into the shell environment. When we install the following items, we will update the Windows environment variables.
Step 2) Install the latest Eclipse
Eclipse is available from http://www.eclipse.org/downloads/
- Eclipse does not have an O/S-specific installer. Thus, the .zip you download does not include an .MSI file
- At the time of writing the latest version was Eclipse Juno (4.2)
- Place the unzipped download in the folder you want to run Eclipse from.
Step 2a) Add Plugins to Eclipse
CloudStack includes portions of Python code, which is best editted with the PyDev Eclipse plug-in
Install Python 2.7
Install PyDev using Eclipse
- Open Eclipse, if it is not already open.
- Navigate to tool bar menu Help --> Installing New Software...
- Using the Add... button, add the site http://pydev.org/updates
to the Work with dropdown list
- 'PyDev' should appear in the window below, select and proceed through the Wizard.
- Keep an eye on the install, you may be prompted to confirm that you trust the PyDev plug-in
The M2E plug-in allows Eclipse to import CloudStack's pom.xml Thus, pom.xml files become a substitute for the .project files that Eclipse normally uses.
Install M2E using Eclipse
- Open Eclipse, if it is not already open.
- Navigate to tool bar menu Help --> Installing New Software...
- Select --All Available Sites-- from the dropdown list.
- Wait for 'Pending...' to disappear from the box with the Name and Version colums
- Filter the results with the text 'm2e'
Add M2Eclipse
Step 3) Install Apache Tomcat 6.0.33
Apache Tomcat is the open source web server and servlet container that hosts CloudStack's management server.
- The web server portion is pure Java. In contrast, Apache web server is written in C
- The servlet container conforms Java Servlet and the JavaServer Pages (JSP) specifications.
You can download Tomcat from http://archive.apache.org/dist/tomcat/tomcat-6/v6.0.33/bin/apache-tomcat-6.0.33.exe
- Unlike Eclipse, the downloaded Tomcat is a self-installing executable.
- Leave the port at 8080 and the username/password empty
- Your JRE may be auto detected. If not, it will probably be a JDK or JRE under C:\Program Files\Java\
- Do not use default install folder. Folders under c:\Program Files are subject to special access control that creates problems later.
To inform the Cygwin environment of where Tomcat is, update your Windows environment variables.
- Define CATALINA_HOME as a Windows System environment variable, and give it the value of the install folder for Tomcat. E.g.
C:\Tomcat6.0
- Unlike JAVA, which an environment variable named after the product to locate its install directory (JAVA_HOME), Tomcat uses an environment variable named after the servlet container component (CATALINA_HOME)
- Add '%CATALINA_HOME%\bin' to the Windows System environment variable PATH
NB: Test your environment variables by opening a Cygwin shell and typing 'which Tomcat6'. This should return the path to the Tomcat executable.
Step 4) Install the JDK.
You can download the latest JDK from http://www.oracle.com/technetwork/java/javase/downloads/index.html.
- Pick the self-installing executable corresponding to your O/S type (32 or 64bits)
- Note where you're installing it. Set the Windows System variable JAVA_HOME to this path.
- I removed the user 'JAVA_HOME' variable to prevent the System variable from being overriden.
Step 5) Install MySQL for windows.
Download the self-installing exe from http://dev.mysql.com/downloads/mysql/5.0.html#downloads
- The most recent 5.1.x is recommended; however, developers are also using 5.5
- Check the box that asks whether you want to include mysql bin directory in the PATH. The option is a checkbox towards the end of the config wizard.
Download the self-installing exe for Python 2.7 from http://www.codegood.com/archives/129
Step 6) Install Apache Ant
Ant is available from http://ant.apache.org/bindownload.cgi
- Ant does not have an O/S-specific installer. Thus, the .zip you download does not include an .MSI file
- Place the unzipped download in the folder you want to run Ant from.
To inform the Cygwin environment of where Ant is, update your Windows environment variables.
- Define ANT_HOME as a Windows System environment variable, and give it the value of the install folder for Tomcat. E.g.
C:\Program Files\Apache Software Foundation\apache-ant-1.8.4
- Add '%ANT_HOME%\bin' to the Windows System environment variable PATH
NB: Test your environment variables by opening a Cygwin shell and typing 'which ant'. This should return the path to the ant executable.
Step 7) Install Apache Maven
Maven is available from http://maven.apache.org/download.html
- Version 3.x is preferred for CloudStack
- Maven does not have an O/S-specific installer. Thus, the .zip you download does not include an .MSI file
- Place the unzipped download in the folder you want to run Maven from.
To inform the Cygwin environment of where Maven is, update your Windows environment variables.
- Define MAVEN_HOME as a Windows System environment variable, and give it the value of the install folder for Tomcat. E.g.
C:\Program Files\Apache Software Foundation\apache-maven-3.0.4
- Add '%MAVEN_HOME%\bin' to the Windows System environment variable PATH
NB: Test your environment variables by opening a Cygwin shell and typing 'which mvn'. This should return the path to the maven executable.
Step 8) Download cloudstack-oss source
From a Cygwin window:
Step 9) Install "mkisofs"
Cygwin's mkisofs is really an alias, and this does not work with the build.
Instead, downloan the .exe from http://svnpenn.blogspot.com/2011/06/mkisofs-for-windows_24.html
- Place in a known folder
- Be sure to update the PATH environment variable to point to the folder with mkisofs
NB: Test your environment variables by opening a Cygwin shell and typing 'which mkisofs'. This should return the path to the mkisofs executable.
Password is assigned to DBROOTPW= in the build/replace.properties file.
E.g.
{{
$ cat build/override/replace.properties
DBUSER=cloud
DBPW=cloud
DBROOTPW=
MSLOG=vmops.log
APISERVERLOG=api.log
DBHOST=localhost
AGENTLOGDIR=logs
AGENTLOG=logs/agent.log
MSMNTDIR=/mnt
COMPONENTS-SPEC=components-premium.xml
}}
Step 11) Build
To pull in dependencies, go to the cloudstack source folder and run:
mvn -P deps
To compile Apache CloudStack, go to the cloudstack source folder and run:
ant clean-all build-all
To deploy Apache CloudStack, run:
ant deploy-server
Deploy the database next:
ant deploydb
Step 12) Verify
To start the server
ant debug
Next, open the mgmt server console using http://localhost:8080 and configure it as required.
Step 13) Parting words
When you make changes to the code, and want to restart the mgmt. server, you should not recreate the mysql database, because that would wipe out the setup. So you make your code changes, and then do –
ant clean-all build-all deploy-server
and debug
ant debug