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:24 UTC
[22/51] [partial] Removing docs from master
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/third-party-ui-plugin.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/third-party-ui-plugin.xml b/docs/en-US/third-party-ui-plugin.xml
deleted file mode 100644
index 297fdaa..0000000
--- a/docs/en-US/third-party-ui-plugin.xml
+++ /dev/null
@@ -1,364 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/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="third-party-ui-plugin">
- <!-- CLOUDSTACK-883 -->
- <title>Third-Party UI Plugin Framework</title>
- <para>Using the new third-party plugin framework, you can write and install extensions to
- &PRODUCT;. The installed and enabled plugins will appear in the UI alongside the
- other features.
- The code for the plugin is simply placed in a special directory
- within &PRODUCT;’s installed code at any time after &PRODUCT; installation. The new plugin
- appears only when it is enabled by the cloud administrator.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/plugin_intro.jpg"/>
- </imageobject>
- <textobject>
- <phrase>plugin_intro.jpg: New plugin button in product navbar</phrase>
- </textobject>
- </mediaobject>
- <para>The left navigation bar of the &PRODUCT; UI has a new Plugins button to help you work with UI plugins.</para>
- <section id="plugin-howto-overview">
- <title>How to Write a Plugin: Overview</title>
- <para>The basic procedure for writing a plugin is:</para>
- <orderedlist>
- <listitem>
- <para>Write the code and create the other files needed. You will need the plugin code
- itself (in Javascript), a thumbnail image, the plugin listing, and a CSS file.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/plugin1.jpg"/>
- </imageobject>
- <textobject>
- <phrase>plugin1.jpg: Write the plugin code</phrase>
- </textobject>
- </mediaobject>
- <para>All UI plugins have the following set of files:</para>
- <programlisting>+-- cloudstack/
- +-- ui/
- +-- plugins/
- +-- csMyFirstPlugin/
- +-- config.js --> Plugin metadata (title, author, vendor URL, etc.)
- +-- icon.png --> Icon, shown on side nav bar and plugin listing
- (should be square, and ~50x50px)
- +-- csMyFirstPlugin.css --> CSS file, loaded automatically when plugin loads
- +-- csMyFirstPlugin.js --> Main JS file, containing plugin code
- </programlisting>
- <para>The same files must also be present at /tomcat/webapps/client/plugins.</para>
- </listitem>
- <listitem>
- <para>The &PRODUCT; administrator adds the folder containing your plugin code under the
- &PRODUCT; PLUGINS folder.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/plugin2.jpg"/>
- </imageobject>
- <textobject>
- <phrase>plugin2.jpg: The plugin code is placed in the PLUGINS folder</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- <listitem>
- <para>The administrator also adds the name of your plugin to the plugin.js file in the
- PLUGINS folder.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/plugin3.jpg"/>
- </imageobject>
- <textobject>
- <phrase>plugin3.jpg: The plugin name is added to plugin.js in the PLUGINS
- folder</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- <listitem>
- <para>The next time the user refreshes the UI in the browser, your plugin will appear in
- the left navigation bar.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/plugin4.jpg"/>
- </imageobject>
- <textobject>
- <phrase>plugin4.jpg: The plugin appears in the UI</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- </orderedlist>
- </section>
- <section id="plugin-howto-details">
- <title>How to Write a Plugin: Implementation Details</title>
- <para>This section requires an understanding of JavaScript and the &PRODUCT; API. You don't
- need knowledge of specific frameworks for this tutorial (jQuery, etc.), since the
- &PRODUCT; UI handles the front-end rendering for you.</para>
- <para>There is much more to the &PRODUCT; UI framework than can be described here. The UI is
- very flexible to handle many use cases, so there are countless options and variations. The
- best reference right now is to read the existing code for the main UI, which is in the /ui
- folder. Plugins are written in a very similar way to the main UI.</para>
- <orderedlist>
- <listitem>
- <para><emphasis role="bold">Create the directory to hold your plugin.</emphasis></para>
- <para>All plugins are composed of set of required files in the directory
- /ui/plugins/pluginID, where pluginID is a short name for your plugin. It's recommended
- that you prefix your folder name (for example, bfMyPlugin) to avoid naming conflicts
- with other people's plugins.</para>
- <para>In this example, the plugin is named csMyFirstPlugin.</para>
- <programlisting>$ cd cloudstack/ui/plugins
-$ mkdir csMyFirstPlugin
-$ ls -l
-
-total 8
-drwxr-xr-x 2 bgregory staff 68 Feb 11 14:44 csMyFirstPlugin
--rw-r--r-- 1 bgregory staff 101 Feb 11 14:26 plugins.js
- </programlisting>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Change to your new plugin directory.</emphasis></para>
- <programlisting>$ cd csMyFirstPlugin
- </programlisting>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Set up the listing.</emphasis></para>
- <para>Add the file config.js, using your favorite editor.</para>
- <programlisting>$ vi config.js</programlisting>
- <para>Add the following content to config.js. This information will be displayed on the
- plugin listing page in the UI:</para>
- <programlisting>(function (cloudStack) {
- cloudStack.plugins.csMyFirstPlugin.config = {
- title: 'My first plugin',
- desc: 'Tutorial plugin',
- externalLink: 'http://www.cloudstack.org/',
- authorName: 'Test Plugin Developer',
- authorEmail: 'plugin.developer@example.com'
- };
-}(cloudStack));
- </programlisting>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Add a new main section.</emphasis></para>
- <para>Add the file csMyFirstPlugin.js, using your favorite editor.</para>
- <programlisting>$ vi csMyFirstPlugin.js</programlisting>
- <para>Add the following content to csMyFirstPlugin.js:</para>
- <programlisting>(function (cloudStack) {
- cloudStack.plugins.csMyFirstPlugin = function(plugin) {
- plugin.ui.addSection({
- id: 'csMyFirstPlugin',
- title: 'My Plugin',
- preFilter: function(args) {
- return isAdmin();
- },
- show: function() {
- return $('<div>').html('Content will go here');
- }
- });
- };
-}(cloudStack));
- </programlisting>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Register the plugin.</emphasis></para>
- <para>You now have the minimal content needed to run the plugin, so you can activate the
- plugin in the UI by adding it to plugins.js. First, edit the file:</para>
- <programlisting>$ cd cloudstack/ui/plugins
-$ vi plugins.js
- </programlisting>
- <para>Now add the following to plugins.js:</para>
- <programlisting>(function($, cloudStack) {
- cloudStack.plugins = [
- 'csMyFirstPlugin'
- ];
-}(jQuery, cloudStack));
- </programlisting>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Check the plugin in the UI.</emphasis></para>
- <para>First, copy all the plugin code that you have created so far to
- /tomcat/webapps/client/plugins. Then refresh the browser and click Plugins in the side
- navigation bar. You should see your new plugin.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Make the plugin do something.</emphasis></para>
- <para>Right now, you just have placeholder content in the new plugin. It's time to add
- real code. In this example, you will write a basic list view, which renders data from
- an API call. You will list all virtual machines owned by the logged-in user. To do
- this, replace the 'show' function in the plugin code with a 'listView' block,
- containing the required syntax for a list view. To get the data, use the
- listVirtualMachines API call. Without any parameters, it will return VMs only for your
- active user. Use the provided 'apiCall' helper method to handle the server call. Of
- course, you are free to use any other method for making the AJAX call (for example,
- jQuery's $.ajax method).</para>
- <para>First, open your plugin's JavaScript source file in your favorite editor:</para>
- <programlisting>$ cd csMyFirstPlugin
-$ vi csMyFirstPlugin.js
- </programlisting>
- <para>Add the following code in csMyFirstPlugin.js:</para>
- <programlisting>(function (cloudStack) {
- cloudStack.plugins.csMyFirstPlugin = function(plugin) {
- plugin.ui.addSection({
- id: 'csMyFirstPlugin',
- title: 'My Plugin',
- preFilter: function(args) {
- return isAdmin();
- },
-
- // Render page as a list view
- listView: {
- id: 'testPluginInstances',
- fields: {
- name: { label: 'label.name' },
- instancename: { label: 'label.internal.name' },
- displayname: { label: 'label.display.name' },
- zonename: { label: 'label.zone.name' }
- },
- dataProvider: function(args) {
- // API calls go here, to retrive the data asynchronously
- //
- // On successful retrieval, call
- // args.response.success({ data: [data array] });
- plugin.ui.apiCall('listVirtualMachines', {
- success: function(json) {
- var vms = json.listvirtualmachinesresponse.virtualmachine;
-
- args.response.success({ data: vms });
- },
- error: function(errorMessage) {
- args.response.error(errorMessage)
- }
- });
- }
- }
- });
- };
-}(cloudStack));
- </programlisting>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Test the plugin.</emphasis></para>
- <para>First, copy all the plugin code that you have created so far to
- /tomcat/webapps/client/plugins. Then refresh the browser. You can see that your
- placeholder content was replaced with a list table, containing 4 columns of virtual
- machine data.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Add an action button.</emphasis></para>
- <para>Let's add an action button to the list view, which will reboot the VM. To do this,
- add an actions block under listView. After specifying the correct format, the actions
- will appear automatically to the right of each row of data.</para>
- <programlisting>$ vi csMyFirstPlugin.js
- </programlisting>
- <para>Now add the following new code in csMyFirstPlugin.js. (The dots ... show where we
- have omitted some existing code for the sake of space. Don't actually cut and paste
- that part):</para>
- <programlisting>...
- listView: {
- id: 'testPluginInstances',
- ...
-
- actions: {
- // The key/ID you specify here will determine what icon is
- // shown in the UI for this action,
- // and will be added as a CSS class to the action's element
- // (i.e., '.action.restart')
- //
- // -- here, 'restart' is a predefined name in &PRODUCT; that will
- // automatically show a 'reboot' arrow as an icon;
- // this can be changed in csMyFirstPlugin.css
- restart: {
- label: 'Restart VM',
- messages: {
- confirm: function() { return 'Are you sure you want to restart this VM?' },
- notification: function() { return 'Rebooted VM' }
- },
- action: function(args) {
- // Get the instance object of the selected row from context
- //
- // -- all currently loaded state is stored in 'context' as objects,
- // such as the selected list view row,
- // the selected section, and active user
- //
- // -- for list view actions, the object's key will be the same as
- // listView.id, specified above;
- // always make sure you specify an 'id' for the listView,
- // or else it will be 'undefined!'
- var instance = args.context.testPluginInstances[0];
-
- plugin.ui.apiCall('rebootVirtualMachine', {
- // These will be appended to the API request
- //
- // i.e., rebootVirtualMachine&id=...
- data: {
- id: instance.id
- },
- success: function(json) {
- args.response.success({
- // This is an async job, so success here only indicates
- // that the job was initiated.
- //
- // To pass the job ID to the notification UI
- // (for checking to see when action is completed),
- // '_custom: { jobID: ... }' needs to always be passed on success,
- // in the same format as below
- _custom: { jobId: json.rebootvirtualmachineresponse.jobid }
- });
- },
-
-
- error: function(errorMessage) {
- args.response.error(errorMessage); // Cancel action, show error message returned
- }
- });
- },
-
- // Because rebootVirtualMachine is an async job, we need to add
- // a poll function, which will perodically check
- // the management server to see if the job is ready
- // (via pollAsyncJobResult API call)
- //
- // The plugin API provides a helper function, 'plugin.ui.pollAsyncJob',
- / which will work for most jobs
- // in &PRODUCT;
- notification: {
- poll: plugin.ui.pollAsyncJob
- }
- }
- },
-
- dataProvider: function(args) {
- ...
-...
- </programlisting>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Add the thumbnail icon.</emphasis></para>
- <para>Create an icon file; it should be square, about 50x50 pixels, and named icon.png.
- Copy it into the same directory with your plugin code:
- cloudstack/ui/plugins/csMyFirstPlugin/icon.png.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Add the stylesheet.</emphasis></para>
- <para>Create a CSS file, with the same name as your .js file. Copy it into the same
- directory with your plugin code:
- cloudstack/ui/plugins/csMyFirstPlugin/csMyFirstPlugin.css.</para>
- </listitem>
- </orderedlist>
- </section>
- </chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/time-zones.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/time-zones.xml b/docs/en-US/time-zones.xml
deleted file mode 100644
index 6b3b64e..0000000
--- a/docs/en-US/time-zones.xml
+++ /dev/null
@@ -1,137 +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.
--->
-
-<appendix id="time-zones">
- <title>Time Zones</title>
- <para>The following time zone identifiers are accepted by &PRODUCT;. There are several places that have a time zone as a required or optional parameter. These include scheduling recurring snapshots, creating a user, and specifying the usage time zone in the Configuration table.</para>
- <informaltable frame="all">
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" />
- <colspec colname="c2" />
- <colspec colname="c3" />
- <tbody>
- <row>
- <entry><para>Etc/GMT+12</para></entry>
- <entry><para>Etc/GMT+11</para></entry>
- <entry><para>Pacific/Samoa</para></entry>
- </row>
- <row>
- <entry><para>Pacific/Honolulu</para></entry>
- <entry><para>US/Alaska</para></entry>
- <entry><para>America/Los_Angeles</para></entry>
- </row>
- <row>
- <entry><para>Mexico/BajaNorte</para></entry>
- <entry><para>US/Arizona</para></entry>
- <entry><para>US/Mountain</para></entry>
- </row>
- <row>
- <entry><para>America/Chihuahua</para></entry>
- <entry><para>America/Chicago</para></entry>
- <entry><para>America/Costa_Rica</para></entry>
- </row>
- <row>
- <entry><para>America/Mexico_City</para></entry>
- <entry><para>Canada/Saskatchewan</para></entry>
- <entry><para>America/Bogota</para></entry>
- </row>
- <row>
- <entry><para>America/New_York</para></entry>
- <entry><para>America/Caracas</para></entry>
- <entry><para>America/Asuncion</para></entry>
- </row>
- <row>
- <entry><para>America/Cuiaba</para></entry>
- <entry><para>America/Halifax</para></entry>
- <entry><para>America/La_Paz</para></entry>
- </row>
- <row>
- <entry><para>America/Santiago</para></entry>
- <entry><para>America/St_Johns</para></entry>
- <entry><para>America/Araguaina</para></entry>
- </row>
- <row>
- <entry><para>America/Argentina/Buenos_Aires</para></entry>
- <entry><para>America/Cayenne</para></entry>
- <entry><para>America/Godthab</para></entry>
- </row>
- <row>
- <entry><para>America/Montevideo</para></entry>
- <entry><para>Etc/GMT+2</para></entry>
- <entry><para>Atlantic/Azores</para></entry>
- </row>
- <row>
- <entry><para>Atlantic/Cape_Verde</para></entry>
- <entry><para>Africa/Casablanca</para></entry>
- <entry><para>Etc/UTC</para></entry>
- </row>
- <row>
- <entry><para>Atlantic/Reykjavik</para></entry>
- <entry><para>Europe/London</para></entry>
- <entry><para>CET</para></entry>
- </row>
- <row>
- <entry><para>Europe/Bucharest</para></entry>
- <entry><para>Africa/Johannesburg</para></entry>
- <entry><para>Asia/Beirut</para></entry>
- </row>
- <row>
- <entry><para>Africa/Cairo</para></entry>
- <entry><para>Asia/Jerusalem</para></entry>
- <entry><para>Europe/Minsk</para></entry>
- </row>
- <row>
- <entry><para>Europe/Moscow</para></entry>
- <entry><para>Africa/Nairobi</para></entry>
- <entry><para>Asia/Karachi</para></entry>
- </row>
- <row>
- <entry><para>Asia/Kolkata</para></entry>
- <entry><para>Asia/Bangkok</para></entry>
- <entry><para>Asia/Shanghai</para></entry>
- </row>
- <row>
- <entry><para>Asia/Kuala_Lumpur</para></entry>
- <entry><para>Australia/Perth</para></entry>
- <entry><para>Asia/Taipei</para></entry>
- </row>
- <row>
- <entry><para>Asia/Tokyo</para></entry>
- <entry><para>Asia/Seoul</para></entry>
- <entry><para>Australia/Adelaide</para></entry>
- </row>
- <row>
- <entry><para>Australia/Darwin</para></entry>
- <entry><para>Australia/Brisbane</para></entry>
- <entry><para>Australia/Canberra</para></entry>
- </row>
- <row>
- <entry><para>Pacific/Guam</para></entry>
- <entry><para>Pacific/Auckland</para></entry>
- <entry><para></para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
-</appendix>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/tools.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/tools.xml b/docs/en-US/tools.xml
deleted file mode 100644
index 8cddf28..0000000
--- a/docs/en-US/tools.xml
+++ /dev/null
@@ -1,31 +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.
--->
-
-<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" />
- <xi:include href="cloudmonkey.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="libcloud-examples.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/topology-req.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/topology-req.xml b/docs/en-US/topology-req.xml
deleted file mode 100644
index 75fe69b..0000000
--- a/docs/en-US/topology-req.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="topology-req">
- <title>Topology Requirements</title>
- <xi:include href="security-req.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="runtime-internal-comm-req.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="storage-nw-topology-req.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="external-fw-topology-req.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="adv-zone-topology-req.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="xenserver-topology-req.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="vmware-topology-req.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="kvm-topology-req.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="lxc-topology-req.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/translating-documentation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/translating-documentation.xml b/docs/en-US/translating-documentation.xml
deleted file mode 100644
index 4d5e3d2..0000000
--- a/docs/en-US/translating-documentation.xml
+++ /dev/null
@@ -1,38 +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="translating-documentation">
- <title>Translating &PRODUCT; Documentation</title>
-
- <para>There are two ways to translate the documentation:</para>
- <para>
- <itemizedlist>
- <listitem><para>Directly using the Transifex website and using their user interface.</para></listitem>
- <listitem><para>Using the Transifex client and pushing your translated strings to the website.</para></listitem>
- </itemizedlist>
- </para>
- <para>Once a translation is complete, a site admin will pull the translated strings within the &PRODUCT; repository, build the documentation and publish it.</para>
- <para>For instructions on how to use the Transifex website see <ulink url="http://sebgoa.blogspot.ch/2012/11/translating-apache-cloudstack-docs-with.html">http://sebgoa.blogspot.ch/2012/11/translating-apache-cloudstack-docs-with.html</ulink></para>
- <para>For instructions on how to use the Transifex client to translate from the command line see <ulink url="http://sebgoa.blogspot.ch/2012/12/using-transifex-client-to-translate.html">http://sebgoa.blogspot.ch/2012/12/using-transifex-client-to-translate.html</ulink></para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/troubleshooting-alerts.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-alerts.xml b/docs/en-US/troubleshooting-alerts.xml
deleted file mode 100644
index 0efeb81..0000000
--- a/docs/en-US/troubleshooting-alerts.xml
+++ /dev/null
@@ -1,57 +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="troubleshooting-alerts">
- <title>Alerts</title>
- <para>The following is the list of alert type numbers.</para>
- <programlisting>
-MEMORY = 0
-CPU = 1
-STORAGE =2
-STORAGE_ALLOCATED = 3
-PUBLIC_IP = 4
-PRIVATE_IP = 5
-HOST = 6
-USERVM = 7
-DOMAIN_ROUTER = 8
-CONSOLE_PROXY = 9
-ROUTING = 10// lost connection to default route (to the gateway)
-STORAGE_MISC = 11 // lost connection to default route (to the gateway)
-USAGE_SERVER = 12 // lost connection to default route (to the gateway)
-MANAGMENT_NODE = 13 // lost connection to default route (to the gateway)
-DOMAIN_ROUTER_MIGRATE = 14
-CONSOLE_PROXY_MIGRATE = 15
-USERVM_MIGRATE = 16
-VLAN = 17
-SSVM = 18
-USAGE_SERVER_RESULT = 19
-STORAGE_DELETE = 20;
-UPDATE_RESOURCE_COUNT = 21; //Generated when we fail to update the resource count
-USAGE_SANITY_RESULT = 22;
-DIRECT_ATTACHED_PUBLIC_IP = 23;
-LOCAL_STORAGE = 24;
-RESOURCE_LIMIT_EXCEEDED = 25; //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only
-
- </programlisting>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/troubleshooting-lb-rules-fails.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-lb-rules-fails.xml b/docs/en-US/troubleshooting-lb-rules-fails.xml
deleted file mode 100644
index 6295534..0000000
--- a/docs/en-US/troubleshooting-lb-rules-fails.xml
+++ /dev/null
@@ -1,39 +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="troubleshooting-lb-rules-fails">
- <title>Load balancer rules fail after changing network offering</title>
- <formalpara>
- <title>Symptom</title>
- <para>After changing the network offering on a network, load balancer rules stop working.</para>
- </formalpara>
- <formalpara>
- <title>Cause</title>
- <para>Load balancing rules were created while using a network service offering that includes an external load balancer device such as NetScaler, and later the network service offering changed to one that uses the &PRODUCT; virtual router.</para>
- </formalpara>
- <formalpara>
- <title>Solution</title>
- <para>Create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function.</para>
- </formalpara>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/troubleshooting-recover-lost-virtual-router.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-recover-lost-virtual-router.xml b/docs/en-US/troubleshooting-recover-lost-virtual-router.xml
deleted file mode 100644
index 12a5150..0000000
--- a/docs/en-US/troubleshooting-recover-lost-virtual-router.xml
+++ /dev/null
@@ -1,46 +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="troubleshooting-recover-lost-virtual-router">
- <title>Recovering a Lost Virtual Router </title>
- <formalpara>
- <title>Symptom</title>
- <para>A virtual router is running, but the host is disconnected. A virtual router no longer functions as expected.</para>
- </formalpara>
- <formalpara>
- <title>Cause</title>
- <para>The Virtual router is lost or down.</para>
- </formalpara>
- <formalpara>
- <title>Solution</title>
- <para>If you are sure that a virtual router is down forever, or no longer functions as expected, destroy it. You must create one afresh while keeping the backup router up and running (it is assumed this is in a redundant router setup):</para>
- </formalpara>
- <itemizedlist>
- <listitem><para>Force stop the router. Use the stopRouter API with forced=true parameter to do so.</para></listitem>
- <listitem><para>Before you continue with destroying this router, ensure that the backup router is running. Otherwise the network connection will be lost.</para></listitem>
- <listitem><para>Destroy the router by using the destroyRouter API.</para></listitem>
- </itemizedlist>
- <para>Recreate the missing router by using the restartNetwork API with cleanup=false parameter. For more information about redundant router setup, see Creating a New Network Offering.</para>
- <para>For more information about the API syntax, see the API Reference at <ulink url="http://docs.cloudstack.org/CloudStack_Documentation/API_Reference%3A_CloudStack"></ulink>API Reference.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/troubleshooting-unable-to-deploy-vms.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-unable-to-deploy-vms.xml b/docs/en-US/troubleshooting-unable-to-deploy-vms.xml
deleted file mode 100644
index 412b9bf..0000000
--- a/docs/en-US/troubleshooting-unable-to-deploy-vms.xml
+++ /dev/null
@@ -1,39 +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="troubleshooting-unable-to-deploy-vms">
- <title>Unable to deploy VMs from uploaded vSphere template</title>
- <formalpara>
- <title>Symptom</title>
- <para>When attempting to create a VM, the VM will not deploy. </para>
- </formalpara>
- <formalpara>
- <title>Cause</title>
- <para>If the template was created by uploading an OVA file that was created using vSphere Client, it is possible the OVA contained an ISO image. If it does, the deployment of VMs from the template will fail.</para>
- </formalpara>
- <formalpara>
- <title>Solution</title>
- <para>Remove the ISO and re-upload the template.</para>
- </formalpara>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/troubleshooting-unable-to-power-on-vm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-unable-to-power-on-vm.xml b/docs/en-US/troubleshooting-unable-to-power-on-vm.xml
deleted file mode 100644
index e037eda..0000000
--- a/docs/en-US/troubleshooting-unable-to-power-on-vm.xml
+++ /dev/null
@@ -1,45 +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="troubleshooting-unable-to-power-on-vm">
- <title>Unable to power on virtual machine on VMware</title>
- <formalpara>
- <title>Symptom</title>
- <para>Virtual machine does not power on. You might see errors like: </para>
- </formalpara>
- <itemizedlist>
- <listitem><para>Unable to open Swap File</para></listitem>
- <listitem><para>Unable to access a file since it is locked</para></listitem>
- <listitem><para>Unable to access Virtual machine configuration</para></listitem>
- </itemizedlist>
- <formalpara>
- <title>Cause</title>
- <para>A known issue on VMware machines. ESX hosts lock certain critical virtual machine files and file systems to prevent concurrent changes. Sometimes the files are not unlocked when the virtual machine is powered off. When a virtual machine attempts to power on, it can not access these critical files, and the virtual machine is unable to power on.</para>
- </formalpara>
- <formalpara>
- <title>Solution</title>
- <para>See the following:</para>
- </formalpara>
- <para><ulink url="http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=10051/">VMware Knowledge Base Article</ulink></para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/troubleshooting-working-with-server-logs.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting-working-with-server-logs.xml b/docs/en-US/troubleshooting-working-with-server-logs.xml
deleted file mode 100644
index fa0f78c..0000000
--- a/docs/en-US/troubleshooting-working-with-server-logs.xml
+++ /dev/null
@@ -1,41 +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="troubleshooting-working-with-server-logs">
- <title>Working with Server Logs</title>
- <para>The &PRODUCT; Management Server logs all web site, middle tier, and database activities for diagnostics purposes in /var/log/cloudstack/management/. The &PRODUCT; logs a variety of error messages. We recommend this command to find the problematic output in the Management Server log:.</para>
- <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>
- <programlisting>
- grep -i -E 'exception|unable|fail|invalid|leak|warn|error' /var/log/cloudstack/management/management-server.log
- </programlisting>
- <para>The &PRODUCT; processes requests with a Job ID. If you find an error in the logs and you are interested in debugging the issue you can grep for this job ID in the management server log. For example, suppose that you find the following ERROR message:</para>
- <programlisting>
- 2010-10-04 13:49:32,595 ERROR [cloud.vm.UserVmManagerImpl] (Job-Executor-11:job-1076) Unable to find any host for [User|i-8-42-VM-untagged]
- </programlisting>
- <para>Note that the job ID is 1076. You can track back the events relating to job 1076 with the following grep:</para>
- <programlisting>
- grep "job-1076)" management-server.log
- </programlisting>
- <para>The &PRODUCT; Agent Server logs its activities in /var/log/cloudstack/agent/.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/troubleshooting.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troubleshooting.xml b/docs/en-US/troubleshooting.xml
deleted file mode 100644
index 570d02e..0000000
--- a/docs/en-US/troubleshooting.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.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="troubleshooting">
- <title>Troubleshooting</title>
- <xi:include href="events.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="troubleshooting-working-with-server-logs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="troublesht-dataloss-on-exp-primary-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="troubleshooting-recover-lost-virtual-router.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="troublesht-mtn-mode-not-working-on-vCenter.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="troubleshooting-unable-to-deploy-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="troubleshooting-unable-to-power-on-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="troubleshooting-lb-rules-fails.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/troublesht-dataloss-on-exp-primary-storage.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troublesht-dataloss-on-exp-primary-storage.xml b/docs/en-US/troublesht-dataloss-on-exp-primary-storage.xml
deleted file mode 100644
index 4a94f60..0000000
--- a/docs/en-US/troublesht-dataloss-on-exp-primary-storage.xml
+++ /dev/null
@@ -1,45 +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="troubleshooting-dataloss-on-exported-primary-storage">
- <title>Data Loss on Exported Primary Storage</title>
- <formalpara>
- <title>Symptom</title>
- <para>Loss of existing data on primary storage which has been exposed as a Linux NFS server export on an iSCSI volume. </para>
- </formalpara>
- <formalpara>
- <title>Cause</title>
- <para>It is possible that a client from outside the intended pool has mounted the storage. When this occurs, the LVM is wiped and all data in the volume is lost</para>
- </formalpara>
- <formalpara>
- <title>Solution</title>
- <para>When setting up LUN exports, restrict the range of IP addresses that are allowed access by specifying a subnet mask. For example:</para>
- </formalpara>
- <programlisting>echo “/export 192.168.1.0/24(rw,async,no_root_squash)” > /etc/exports</programlisting>
- <para>Adjust the above command to suit your deployment needs.</para>
- <formalpara>
- <title>More Information</title>
- <para>See the export procedure in the "Secondary Storage" section of the &PRODUCT; Installation Guide</para>
- </formalpara>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/troublesht-mtn-mode-not-working-on-vCenter.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/troublesht-mtn-mode-not-working-on-vCenter.xml b/docs/en-US/troublesht-mtn-mode-not-working-on-vCenter.xml
deleted file mode 100644
index 764d188..0000000
--- a/docs/en-US/troublesht-mtn-mode-not-working-on-vCenter.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="troubleshooting-maintenance-mode-not-working-on-vCenter">
- <title>Maintenance mode not working on vCenter</title>
- <formalpara>
- <title>Symptom</title>
- <para>Host was placed in maintenance mode, but still appears live in vCenter. </para>
- </formalpara>
- <formalpara>
- <title>Cause</title>
- <para>The &PRODUCT; administrator UI was used to place the host in scheduled maintenance mode. This mode is separate from vCenter's maintenance mode.</para>
- </formalpara>
- <formalpara>
- <title>Solution</title>
- <para>Use vCenter to place the host in maintenance mode.</para>
- </formalpara>
- <formalpara>
- <title>More Information</title>
- <para>See <xref linkend="scheduled-maintenance-maintenance-mode-hosts"/></para>
- </formalpara>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/tuning.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/tuning.xml b/docs/en-US/tuning.xml
deleted file mode 100644
index 4f9dd01..0000000
--- a/docs/en-US/tuning.xml
+++ /dev/null
@@ -1,33 +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.
--->
-
-<chapter id="tuning">
- <title>Tuning</title>
- <para>This section provides tips on how to improve the performance of your cloud.</para>
- <xi:include href="performance-monitoring.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="increase-management-server-max-memory.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="set-database-buffer-pool-size.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="set-monitor-total-vm-limits-per-host.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="configure-xenserver-dom0-memory.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/ui.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/ui.xml b/docs/en-US/ui.xml
deleted file mode 100644
index 94ea4ea..0000000
--- a/docs/en-US/ui.xml
+++ /dev/null
@@ -1,29 +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.
--->
-
-<chapter id="ui">
- <title>User Interface</title>
- <xi:include href="log-in.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="using-sshkeys.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/update-iso-vm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/update-iso-vm.xml b/docs/en-US/update-iso-vm.xml
deleted file mode 100644
index 98105f5..0000000
--- a/docs/en-US/update-iso-vm.xml
+++ /dev/null
@@ -1,47 +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="update-iso-vm">
- <!-- CLOUDSTACK-667 -->
- <title>Changing a VM's Base Image</title>
- <para>Every VM is created from a base image, which is a template or ISO which has been created and
- stored in &PRODUCT;. Both cloud administrators and end users can create and modify templates,
- ISOs, and VMs.</para>
- <para>In &PRODUCT;, you can change an existing VM's base image from one template to another,
- or from one ISO to another. (You can not change from an ISO to a template, or from a
- template to an ISO).</para>
- <para>For example, suppose there is a
- template based on a particular operating system, and the OS vendor releases a software patch.
- The administrator or user naturally wants to apply the patch and then make sure existing VMs
- start using it. Whether a software update is involved or not, it's also possible to simply
- switch a VM from its current template to any other desired template.</para>
- <para>To change a VM's base image, call the restoreVirtualMachine API command and pass in the
- virtual machine ID and a new template ID. The template ID parameter may refer to either a
- template or an ISO, depending on which type of base image the VM was already using (it must
- match the previous type of image). When this call occurs, the VM's root disk is first destroyed,
- then a new root disk is created from the source designated in the template ID parameter. The new
- root disk is attached to the VM, and now the VM is based on the new template.</para>
- <para>You can also omit the template ID parameter from the restoreVirtualMachine call. In this
- case, the VM's root disk is destroyed and recreated, but from the same template or ISO that was
- already in use by the VM.</para>
-</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/upgrade-virtual-router-with-service-offering.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/upgrade-virtual-router-with-service-offering.xml b/docs/en-US/upgrade-virtual-router-with-service-offering.xml
deleted file mode 100644
index dad1d90..0000000
--- a/docs/en-US/upgrade-virtual-router-with-service-offering.xml
+++ /dev/null
@@ -1,36 +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="upgrade-virtual-router-with-service-offering">
- <title>Upgrading a Virtual Router with System Service Offerings</title>
- <para>When &PRODUCT; creates a virtual router, it uses default settings which are defined in a default system service offering. See <xref linkend="system-service-offerings"/>. All the virtual routers in a single guest network use the same system service offering. You can upgrade the capabilities of the virtual router by creating and applying a custom system service offering.</para>
- <orderedlist>
- <listitem><para>Define your custom system service offering. See <xref linkend="creating-system-service-offerings"/>. In System VM Type, choose Domain Router.</para></listitem>
- <listitem><para>Associate the system service offering with a network offering.
- <phrase condition="install">See "Creating Network Offerings" in the Administrator's Guide.</phrase>
- <phrase condition="admin">See <xref linkend="creating-network-offerings"/>.</phrase>
- </para></listitem>
- <listitem><para>Apply the network offering to the network where you want the virtual routers to use the new system service offering. If this is a new network, follow the steps in Adding an Additional Guest Network on page 66. To change the service offering for existing virtual routers, follow the steps in <xref linkend="change-network-offering-on-guest-network"/>.</para></listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/upload-existing-volume-to-vm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/upload-existing-volume-to-vm.xml b/docs/en-US/upload-existing-volume-to-vm.xml
deleted file mode 100644
index 4681374..0000000
--- a/docs/en-US/upload-existing-volume-to-vm.xml
+++ /dev/null
@@ -1,111 +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="upload-existing-volume-to-vm">
- <title>Uploading an Existing Volume to a Virtual Machine</title>
- <para>Existing data can be made accessible to a virtual machine. This is called uploading a volume
- to the VM. For example, this is useful to upload data from a local file system and attach it to
- a VM. Root administrators, domain administrators, and end users can all upload existing volumes
- to VMs.</para>
- <para>The upload is performed using HTTP. The uploaded volume is placed in the zone's secondary
- storage</para>
- <para>You cannot upload a volume if the preconfigured volume limit has already been reached. The
- default limit for the cloud is set in the global configuration parameter max.account.volumes,
- but administrators can also set per-domain limits that are different from the global default.
- See Setting Usage Limits </para>
- <para>To upload a volume:</para>
- <orderedlist>
- <listitem>
- <para>(Optional) Create an MD5 hash (checksum) of the disk image file that you are going to
- upload. After uploading the data disk, &PRODUCT; will use this value to verify that no data
- corruption has occurred.</para>
- </listitem>
- <listitem>
- <para>Log in to the &PRODUCT; UI as an administrator or user</para>
- </listitem>
- <listitem>
- <para>In the left navigation bar, click Storage.</para>
- </listitem>
- <listitem>
- <para>Click Upload Volume.</para>
- </listitem>
- <listitem>
- <para>Provide the following:</para>
- <itemizedlist>
- <listitem>
- <para>Name and Description. Any desired name and a brief description that can be shown in
- the UI.</para>
- </listitem>
- <listitem>
- <para>Availability Zone. Choose the zone where you want to store the volume. VMs running
- on hosts in this zone can attach the volume.</para>
- </listitem>
- <listitem>
- <para>Format. Choose one of the following to indicate the disk image format of the
- volume.</para>
- <informaltable>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry><para>Hypervisor</para></entry>
- <entry><para>Disk Image Format</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>XenServer</para></entry>
- <entry><para>VHD</para></entry>
- </row>
- <row>
- <entry><para>VMware</para></entry>
- <entry><para>OVA</para></entry>
- </row>
- <row>
- <entry><para>KVM</para></entry>
- <entry><para>QCOW2</para></entry>
- </row>
- <!-- <row>
- <entry><para>OVM</para></entry>
- <entry><para>RAW</para></entry>
- </row> -->
- </tbody>
- </tgroup>
- </informaltable>
- </listitem>
- <listitem>
- <para>URL. The secure HTTP or HTTPS URL that &PRODUCT; can use to access your disk. The
- type of file at the URL must match the value chosen in Format. For example, if Format is
- VHD, the URL might look like the following:</para>
- <para>http://yourFileServerIP/userdata/myDataDisk.vhd</para>
- </listitem>
- <listitem>
- <para>MD5 checksum. (Optional) Use the hash that you created in step 1.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Wait until the status of the volume shows that the upload is complete. Click Instances -
- Volumes, find the name you specified in step 5, and make sure the status is Uploaded.</para>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/upload-template.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/upload-template.xml b/docs/en-US/upload-template.xml
deleted file mode 100644
index f270c89..0000000
--- a/docs/en-US/upload-template.xml
+++ /dev/null
@@ -1,67 +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="upload-template">
- <title>Uploading Templates</title>
- <warning><title>vSphere Templates and ISOs</title><para>If you are uploading a template that was created using vSphere Client, be sure the OVA file does not contain an ISO. If it does, the deployment of VMs from the template will fail.</para></warning>
- <para>Templates are uploaded based on a URL. HTTP is the supported access protocol. Templates are frequently large files. You can optionally gzip them to decrease upload times.</para>
- <para>To upload a template:</para>
- <orderedlist>
- <listitem><para>In the left navigation bar, click Templates.</para></listitem>
- <listitem><para>Click Register Template.</para></listitem>
- <listitem><para>Provide the following:</para>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Name and Description</emphasis>. These will be shown in the UI, so
- choose something descriptive.</para></listitem>
- <listitem><para><emphasis role="bold">URL</emphasis>. The Management Server will download the file from the
- specified URL, such as http://my.web.server/filename.vhd.gz.</para></listitem>
- <listitem><para><emphasis role="bold">Zone</emphasis>. Choose the zone where you want the template to be
- available, or All Zones to make it available throughout
- &PRODUCT;.</para></listitem>
- <listitem><para><emphasis role="bold">OS Type</emphasis>: This helps &PRODUCT; and the hypervisor perform
- certain operations and make assumptions that improve the performance of the
- guest. Select one of the following:</para>
- <itemizedlist>
- <listitem><para>If the operating system of the stopped VM is listed, choose it.</para></listitem>
- <listitem><para>If the OS type of the stopped VM is not listed, choose Other.</para>
- <note><para>You should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other.</para></note></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para><emphasis role="bold">Hypervisor</emphasis>: The supported hypervisors are listed. Select the desired one.</para></listitem>
- <listitem><para><emphasis role="bold">Format</emphasis>. The format of the template upload file, such as VHD
- or OVA.</para></listitem>
- <listitem><para><emphasis role="bold">Password Enabled</emphasis>. Choose Yes if your template has the
- &PRODUCT; password change script installed. See Adding Password
- Management to Your Templates</para></listitem>
- <listitem><para><emphasis role="bold">Extractable</emphasis>. Choose Yes if the template is available for extraction. If this option is selected, end users can
- download a full image of a template.</para></listitem>
- <listitem><para><emphasis role="bold">Public</emphasis>. Choose Yes to make this template accessible to all
- users of this &PRODUCT; installation. The template will appear in the
- Community Templates list. See <xref linkend="private-public-template"/>.</para></listitem>
- <listitem><para><emphasis role="bold">Featured</emphasis>. Choose Yes if you would like this template to be
- more prominent for users to select. The template will appear in the Featured
- Templates list. Only an administrator can make a template Featured.</para></listitem>
- </itemizedlist></listitem>
-
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/usage-record-format.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/usage-record-format.xml b/docs/en-US/usage-record-format.xml
deleted file mode 100644
index 7f7db06..0000000
--- a/docs/en-US/usage-record-format.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.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="usage-record-format">
- <title>Usage Record Format</title>
- <xi:include href="virtual-machine-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="network-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="ipaddress-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="disk-volume-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="template-iso-snapshot-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="lb-policy-pfwd-rule-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="network-offering-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="VPN-user-usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/usage-types.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/usage-types.xml b/docs/en-US/usage-types.xml
deleted file mode 100644
index 5a18902..0000000
--- a/docs/en-US/usage-types.xml
+++ /dev/null
@@ -1,109 +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="usage-types">
- <title>Usage Types</title>
- <para>The following table shows all usage types.</para>
-<informaltable>
- <tgroup cols="3">
- <colspec colname="c1" colnum="1" colwidth="4cm" />
- <colspec colname="c2" colnum="2" colwidth="8cm" />
- <colspec colname="c3" colnum="3" colwidth="5cm" />
- <thead>
- <row>
- <entry>Type ID</entry>
- <entry>Type Name</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>1</entry>
- <entry>RUNNING_VM</entry>
- <entry>Tracks the total running time of a VM per usage record period. If the VM is upgraded during the usage period, you will get a separate Usage Record for the new upgraded VM.</entry>
- </row>
- <row>
- <entry><para>2</para></entry>
- <entry><para>ALLOCATED_VM</para></entry>
- <entry><para>Tracks the total time the VM has been created to the time when it has been destroyed. This usage type is also useful in determining usage for specific templates such as Windows-based templates.</para></entry>
- </row>
- <row>
- <entry><para>3</para></entry>
- <entry><para>IP_ADDRESS</para></entry>
- <entry><para>Tracks the public IP address owned by the account.</para></entry>
- </row>
- <row>
- <entry><para>4</para></entry>
- <entry><para>NETWORK_BYTES_SENT</para></entry>
- <entry><para>Tracks the total number of bytes sent by all the VMs for an account. Cloud.com does not currently track network traffic per VM.</para></entry>
- </row>
- <row>
- <entry><para>5</para></entry>
- <entry><para>NETWORK_BYTES_RECEIVED</para></entry>
- <entry><para>Tracks the total number of bytes received by all the VMs for an account. Cloud.com does not currently track network traffic per VM.</para></entry>
- </row>
- <row>
- <entry><para>6</para></entry>
- <entry><para>VOLUME</para></entry>
- <entry><para>Tracks the total time a disk volume has been created to the time when it has been destroyed.</para></entry>
- </row>
- <row>
- <entry><para>7</para></entry>
- <entry><para>TEMPLATE</para></entry>
- <entry><para>Tracks the total time a template (either created from a snapshot or uploaded to the cloud) has been created to the time it has been destroyed. The size of the template is also returned.</para></entry>
- </row>
- <row>
- <entry><para>8</para></entry>
- <entry><para>ISO</para></entry>
- <entry><para>Tracks the total time an ISO has been uploaded to the time it has been removed from the cloud. The size of the ISO is also returned.</para></entry>
- </row>
- <row>
- <entry><para>9</para></entry>
- <entry><para>SNAPSHOT</para></entry>
- <entry><para>Tracks the total time from when a snapshot has been created to the time it have been destroyed.</para></entry>
- </row>
- <row>
- <entry><para>11</para></entry>
- <entry><para>LOAD_BALANCER_POLICY</para></entry>
- <entry><para>Tracks the total time a load balancer policy has been created to the time it has been removed. Cloud.com does not track whether a VM has been assigned to a policy.</para></entry>
- </row>
- <row>
- <entry><para>12</para></entry>
- <entry><para>PORT_FORWARDING_RULE</para></entry>
- <entry><para>Tracks the time from when a port forwarding rule was created until the time it was removed.</para></entry>
- </row>
- <row>
- <entry><para>13</para></entry>
- <entry><para>NETWORK_OFFERING</para></entry>
- <entry><para>The time from when a network offering was assigned to a VM until it is removed.</para></entry>
- </row>
- <row>
- <entry><para>14</para></entry>
- <entry><para>VPN_USERS</para></entry>
- <entry><para>The time from when a VPN user is created until it is removed.</para></entry>
- </row>
- </tbody>
- </tgroup>
-</informaltable>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/use-project-view.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/use-project-view.xml b/docs/en-US/use-project-view.xml
deleted file mode 100644
index df874d8..0000000
--- a/docs/en-US/use-project-view.xml
+++ /dev/null
@@ -1,38 +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="use-project-view">
- <title>Using the Project View</title>
- <para>If you are a member of a project, you can use &PRODUCT;’s project view to see project members, resources consumed, and more. The project view shows only information related to one project. It is a useful way to filter out other information so you can concentrate on a project status and resources.</para>
- <orderedlist>
- <listitem><para>Log in to the &PRODUCT; UI.</para></listitem>
- <listitem><para>Click Project View.</para></listitem>
- <listitem><para>The project dashboard appears, showing the project’s VMs, volumes, users, events, network settings, and more. From the dashboard, you can:</para>
- <itemizedlist>
- <listitem><para>Click the Accounts tab to view and manage project members. If you are the project administrator, you can add new members, remove members, or change the role of a member from user to admin. Only one member at a time can have the admin role, so if you set another user’s role to admin, your role will change to regular user.</para></listitem>
- <listitem><para>(If invitations are enabled) Click the Invitations tab to view and manage invitations that have been sent to new project members but not yet accepted. Pending invitations will remain in this list until the new member accepts, the invitation timeout is reached, or you cancel the invitation.</para></listitem>
- </itemizedlist>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/user-data-and-meta-data.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/user-data-and-meta-data.xml b/docs/en-US/user-data-and-meta-data.xml
deleted file mode 100644
index 3400701..0000000
--- a/docs/en-US/user-data-and-meta-data.xml
+++ /dev/null
@@ -1,45 +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="user-data-and-meta-data">
- <title>User Data and Meta Data</title>
- <para>&PRODUCT; provides API access to attach up to 32KB of user data to a deployed VM. Deployed VMs also have access to instance metadata via the virtual router.</para>
- <para>User data can be accessed once the IP address of the virtual router is known. Once the IP address is known, use the following steps to access the user data:</para>
- <orderedlist>
- <listitem><para>Run the following command to find the virtual router.</para>
- <programlisting># cat /var/lib/dhclient/dhclient-eth0.leases | grep dhcp-server-identifier | tail -1</programlisting>
- </listitem>
- <listitem><para>Access user data by running the following command using the result of the above command</para><programlisting># curl http://10.1.1.1/latest/user-data</programlisting></listitem>
- </orderedlist>
- <para>Meta Data can be accessed similarly, using a URL of the form http://10.1.1.1/latest/meta-data/{metadata type}. (For backwards compatibility, the previous URL http://10.1.1.1/latest/{metadata type} is also supported.) For metadata type, use one of the following:</para>
- <itemizedlist>
- <listitem><para>service-offering. A description of the VMs service offering</para></listitem>
- <listitem><para>availability-zone. The Zone name</para></listitem>
- <listitem><para>local-ipv4. The guest IP of the VM</para></listitem>
- <listitem><para>local-hostname. The hostname of the VM</para></listitem>
- <listitem><para>public-ipv4. The first public IP for the router. (E.g. the first IP of eth2)</para></listitem>
- <listitem><para>public-hostname. This is the same as public-ipv4</para></listitem>
- <listitem><para>instance-id. The instance name of the VM</para></listitem>
- </itemizedlist>
-</section>