CLOUDSTACK-102: Update INSTALL.txt to recent changes Signed-off-by: Rohit Yadav <[email protected]>
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/55478248 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/55478248 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/55478248 Branch: refs/heads/master Commit: 55478248344ba502035e6287be72da2babd1f2ce Parents: 3187bc6 Author: Rohit Yadav <[email protected]> Authored: Wed Sep 26 20:54:58 2012 +0530 Committer: Alex Huang <[email protected]> Committed: Mon Oct 1 17:00:44 2012 -0700 ---------------------------------------------------------------------- INSTALL.md | 143 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ INSTALL.txt | 70 -------------------------- README.md | 2 +- 3 files changed, 144 insertions(+), 71 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/55478248/INSTALL.md ---------------------------------------------------------------------- diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..54d0251 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,143 @@ +This document describes how to set up and configure a single server CloudStack +development environment. If you aren't looking for a development environment, +the easiest way to deploy CloudStack is by using RPM or DEB packages from: + + - http://cloudstack.org/download.html + - http://jenkins.cloudstack.org (CI/Build server) + - http://cloudstack.apt-get.eu (Debian repository) + +CloudStack developers use various platforms for development, this guide will +focus on CentOS and was tested against a CentOS 6.2 x86_64 setup. + +Refer to the [wiki](http://cwiki.apache.org/confluence/display/CLOUDSTACK/Index) +for the latest information, especially: + + - [Setting up development environment](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Setting+up+CloudStack+Development+Environment) for CloudStack. + - [Building](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Building+with+Maven) CloudStack. + +## Setting up Development Environment + +### Installing Tools and Dependencies + +Install tools and dependencies used for development: + + $ yum install git ant ant-devel java-1.6.0-openjdk java-1.6.0-openjdk-devel + mysql mysql-server tomcat6 mkisofs gcc python MySQL-python openssh-clients wget + +Set up Maven (3.0.4): + + $ wget http://www.us.apache.org/dist/maven/maven-3/3.0.4/binaries/apache-maven-3.0.4-bin.tar.gz + $ cd /usr/local/ # or any path + $ tar -zxvf apache-maven-3.0.4-bin.tar.gz + $ echo export M2_HOME=/usr/local/apache-maven-3.0.4 >> ~/.bashrc # or .zshrc or .profile + $ echo export PATH=${M2_HOME}/bin:${PATH} >> ~/.bashrc # or .zshrc or .profile + +Note: Tomcat 6.0.35 has some known issue with CloudStack, please use Tomcat +6.0.33 from http://archive.apache.org/dist/tomcat/tomcat-6/v6.0.33/bin + +### Configure Environment + +Set CATALINA_HOME to path where you extract/install tomcat, put them in your +.bashrc or .zshrc or .profile: + + $ echo export CATALINA_HOME=/usr/share/tomcat6/ >> ~/.bashrc + +Fix permissions on CATALINA_HOME: + + $ chown -R <you>:<your-group> $CATALINA_HOME + +Generate you ssh keys, useful for ssh-ing to your hosts and vm etc.: + + $ ssh-keygen -t rsa -q + +CloudStack uses some ports, make sure at least those used by the management +server are available and not blocked by any local firewall. Following ports are +used by CloudStack and its entities: + +8787: CloudStack (Tomcat) debug socket +9090, 8250: CloudStack Management Server, User/Client API +8096: User/Client to CloudStack Management Server (unauthenticated) +3306: MySQL Server +3922, 8250, 80/443, 111/2049, 53: Secondary Storage VM +3922, 8250, 53: Console Proxy VM +3922, 8250, 53: Virtual Router +22, 80, 443: XenServer, XAPI +22: KVM +443: vCenter +DNS: 53 +NFS: 111/2049 + +### Configuring MySQL Server + +Start the MySQL service: + + $ service mysqld start + +### Getting the Source Code + +You may get the source code from the repository hosted on Apache: + + $ git clone https://git-wip-us.apache.org/repos/asf/incubator-cloudstack.git + +Or, you may fork a repository from the official Apache CloudStack mirror by +Apache on [Github](https://github.com/apache/incubator-cloudstack) + +To keep yourself updated on a branch, do: + + $ git pull <origin> <branch> + +For example, for master: + + $ git pull origin master + +## Building + +Populate the dependencies using Maven: + + $ mvn -P deps + +Clean previous build, if needed: + + $ mvn clean + $ ant clean-all + $ ant clean-tomcat + +Build all sub-modules: + + $ ant build-all + +Deploy the built project on tomcat: + + $ ant deploy-server + +Clear old database (if any) and deploy the database schema: + + $ ant deploydb + +Start the management server in debug mode: + + $ ant debug + +If this works, you've successfully setup a single server CloudStack installation. + +Open the following URL on your browser to access the Management Server UI: + + http://localhost:8080/client/ + +Or, + + http://management-server-ip-address:8080/client + +The default credentials are; user: admin, password: password and the domain +field should be left blank which is defaulted to the ROOT domain. + +## Packaging + +To create rpms: + + $ mvn -P deps && ./waf rpm + +To create debs: + + $ mvn -P deps && dpkg-buildpackage + http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/55478248/INSTALL.txt ---------------------------------------------------------------------- diff --git a/INSTALL.txt b/INSTALL.txt deleted file mode 100644 index 8740478..0000000 --- a/INSTALL.txt +++ /dev/null @@ -1,70 +0,0 @@ -This document describes how to set up and configure a single server CloudStack development environment. If you aren't looking for a development environment The easiest way is to deploy CloudStack from RPM package, building CloudStack from source is for developers. This guide is all about building CloudStack from the source and installing directly from there . This guide is suitable for you if you want to develop the CloudStack. - -I have tested this procedure on Fedora Core 14 - -Step 1: Install the tools and dependencies: -For fedora the package names are ant ant-devel, openjdk, openjdk-devel - -Tools: -yum install ant ant-devel openjdk openjdk-devel mysql mysql-server tomcat - -Dependencies: -yum install jakarta-commons-collections jakarta-commons-dbcp.noarch apache-commons-logging.noarch jakarta-commons-pool jakarta-commons-httpclient.noarch ws-commons-util.noarch glibc-devel gcc python MySQL-python openssh-clients - -Tomcat: -Download tomcat6.0.33 from http://archive.apache.org/dist/tomcat/tomcat-6/v6.0.33/bin/ instead of using distribution's default tomcat. Set CATALINA_HOME and CATALINA_BASE to path where you extract tomcat in environment variable, it would be better off setting them in .bashrc as it will take effect every time you log in. - -Note: Tomcat6.0.35 has some known issue with CloudStack, please avoid it - -SSHKEY: -Run: -sh-keygen -t rsa -q -to create sshkey for your account if you don't have one - -Step 2: Configuration - -Start the MySQL service : - -# service mysqld start - -Step 3: Get the source - -$ git clone https://github.com/CloudStack/CloudStack.git - -For subsequent pulls, do: -$ git pull - -Step 4: Building, testing, and deploying CloudStack using Ant : - -Ant is a Java-based build tool designed to be cross-platform, easy to use, extensible, and scalable. Ant is controlled by providing a text file that tells how to perform all the stages of building, testing, and deploying a project. These files are build files, and every project that uses Ant must have at least one named as build.xml. You can see build.xml in your CloudStack source. - -Type to build CloudStack : -$ ant clean-all build-all - -Type to deploy mgt server : -$ ant deploy-server - -Type to deploy database : -$ ant deploydb - -Type to run mgt server: -$ ant debug - -If all of the above process is successful. You are done the single server CloudStack installation.Now your CloudStack Management Server is running. - -Open your browser and type the bellow url in address bar: - -http://localhost:8080/client/ - -OR - -http://management-server-ip-address:8080/client - -You can see CloudStack Management Console page via a web browser. It will show you management consle login page. You can use the default username and password and leave domain as blank. - -The default credentials are âadminâ for user and âpasswordâ for password. The domain field should be left blank. A blank -domain field is defaulted to the ROOT domain. - -NOTE : This document is very basic CloudStack development installation. If you are very new to CloudStack and want to feel the power of CloudStack very quickly in RPM based distro, this document will guide very clear step to get it done. Since I am new to CloudStack, I doing this documentation by learning from community. I will keet update new information in this guide to make it more valuable resource. - - http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/55478248/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index a672397..c565de6 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Software License Version 2. To build the default build target, use maven3 and execute: -maven install +mvn install ## Including optional third party libraries in your build
