You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by da...@apache.org on 2014/09/16 12:51:59 UTC
[10/15] Cleaning the README, INSTALL and CHANGES file
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/528ac4c6/INSTALL.md
----------------------------------------------------------------------
diff --git a/INSTALL.md b/INSTALL.md
index b92739a..74bac0c 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,94 +1,55 @@
-This document describes how to develop, build, package and install Apache
-CloudStack. For more information please refer to:
+# Apache CloudStack Installation basics
- http://cloudstack.apache.org
+This document describes how to develop, build, package and install Apache
+CloudStack. For more information please refer to the official [documentation](http://docs.cloudstack.apache.org)
+or the developer [wiki](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Home).
Apache CloudStack developers use various platforms for development, this guide
-was tested against a CentOS 6.2 x86_64 setup.
+was tested against a CentOS 6.5 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 Apache CloudStack.
- - [Building](https://cwiki.apache.org/confluence/display/CLOUDSTACK/How+to+build+CloudStack) Apache CloudStack.
+* [Setting up development environment](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Setting+up+CloudStack+Development+Environment) for Apache CloudStack.
+* [Building](https://cwiki.apache.org/confluence/display/CLOUDSTACK/How+to+build+CloudStack) Apache CloudStack.
## Setting up Development Environment
-### Installing Tools and Dependencies
-
Install tools and dependencies used for development:
$ yum install git ant ant-devel java-1.7.0-openjdk java-1.7.0-openjdk-devel
mysql mysql-server tomcat6 mkisofs gcc python MySQL-python openssh-clients wget
-Set up Maven (3.0.5):
-
- $ wget http://www.us.apache.org/dist/maven/maven-3/3.0.5/binaries/apache-maven-3.0.5-bin.tar.gz
- $ cd /usr/local/ # or any path
- $ tar -zxvf apache-maven-3.0.5-bin.tar.gz
- $ echo export M2_HOME=/usr/local/apache-maven-3.0.5 >> ~/.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 Apache CloudStack, please use Tomcat
-6.0.33 from http://archive.apache.org/dist/tomcat/tomcat-6/v6.0.33/bin
-
-### Configure Environment
+ #yum -y update
+ #yum -y install java-1.7.0-openjdk
+ #yum -y install java-1.7.0-openjdk-devel
+ #yum -y install mysql-server
+ #yum -y install git
+ #yum -y install genisoimage
-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
-
-Apache 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 Apache CloudStack and its entities:
-
- 8080: API Server (authenticated), browser or CLI client to management server
- 8096: API Server (unauthenticated), browser or CLI client to management server
- 8787: Remote java debug debugging port, from IDE to management server
- 9090: Management server to management server (cluster)
- 7080: AWS API Server to which an AWS client can connect
- 80/443: HTTP client to Secondary Storage VM (template download)
- 111/2049: Secondary Storage to NFS server
- 3922: Port used to ssh/scp into system vms (SSVM, CPVM, VR)
- 8250: Agent (SSVM, CPVM, VR) to management server
- 22, 80, 443: XenServer, XAPI
- 22: KVM
- 443: vCenter
- 53: DNS
- 111/2049: NFS
- 3306: MySQL Server to which the management server connects
+Set up Maven (3.0.5):
-### Configuring MySQL Server
+ #wget http://www.us.apache.org/dist/maven/maven-3/3.0.5/binaries/apache-maven-3.0.5-bin.tar.gz
+ #tar -zxvf apache-maven-3.0.5-bin.tar.gz -C /usr/local
+ #cd /usr/local
+ #ln -s apache-maven-3.0.5 maven
+ #echo export M2_HOME=/usr/local/maven >> ~/.bashrc # or .zshrc or .profile
+ #echo export PATH=/usr/local/maven/bin:${PATH} >> ~/.bashrc # or .zshrc or .profile
+ #source ~/.bashrc
Start the MySQL service:
$ service mysqld start
-### Getting the Source Code
+## Getting the Source Code
You may get the source code from the repository hosted on Apache:
- $ git clone git://git.apache.org/cloudstack.git
+ $ git clone https://git-wip-us.apache.org/repos/asf/cloudstack.git
-Or, you may fork a repository from the official Apache CloudStack mirror by
-Apache on [Github](https://github.com/apache/cloudstack)
+Or, you may fork the repository from the official Apache CloudStack mirror on [Github](https://github.com/apache/cloudstack)
-To keep yourself updated on a branch, do:
+To checkout a specific branch, for example 4.4, do:
- $ git pull <origin> <branch>
-
-For example, for master:
-
- $ git pull origin master
+ $ git fetch origin
+ $ git checkout -b 4.4 origin/4.4
## Building
@@ -96,23 +57,6 @@ Clean and build:
$ mvn clean install -P systemvm,developer
-CloudStack supports several plugins that depend on libraries with distribution restrictions.
-Because of this they are not included in the default build. Enable these additional plugins
-activate their respective profiles. For convenience adding -Dnoredist will enable all plugins
-that depend on libraries with distribution restrictions. The build procedure expects that the
-required libraries are present in the maven repository.
-
-The following procedure can be used to add the libraries to the local maven repository. Details
-on obtaining the required libraries can be found in this file. Note that this will vary between
-releases of cloudstack
-
- $ cd deps
- $ ./install-non-oss.sh
-
-To build all non redistributable components, add the noredist flag to the build command:
-
- $ mvn clean install -P systemvm,developer -Dnoredist
-
Clear old database (if any) and deploy the database schema:
$ mvn -P developer -pl developer -Ddeploydb
@@ -131,101 +75,74 @@ 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.
-If you want to contribute your changes, send your [git formatted patch](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Git) to:
-https://reviews.apache.org/groups/cloudstack or contact on the developer mailing list.
+## Building with non-redistributable plugins
-## Packaging and Installation
+CloudStack supports several plugins that depend on libraries with distribution restrictions.
+Because of this they are not included in the default build. Enable these additional plugins
+activate their respective profiles. For convenience adding -Dnoredist will enable all plugins
+that depend on libraries with distribution restrictions. The build procedure expects that the
+required libraries are present in the maven repository.
-Before packaging, please make sure you go through the "Building" section above.
-This section describes packaging and installation.
+The following procedure can be used to add the libraries to the local maven repository. Details
+on obtaining the required libraries can be found in this file. Note that this will vary between
+releases of CloudStack
-### Debian/Ubuntu
+ $ cd deps
+ $ ./install-non-oss.sh
-To create debs:
+To build all non redistributable components, add the noredist flag to the build command:
- $ mvn -P deps # -D noredist, for noredist as described in the "Building" section above
- $ dpkg-buildpackage
+ $ mvn clean install -P systemvm,developer -Dnoredist
-All the deb packages will be created in ../$PWD
+## Packaging and Installation
-To create an apt repo: (assuming appropriate user privileges)
+Before packaging, please make sure you go through the "Building" section above. This section describes packaging and installation.
- $ path=/path/to/your/webserver/cloudstack
- $ mv ../*.deb $path
- $ dpkg-scanpackages $path /dev/null | gzip -9c > $path/Packages.gz
+### Debian/Ubuntu
-Configure your system to use your new apt repo:
+To create debs install the following extra packages:
- $ echo "deb $path ./" >> /etc/apt/sources.list.d/cloudstack.list
+ #apt-get -y install python-mysqldb
+ #apt-get -y install debhelper
+ #apt-get -y install tomcat6
-Installation:
+Then:
-Install needed packages, apt-get upgrade for upgrading:
+ $ mvn -P deps # -D noredist, for noredist as described in the "Building" section above
+ $ dpkg-buildpackage -uc -us
- $ apt-get update
- $ apt-get install cloud-client # management server
- $ apt-get install mysql-server # mysql server
- $ apt-get install cloud-agent cloud-system-iso # agent (kvm)
- $ apt-get install cloud-awsapi # awsapi server
- $ apt-get install cloud-usage # usage server
+All the deb packages will be located one level down.
### RHEL/CentOS
-To create rpms:
-
- $ cd packaging/centos63
- $ bash packaging.sh [ -p NOREDIST ]
-
-All the rpm packages will be create in dist/rpmbuild/RPMS/x86_64
+To create rpms, install the following extra packages:
-To create a yum repo: (assuming appropriate user privileges)
+ #yum -y install rpm-build
+ #yum -y install tomcat6
+ #yum -y install ws-commons-util
+ #yum -y instal gcc
+ #yum -y install glibc-devel
+ #yum -y install MySQL-python
- $ path=/path/to/your/webserver/cloudstack
- $ cd dist/rpmbuild/RPMS/x86_64
- $ mv *.rpm $path
- $ createrepo $path
+Then:
-Configure your system to use your new yum repo, add the following to /etc/yum.repos.d/cloudstack.repo:
-
- [apache-cloudstack]
- name=Apache CloudStack
- baseurl=http://webserver.tld/path/to/repo
- enabled=1
- gpgcheck=0
-
-Installation:
-
-Install needed packages:
-
- $ yum update
- $ yum install cloudstack-management # management server
- $ yum install mysql-server # mysql server
- $ yum install cloudstack-agent # agent (kvm)
- $ yum install cloudstack-usage # usage server
-
-## Installing CloudMonkey CLI
-
-CloudMonkey is a CLI for Apache CloudStack. It was earlier in `tools/cli` within
-the source code but now it has its own repository:
+ $ cd packaging/centos63
+ $ package.sh
- https://git-wip-us.apache.org/repos/asf?p=cloudstack-cloudmonkey.git
+To create packages for noredist add the `-p noredist` option to the package script.
+All the rpm packages will be created in `dist/rpmbuild/RPMS/x86_64` directory.
## Notes
If you will be using Xen as your hypervisor, please download [vhd-util](http://download.cloud.com.s3.amazonaws.com/tools/vhd-util)
If management server is installed on RHEL/CentOS, then copy vhd-util into:
-/usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver/
+
+ /usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver/
If management server is installed on Ubuntu, then put vhd-util into:
-/usr/lib/cloud/common/scripts/vm/hypervisor/xenserver/vhd-util
-Once, you've successfully installed Apache CloudStack you may read the user manuals
-and guides which contains technical documentation for Apache CloudStack.
+ /usr/lib/cloud/common/scripts/vm/hypervisor/xenserver/vhd-util
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/528ac4c6/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index cce22ae..ac077f9 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# Apache CloudStack
+
+
Apache CloudStack is open source software designed to deploy and manage large
networks of virtual machines, as a highly available, highly scalable
Infrastructure as a Service (IaaS) cloud computing platform. CloudStack is used
@@ -13,36 +15,77 @@ Network-as-a-Service, user and account management, a full and open native API,
resource accounting, and a first-class User Interface (UI).
CloudStack currently supports the most popular hypervisors:
-VMware, KVM, XenServer, Xen Cloud Platform (XCP) and Hyper-V.
+VMware vSphere, KVM, XenServer, XenProject and Hyper-V as well as LXC containers.
Users can manage their cloud with an easy to use Web interface, command line
-tools, and/or a full-featured RESTful API. In addition, CloudStack provides an
-API that's compatible with AWS EC2 and S3 for organizations that wish to deploy
-hybrid clouds.
+tools, and/or a full-featured query based API.
-For more information on Apache CloudStack, please visit:
-http://cloudstack.apache.org
+For more information on Apache CloudStack, please visit the [website](http://cloudstack.apache.org)
## Who Uses CloudStack?
-There are more than 150 known organisations using Apache CloudStack (or a
-commercial distribution of CloudStack). Our users include many major service
-providers running CloudStack to offer public cloud services, product vendors who
-incorporate or integrate with Cloudstack in their own products, organisations
-who have used Cloudstack to build their own private clouds, and systems
-integrators that offer CloudStack related services.
+* There are more than 150 known organizations using Apache CloudStack (or a commercial distribution of CloudStack). Our users include many major service providers running CloudStack to offer public cloud services, product vendors who incorporate or integrate with CloudStack in their own products, organizations who have used CloudStack to build their own private clouds, and systems integrators that offer CloudStack related services.
+
+* See our [case studies](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Case+Studies) highlighting successful deployments of Apache CloudStack.
+
+* See the up-to-date list of current [users](http://cloudstack.apache.org/users.html).
+
+* If you are using CloudStack in your organization and your company is not listed above, please complete our brief adoption [survey](http://cloudstack.apache.org/survey.html). We're happy to keep your company name anonymous if you require.
+
+## Getting Started
+
+* Download a released [version](http://cloudstack.apache.org/downloads.html)
+* Build from source with the instructions in the [INSTALL.md](INSTALL.md) file.
+
+## Links
+
+* [Documentation](http://docs.cloudstack.apache.org)
+* Developer [wiki](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Home)
+* [Release notes](http://docs.cloudstack.apache.org/projects/cloudstack-release-notes)
+* Design [documents](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Design)
+* API [documentation](http://cloudstack.apache.org/docs/api)
+
+## Getting Involved and Contributing
+
+Interested in helping out with Apache CloudStack? Great! We welcome
+participation from anybody willing to work [The Apache Way](http://theapacheway.com) and make a
+contribution. Note that you do not have to be a developer in order to contribute
+to Apache CloudStack. We need folks to help with documentation, translation,
+promotion etc.See our contribution [page](http://cloudstack.apache.org/contribute.html).
+
+If you're interested in learning more or participating in the Apache CloudStack
+project, the mailing lists are the best way to do that. While the project has
+several communications channels, the [mailing lists](http://cloudstack.apache.org/mailing-lists.html) are the most active and the
+official channels for making decisions about the project itself.
+
+Mailing lists:
+- [Development Mailing List](mailto:dev-subscribe@cloudstack.apache.org)
+- [Users Mailing List](mailto:users-subscribe@cloudstack.apache.org)
+- [Commits Mailing List](mailto:commits-subscribe@cloudstack.apache.org)
+- [Issues Mailing List](mailto:issues-subscribe@cloudstack.apache.org)
+- [Marketing Mailing List](mailto:marketing-subscribe@cloudstack.apache.org)
+
+IRC, join us on irc.freenode.net on:
+- `#cloudstack`: General Apache CloudStack conversation and end user support
+- `#cloudstack-dev`: Development discussions
+
+Report and/or check bugs on [JIRA](https://issues.apache.org/jira/browse/CLOUDSTACK) and check our
+developer [page](http://cloudstack.apache.org/developers.html) for contributing code.
+
+## News and Events
-For case studies highlighting successful deployments of Apache CloudStack, please
-visit: https://cwiki.apache.org/confluence/display/CLOUDSTACK/Case+Studies
+* [Blog](https://blogs.apache.org/cloudstack)
+* [Twitter](https://twitter.com/cloudstack)
+* [Planet CloudStack](http://planet.apache.org/cloudstack)
+* [Events and meetup](http://lanyrd.com/topics/apache-cloudstack)
-For the up-to-date list of current users, please visit:
-http://cloudstack.apache.org/users.html
+## Reporting Security Vulnerabilities
-If you are using CloudStack in your organisation and your company isn't listed
-above, please complete our brief adoption survey. We're happy to keep your
-company name anonymous if you require.
+If you've found an issue that you believe is a security vulnerability in a
+released version of CloudStack, please report it to `security@cloudstack.apache.org` with details about the vulnerability, how it
+might be exploited, and any additional information that might be useful.
-CloudStack survey page: http://cloudstack.apache.org/survey.html
+For more details, please visit our security [page](http://cloudstack.apache.org/security.html)
## License
@@ -85,111 +128,9 @@ Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Sec
The following provides more details on the included cryptographic software:
- CloudStack makes use of JaSypt cryptographic libraries
-
- CloudStack has a system requirement of MySQL, and uses native database encryption
- functionality.
-
- CloudStack makes use of the Bouncy Castle general-purpose encryption library.
-
- CloudStack can optionally interacts with and controls OpenSwan-based VPNs.
-
- CloudStack has a dependency on Apache WSS4J as part of the AWSAPI implementation.
-
- CloudStack has a dependency on and makes use of JSch - a java SSH2 implementation.
-
-## Downloading
-
-You can download released versions from: http://cloudstack.apache.org/downloads.html
-
-## Building
-
-Please see the [INSTALL.md](INSTALL.md) file included in the root directory of the source tree.
-
-## Tooling
-
-Please see the [README.tools.md](README.tools.md) file included in the root directory of the source tree.
-
-## Documentation
-
-Project wiki:
-https://cwiki.apache.org/confluence/display/CLOUDSTACK/Home
-
-Getting started documentation:
-http://docs.cloudstack.apache.org/en/master
-
-Installation documentation:
-http://docs.cloudstack.apache.org/projects/cloudstack-installation
-
-Administration documentation:
-http://docs.cloudstack.apache.org/projects/cloudstack-administration
-
-Latest release notes:
-http://docs.cloudstack.apache.org/projects/cloudstack-release-notes
-
-Design documents:
-https://cwiki.apache.org/confluence/display/CLOUDSTACK/Design
-
-API documentation:
-http://cloudstack.apache.org/docs/api
-
-## Getting Involved and Contributing
-
-Interested in helping out with Apache CloudStack? Great! We welcome
-participation from anybody willing to work The Apache Way and make a
-contribution. Note that you do not have to be a developer in order to contribute
-to Apache CloudStack. We need folks to help with documentation, translation,
-promotion etc.
-
-If you're interested in learning more or participating in the Apache CloudStack
-project, the mailing lists are the best way to do that. While the project has
-several communications channels, the mailing lists are the most active and the
-official channels for making decisions about the project itself.
-
-Mailing lists:
-- [Development Mailing List](mailto:dev-subscribe@cloudstack.apache.org)
-- [Users Mailing List](mailto:users-subscribe@cloudstack.apache.org)
-- [Commits Mailing List](mailto:commits-subscribe@cloudstack.apache.org)
-- [Issues Mailing List](mailto:issues-subscribe@cloudstack.apache.org)
-- [Marketing Mailing List](mailto:marketing-subscribe@cloudstack.apache.org)
-
-For more details on mailing lists subscription and usage, please visit:
-http://cloudstack.apache.org/mailing-lists.html
-
-IRC, join us on irc.freenode.net on:
-- `#cloudstack`: General Apache CloudStack conversation and end user support
-- `#cloudstack-dev`: Development discussions
-- `#cloudstack-meeting`: Weekly and ad-hoc meeting room for the CloudStack community
-
-Bug reporting:
-https://issues.apache.org/jira/browse/CLOUDSTACK
-
-Developer resources:
-http://cloudstack.apache.org/developers.html
-
-Please see our contributing page for more details:
-http://cloudstack.apache.org/contribute.html
-
-## News and Events
-
-Blog:
-https://blogs.apache.org/cloudstack
-
-Twitter:
-https://twitter.com/cloudstack
-
-Planet CloudStack:
-http://planet.apache.org/cloudstack
-
-Events and meetup:
-http://lanyrd.com/topics/apache-cloudstack
-
-## Reporting Security Vulnerabilities
-
-If you've found an issue that you believe is a security vulnerability in a
-released version of CloudStack, please report it to
-`security@cloudstack.apache.org` with details about the vulnerability, how it
-might be exploited, and any additional information that might be useful.
-
-For more details, please visit: http://cloudstack.apache.org/security.html
-
+* CloudStack makes use of JaSypt cryptographic libraries
+* CloudStack has a system requirement of MySQL, and uses native database encryption functionality.
+* CloudStack makes use of the Bouncy Castle general-purpose encryption library.
+* CloudStack can optionally interacts with and controls OpenSwan-based VPNs.
+* CloudStack has a dependency on Apache WSS4J as part of the AWSAPI implementation.
+* CloudStack has a dependency on and makes use of JSch - a java SSH2 implementation.
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/528ac4c6/README.tools.md
----------------------------------------------------------------------
diff --git a/README.tools.md b/README.tools.md
deleted file mode 100644
index 069c342..0000000
--- a/README.tools.md
+++ /dev/null
@@ -1,260 +0,0 @@
-> Licensed to the Apache Software Foundation (ASF) under one
-> or more contributor license agreements. See the NOTICE file
-> distributed with this work for additional information
-> regarding copyright ownership. The ASF licenses this file
-> to you under the Apache License, Version 2.0 (the
-> "License"); you may not use this file except in compliance
-> with the License. You may obtain a copy of the License at
->
-> http://www.apache.org/licenses/LICENSE-2.0
->
-> Unless required by applicable law or agreed to in writing,
-> software distributed under the License is distributed on an
-> "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-> KIND, either express or implied. See the License for the
-> specific language governing permissions and limitations
-> under the License.
-
-
----------------------------------------------------------------------------
-This README describes the various tools available with Apache Cloudstack -
-for compiling, deploying, building and testing the project
----------------------------------------------------------------------------
-
-DevCloud
-=========================================================
-Under tools/devcloud
-
-NOTE - DevCloud (tools/devcloud) is a work in progress. The project has not
-determined how to best establish a nightly DevCloud build process, or how to
-distribute the image.
-
-#### Contents: ####
-
-Under tools/devcloud are various scripts used to build the devcloud image.
-devcloudsetup.sh - the origional devcloud build script (assumes an Ubuntu 12.04
-VM image)
-
- $ cd tools/devcloud
-
-* build_vagrant_basebox.sh - a script that uses VirtualBox, VeeWee, Vagrant
-(patched) and puppet to create a devcloud basebox
-* veewee - configuration files used to build a basic Ubuntu 12.04 vagrant box
-via VeeWee
-* basebuild - The Vagrantfile and puppet module that gets applied to the basic
-Ubuntu 12.04 box
-* devcloudbox - The Vagrantfile and puppet module that is used with the
-[hopefully] distributed devcloud base box
-
-#### Instructions: ####
-
-To build a "devcloud base box", run you need a system with VirtualBox and rvm
-installed (use ruby 1.9.2). Run build_vagrant_basebox.sh to build the base
-box.
-
-To use the "devcloud base box" that is created in the previous step, you need
-to have installed a forked version of Vagrant (until we make the changes
-plugins instead of direct source patches) that can be found here:
-
-Once installed per the Vagrant installation process, run:
-
- $ vagrant box add devcloud [path to devcloud.box]
-
-Then, either go into the devcloudbox folder of your checked out version of the
-CloudStack code (cloudstack/tools/devcloud/devcloudbox), or copy the
-contents of that folder to another location.
-
-Assuming the patched Vagrant installation is working, you then
-simply run "vagrant up" from within that directory.
-
-#### Installation ####
-
-Install DevCloud Base system:
-
-1. get code from https://github.com/jedi4ever/veewee, and install
-2. veewee vbox define devcloud ubuntu-12.04-server-i386
-3. put these two files(definition.rb and preseed.cfg) under ./definition/devcloud/
-3. veewee vbox build devcloud
-
-
-Marvin
-=========================================================
-Under tools/marvin
-
-Marvin is the functional testing framework for CloudStack written in python.
-Writing of unittests and functional tests with Marvin makes testing with
-cloudstack easier
-
-Visit the
-[wiki](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Testing+with+Python)
-for the most updated information
-
-#### Dependencies ####
-Marvin will require the following dependencies, these will be automatically
-downloaded from the python cheeseshop when you install Marvin.
-
-- mysql-connector-python,
-- paramiko,
-- nose,
-- unittest-xml-reporting,
-
-#### Installation ####
-
- $ untar Marvin-0.1.0.tar.gz
- $ cd Marvin-0.1.0
- $ python setup.py install
-
-#### Features ####
-
-1. very handy cloudstack API python wrapper
-2. support async job executing in parallel
-3. remote ssh login/execute command
-4. mysql query
-
-#### Examples ####
-
-Examples on how to develop your own configuration can be found in the marvin sandbox.
-Under tools/marvin/marvin/sandbox
-
-To generate the config for a deployment. Alter the .properties file in the sandbox. For example the
-simualtordemo.properties after modification can generate the config file as
-shown below
-
- $ python simulator_setup.py -i simulatordemo.properties -o simulatordemo.cfg
-
-To deploy the environment and run the tests
-
- $ python -m marvin.deployAndRun -c simulatordemo.cfg -t /tmp/t.log -r /tmp/r.log -d testcase
-
-#### Tests ####
-
-Functional Tests written using marvin can be found under test/integration
-folder. These are tests that are written to be run against a live deployed
-system.
-
-To run the tests - you should have marvin installed and correctly importable.
-The tests are long running and are best monitored by external hudson jobs.
-
-Also you will have to point marvin to the right configuration file that has
-details about your cloudstack deployment. For more help on how to write the
-config file and run tests check the tutorial at :
-
-[] (https://cwiki.apache.org/confluence/display/CLOUDSTACK/Testing+with+Python)
-
-#### Build Verification Testing (BVT) ####
-
-These test cases are the core functionality tests that ensure the application
-is stable and can be tested thoroughly. These BVT cases definitions are
-located at :
-[] (https://docs.google.com/a/cloud.com/spreadsheet/ccc?key=0Ak8acbfxQG8ndEppOGZSLV9mUF9idjVkTkZkajhTZkE&invite=CPij0K0L)
-
-##### Guidelines on tests #####
-
-BVT test cases are being developed using Python unittests2. Following are
-certain guidelines being followed
-
-1. Tests exercised for the same resource should ideally be present under a
-single suite or file.
-
-2. Time-consuming operations that create new cloud resources like server
-creation, volume creation etc should not necessarily be exercised per unit
-test. The resources can be shared by creating them at the class-level using
-setUpClass and shared across all instances during a single run.
-
-3. Certain tests pertaining to NAT, Firewall and Load Balancing warrant fresh
-resources per test. Hence a call should be taken by the stakeholders regarding
-sharing resources.
-
-4. Ensure that the tearDown/tearDownClass functions clean up all the resources
-created during the test run.
-
-For more information about unittests: [] (http://docs.python.org/library/unittest.html)
-
-##### BVT Tests #####
-Under test/integration/smoke
-
-The following files contain these BVT cases:
-
-1. test_vm_life_cycle.py - VM Life Cycle tests
-2. test_volumes.py - Volumes related tests
-3. test_snapshots.py - Snapshots related tests
-4. test_disk_offerings.py - Disk Offerings related tests
-5. test_service_offerings.py - Service Offerings related tests
-6. test_hosts.py - Hosts and Clusters related tests
-7. test_iso.py - ISO related tests
-8. test_network.py - Network related tests
-9. test_primary_storage.py - Primary storage related tests
-10. test_secondary_storage.py - Secondary storage related tests
-11. test_ssvm.py - SSVM & CPVM related tests
-12. test_templates.py - Templates related tests
-13. test_routers.py - Router related tests
-
-
-##### P1 Tests #####
-Under test/integration/component
-
-These test cases are the core functionality tests that ensure the application
-is stable and can be tested thoroughly. These P1 cases definitions are located
-at :
-[] (https://docs.google.com/a/clogeny.com/spreadsheet/ccc?key=0Aq5M2ldK6eyedDJBa0EzM0RPNmdVNVZOWnFnOVJJcHc&hl=en_US)
-
-The following files contain these P1 cases:
-
-1. test_snapshots.py - Snapshots related tests
-2. test_routers.py - Router related tests
-3. test_usage.py - Usage realted tests
-4. test_account.py - Account related tests
-5. test_resource_limits.py - Resource limits tests
-6. test_security_groups.py - Security groups related tests
-7. test_templates.py - templates related tests
-8. test_volumes.py - Volumes related tests
-9. test_blocker_bugs.py - Blocker bugs tests
-10. test_project_configs.py - Project global configuration related tests
-11. test_project_limits.py - Project resource limits related tests
-12. test_project_resources.py - Project resource creation related tests
-13. test_project_usage.py - Project usage related tests
-14. test_projects - Projects functionality tests
-
-Marvin Sandbox
-=========================================================
-In: tools/marvin/marvin/sandbox
-
-In here you should find a few common deployment models of CloudStack that you
-can configure with properties files to suit your own deployment. One deployment
-model for each of - advanced zone, basic zone and a simulator demo are given.
-
-$ ls -
-basic/
-advanced/
-simulator/
-
-Each property file is divided into logical sections and should be familiar to
-those who have deployed CloudStack before. Once you have your properties file
-you will have to create a JSON configuration of your deployment using the
-python script provided in the respective folder.
-
-The demo files are from the tutorial for testing with python that can be found at
- https://cwiki.apache.org/confluence/display/CLOUDSTACK/Testing+with+Python
-
-A common deployment model of a simulator.cfg that can be used for debugging is
-included. This will configure an advanced zone with simulators that can be used
-for debugging purposes when you do not have hardware to debug with.
-
-To do this:
-$ cd cloudstack-oss/
-$ ant run-simulator #This will start up the mgmt server with the simulator seeded
-
-## In another shell
-$ ant run-simulator
-
-test/conf - EC2 script
-=========================================================
-
-To run submitCertEC2 and deleteCertEC2 scripts, update parameters in conf/tool.properties file:
-
-* host - ip address of the host where cloud-bridge software is installed
-* port - port cloud-bridge software is listening to
-* accesspoint - access point for cloud-bridge REST request
-* version - Amazon EC2 api version supported by cloud-bridge
-* signaturemethod - HmacSHA1 or HmacSHA256
-* expires - the date when certificate expires
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/528ac4c6/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 4f00b35..c965436 100644
--- a/pom.xml
+++ b/pom.xml
@@ -702,7 +702,7 @@
<numUnapprovedLicenses>0</numUnapprovedLicenses>
<excludeSubProjects>false</excludeSubProjects>
<excludes>
- <exclude>CHANGES</exclude>
+ <exclude>CHANGES.md</exclude>
<exclude>README.md</exclude>
<exclude>INSTALL.md</exclude>
<exclude>.idea/</exclude>
@@ -819,6 +819,7 @@
<exclude>systemvm/patches/debian/config/var/www/html/latest/.htaccess</exclude>
<exclude>systemvm/patches/debian/vpn/etc/ipsec.d/l2tp.conf</exclude>
<exclude>tools/transifex/.tx/config</exclude>
+ <exclude>tools/logo/apache_cloudstack.png</exclude>
<exclude>tools/marvin/marvin/sandbox/advanced/sandbox.cfg</exclude>
<exclude>tools/ngui/static/bootstrap/*</exclude>
<exclude>tools/ngui/static/js/lib/*</exclude>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/528ac4c6/tools/logo/apache_cloudstack.png
----------------------------------------------------------------------
diff --git a/tools/logo/apache_cloudstack.png b/tools/logo/apache_cloudstack.png
new file mode 100644
index 0000000..d0fde45
Binary files /dev/null and b/tools/logo/apache_cloudstack.png differ