You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ke...@apache.org on 2013/10/08 21:25:35 UTC
[33/51] [partial] Removing docs from master
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/gsoc-midsummer-shiva.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/gsoc-midsummer-shiva.xml b/docs/en-US/gsoc-midsummer-shiva.xml
deleted file mode 100644
index c26c5a8..0000000
--- a/docs/en-US/gsoc-midsummer-shiva.xml
+++ /dev/null
@@ -1,283 +0,0 @@
-<?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_GSoC_Guide.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="gsoc-midsummer-shiva">
- <title>Mid-Summer Progress Updates</title>
- <para>This section describes Mid-Summer Progress of Shiva Teja - "Create A New Modular UI for Apache CloudStack"</para>
- <section id="introduction-shiva">
- <title>Introduction</title>
- <para>
- The progress on my project has been very smooth so far and I got to learn a lot. I started with learning git and backbone.js and then went on to learn angular.js and evantually made a basic usable UI with angular.js. Sebastien has been guiding me and helping me throughout the period. Both CloudStack and Angular.js communities have been helpful along the way.
- </para>
- <para>I am happy with the progress so far and it is possible to reach the goals with a slightly faster pace.</para>
- </section>
- <section id="ui-progress">
- <title>Progress and Experience So Far</title>
- <para>
- I made a basic UI from which a user can list a bunch of collections, launch VMs(and similar actions), edit configurations, add accounts, search through some of the fields. I've also added a very basic notification service and work is in progress for making a dropdown notification similar to the current UI.
- </para>
- <para>
- I started by learning backbone.js and improving the prototype that I've made with my proposal. Then I looked into the current UI's code and tried to make plugins. There was a lot of repeated DOM manipulation and ajax calls throughout the UI.Then I almost took a week looking into angular.js and experimenting with it. I finally chose angular.js because it does lot more than backbone and lets you do the same stuff in lesser and more elegant code, thus, easily maintainable. It was obvious that most of repetitive DOM manipulation can be removed with angular's directives and AJAX calls with, obviously, models. This is one of important reasons I feel that CloudStack should move from just jQuery to an MVC like angular. Apart from code reusabilty for custom UIs, angular offers much lesser, more structured and elegant code. Rolling out new features becomes a much easier task. Implementing features like Quick View or UI tooltips that are present in the current UI is just a matter o
f implementing another directive.
- </para>
- <para>
- Learning the framework and developing the app while following best practices was not easy at the beginning. I had difficulties in deciding things like structure of the app. Looking into existing apps like <ulink url="https://github.com/angular-app/angular-app"><citetitle>angular-app</citetitle></ulink> and famous threads on the mailing list helped.
- </para>
- <para>
- Another slightly challenging task was to desing the angular.js models for cloudstack. Angular.js documentation say just use any Plain Old Javascript Objects. Given that statement, there are so many possible ways of doing it. So deciding the best one was frustrating at the beginning, but turned out to be simple. A rule of thumb that I think should be followed throughout the app is to return <ulink url="http://docs.angularjs.org/api/ng.$q"><citetitle>promises</citetitle></ulink> whenever possible. Promises remove unnecessary callbacks and offers a much more elegant structuring of code. All the models and collections in the current UI return promises which allows us to take actions after the specified actions on models and collections takes place.
- </para>
- <para>
- Making complex directives can also be frustrating at the beginning. Videos from <ulink url="http://egghead.io"><citetitle>egghead.io</citetitle></ulink> came handy for understanding directives in depth. I feel that these are the next most powerful things that angular offers after 'the ability to use POJOs for models'. All the DOM manipulations can be put into directives and can be reused easily.
- </para>
- </section>
- <section id="ui-screenshots">
- <title>Screenshots</title>
- <para>I'll try to explain the things that you can do with the UI developed so far with some screenshots and a bit of the code assosciated</para>
- <section id="instances-tab">
- <title>Instances tab</title>
- <itemizedlist>
- <listitem>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/instances-screen.png"/>
- </imageobject>
- <textobject>
- <phrase>instances-screen.png: Instances tab</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- <listitem>
- <para>Simple confirmation modal when you click start vm button</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/start-vm-screen.png"/>
- </imageobject>
- <textobject>
- <phrase>start-vm-screen.png: Start vm screen</phrase>
- </textobject>
- </mediaobject>
- <para>This is simple directive which launches such modal on click and can perform actions for 'yes' and 'no' clicks.(can be found at static/js/common/directives/confirm.js). In this case it'll call model.start() which will call the requester service to start the vm</para>
- </listitem>
- <listitem>
- <para>And the vm is running!</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/vm-running.png"/>
- </imageobject>
- <textobject>
- <phrase>vm-running.png: Running vm</phrase>
- </textobject>
- </mediaobject>
- <para>Labels automatically get updated by watching model changes</para>
- </listitem>
- <listitem>
- <para>Async calls</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/async-calls.png"/>
- </imageobject>
- <textobject>
- <phrase>async-calls.png: Example Async Calls</phrase>
- </textobject>
- </mediaobject>
- <para>Async calls are taken care by a service named requester which returns a promise. It resolves the promise when the query-async-job request returns with a result</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="modal-forms">
- <title>Example Modal Forms</title>
- <itemizedlist>
- <listitem>
- <para>The Modal Form for adding an account</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/add-account-screen.png"/>
- </imageobject>
- <textobject>
- <phrase>add-account-screen.png: Add Account</phrase>
- </textobject>
- </mediaobject>
- <para>modal-form is directive that I wrote which can used for modal forms across the UI. Example usage can be seen in accounts or volumes in static/js/app</para>
- </listitem>
- <listitem>
- <para>Create Account request sent on submitting that form</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/create-account-request.png"/>
- </imageobject>
- <textobject>
- <phrase>create-account-request.png: Create Account Request</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- </itemizedlist>
- </section>
- <section id="edit-configurations">
- <title>Edit Configurations</title>
- <itemizedlist>
- <listitem>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/configurations-screen.png"/>
- </imageobject>
- <textobject>
- <phrase>configurations-screen.png: Configuration Screen</phrase>
- </textobject>
- </mediaobject>
- <para>I've moved the description of the configurations from a column in the current UI to a tooltip. These tooltips appear when you hover over the configurations.</para>
- </listitem>
- <listitem>
- <para>An input text box like this appears when you click edit</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/edit-configuration.png"/>
- </imageobject>
- <textobject>
- <phrase>edit-configuration.png: Configurations edit screen</phrase>
- </textobject>
- </mediaobject>
- <para>This is handled by edit-in-place directive that I wrote</para>
- </listitem>
- <listitem>
- <para>This shows that the configuration has been updated and the basic notification service that pops up</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/configuration-edit-success.png"/>
- </imageobject>
- <textobject>
- <phrase>configuration-edit-success.png: Configurations edit success screen</phrase>
- </textobject>
- </mediaobject>
- <para>It is as simple as calling model.update when the save button is clicked. As it returns a promise, it can be used to call the notification service whenever there are model changes.</para>
- </listitem>
- </itemizedlist>
- <para>I tried my best to give an overview on code along with the screenshots. For more on the <ulink url="https://github.com/shivateja/cloudstack-ui/tree/angular-rawapi"><citetitle>code</citetitle></ulink>, I'd recommend going through it thoroughly, as I'd love to have someone look at my code point out mistakes at this early stage.</para>
- </section>
- </section>
- <section id="rest-api">
- <title>RESTful API</title>
- <para>I worked on the RESTful API for a while. I read a lot about REST but I could not get an elegant way of designing the API for the non RESTful verbs like start, stop etc. I have finished working the on the verbs that are RESTful(like list, update, delete..etc). The API can also handle sub-entities like listing virtual machines in a domain</para>
- <para>Here are some screenshots:</para>
- <itemizedlist>
- <listitem>
- <para>List all virtual machines. Anything similar should work</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/list-virtualmachines.png"/>
- </imageobject>
- <textobject>
- <phrase>list-virtualmachines.png: List All Virtual Machines</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- <listitem>
- <para>List the properties of a specific vm</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/list-specific-vm.png"/>
- </imageobject>
- <textobject>
- <phrase>list-specific-vm.png: List Properties of a specific vm</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- <listitem>
- <para>List virtual machines of a domain. Anything similar should work</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/list-domain-vms.png"/>
- </imageobject>
- <textobject>
- <phrase>list-domain-vms.png: List virtual machines of a domain</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- <listitem>
- <para>Create an account with a POST request. You can also do update, delete etc.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/create-account-post.png"/>
- </imageobject>
- <textobject>
- <phrase>create-account-post.png: Create Account with POST request</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- </itemizedlist>
- </section>
- <section id="misc-shiva">
- <title>Miscellaneous</title>
- <para>There are lot of other things that I've experimented with along the way which are not shown in screenshots. Although my initial timeline was designed keeping backbone.js in mind, I've been following a similar version of it till now. It has been a bit slow as I had to learn and implement at the same time. I've been rolling out things very fast for the past couple of weeks as I am good to go with most of the angular.js concepts. The project can be finished very easily if I continue the same pace. Here's a list of important things that will be implemented next, in the same order(I have already experimented with most of them.)</para>
- <itemizedlist>
- <listitem>
- <para>Authentication handling: This is a slightly tough task. I looked into existing apps and made a basic security service which can be used for this purpose.</para>
- </listitem>
- <listitem>
- <para>Infinite scroll directive: I am loading all the data at a time in the current UI. This does not work well with huge production clouds. Again, changes the structure of collections slightly, important thing to be taken care of before doing further development.</para>
- </listitem>
- <listitem>
- <para>A modal wizard directive required for adding instances.</para>
- </listitem>
- <listitem>
- <para>After finishing those three I'd be equipped with enough UI stuff that can let me concentrate on my models. I'll try to add as many functionalities to the models which can easily used throught this UI, and also reusable in custon UIs. After finishing these, I'll implement a better notification system.</para>
- </listitem>
- <listitem>
- <para>Tests: Although I should've done these parallelly while developing the UI, given the lack of experience, it took me some time to realize that tests are important. I have setup a test environment karma and I'll soon write tests for whatever I've written so far.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="experience-shiva">
- <title>Experience gained working on OSS and CloudStack</title>
- <para>Working on OSS has been very different and offered much more to learn what a university project could offer me. Asking and answering questions is one of the important thing that really helped me and I feel this was the important part of the development so far. Although I was a bit shy to ask questions at the beginning, I really loved the way angular.js community has helped even for silly questions. Soon, I realized the same happens on the CloudStack mailing list or any OSS mailing list for that matter. Solving others problems also helps a lot in building up knowledge. So, answering questions is also one of the important thing about working on Open Source Software. Being nice and polite on the public discussions like this improves personality. I am really glad to be a part of it now and very thankful to Google for such a wonderful program that introduces students to real-world software problems at very early stages of student's experience.</para>
- <para>I did not know much about CloudStack itself when I started working on the project. Following the discussions on mailing list, I googled for different terms used, watched a few videos on cloud and I'm really interested in learning more. I really hope to join the real CloudStack development soon.</para>
- </section>
- <section id="conclusion-shiva">
- <title>Conclusion</title>
- <para>You can find a demo of the UI <ulink url="http://students.iitmandi.ac.in:20000"><citetitle>here</citetitle></ulink> live in action.</para>
- <para>I am really happy with the progress and experience so far. The goals of the project look easily reachable with the experience I have now. I still have RESTful API to be handled at the end. So I'll have to finish most of the project by the end of the august. Each of the task in the next todo list I've mentioned above should not take much time if things go well and models required for the UI should be ready by august last week so that I can take care of any UI specific things and RESTful stuff.
- </para>
- <para>Here's small list of things that I've learned so far:</para>
- <itemizedlist>
- <listitem>
- <para>Git concepts, along with using JIRA and Review Board.</para>
- </listitem>
- <listitem>
- <para>Some advanced JS concepts and JS frameworks like jQuery, backbone.js, angular.js. Using Twitter Bootstrap for faster UI development.</para>
- </listitem>
- <listitem>
- <para>Basics of designing and structuring RESTful APIs</para>
- </listitem>
- <listitem>
- <para>Cloudmonkey's code and usage. I had to look into its code when I was designing the RESTful API.</para>
- </listitem>
- <listitem>
- <para>A bit more in depth understanding of Flask web framework</para>
- </listitem>
- <listitem>
- <para>Exposure to testing environment like karma and testing the UI in different browsers</para>
- </listitem>
- </itemizedlist>
- <para>Code written so far is available <ulink url="http://github.com/shivateja/cloudstack-ui/tree/angular-rawapi"><citetitle>here</citetitle></ulink> and <ulink url="http://github.com/shivateja/cloudstack-restful-api"><citetitle>here</citetitle></ulink></para>
- <para>I thank Google and CloudStack for giving me this oppurtunity, Sebastien and Kelcey for helping me along the way.</para>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/gsoc-midsummer.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/gsoc-midsummer.xml b/docs/en-US/gsoc-midsummer.xml
deleted file mode 100644
index 74ca62a..0000000
--- a/docs/en-US/gsoc-midsummer.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-<?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_GSoC_Guide.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="gsoc-midsummer">
- <title>Mid-Summer Progress Updates</title>
- <para>This chapter describes the progress of each &PRODUCT; Google Summer of Code project.</para>
-
- <xi:include href="gsoc-midsummer-dharmesh.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="gsoc-midsummer-ian.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="gsoc-midsummer-meng.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="gsoc-midsummer-nguyen.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="gsoc-midsummer-shiva.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/gsoc-proposals.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/gsoc-proposals.xml b/docs/en-US/gsoc-proposals.xml
deleted file mode 100644
index 7c4b50c..0000000
--- a/docs/en-US/gsoc-proposals.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-<?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_GSoC_Guide.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="gsoc-proposals">
- <title>Google Summer of Code Proposals</title>
- <para>This chapter contains the five proposals awarded to &PRODUCT; for the 2013 Google Summer of Code project.</para>
-
- <xi:include href="gsoc-dharmesh.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="gsoc-imduffy15.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="gsoc-meng.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="gsoc-tuna.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="gsoc-shiva.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/gsoc-shiva.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/gsoc-shiva.xml b/docs/en-US/gsoc-shiva.xml
deleted file mode 100644
index fe36d8e..0000000
--- a/docs/en-US/gsoc-shiva.xml
+++ /dev/null
@@ -1,70 +0,0 @@
-<?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_GSoC_Guide.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="gsoc-shiva">
- <title>Shiva Teja's 2013 GSoC Proposal</title>
- <para>This chapter describes Shiva Teja's 2013 Google Summer of Code project within the &PRODUCT; ASF project. It is a copy paste of the submitted proposal.</para>
- <section id="gsoc-abstract-shiva">
- <title>Abstract</title>
- <para>
- The aim of this project is to create a new modular UI for Apache CloudStack using Bootstrap by Twitter and Backbone.js. To achieve this easily, I'll be creating a RESTful wrapper API on top of the current CloudStack API. I hope this project will make custom UIs for CloudStack very easy.</para>
-
- <para>Why does CloudStack need a new UI?</para>
-
- <para>The current UI cannot be reused easliy to make a custom UI. The UI I will be making using backbone.js can be reused very easily to make custom UIs. The models, views, routers etc can remain the same in all the UIs. The user interface can be changed just by changing the templates. Check the implementation details below for further details.</para>
-
- <para>Why does it need a RESTful wrapper API ?</para>
-
- <para>Backbone.js heavily depends on RESTful architecture. Making a new UI with backbone.js using a query based API might not be easy.</para>
- </section>
- <section id="gsoc-deliverables-shiva">
- <title>List of deliverables</title>
- <orderedlist>
- <listitem><para>A new UI for CloudStack(with almost all features in the current UI and new ones, if any).</para></listitem>
- <listitem><para>A RESTful wrapper API on top of the CloudStack API</para></listitem>
- <listitem><para>Some documentation about using this UI to make a custom UI.</para></listitem>
- </orderedlist>
- </section>
- <section id="gsoc-approach-shiva">
- <title>Approach</title>
- <para>Wrapper API: Backbone.js, by default, uses four HTTP methods(GET, PUT, POST, DELETE) for communicating with the server. It uses GET to fetch a resource from the server, POST to create a resource, PUT to update the resource and DELETE to delete the resource. A query based API can probably be used to make the UI by overriding backbone's<ulink url="http://backbonejs.org/#Sync"><citetitle> default sync function</citetitle></ulink>. But it makes more sense to have an API which supports the above mentioned method and is resource based. This RESTful API works on top of the CloudStack API. The main task is to map the combinations of these HTTP methods and the resources to appropriate CloudStack API command. The other task is to decide on how the URLs should look like. Say for starting a virtual machine, for it to be RESTful, we have to use POST as we are creating a resource, or a PUT as we are changing the state of a virtual machine. So the possible options on the URL could be to do
a POST /runningvirtualmachines and respond with 201 Created code or a PUT on /virtualmachines/id and respond with 200 OK. If these are decided, the wrapper can be generated or be written manually, which can use defined patters to map to appropriate CloudStack API commands(Similar to what cloudmonkey does. See this <ulink url="https://github.com/shivateja/cloudstack-restful-api"><citetitle>prototype</citetitle></ulink>. I can use cloudmonkey's code to generate the required API entity verb relationships. Each verb will have a set of rules saying what method should be used in the RESTful API and how should it look like in the URL. Another possible way could be to group entities first manually and write the wrapper manually(something like zone/pods/cluster). Some possibilities have been discussed in <ulink url="http://mail-archives.apache.org/mod_mbox/cloudstack-dev/201304.mbox/%3CCAJrLSbaqa08uHw_xETt7Q59Nex%3DThQzvqEJyoXK8Q-OwN04Suw%40mail.gmail.com%3E"><citetitle>this thread</citetit
le></ulink>.</para>
-
- <para>UI: It will be a single page app. It'll use <ulink url="http://underscorejs.org/#template">client side templating</ulink> for rendering. This makes it very easy to make a custom UI because it can be achieved just by changing the templates. Backbone views will make use of these templates to render the appropriate models/collections. A completely new interface can be written just by changing the templates. Javascript code can completely remain the same. The views will take care of appropriate DOM events. Such event will correspond to appropriate model/collection chages, thus causing appropriate API calls.</para>
- </section>
- <section id="gsoc-schedule-shiva">
- <title>Approximate Schedle</title>
- <para>Till June 17 - Decide on how the RESTful API should look like and design algorithms to generate the wrapper.</para>
- <para>July 5(soft deadline), July 10(hard deadline) : Wrapper API will be ready.</para>
- <para>July 12(soft) - July 15(hard): Make basic wireframes and designs for the website and get them approved.</para>
- <para>July 29(mid term evaluation) : All the basic models, views, routes of the UI should be ready along with a few templates.</para>
- <para>August 15(hard deadline, shouldn't take much time actually) - A basic usable UI where users can just list all the entities which are present in the current UI's main navigation( Like Instances, Templates, Accounts etc)</para>
- <para>September 1(hard) - From this UI, users should be able to launch instances, edit settings of most of the entities.</para>
- <para>September 16(Pencil down!) - Fix some design tweaks and finish a completely usable interface with functions similar to current UI.</para>
- <para>September 23 - Finish the documentation on how to use this UI to make custom UIs.</para>
- </section>
- <section id="gsoc-aboutme-shiva">
- <title>About Me</title>
- <para> I am a 2nd year computer science undergrad studying at IIT Mandi, India. I've been using Python for an year and a half now. I've used Django, Flask and Tornado for my small projects. Along with Python, I use C++ for competitive programming. Recently, I fell in love with Haskell. I've always been fascinated about web technologies.</para>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/gsoc-tuna.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/gsoc-tuna.xml b/docs/en-US/gsoc-tuna.xml
deleted file mode 100644
index aa9726f..0000000
--- a/docs/en-US/gsoc-tuna.xml
+++ /dev/null
@@ -1,231 +0,0 @@
-<?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_GSoC_Guide.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="gsoc-tuna">
- <title>Nguyen's 2013 GSoC Proposal</title>
- <para>This chapter describes Nguyen 2013 Google Summer of Code project within the &PRODUCT; ASF project. It is a copy paste of the submitted proposal.</para>
- <section id="add-xen-xcp-support-for-gre-sdn-controller">
- <title>Add Xen/XCP support for GRE SDN controller</title>
- <para>
- "This project aims to enhance the current native SDN controller in supporting Xen/XCP and integrate successfully the open source SDN controller (FloodLight) driving Open vSwitch through its interfaces."
- </para>
- </section>
- <section id="Abstract">
- <title>Abstract</title>
- <para>
- SDN, standing for Software-Defined Networking, is an approach to building data network equipments and softwares. It were invented by ONRC, Stanford University. SDN basically decouples the control from physical networking boxes and given to a software application called a controller. SDN has three parts: controller, protocols and switch; In which, OpenFlow is an open standard to deploy innovative protocols. Nowaday, more and more datacenters use SDN instead of traditional physical networking boxes. For example, Google announced that they completely built its own switches and SDN confrollers for use in its internal backbone network.
- </para>
- <para>
- OpenvSwitch, an open source software switch, is widely used as a virtual switch in virtualized server environments. It can currently run on any Linux-based virtualization platform, such as: KVM, Xen (XenServer, XCP, Xen hypervisor), VirtualBox... It also has been ported to a number of different operating systems and hardware platforms: Linux, FreeBSD, Windows and even non-POSIX embedded systems. In cloud computing IaaS, using OpenvSwitch instead of Linux bridge on compute nodes becomes an inevitable trend because of its powerful features and the ability of OpenFlow integration as well.
- </para>
- <para>
- In CloudStack, we already have a native SDN controller. With KVM hypervisor, developers can easily install OpenvSwitch module; whereas, Xen even has a build-in one. The combination of SDN controller and OpenvSwitch gives us many advanced things. For example, creating GRE tunnels as an isolation method instead of VLAN is a good try. In this project, we are planning to support GRE tunnels in Xen/XCP hypervisor with the native SDN controller. When it's done, substituting open-sources SDN controllers (floodlight, beacon, pox, nox) for the current one is an amazing next step.
- </para>
- </section>
- <section id="design-desription">
- <title>Design description</title>
- <para>
- CloudStack currently has a native SDN Controller that is used to build meshes of GRE tunnels between Xen hosts. There consists of 4 parts: OVS tunnel manager, OVS Dao/VO, Command/Answer and Ovs tunnel plugin. The details are as follow:
- </para>
- <para>
- <emphasis role="bold">OVS tunnel manager:</emphasis> Consist of OvsElement and OvsTunnelManager.
- </para>
- <para>
- OvsElement is used for controlling Ovs tunnel lifecycle (prepare, release)
- </para>
- <itemizedlist>
- <listitem>
- <para>prepare(network, nic, vm, dest): create tunnel for vm on network to dest</para>
- </listitem>
- <listitem>
- <para>release(network, nic, vm): destroy tunnel for vm on network</para>
- </listitem>
- </itemizedlist>
- <para>
- OvsTunnelManager drives bridge configuration and tunnel creation via calling respective commands to Agent.
- </para>
- <itemizedlist>
- <listitem>
- <para>destroyTunnel(vm, network): call OvsDestroyTunnelCommand to destroy tunnel for vm on network</para>
- </listitem>
- <listitem>
- <para>createTunnel(vm, network, dest): call OvsCreateTunnelCommand to create tunnel for vm on network to dest</para>
- </listitem>
- </itemizedlist>
- <para>
- <emphasis role="bold">OVS tunnel plugin:</emphasis> These are ovstunnel and ovs-vif-flows.py script, writen as XAPI plugin. The OVS tunnel manager will call them via XML-RPC.
- </para>
- <para>
- Ovstunnel plugin calls corresponding vsctl commands for setting up the OVS bridge, creating GRE tunnels or destroying them.
- </para>
- <itemizedlist>
- <listitem>
- <para>setup_ovs_bridge()</para>
- </listitem>
- <listitem>
- <para>destroy_ovs_bridge()</para>
- </listitem>
- <listitem>
- <para>create_tunnel()</para>
- </listitem>
- <listitem>
- <para>destroy_tunnel()</para>
- </listitem>
- </itemizedlist>
- <para>
- Ovs-vif-flow.py clears or applies rule for VIFs every time it is plugged or unplugged from a OVS bridge.
- </para>
- <itemizedlist>
- <listitem>
- <para>clear_flow()</para>
- </listitem>
- <listitem>
- <para>apply_flow()</para>
- </listitem>
- </itemizedlist>
- <para>
- <emphasis role="bold">OVS command/answer:</emphasis> It is designed under the format of requests and answers between Manager and Plugin. These commands will correspondence exactly the mentioned manipulations.
- </para>
- <itemizedlist>
- <listitem>
- <para>OvsSetupBridgeCommand</para>
- </listitem>
- <listitem>
- <para>OvsSetupBridgeAnswer</para>
- </listitem>
- <listitem>
- <para>OvsDestroyBridgeCommand</para>
- </listitem>
- <listitem>
- <para>OvsDestroyBridgeAnswer</para>
- </listitem>
- <listitem>
- <para>OvsCreateTunnelCommand</para>
- </listitem>
- <listitem>
- <para>OvsCreateTunnelAnswer</para>
- </listitem>
- <listitem>
- <para>OvsDestroyTunnelCommand</para>
- </listitem>
- <listitem>
- <para>OvsDestroyTunnelAnswer</para>
- </listitem>
- <listitem>
- <para>OvsFetchInterfaceCommand</para>
- </listitem>
- <listitem>
- <para>OvsFetchInterfaceAnswer</para>
- </listitem>
- </itemizedlist>
- <para>
- <emphasis role="bold">OVS Dao/VO</emphasis>
- </para>
- <itemizedlist>
- <listitem>
- <para>OvsTunnelInterfaceDao</para>
- </listitem>
- <listitem>
- <para>OvsTunnelInterfaceVO</para>
- </listitem>
- <listitem>
- <para>OvsTunnelNetworkDao</para>
- </listitem>
- <listitem>
- <para>OvsTunnelNetworkVO</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="integrate-floodLight-as-sdn-controller">
- <title>Integrate FloodLight as SDN controller</title>
- <para>
- I think that we maybe deploy FloodLight Server as a new SystemVM. This VM acts like current SystemVMs. One Floodlight SystemVM per Zone, so it can manage for virtual switches under this zone.
- </para>
- </section>
- <section id="Deliverables">
- <title>Deliverables</title>
- <para>
- GRE has been used as isolation method in CloudStack when deploy with Xen/XCP hosts.
- </para>
- <itemizedlist>
- <listitem>
- <para>User set sdn.ovs.controller parameter in Global Setting to true. He deploys Advance Networking and chooses GRE as isolation method</para>
- </listitem>
- <listitem>
- <para>Make use of Floodlight instead of native SDN controller.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="About-me">
- <title>About me</title>
- <para>
- My name is Nguyen Anh Tu, a young and enthusiastic researcher in Cloud Computing Center - Viettel Research and Development Institute, Vietnam. Since last year, we has built Cloud Platform based on CloudStack, starting with version 3.0.2. As the results, some advanced modules were successfully developed, consists of:
- </para>
- <itemizedlist>
- <listitem>
- <para>Encrypt Data Volume for VMs.</para>
- </listitem>
- <listitem>
- <para>Dynamic Allocate Memory for VMs by changing policy on Squeeze Daemon.</para>
- </listitem>
- <listitem>
- <para>AutoScale without using NetScale.</para>
- </listitem>
- <listitem>
- <para>Deploy a new SystemVM type for Intrustion Detection System.</para>
- </listitem>
- </itemizedlist>
- <para>
- Given the working experience and recent researches, I have obtained remarkably the understanding of specific knowledges to carry on this project, details as follow:
- </para>
- <itemizedlist>
- <listitem>
- <para>Java source code on CloudStack: Design Pattern, Spring framework.</para>
- </listitem>
- <listitem>
- <para>Bash, Python programming.</para>
- </listitem>
- <listitem>
- <para>XAPI plugin.</para>
- </listitem>
- <listitem>
- <para>XML-RPC.</para>
- </listitem>
- <listitem>
- <para>OpenVSwitch on Xen.</para>
- </listitem>
- </itemizedlist>
- <para>
- Other knowledges:
- </para>
- <itemizedlist>
- <listitem>
- <para>XAPI RRD, XenStore.</para>
- </listitem>
- <listitem>
- <para>Ocaml Programming (XAPI functions).</para>
- </listitem>
- </itemizedlist>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/guest-ip-ranges.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/guest-ip-ranges.xml b/docs/en-US/guest-ip-ranges.xml
deleted file mode 100644
index c49dc6a..0000000
--- a/docs/en-US/guest-ip-ranges.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-<?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="guest-ip-ranges">
- <title>Guest IP Ranges</title>
- <para>The IP ranges for guest network traffic are set on a per-account basis by the user. This
- allows the users to configure their network in a fashion that will enable VPN linking between
- their guest network and their clients.</para>
- <para>In shared networks in Basic zone and Security Group-enabled Advanced networks, you will have
- the flexibility to add multiple guest IP ranges from different subnets. You can add or remove
- one IP range at a time. For more information, see <xref linkend="multiple-ip-range"/>.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/guest-network.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/guest-network.xml b/docs/en-US/guest-network.xml
deleted file mode 100644
index 692eb29..0000000
--- a/docs/en-US/guest-network.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?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="guest-network">
- <title>Guest Network</title>
- <para>In a &PRODUCT; cloud, guest VMs can communicate with each other using shared infrastructure with the security and user perception that the guests have a private LAN.</para>
- <para>The &PRODUCT; virtual router is the main component providing networking features for guest traffic.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/guest-nw-usage-with-traffic-sentinel.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/guest-nw-usage-with-traffic-sentinel.xml b/docs/en-US/guest-nw-usage-with-traffic-sentinel.xml
deleted file mode 100644
index d6fc10b..0000000
--- a/docs/en-US/guest-nw-usage-with-traffic-sentinel.xml
+++ /dev/null
@@ -1,72 +0,0 @@
-<?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="guest-nw-usage-with-traffic-sentinel">
- <title>Guest Network Usage Integration for Traffic Sentinel</title>
- <para>To collect usage data for a guest network, &PRODUCT; needs to pull the data from an external
- network statistics collector installed on the network. Metering statistics for guest networks
- are available through &PRODUCT;’s integration with inMon Traffic Sentinel.</para>
- <para>Traffic Sentinel is a network traffic usage data collection package. &PRODUCT; can feed
- statistics from Traffic Sentinel into its own usage records, providing a basis for billing users
- of cloud infrastructure. Traffic Sentinel uses the traffic monitoring protocol sFlow. Routers
- and switches generate sFlow records and provide them for collection by Traffic Sentinel, then
- &PRODUCT; queries the Traffic Sentinel database to obtain this information</para>
- <para>To construct the query, &PRODUCT; determines what guest IPs were in use during the current
- query interval. This includes both newly assigned IPs and IPs that were assigned in a previous
- time period and continued to be in use. &PRODUCT; queries Traffic Sentinel for network
- statistics that apply to these IPs during the time period they remained allocated in &PRODUCT;.
- The returned data is correlated with the customer account that owned each IP and the timestamps
- when IPs were assigned and released in order to create billable metering records in &PRODUCT;.
- When the Usage Server runs, it collects this data.</para>
- <para>To set up the integration between &PRODUCT; and Traffic Sentinel:</para>
- <orderedlist>
- <listitem>
- <para>On your network infrastructure, install Traffic Sentinel and configure it to gather
- traffic data. For installation and configuration steps, see inMon documentation at <ulink
- url="http://inmon.com.">Traffic Sentinel Documentation</ulink>.</para>
- </listitem>
- <listitem>
- <para>In the Traffic Sentinel UI, configure Traffic Sentinel to accept script querying from
- guest users. &PRODUCT; will be the guest user performing the remote queries to gather
- network usage for one or more IP addresses.</para>
- <para>Click File > Users > Access Control > Reports Query, then select Guest from the
- drop-down list.</para>
- </listitem>
- <listitem>
- <para>On &PRODUCT;, add the Traffic Sentinel host by calling the &PRODUCT; API command
- addTrafficMonitor. Pass in the URL of the Traffic Sentinel as protocol + host + port
- (optional); for example, http://10.147.28.100:8080. For the addTrafficMonitor command
- syntax, see the API Reference at <ulink
- url="http://cloudstack.apache.org/docs/api/index.html">API
- Documentation</ulink>.</para>
- <para>For information about how to call the &PRODUCT; API, see the Developer’s Guide at
- <ulink url="http://cloudstack.apache.org/docs/en-US/index.html">
- &PRODUCT; API Developer's Guide</ulink>.</para>
- </listitem>
- <listitem>
- <para>Log in to the &PRODUCT; UI as administrator.</para>
- </listitem>
- <listitem>
- <para>Select Configuration from the Global Settings page, and set the following:</para>
- <para>direct.network.stats.interval: How often you want &PRODUCT; to query Traffic
- Sentinel.</para>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/guest-traffic.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/guest-traffic.xml b/docs/en-US/guest-traffic.xml
deleted file mode 100644
index 943073e..0000000
--- a/docs/en-US/guest-traffic.xml
+++ /dev/null
@@ -1,43 +0,0 @@
-<?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="guest-traffic">
- <title>Guest Traffic</title>
- <para>A network can carry guest traffic only between VMs within one zone. Virtual machines in different zones cannot communicate with each other using their IP addresses; they must communicate with each other by routing through a public IP address.</para>
- <para>See a typical guest traffic setup given below:</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/guest-traffic-setup.png" />
- </imageobject>
- <textobject><phrase>guest-traffic-setup.png: Depicts a guest traffic setup</phrase></textobject>
- </mediaobject>
- <para>Typically, the Management Server automatically creates a virtual router for each network. A
- virtual router is a special virtual machine that runs on the hosts. Each virtual router in an
- isolated network has three network interfaces. If multiple public VLAN is used, the router will
- have multiple public interfaces. Its eth0 interface serves as the gateway for the guest traffic
- and has the IP address of 10.1.1.1. Its eth1 interface is used by the system to configure the
- virtual router. Its eth2 interface is assigned a public IP address for public traffic. If
- multiple public VLAN is used, the router will have multiple public interfaces.</para>
- <para>The virtual router provides DHCP and will automatically assign an IP address for each guest VM within the IP range assigned for the network. The user can manually reconfigure guest VMs to assume different IP addresses.</para>
- <para>Source NAT is automatically configured in the virtual router to forward outbound traffic for all guest VMs</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/ha-enabled-vm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/ha-enabled-vm.xml b/docs/en-US/ha-enabled-vm.xml
deleted file mode 100644
index 19666a4..0000000
--- a/docs/en-US/ha-enabled-vm.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?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="ha-enabled-vm">
- <title>HA-Enabled Virtual Machines</title>
- <para>The user can specify a virtual machine as HA-enabled. By default, all virtual router VMs and Elastic Load Balancing VMs are automatically configured as HA-enabled. When an HA-enabled VM crashes, &PRODUCT; detects the crash and restarts the VM automatically within the same Availability Zone. HA is never performed across different Availability Zones. &PRODUCT; has a conservative policy towards restarting VMs and ensures that there will never be two instances of the same VM running at the same time. The Management Server attempts to start the VM on another Host in the same cluster.</para>
- <para>HA features work with iSCSI or NFS primary storage. HA with local storage is not supported.</para>
- </section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/ha-for-hosts.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/ha-for-hosts.xml b/docs/en-US/ha-for-hosts.xml
deleted file mode 100644
index 15b5fa7..0000000
--- a/docs/en-US/ha-for-hosts.xml
+++ /dev/null
@@ -1,30 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter 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="ha-for-hosts">
- <title>HA for Hosts</title>
- <para>The user can specify a virtual machine as HA-enabled. By default, all virtual router VMs and Elastic Load Balancing VMs are automatically configured as HA-enabled. When an HA-enabled VM crashes, &PRODUCT; detects the crash and restarts the VM automatically within the same Availability Zone. HA is never performed across different Availability Zones. &PRODUCT; has a conservative policy towards restarting VMs and ensures that there will never be two instances of the same VM running at the same time. The Management Server attempts to start the VM on another Host in the same cluster.</para>
- <para>HA features work with iSCSI or NFS primary storage. HA with local storage is not supported.</para>
- <xi:include href="dedicated-ha-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/ha-management-server.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/ha-management-server.xml b/docs/en-US/ha-management-server.xml
deleted file mode 100644
index 1afebce..0000000
--- a/docs/en-US/ha-management-server.xml
+++ /dev/null
@@ -1,30 +0,0 @@
-<?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="ha-management-server">
- <title>HA for Management Server</title>
- <para>The &PRODUCT; Management Server should be deployed in a multi-node configuration such that it is not susceptible to individual server failures. The Management Server itself (as distinct from the MySQL database) is stateless and may be placed behind a load balancer.</para>
- <para>Normal operation of Hosts is not impacted by an outage of all Management Serves. All guest VMs will continue to work.</para>
- <para>When the Management Server is down, no new VMs can be created, and the end user and admin UI, API, dynamic load distribution, and HA will cease to work.</para>
- </section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/hardware-config-eg.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/hardware-config-eg.xml b/docs/en-US/hardware-config-eg.xml
deleted file mode 100644
index 3174bfa..0000000
--- a/docs/en-US/hardware-config-eg.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?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="hardware-config-eg">
- <title>Example Hardware Configuration</title>
- <para>This section contains an example configuration of specific switch models for zone-level
- layer-3 switching. It assumes VLAN management protocols, such as VTP or GVRP, have been
- disabled. The example scripts must be changed appropriately if you choose to use VTP or
- GVRP.</para>
- <xi:include href="dell62xx-hardware.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="cisco3750-hardware.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/hardware-firewall.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/hardware-firewall.xml b/docs/en-US/hardware-firewall.xml
deleted file mode 100644
index efab3c7..0000000
--- a/docs/en-US/hardware-firewall.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-<?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="hardware-firewall">
- <title>Hardware Firewall</title>
- <para>All deployments should have a firewall protecting the management server; see Generic
- Firewall Provisions. Optionally, some deployments may also have a Juniper SRX firewall that will
- be the default gateway for the guest networks; see <xref
- linkend="external-guest-firewall-integration"/>.</para>
- <xi:include href="generic-firewall-provisions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="external-guest-firewall-integration.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="vnmc-cisco.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="external-guest-lb-integration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/health-checks-for-lb-rules.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/health-checks-for-lb-rules.xml b/docs/en-US/health-checks-for-lb-rules.xml
deleted file mode 100644
index 4c7e091..0000000
--- a/docs/en-US/health-checks-for-lb-rules.xml
+++ /dev/null
@@ -1,51 +0,0 @@
-<?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="health-checks-for-lb-rules">
- <!-- CLOUDSTACK-443 -->
- <title>Health Checks for Load Balancer Rules</title>
- <para>(NetScaler load balancer only; requires NetScaler version 10.0)
- </para>
- <para>Health checks are used in load-balanced applications to ensure that requests are forwarded
- only to running, available services.
- When creating a load balancer rule, you can specify a health check policy.
- This is in addition to specifying the
- stickiness policy, algorithm, and other load balancer rule options.
- You can configure one health check policy per load balancer rule.</para>
- <para>Any load balancer rule defined on a NetScaler load balancer in &PRODUCT; can have a health check policy.
- The policy consists of a ping path, thresholds to define "healthy" and "unhealthy" states,
- health check frequency, and timeout wait interval.</para>
- <para>When a health check policy is in effect,
- the load balancer will stop forwarding requests to any resources that are found to be unhealthy.
- If the resource later becomes available again, the periodic health check
- will discover it, and the resource will once again be added to the pool of resources that can
- receive requests from the load balancer.
- At any given time, the most recent result of the health check is displayed in the UI.
- For any VM that is attached to a load balancer rule with a health check configured,
- the state will be shown as UP or DOWN in the UI depending on the result of the most recent health check.</para>
- <para>You can delete or modify existing health check policies.</para>
- <para>To configure how often the health check is performed by default, use the global
- configuration setting healthcheck.update.interval (default value is 600 seconds).
- You can override this value for an individual health check policy.</para>
- <para>For details on how to set a health check policy using the UI, see <xref linkend="add-load-balancer-rule"/>.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/host-add-vsphere.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/host-add-vsphere.xml b/docs/en-US/host-add-vsphere.xml
deleted file mode 100644
index b478464..0000000
--- a/docs/en-US/host-add-vsphere.xml
+++ /dev/null
@@ -1,28 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter 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="host-add-vsphere">
- <title>Adding a Host (vSphere)</title>
- <para>For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add Cluster: vSphere.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/host-add-xenserver-kvm-ovm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/host-add-xenserver-kvm-ovm.xml b/docs/en-US/host-add-xenserver-kvm-ovm.xml
deleted file mode 100644
index 91c36ab..0000000
--- a/docs/en-US/host-add-xenserver-kvm-ovm.xml
+++ /dev/null
@@ -1,157 +0,0 @@
-<?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="host-add-xenserver-kvm-ovm">
- <title>Adding a Host (XenServer or KVM)</title>
- <para>XenServer and KVM hosts can be added to a cluster at any time.</para>
- <section>
- <title>Requirements for XenServer and KVM Hosts</title>
- <warning>
- <para>Make sure the hypervisor host does not have any VMs already running before you add it to
- &PRODUCT;.</para>
- </warning>
- <para>Configuration requirements:</para>
- <itemizedlist>
- <listitem>
- <para>Each cluster must contain only hosts with the identical hypervisor. </para>
- </listitem>
- <listitem>
- <para>For XenServer, do not put more than 8 hosts in a cluster. </para>
- </listitem>
- <listitem>
- <para>For KVM, do not put more than 16 hosts in a cluster.</para>
- </listitem>
- </itemizedlist>
- <para>For hardware requirements, see the installation section for your hypervisor in the
- &PRODUCT; Installation Guide.</para>
- <section>
- <title>XenServer Host Additional Requirements</title>
- <para>If network bonding is in use, the administrator must cable the new host identically to
- other hosts in the cluster. </para>
- <para>For all additional hosts to be added to the cluster, run the following command. This
- will cause the host to join the master in a XenServer pool. </para>
- <programlisting># xe pool-join master-address=[master IP] master-username=root master-password=[your password]</programlisting>
- <note>
- <para>When copying and pasting a command, be sure the command has pasted as a single line
- before executing. Some document viewers may introduce unwanted line breaks in copied
- text.</para>
- </note>
- <para>With all hosts added to the XenServer pool, run the cloud-setup-bond script. This script
- will complete the configuration and setup of the bonds on the new hosts in the
- cluster.</para>
- <orderedlist>
- <listitem>
- <para>Copy the script from the Management Server in
- /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver/cloud-setup-bonding.sh to the
- master host and ensure it is executable.</para>
- </listitem>
- <listitem>
- <para>Run the script:</para>
- <programlisting># ./cloud-setup-bonding.sh</programlisting>
- </listitem>
- </orderedlist>
- </section>
- <section>
- <title>KVM Host Additional Requirements</title>
- <itemizedlist>
- <listitem>
- <para>If shared mountpoint storage is in use, the administrator should ensure that the new
- host has all the same mountpoints (with storage mounted) as the other hosts in the
- cluster.</para>
- </listitem>
- <listitem>
- <para>Make sure the new host has the same network configuration (guest, private, and
- public network) as other hosts in the cluster.</para>
- </listitem>
- <listitem>
- <para>If you are using OpenVswitch bridges edit the file agent.properties on the KVM host
- and set the parameter <emphasis role="italic">network.bridge.type</emphasis> to
- <emphasis role="italic">openvswitch</emphasis> before adding the host to &PRODUCT;</para>
- </listitem>
- </itemizedlist>
- </section>
- <!-- <section>
- <title>OVM Host Additional Requirements</title>
- <para>Before adding a used host in &PRODUCT;, as part of the cleanup procedure on the host, be
- sure to remove /etc/ovs-agent/db/.</para>
- </section> -->
- </section>
- <section>
- <title>Adding a XenServer or KVM Host</title>
- <orderedlist>
- <listitem>
- <para>If you have not already done so, install the hypervisor software on the host. You will
- need to know which version of the hypervisor software version is supported by &PRODUCT;
- and what additional configuration is required to ensure the host will work with &PRODUCT;.
- To find these installation details, see the appropriate section for your hypervisor in the
- &PRODUCT; Installation Guide.</para>
- </listitem>
- <listitem>
- <para>Log in to the &PRODUCT; UI as administrator.</para>
- </listitem>
- <listitem>
- <para>In the left navigation, choose Infrastructure. In Zones, click View More, then click
- the zone in which you want to add the host.</para>
- </listitem>
- <listitem>
- <para>Click the Compute tab. In the Clusters node, click View All.</para>
- </listitem>
- <listitem>
- <para>Click the cluster where you want to add the host.</para>
- </listitem>
- <listitem>
- <para>Click View Hosts.</para>
- </listitem>
- <listitem>
- <para>Click Add Host.</para>
- </listitem>
- <listitem>
- <para>Provide the following information.</para>
- <itemizedlist>
- <listitem>
- <para>Host Name. The DNS name or IP address of the host.</para>
- </listitem>
- <listitem>
- <para>Username. Usually root.</para>
- </listitem>
- <listitem>
- <para>Password. This is the password for the user from your XenServer or KVM
- install).</para>
- </listitem>
- <listitem>
- <para>Host Tags (Optional). Any labels that you use to categorize hosts for ease of
- maintenance. For example, you can set to the cloud's HA tag (set in the ha.tag global
- configuration parameter) if you want this host to be used only for VMs with the "high
- availability" feature enabled. For more information, see HA-Enabled Virtual Machines
- as well as HA for Hosts.</para>
- </listitem>
- </itemizedlist>
- <para>There may be a slight delay while the host is provisioned. It should automatically
- display in the UI. </para>
- </listitem>
- <listitem>
- <para>Repeat for additional hosts. </para>
- </listitem>
- </orderedlist>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/host-add.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/host-add.xml b/docs/en-US/host-add.xml
deleted file mode 100644
index 74509d6..0000000
--- a/docs/en-US/host-add.xml
+++ /dev/null
@@ -1,42 +0,0 @@
-<?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="host-add">
- <title>Adding a Host</title>
- <orderedlist>
- <listitem><para>Before adding a host to the &PRODUCT; configuration, you must first install your chosen hypervisor on the host. &PRODUCT; can manage hosts running VMs under a variety of hypervisors.</para>
- <para>The &PRODUCT; Installation Guide provides instructions on how to install each supported hypervisor
- and configure it for use with &PRODUCT;. See the appropriate section in the Installation Guide for information about which version of your chosen hypervisor is supported, as well as crucial additional steps to configure the hypervisor hosts for use with &PRODUCT;.</para>
- <warning><para>Be sure you have performed the additional &PRODUCT;-specific configuration steps described in the hypervisor installation section for your particular hypervisor.</para></warning>
- </listitem>
- <listitem><para>Now add the hypervisor host to &PRODUCT;. The technique to use varies depending on the hypervisor.</para>
- <itemizedlist>
- <listitem><para><xref linkend="host-add-xenserver-kvm-ovm" /></para></listitem>
- <listitem><para><xref linkend="host-add-vsphere" /></para></listitem>
- </itemizedlist>
- </listitem>
- </orderedlist>
- <xi:include href="host-add-xenserver-kvm-ovm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="host-add-vsphere.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</section>