You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by bh...@apache.org on 2012/12/24 01:57:38 UTC
[49/50] [abbrv] git commit: Change in Dev Guide to add Maven and
Tools Chapter
Change in Dev Guide to add Maven and Tools Chapter
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/6507055b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/6507055b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/6507055b
Branch: refs/heads/api_refactoring
Commit: 6507055ba1df63ef280200fda9e9f33563e3243e
Parents: be6acc7
Author: Sebastien Goasguen <ru...@gmail.com>
Authored: Sat Dec 15 23:27:32 2012 +0100
Committer: Joe Brockmeier <jz...@zonker.net>
Committed: Sat Dec 15 00:29:12 2012 -0600
----------------------------------------------------------------------
docs/en-US/API_Developers_Guide.ent | 21 --------
docs/en-US/API_Developers_Guide.xml | 56 --------------------
docs/en-US/Developers_Guide.ent | 21 ++++++++
docs/en-US/Developers_Guide.xml | 58 +++++++++++++++++++++
docs/en-US/building-devcloud.xml | 32 +++++++++++
docs/en-US/building-prerequisites.xml | 66 ++++++++++++++++++++++++
docs/en-US/building-with-maven-deploy.xml | 39 ++++++++++++++
docs/en-US/building-with-maven-steps.xml | 33 ++++++++++++
docs/en-US/building-with-maven.xml | 32 +++++++++++
docs/en-US/devcloud-usage-mode.xml | 60 +++++++++++++++++++++
docs/en-US/devcloud.xml | 38 ++++++++++++++
docs/en-US/developer-introduction.xml | 2 +-
docs/en-US/images/DevCloud-hostonly.png | Bin 0 -> 39311 bytes
docs/en-US/images/DevCloud.png | Bin 0 -> 33529 bytes
docs/en-US/marvin.xml | 32 +++++++++++
docs/en-US/source-build.xml | 49 +++++++++++++++++
docs/en-US/tools.xml | 29 ++++++++++
docs/publican-devguide.cfg | 2 +-
18 files changed, 491 insertions(+), 79 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/API_Developers_Guide.ent
----------------------------------------------------------------------
diff --git a/docs/en-US/API_Developers_Guide.ent b/docs/en-US/API_Developers_Guide.ent
deleted file mode 100644
index 47a2b67..0000000
--- a/docs/en-US/API_Developers_Guide.ent
+++ /dev/null
@@ -1,21 +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.
--->
-<!ENTITY PRODUCT "CloudStack">
-<!ENTITY BOOKID "Technical Documentation">
-<!ENTITY YEAR "2012">
-<!ENTITY HOLDER "Apache Software Foundation">
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/API_Developers_Guide.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/API_Developers_Guide.xml b/docs/en-US/API_Developers_Guide.xml
deleted file mode 100644
index c691ad0..0000000
--- a/docs/en-US/API_Developers_Guide.xml
+++ /dev/null
@@ -1,56 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- 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.
--->
-
-<book>
- <bookinfo id="cloudstack_developers">
- <title>&PRODUCT; API Developer's Guide</title>
- <productname>Apache CloudStack</productname>
- <productnumber>4.0.0-incubating</productnumber>
- <edition></edition>
- <pubsnumber></pubsnumber>
- <abstract>
- <para>
- How to integrate with &PRODUCT; using the &PRODUCT; API.
- </para>
- </abstract>
- <corpauthor>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
- </imageobject>
- </inlinemediaobject>
- </corpauthor>
- <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </bookinfo>
- <xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="api-calls.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</book>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/Developers_Guide.ent
----------------------------------------------------------------------
diff --git a/docs/en-US/Developers_Guide.ent b/docs/en-US/Developers_Guide.ent
new file mode 100644
index 0000000..47a2b67
--- /dev/null
+++ b/docs/en-US/Developers_Guide.ent
@@ -0,0 +1,21 @@
+<!-- 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.
+-->
+<!ENTITY PRODUCT "CloudStack">
+<!ENTITY BOOKID "Technical Documentation">
+<!ENTITY YEAR "2012">
+<!ENTITY HOLDER "Apache Software Foundation">
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/Developers_Guide.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/Developers_Guide.xml b/docs/en-US/Developers_Guide.xml
new file mode 100644
index 0000000..6c09354
--- /dev/null
+++ b/docs/en-US/Developers_Guide.xml
@@ -0,0 +1,58 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+<book>
+ <bookinfo id="cloudstack_developers">
+ <title>&PRODUCT; Developer's Guide</title>
+ <productname>Apache CloudStack</productname>
+ <productnumber>4.0.0-incubating</productnumber>
+ <edition></edition>
+ <pubsnumber></pubsnumber>
+ <abstract>
+ <para>
+ This guide shows how to develop &PRODUCT;, use the API for operation and integration, access the usage data and use &PRODUCT; specific tools to ease development, testing and integration.
+ </para>
+ </abstract>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+ <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </bookinfo>
+ <xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="building-with-maven.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="api-calls.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="tools.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</book>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/building-devcloud.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/building-devcloud.xml b/docs/en-US/building-devcloud.xml
new file mode 100644
index 0000000..5f792c3
--- /dev/null
+++ b/docs/en-US/building-devcloud.xml
@@ -0,0 +1,32 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+<section id="building-devcloud">
+ <title>Building DevCloud</title>
+ <para>The DevCloud appliance can be downloaded from the wiki at <ulink url="https://cwiki.apache.org/confluence/display/CLOUDSTACK/DevCloud"></ulink>. It can also be built from scratch. Code is being developed to provide this alternative build. It is based on <emphasis>veewee</emphasis>, <emphasis>Vagrant</emphasis> and <emphasis>Puppet</emphasis>.</para>
+ <para>The goal is to automate the DevCloud build and make this automation capability available to all within the source release of &PRODUCT;</para>
+ <warning><para>This is under heavy development. The code is located in the source tree under <emphasis>tools/devcloud</emphasis> </para>
+ <para>A preliminary wiki page describes the build at <ulink url="https://cwiki.apache.org/CLOUDSTACK/building-devcloud.html">https://cwiki.pache.org/CLOUDSTACK/building-devcloud.html</ulink></para>
+ </warning>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/building-prerequisites.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/building-prerequisites.xml b/docs/en-US/building-prerequisites.xml
new file mode 100644
index 0000000..d97ca40
--- /dev/null
+++ b/docs/en-US/building-prerequisites.xml
@@ -0,0 +1,66 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+
+<section id="build-prerequisites">
+ <title>Build Procedure Prerequisites</title>
+ <para>In this section we will assume that you are using the Ubuntu Linux distribution with the Advanced Packaging Tool (APT). If you are using a different distribution or OS and a different packaging tool, adapt the following instructions to your environment. To build &PRODUCT; you will need:</para>
+ <itemizedlist>
+ <listitem>
+ <para>git, <ulink url="http://git-scm.com">http://git-scm.com</ulink></para>
+ <para><programlisting>sudo apt-get install git-core</programlisting></para>
+ </listitem>
+ <listitem>
+ <para>maven, <ulink url="http://maven.apache.org">http://maven.apache.org</ulink></para>
+ <para><programlisting>sudo apt-get install maven</programlisting></para>
+ <para>Make sure that you installed maven 3</para>
+ <para><programlisting>$ mvn --version
+Apache Maven 3.0.4
+Maven home: /usr/share/maven
+Java version: 1.6.0_24, vendor: Sun Microsystems Inc.
+Java home: /usr/lib/jvm/java-6-openjdk-amd64/jre
+Default locale: en_US, platform encoding: UTF-8
+OS name: "linux", version: "3.2.0-33-generic", arch: "amd64", family: "unix"</programlisting></para>
+ </listitem>
+ <listitem>
+ <para>java</para>
+ <para>set the JAVA_HOME environment variable</para>
+ <para><programlisting>$ export JAVA_HOME=/usr/lib/jvm/java-6-openjdk</programlisting></para>
+ </listitem>
+ </itemizedlist>
+
+ <para>In addition, to deploy and run &PRODUCT; in a development environment you will need:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Mysql</para>
+ <para><programlisting>sudo apt-get install mysql-server-5.5</programlisting></para>
+ <para>Start the mysqld service and create a cloud user with cloud as a password</para>
+ </listitem>
+ <listitem>
+ <para>Tomcat 6</para>
+ <para><programlisting>sudo apt-get install tomcat6</programlisting></para>
+ </listitem>
+ </itemizedlist>
+
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/building-with-maven-deploy.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/building-with-maven-deploy.xml b/docs/en-US/building-with-maven-deploy.xml
new file mode 100644
index 0000000..e4b9801
--- /dev/null
+++ b/docs/en-US/building-with-maven-deploy.xml
@@ -0,0 +1,39 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+<section id="building-with-maven-deploy">
+ <title>Deployment and Testing Steps</title>
+ <para>Deploying the &PRODUCT; code that you compiled is a two step process:</para>
+ <orderedlist>
+ <listitem><para>If you have not configured the database or modified its properties do:</para>
+ <para><programlisting>mvn -P developer -pl developer -Ddeploydb</programlisting></para>
+ </listitem>
+ <listitem><para>Then you need to run the &PRODUCT; management server. To attach a debugger to it, do:</para>
+ <para><programlisting>export MAVEN_OPTS="-Xmx1024 -Xdebug -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n"</programlisting></para>
+ <para><programlisting>mvn -pl :cloud-client-ui jetty:run</programlisting></para>
+ </listitem>
+ </orderedlist>
+ <warning><para>When dealing with the database, remember that you may wipe it entirely and lose any data center configuration that you may have set previously.</para></warning>
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/building-with-maven-steps.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/building-with-maven-steps.xml b/docs/en-US/building-with-maven-steps.xml
new file mode 100644
index 0000000..319654f
--- /dev/null
+++ b/docs/en-US/building-with-maven-steps.xml
@@ -0,0 +1,33 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+<section id="building-with-maven-steps">
+ <title>Building Steps</title>
+ <para>&PRODUCT; uses git for source version control, first make sure you have the source code by pulling it:</para>
+ <programlisting>git clone https://git-wip-us.apache.org/repos/asf/incubator-cloudstack.git</programlisting>
+ <para>Several Project Object Models (POM) are defined to deal with the various build targets of &PRODUCT;. Certain features require some packages that are not compatible with the Apache license and therefore need to be downloaded on your own. Check the wiki for additional information <ulink url="https://cwiki.apache.org/CLOUDSTACK/building-with-maven.html">https://cwiki.apache.org/CLOUDSTACK/building-with-maven.html</ulink>. In order to build all the open source targets of &PRODUCT; do:</para>
+ <para><programlisting>mvn clean install</programlisting></para>
+ <para>The resulting jar files will be in the target directory of the subdirectory of the compiled module.</para>
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/building-with-maven.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/building-with-maven.xml b/docs/en-US/building-with-maven.xml
new file mode 100644
index 0000000..5363b1d
--- /dev/null
+++ b/docs/en-US/building-with-maven.xml
@@ -0,0 +1,32 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+<chapter id="building-with-maven">
+ <title>Using Maven to Build &PRODUCT;</title>
+ <xi:include href="source-build.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="building-prerequisites.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="building-with-maven-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="building-with-maven-deploy.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/devcloud-usage-mode.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/devcloud-usage-mode.xml b/docs/en-US/devcloud-usage-mode.xml
new file mode 100644
index 0000000..bb65f90
--- /dev/null
+++ b/docs/en-US/devcloud-usage-mode.xml
@@ -0,0 +1,60 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+<section id="devcloud-usage-mode">
+ <title>DevCloud Usage Mode</title>
+ <para>DevCloud can be used in several different ways:</para>
+ <orderedlist>
+ <listitem>
+ <para>Full sandbox. Where &PRODUCT; is run within the DevCloud instance started in Virtual Box.</para>
+ <para>In this mode, the &PRODUCT; management server runs within the instance and nested virtualization allows instantiation of tiny VMs within DevCloud itself. &PRODUCT; code modifications are done within DevCloud.</para>
+ <para>The following diagram shows the architecture of the SandBox mode.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/DevCloud.png" />
+ </imageobject>
+ <textobject>
+ <phrase>DevCloud.png: Schematic of the DevCloud SandBox architecture</phrase>
+ </textobject>
+ </mediaobject>
+ </listitem>
+ <listitem>
+ <para>A deployment environment. Where &PRODUCT; code is developed in the localhost of the developer and the resulting build is deployed within DevCloud</para>
+ <para>This mode was used in the testing procedure of &PRODUCT; 4.0.0 incubating release. See the following screencast to see how: <ulink url="http://vimeo.com/54621457">http://vimeo.com/54621457</ulink></para>
+ </listitem>
+ <listitem>
+ <para>A host-only mode. Where DevCloud is used only as a host. &PRODUCT; management server is run in the localhost of the developer</para>
+ <para>This mode makes use of a host-only interface defined in the Virtual Box preferences. Check the following screencast to see how: <ulink url="http://vimeo.com/54610161">http://vimeo.com/54610161</ulink></para>
+ <para>The following schematic shows the architecture of the Host-Only mode.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/DevCloud-hostonly.png" />
+ </imageobject>
+ <textobject>
+ <phrase>DevCloud-hostonly.png: Schematic of the DevCloud host-only architecture </phrase>
+ </textobject>
+ </mediaobject>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/devcloud.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/devcloud.xml b/docs/en-US/devcloud.xml
new file mode 100644
index 0000000..6778187
--- /dev/null
+++ b/docs/en-US/devcloud.xml
@@ -0,0 +1,38 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+<section id="devcloud">
+ <title>DevCloud</title>
+ <para>DevCloud is the &PRODUCT; sandbox. It is provided as a Virtual Box appliance. It is meant to be used as a development environment to easily test new &PRODUCT; development. It has also been used for training and &PRODUCT; demos since it provides a <emphasis>Cloud in a box</emphasis>.</para>
+ <note>
+ <para>DevCloud is provided as a convenience by community members. It is not an official &PRODUCT; release artifact.</para>
+ <para>The &PRODUCT; source code however, contains tools to build your own DevCloud.</para>
+ </note>
+ <warning>
+ <para>DevCloud is under development and should be considered a Work In Progress (WIP), the wiki is the most up to date documentation:</para>
+ <para><ulink url="https://cwiki.apache.org/confluence/display/CLOUDSTACK/DevCloud"></ulink></para>
+ </warning>
+ <xi:include href="devcloud-usage-mode.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="building-devcloud.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/developer-introduction.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/developer-introduction.xml b/docs/en-US/developer-introduction.xml
index bb5251b..9d54f31 100644
--- a/docs/en-US/developer-introduction.xml
+++ b/docs/en-US/developer-introduction.xml
@@ -23,7 +23,7 @@
-->
<chapter id="developer-introduction">
- <title>Introduction for Developers</title>
+ <title>Introduction to the &PRODUCT; API</title>
<xi:include href="roles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="api-reference.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="developer-getting-started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/images/DevCloud-hostonly.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/DevCloud-hostonly.png b/docs/en-US/images/DevCloud-hostonly.png
new file mode 100644
index 0000000..111f93a
Binary files /dev/null and b/docs/en-US/images/DevCloud-hostonly.png differ
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/images/DevCloud.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/DevCloud.png b/docs/en-US/images/DevCloud.png
new file mode 100644
index 0000000..5e83ca9
Binary files /dev/null and b/docs/en-US/images/DevCloud.png differ
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/marvin.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/marvin.xml b/docs/en-US/marvin.xml
new file mode 100644
index 0000000..062616a
--- /dev/null
+++ b/docs/en-US/marvin.xml
@@ -0,0 +1,32 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+<section id="marvin">
+ <title>Marvin</title>
+ <para>Marvin is the &PRODUCT; automation framework. It originated as a tool for integration testing but is now also used to build DevCloud as well as to provide a Python &PRODUCT; API binding.</para>
+ <note>
+ <para>Marvin's complete documenation is on the wiki at <ulink url="https://cwiki.apache.org/CLOUDSTACK/testing-with-python.html">https://cwiki.apache.org/CLOUDSTACK/testing-with-python.html</ulink></para>
+ <para>The source code is located at <emphasis>tools/marvin</emphasis></para>
+ </note>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/source-build.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/source-build.xml b/docs/en-US/source-build.xml
new file mode 100644
index 0000000..3321896
--- /dev/null
+++ b/docs/en-US/source-build.xml
@@ -0,0 +1,49 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+<section id="source-build">
+ <title>Building &PRODUCT; from Source</title>
+ <note>
+ <para>Prior to the 4.0.0 incubating release, Ant was used to build &PRODUCT;. Starting with 4.0.0 a migration to Maven is underway.</para>
+ <para>The website and the wiki contain up to date information on the build procedure at:</para>
+ <itemizedlist>
+ <listitem><para><ulink url="https://cwiki.apache.org/CLOUDSTACK/building-with-maven.html">https://cwiki.apache.org/CLOUDSTACK/building-with-maven.html</ulink></para></listitem>
+ <listitem><para><ulink url="http://incubator.apache.org/cloudstack/develop/environment.html">http://incubator.apache.org/cloudstack/develop/environment.html</ulink></para></listitem>
+ </itemizedlist>
+ </note>
+ <para>The overarching steps to build &PRODUCT; are:.</para>
+ <itemizedlist>
+ <listitem><para>Install the prerequisites and setup your environment</para></listitem>
+ <listitem><para>Understand that various Maven profiles and build targets</para></listitem>
+ <listitem><para>Deploy and test your build </para></listitem>
+ <listitem><para>If needed, learn how to build binaries</para></listitem>
+ </itemizedlist>
+
+ <note>
+ <para>Learning Maven is outside the scope of this documentation.</para>
+ <para>Go to the Maven website at <ulink url="http://maven.apache.org/guides/getting-started/index.html">http://maven.apache.org/guides/getting-started/index.html</ulink></para>
+ </note>
+
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/en-US/tools.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/tools.xml b/docs/en-US/tools.xml
new file mode 100644
index 0000000..66fe894
--- /dev/null
+++ b/docs/en-US/tools.xml
@@ -0,0 +1,29 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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.
+-->
+
+<chapter id="tools">
+ <title>Tools</title>
+ <xi:include href="devcloud.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="marvin.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/6507055b/docs/publican-devguide.cfg
----------------------------------------------------------------------
diff --git a/docs/publican-devguide.cfg b/docs/publican-devguide.cfg
index 006c0d1..a8e28ae 100644
--- a/docs/publican-devguide.cfg
+++ b/docs/publican-devguide.cfg
@@ -20,7 +20,7 @@
xml_lang: en-US
type: Book
-docname: API_Developers_Guide
+docname: Developers_Guide
brand: cloudstack
chunk_first: 1
chunk_section_depth: 1