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:39 UTC
[37/51] [partial] Removing docs from master
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/devcloud-usage-mode.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/devcloud-usage-mode.xml b/docs/en-US/devcloud-usage-mode.xml
deleted file mode 100644
index bc211ce..0000000
--- a/docs/en-US/devcloud-usage-mode.xml
+++ /dev/null
@@ -1,60 +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="devcloud-usage-mode">
- <title>DevCloud Usage Mode</title>
- <para>DevCloud can be used in several different ways:</para>
- <orderedlist>
- <listitem>
- <para>Full sandbox. Where &PRODUCT; is run within the DevCloud instance started in Virtual Box.</para>
- <para>In this mode, the &PRODUCT; management server runs within the instance and nested virtualization allows instantiation of tiny VMs within DevCloud itself. &PRODUCT; code modifications are done within DevCloud.</para>
- <para>The following diagram shows the architecture of the SandBox mode.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/DevCloud.png" scale="50"/>
- </imageobject>
- <textobject>
- <phrase>DevCloud.png: Schematic of the DevCloud SandBox architecture</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- <listitem>
- <para>A deployment environment. Where &PRODUCT; code is developed in the localhost of the developer and the resulting build is deployed within DevCloud</para>
- <para>This mode was used in the testing procedure of &PRODUCT; 4.0.0 incubating release. See the following screencast to see how: <ulink url="http://vimeo.com/54621457">http://vimeo.com/54621457</ulink></para>
- </listitem>
- <listitem>
- <para>A host-only mode. Where DevCloud is used only as a host. &PRODUCT; management server is run in the localhost of the developer</para>
- <para>This mode makes use of a host-only interface defined in the Virtual Box preferences. Check the following screencast to see how: <ulink url="http://vimeo.com/54610161">http://vimeo.com/54610161</ulink></para>
- <para>The following schematic shows the architecture of the Host-Only mode.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/DevCloud-hostonly.png" scale="50"/>
- </imageobject>
- <textobject>
- <phrase>DevCloud-hostonly.png: Schematic of the DevCloud host-only architecture </phrase>
- </textobject>
- </mediaobject>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/devcloud.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/devcloud.xml b/docs/en-US/devcloud.xml
deleted file mode 100644
index 6778187..0000000
--- a/docs/en-US/devcloud.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="devcloud">
- <title>DevCloud</title>
- <para>DevCloud is the &PRODUCT; sandbox. It is provided as a Virtual Box appliance. It is meant to be used as a development environment to easily test new &PRODUCT; development. It has also been used for training and &PRODUCT; demos since it provides a <emphasis>Cloud in a box</emphasis>.</para>
- <note>
- <para>DevCloud is provided as a convenience by community members. It is not an official &PRODUCT; release artifact.</para>
- <para>The &PRODUCT; source code however, contains tools to build your own DevCloud.</para>
- </note>
- <warning>
- <para>DevCloud is under development and should be considered a Work In Progress (WIP), the wiki is the most up to date documentation:</para>
- <para><ulink url="https://cwiki.apache.org/confluence/display/CLOUDSTACK/DevCloud"></ulink></para>
- </warning>
- <xi:include href="devcloud-usage-mode.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="building-devcloud.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/developer-getting-started.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/developer-getting-started.xml b/docs/en-US/developer-getting-started.xml
deleted file mode 100644
index 1456028..0000000
--- a/docs/en-US/developer-getting-started.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="getting-started">
- <title>Getting Started</title>
- <para>
- To get started using the &PRODUCT; API, you should have the following:</para>
- <itemizedlist>
- <listitem><para>URL of the &PRODUCT; server you wish to integrate with.</para></listitem>
- <listitem><para>Both the API Key and Secret Key for an account. This should have been generated by the administrator of the cloud instance and given to you.</para></listitem>
- <listitem><para>Familiarity with HTTP GET/POST and query strings.</para></listitem>
- <listitem><para>Knowledge of either XML or JSON.</para></listitem>
- <listitem><para>Knowledge of a programming language that can generate HTTP requests; for example, Java or PHP.</para></listitem>
- </itemizedlist>
- </section>
-
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/developer-introduction.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/developer-introduction.xml b/docs/en-US/developer-introduction.xml
deleted file mode 100644
index 9d54f31..0000000
--- a/docs/en-US/developer-introduction.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.
--->
-
-<chapter id="developer-introduction">
- <title>Introduction to the &PRODUCT; API</title>
- <xi:include href="roles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="api-reference.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="developer-getting-started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/disable-enable-zones-pods-clusters.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/disable-enable-zones-pods-clusters.xml b/docs/en-US/disable-enable-zones-pods-clusters.xml
deleted file mode 100644
index 7d52ae7..0000000
--- a/docs/en-US/disable-enable-zones-pods-clusters.xml
+++ /dev/null
@@ -1,53 +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="disable-enable-zones-pods-clusters">
- <title>Disabling and Enabling Zones, Pods, and Clusters</title>
- <para>You can enable or disable a zone, pod, or cluster without permanently removing it from the cloud. This is useful for maintenance or when there are problems that make a portion of the cloud infrastructure unreliable. No new allocations will be made to a disabled zone, pod, or cluster until its state is returned to Enabled. When a zone, pod, or cluster is first added to the cloud, it is Disabled by default.</para>
- <para>To disable and enable a zone, pod, or cluster:</para>
- <orderedlist>
- <listitem><para>Log in to the &PRODUCT; UI as administrator</para></listitem>
- <listitem><para>In the left navigation bar, click Infrastructure.</para>
- </listitem>
- <listitem><para>In Zones, click View More.</para>
- </listitem>
- <listitem><para>If you are disabling or enabling a zone, find the name of the zone in the list, and click the Enable/Disable button.<inlinemediaobject>
- <imageobject>
- <imagedata fileref="./images/enable-disable.png" />
- </imageobject>
- <textobject><phrase>enable-disable.png: button to enable or disable zone, pod, or cluster.</phrase></textobject>
- </inlinemediaobject>
- </para></listitem>
- <listitem><para>If you are disabling or enabling a pod or cluster, click the name of the zone that contains the pod or cluster.</para></listitem>
- <listitem><para>Click the Compute tab.</para>
- </listitem>
- <listitem><para>In the Pods or Clusters node of the diagram, click View All.</para>
- </listitem>
- <listitem><para>Click the pod or cluster name in the list.</para></listitem>
- <listitem><para>Click the Enable/Disable button.
- <inlinemediaobject><imageobject>
- <imagedata fileref="./images/enable-disable.png" />
- </imageobject></inlinemediaobject></para></listitem>
- </orderedlist>
- </section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/disk-volume-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/disk-volume-usage-record-format.xml b/docs/en-US/disk-volume-usage-record-format.xml
deleted file mode 100644
index c15d979..0000000
--- a/docs/en-US/disk-volume-usage-record-format.xml
+++ /dev/null
@@ -1,38 +0,0 @@
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<section id="disk-volume-usage-record-format">
- <title>Disk Volume Usage Record Format</title>
- <para>For disk volumes, the following fields exist in a usage record.</para>
- <itemizedlist>
- <listitem><para>account – name of the account</para></listitem>
- <listitem><para>accountid – ID of the account</para></listitem>
- <listitem><para>domainid – ID of the domain in which this account resides</para></listitem>
- <listitem><para>zoneid – Zone where the usage occurred</para></listitem>
- <listitem><para>description – A string describing what the usage record is tracking</para></listitem>
- <listitem><para>usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for hours)</para></listitem>
- <listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
- <listitem><para>rawusage – A number representing the actual usage in hours</para></listitem>
- <listitem><para>usageid – The volume ID</para></listitem>
- <listitem><para>offeringid – The ID of the disk offering</para></listitem>
- <listitem><para>type – Hypervisor</para></listitem>
- <listitem><para>templateid – ROOT template ID</para></listitem>
- <listitem><para>size – The amount of storage allocated</para></listitem>
- <listitem><para>startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
- </itemizedlist>
- </section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/dns-dhcp.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/dns-dhcp.xml b/docs/en-US/dns-dhcp.xml
deleted file mode 100644
index 2359e83..0000000
--- a/docs/en-US/dns-dhcp.xml
+++ /dev/null
@@ -1,28 +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="dns-dhcp">
- <title>DNS and DHCP</title>
- <para>The Virtual Router provides DNS and DHCP services to the guests. It proxies DNS requests to the DNS server configured on the Availability Zone.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/domains.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/domains.xml b/docs/en-US/domains.xml
deleted file mode 100644
index f348fe8..0000000
--- a/docs/en-US/domains.xml
+++ /dev/null
@@ -1,28 +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="domains">
- <title>Domains</title>
- <para>If the LDAP server requires SSL, you need to enable it in the ldapConfig command by setting the parameters ssl, truststore, and truststorepass. Before enabling SSL for ldapConfig, you need to get the certificate which the LDAP server is using and add it to a trusted keystore. You will need to know the path to the keystore and the password.</para>
- </section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/egress-firewall-rule.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/egress-firewall-rule.xml b/docs/en-US/egress-firewall-rule.xml
deleted file mode 100644
index 93d5a81..0000000
--- a/docs/en-US/egress-firewall-rule.xml
+++ /dev/null
@@ -1,168 +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="egress-firewall-rule">
- <title>Egress Firewall Rules in an Advanced Zone</title>
- <para>The egress traffic originates from a private network to a public network, such as the
- Internet. By default, the egress traffic is blocked in default network offerings, so no outgoing
- traffic is allowed from a guest network to the Internet. However, you can control the egress
- traffic in an Advanced zone by creating egress firewall rules. When an egress firewall rule is
- applied, the traffic specific to the rule is allowed and the remaining traffic is blocked. When
- all the firewall rules are removed the default policy, Block, is applied.</para>
- <section id="prereq-egress">
- <title>Prerequisites and Guidelines</title>
- <para>Consider the following scenarios to apply egress firewall rules:</para>
- <itemizedlist>
- <listitem>
- <para>Egress firewall rules are supported on Juniper SRX and virtual router.</para>
- </listitem>
- <listitem>
- <para>The egress firewall rules are not supported on shared networks.</para>
- </listitem>
- <listitem>
- <para>Allow the egress traffic from specified source CIDR. The Source CIDR is part of guest
- network CIDR.</para>
- </listitem>
- <listitem>
- <para>Allow the egress traffic with protocol TCP,UDP,ICMP, or ALL.</para>
- </listitem>
- <listitem>
- <para>Allow the egress traffic with protocol and destination port range. The port range is
- specified for TCP, UDP or for ICMP type and code.</para>
- </listitem>
- <listitem>
- <para>The default policy is Allow for the new network offerings, whereas on upgrade existing
- network offerings with firewall service providers will have the default egress policy
- Deny.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section>
- <title>Configuring an Egress Firewall Rule</title>
- <orderedlist>
- <listitem>
- <para>Log in to the &PRODUCT; UI as an administrator or end user. </para>
- </listitem>
- <listitem>
- <para>In the left navigation, choose Network.</para>
- </listitem>
- <listitem>
- <para>In Select view, choose Guest networks, then click the Guest network you want.</para>
- </listitem>
- <listitem>
- <para>To add an egress rule, click the Egress rules tab and fill out the following fields to
- specify what type of traffic is allowed to be sent out of VM instances in this guest
- network:</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/egress-firewall-rule.png"/>
- </imageobject>
- <textobject>
- <phrase>egress-firewall-rule.png: adding an egress firewall rule</phrase>
- </textobject>
- </mediaobject>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">CIDR</emphasis>: (Add by CIDR only) To send traffic only to
- the IP addresses within a particular address block, enter a CIDR or a comma-separated
- list of CIDRs. The CIDR is the base IP address of the destination. For example,
- 192.168.0.0/22. To allow all CIDRs, set to 0.0.0.0/0.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Protocol</emphasis>: The networking protocol that VMs uses
- to send outgoing traffic. The TCP and UDP protocols are typically used for data
- exchange and end-user communications. The ICMP protocol is typically used to send
- error messages or network monitoring data.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Start Port, End Port</emphasis>: (TCP, UDP only) A range of
- listening ports that are the destination for the outgoing traffic. If you are opening
- a single port, use the same number in both fields.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">ICMP Type, ICMP Code</emphasis>: (ICMP only) The type of
- message and error code that are sent.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Click Add.</para>
- </listitem>
- </orderedlist>
- </section>
- <section id="default-egress-policy">
- <title>Configuring the Default Egress Policy</title>
- <para>The default egress policy for Isolated guest network is configured by using Network
- offering. Use the create network offering option to determine whether the default policy
- should be block or allow all the traffic to the public network from a guest network. Use this
- network offering to create the network. If no policy is specified, by default all the traffic
- is allowed from the guest network that you create by using this network offering.</para>
- <para>You have two options: Allow and Deny.</para>
- <formalpara>
- <title>Allow</title>
- <para>If you select Allow for a network offering, by default egress traffic is allowed.
- However, when an egress rule is configured for a guest network, rules are applied to block
- the specified traffic and rest are allowed. If no egress rules are configured for the
- network, egress traffic is accepted.</para>
- </formalpara>
- <formalpara>
- <title>Deny</title>
- <para>If you select Deny for a network offering, by default egress traffic for the guest
- network is blocked. However, when an egress rules is configured for a guest network, rules
- are applied to allow the specified traffic. While implementing a guest network, &PRODUCT;
- adds the firewall egress rule specific to the default egress policy for the guest
- network.</para>
- </formalpara>
- <para>This feature is supported only on virtual router and Juniper SRX.</para>
- <orderedlist>
- <listitem>
- <para>Create a network offering with your desirable default egress policy:</para>
- <orderedlist numeration="loweralpha">
- <listitem>
- <para>Log in with admin privileges to the &PRODUCT; UI.</para>
- </listitem>
- <listitem>
- <para>In the left navigation bar, click Service Offerings.</para>
- </listitem>
- <listitem>
- <para>In Select Offering, choose Network Offering.</para>
- </listitem>
- <listitem>
- <para>Click Add Network Offering.</para>
- </listitem>
- <listitem>
- <para>In the dialog, make necessary choices, including firewall provider.</para>
- </listitem>
- <listitem>
- <para>In the Default egress policy field, specify the behaviour.</para>
- </listitem>
- <listitem>
- <para>Click OK.</para>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- <para>Create an isolated network by using this network offering.</para>
- <para>Based on your selection, the network will have the egress public traffic blocked or
- allowed.</para>
- </listitem>
- </orderedlist>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/elastic-ip.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/elastic-ip.xml b/docs/en-US/elastic-ip.xml
deleted file mode 100644
index 8ecbd75..0000000
--- a/docs/en-US/elastic-ip.xml
+++ /dev/null
@@ -1,103 +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="elastic-ip">
- <title>About Elastic IP</title>
- <para>Elastic IP (EIP) addresses are the IP addresses that are associated with an account, and act
- as static IP addresses. The account owner has the complete control over the Elastic IP addresses
- that belong to the account. As an account owner, you can allocate an Elastic IP to a VM of your
- choice from the EIP pool of your account. Later if required you can reassign the IP address to a
- different VM. This feature is extremely helpful during VM failure. Instead of replacing the VM
- which is down, the IP address can be reassigned to a new VM in your account. </para>
- <para>Similar to the public IP address, Elastic IP addresses are mapped to their associated
- private IP addresses by using StaticNAT. The EIP service is equipped with StaticNAT (1:1)
- service in an EIP-enabled basic zone. The default network offering,
- DefaultSharedNetscalerEIPandELBNetworkOffering, provides your network with EIP and ELB network
- services if a NetScaler device is deployed in your zone. Consider the following illustration for
- more details.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/eip-ns-basiczone.png"/>
- </imageobject>
- <textobject>
- <phrase>eip-ns-basiczone.png: Elastic IP in a NetScaler-enabled Basic Zone.</phrase>
- </textobject>
- </mediaobject>
- <para>In the illustration, a NetScaler appliance is the default entry or exit point for the
- &PRODUCT; instances, and firewall is the default entry or exit point for the rest of the data
- center. Netscaler provides LB services and staticNAT service to the guest networks. The guest
- traffic in the pods and the Management Server are on different subnets / VLANs. The policy-based
- routing in the data center core switch sends the public traffic through the NetScaler, whereas
- the rest of the data center goes through the firewall. </para>
- <para>The EIP work flow is as follows:</para>
- <itemizedlist>
- <listitem>
- <para>When a user VM is deployed, a public IP is automatically acquired from the pool of
- public IPs configured in the zone. This IP is owned by the VM's account.</para>
- </listitem>
- <listitem>
- <para>Each VM will have its own private IP. When the user VM starts, Static NAT is provisioned
- on the NetScaler device by using the Inbound Network Address Translation (INAT) and Reverse
- NAT (RNAT) rules between the public IP and the private IP.</para>
- <note>
- <para>Inbound NAT (INAT) is a type of NAT supported by NetScaler, in which the destination
- IP address is replaced in the packets from the public network, such as the Internet, with
- the private IP address of a VM in the private network. Reverse NAT (RNAT) is a type of NAT
- supported by NetScaler, in which the source IP address is replaced in the packets
- generated by a VM in the private network with the public IP address.</para>
- </note>
- </listitem>
- <listitem>
- <para>This default public IP will be released in two cases:</para>
- <itemizedlist>
- <listitem>
- <para>When the VM is stopped. When the VM starts, it again receives a new public IP, not
- necessarily the same one allocated initially, from the pool of Public IPs.</para>
- </listitem>
- <listitem>
- <para>The user acquires a public IP (Elastic IP). This public IP is associated with the
- account, but will not be mapped to any private IP. However, the user can enable Static
- NAT to associate this IP to the private IP of a VM in the account. The Static NAT rule
- for the public IP can be disabled at any time. When Static NAT is disabled, a new public
- IP is allocated from the pool, which is not necessarily be the same one allocated
- initially.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- <para>For the deployments where public IPs are limited resources, you have the flexibility to
- choose not to allocate a public IP by default. You can use the Associate Public IP option to
- turn on or off the automatic public IP assignment in the EIP-enabled Basic zones. If you turn
- off the automatic public IP assignment while creating a network offering, only a private IP is
- assigned to a VM when the VM is deployed with that network offering. Later, the user can acquire
- an IP for the VM and enable static NAT.</para>
- <para condition="admin">For more information on the Associate Public IP option, see <xref
- linkend="creating-network-offerings"/>.</para>
- <para condition="install">For more information on the Associate Public IP option, see the
- Administration Guide.</para>
- <note>
- <para>The Associate Public IP feature is designed only for use with user VMs. The System VMs
- continue to get both public IP and private by default, irrespective of the network offering
- configuration.</para>
- </note>
- <para>New deployments which use the default shared network offering with EIP and ELB services to
- create a shared network in the Basic zone will continue allocating public IPs to each user
- VM.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/enable-disable-static-nat-vpc.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/enable-disable-static-nat-vpc.xml b/docs/en-US/enable-disable-static-nat-vpc.xml
deleted file mode 100644
index 467a304..0000000
--- a/docs/en-US/enable-disable-static-nat-vpc.xml
+++ /dev/null
@@ -1,112 +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="enable-disable-static-nat-vpc">
- <title>Enabling or Disabling Static NAT on a VPC</title>
- <para>A static NAT rule maps a public IP address to the private IP address of a VM in a VPC to
- allow Internet traffic to it. This section tells how to enable or disable static NAT for a
- particular IP address in a VPC.</para>
- <para>If port forwarding rules are already in effect for an IP address, you cannot enable static
- NAT to that IP.</para>
- <para>If a guest VM is part of more than one network, static NAT rules will function only if they
- are defined on the default network.</para>
- <orderedlist>
- <listitem>
- <para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
- </listitem>
- <listitem>
- <para>In the left navigation, choose Network.</para>
- </listitem>
- <listitem>
- <para>In the Select view, select VPC.</para>
- <para>All the VPCs that you have created for the account is listed in the page.</para>
- </listitem>
- <listitem>
- <para>Click the Configure button of the VPC to which you want to deploy the VMs.</para>
- <para>The VPC page is displayed where all the tiers you created are listed in a
- diagram.</para>
- <para>For each tier, the following options are displayed.</para>
- <itemizedlist>
- <listitem>
- <para>Internal LB</para>
- </listitem>
- <listitem>
- <para>Public LB IP</para>
- </listitem>
- <listitem>
- <para>Static NAT</para>
- </listitem>
- <listitem>
- <para>Virtual Machines</para>
- </listitem>
- <listitem>
- <para>CIDR</para>
- </listitem>
- </itemizedlist>
- <para>The following router information is displayed:</para>
- <itemizedlist>
- <listitem>
- <para>Private Gateways</para>
- </listitem>
- <listitem>
- <para>Public IP Addresses</para>
- </listitem>
- <listitem>
- <para>Site-to-Site VPNs</para>
- </listitem>
- <listitem>
- <para>Network ACL Lists</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>In the Router node, select Public IP Addresses.</para>
- <para>The IP Addresses page is displayed.</para>
- </listitem>
- <listitem>
- <para>Click the IP you want to work with.</para>
- </listitem>
- <listitem>
- <para>In the Details tab,click the Static NAT button.<inlinemediaobject>
- <imageobject>
- <imagedata fileref="./images/enable-disable.png"/>
- </imageobject>
- <textobject>
- <phrase>enable-disable.png: button to enable Static NAT.</phrase>
- </textobject>
- </inlinemediaobject>The button toggles between Enable and Disable, depending on whether
- static NAT is currently enabled for the IP address.</para>
- </listitem>
- <listitem>
- <para>If you are enabling static NAT, a dialog appears as follows:</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/select-vm-staticnat-vpc.png"/>
- </imageobject>
- <textobject>
- <phrase>select-vmstatic-nat.png: selecting a tier to apply staticNAT.</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- <listitem>
- <para>Select the tier and the destination VM, then click Apply.</para>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/enable-disable-static-nat.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/enable-disable-static-nat.xml b/docs/en-US/enable-disable-static-nat.xml
deleted file mode 100644
index 0154dca..0000000
--- a/docs/en-US/enable-disable-static-nat.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="enable-disable-static-nat">
- <title>Enabling or Disabling Static NAT</title>
- <para>If port forwarding rules are already in effect for an IP address, you cannot enable static NAT to that IP.</para>
- <para>If a guest VM is part of more than one network, static NAT rules will function only if they are defined on the default network.</para>
- <orderedlist>
- <listitem><para>Log in to the &PRODUCT; UI as an administrator or end user.</para></listitem>
- <listitem><para>In the left navigation, choose Network.</para></listitem>
- <listitem><para>Click the name of the network where you want to work with.</para></listitem>
- <listitem><para>Click View IP Addresses.</para></listitem>
- <listitem><para>Click the IP address you want to work with.</para>
- </listitem>
- <listitem><para>Click the Static NAT <inlinemediaobject>
- <imageobject>
- <imagedata fileref="./images/enable-disable.png"/>
- </imageobject>
- <textobject>
- <phrase>ReleaseIPButton.png: button to release an IP</phrase>
- </textobject>
- </inlinemediaobject>button.</para><para>The button toggles between Enable and Disable, depending on whether static NAT is currently enabled for the IP address.</para></listitem>
- <listitem><para>If you are enabling static NAT, a dialog appears where you can choose the destination VM and
- click Apply.</para></listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/enable-security-groups.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/enable-security-groups.xml b/docs/en-US/enable-security-groups.xml
deleted file mode 100644
index c957310..0000000
--- a/docs/en-US/enable-security-groups.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="enable-security-groups">
- <title>Enabling Security Groups</title>
- <para>In order for security groups to function in a zone, the security groups feature must first be
- enabled for the zone. The administrator can do this when creating a new zone, by selecting a
- network offering that includes security groups. The procedure is described in Basic Zone
- Configuration in the Advanced Installation Guide. The administrator can not enable security
- groups for an existing zone, only when creating a new zone.</para>
-</section>
-
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/enabling-api-call-expiration.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/enabling-api-call-expiration.xml b/docs/en-US/enabling-api-call-expiration.xml
deleted file mode 100644
index cd82d3d..0000000
--- a/docs/en-US/enabling-api-call-expiration.xml
+++ /dev/null
@@ -1,40 +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="enabling-api-call-expiration">
- <title>Enabling API Call Expiration</title>
- <para>
- You can set an expiry timestamp on API calls to prevent replay attacks over non-secure channels, such as HTTP. The server tracks the expiry timestamp you have specified and rejects all the subsequent API requests that come in after this validity period.
- </para>
- <para>To enable this feature, add the following parameters to the API request:</para>
- <itemizedlist>
- <listitem><para>signatureVersion=3: If the signatureVersion parameter is missing or is not equal to 3, the expires parameter is ignored in the API request.</para></listitem>
- <listitem><para>expires=YYYY-MM-DDThh:mm:ssZ: Specifies the date and time at which the signature included in the request is expired. The timestamp is expressed in the YYYY-MM-DDThh:mm:ssZ format, as specified in the ISO 8601 standard.</para></listitem>
- </itemizedlist>
- <para>For example:</para>
- <programlisting>expires=2011-10-10T12:00:00+0530</programlisting>
- <para>A sample API request with expiration is given below:</para>
- <programlisting>http://<IPAddress>:8080/client/api?command=listZones&signatureVersion=3&expires=2011-10-10T12:00:00+0530&apiKey=miVr6X7u6bN_sdahOBpjNejPgEsT35eXq-jB8CG20YI3yaxXcgpyuaIRmFI_EJTVwZ0nUkkJbPmY3y2bciKwFQ&signature=Lxx1DM40AjcXU%2FcaiK8RAP0O1hU%3D</programlisting>
- </section>
-
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/enabling-port-8096.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/enabling-port-8096.xml b/docs/en-US/enabling-port-8096.xml
deleted file mode 100644
index 57c492e..0000000
--- a/docs/en-US/enabling-port-8096.xml
+++ /dev/null
@@ -1,37 +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="enabling-port-8096">
- <title>Enabling Port 8096</title>
- <para>
- Port 8096, which allows API calls without authentication, is closed and disabled by default on any fresh 3.0.1 installations. You can enable 8096 (or another port) for this purpose as follows:
- </para>
- <orderedlist>
- <listitem><para>Ensure that the first Management Server is installed and running.</para></listitem>
- <listitem><para>Set the global configuration parameter integration.api.port to the desired port.</para></listitem>
- <listitem><para>Restart the Management Server.</para></listitem>
- <listitem><para>On the Management Server host machine, create an iptables rule allowing access to that port.</para></listitem>
- </orderedlist>
- </section>
-
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/end-user-ui-overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/end-user-ui-overview.xml b/docs/en-US/end-user-ui-overview.xml
deleted file mode 100644
index 6ec1a25..0000000
--- a/docs/en-US/end-user-ui-overview.xml
+++ /dev/null
@@ -1,27 +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="end-user-ui-overview">
- <title>End User's UI Overview</title>
- <para>The &PRODUCT; UI helps users of cloud infrastructure to view and use their cloud resources, including virtual machines, templates and ISOs, data volumes and snapshots, guest networks, and IP addresses. If the user is a member or administrator of one or more &PRODUCT; projects, the UI can provide a project-oriented view.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/error-handling.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/error-handling.xml b/docs/en-US/error-handling.xml
deleted file mode 100644
index 3f119bf..0000000
--- a/docs/en-US/error-handling.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="error-handling">
- <title>Error Handling</title>
- <para>If an error occurs while processing an API request, the appropriate response in the format specified is returned. Each error response consists of an error code and an error text describing what possibly can go wrong. For an example error response, see page 12.</para>
- <para>An HTTP error code of 401 is always returned if API request was rejected due to bad signatures, missing API Keys, or the user simply did not have the permissions to execute the command.</para>
- </section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/event-framework.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/event-framework.xml b/docs/en-US/event-framework.xml
deleted file mode 100644
index 0f62fac..0000000
--- a/docs/en-US/event-framework.xml
+++ /dev/null
@@ -1,110 +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="event-framework">
- <title>Event Notification</title>
- <para>Event notification framework provides a means for the Management Server components to
- publish and subscribe to &PRODUCT; events. Event notification is achieved by implementing the
- concept of event bus abstraction in the Management Server. An event bus is introduced in the
- Management Server that allows the &PRODUCT; components and extension plug-ins to subscribe to the
- events by using the Advanced Message Queuing Protocol (AMQP) client. In &PRODUCT;, a default
- implementation of event bus is provided as a plug-in that uses the RabbitMQ AMQP client. The
- AMQP client pushes the published events to a compatible AMQP server. Therefore all the &PRODUCT;
- events are published to an exchange in the AMQP server. </para>
- <para>A new event for state change, resource state change, is introduced as part of Event
- notification framework. Every resource, such as user VM, volume, NIC, network, public IP,
- snapshot, and template, is associated with a state machine and generates events as part of the
- state change. That implies that a change in the state of a resource results in a state change
- event, and the event is published in the corresponding state machine on the event bus. All the
- &PRODUCT; events (alerts, action events, usage events) and the additional category of resource
- state change events, are published on to the events bus.</para>
- <formalpara>
- <title>Use Cases</title>
- <para>The following are some of the use cases:</para>
- </formalpara>
- <itemizedlist>
- <listitem>
- <para>Usage or Billing Engines: A third-party cloud usage solution can implement a plug-in
- that can connects to &PRODUCT; to subscribe to &PRODUCT; events and generate usage data. The
- usage data is consumed by their usage software.</para>
- </listitem>
- <listitem>
- <para>AMQP plug-in can place all the events on the a message queue, then a AMQP message broker
- can provide topic-based notification to the subscribers.</para>
- </listitem>
- <listitem>
- <para>Publish and Subscribe notification service can be implemented as a pluggable service in
- &PRODUCT; that can provide rich set of APIs for event notification, such as topics-based
- subscription and notification. Additionally, the pluggable service can deal with
- multi-tenancy, authentication, and authorization issues.</para>
- </listitem>
- </itemizedlist>
- <formalpara>
- <title>Configuration</title>
- <para>As a &PRODUCT; administrator, perform the following one-time configuration to enable event
- notification framework. At run time no changes can control the behaviour.</para>
- </formalpara>
- <orderedlist>
- <listitem>
- <para>Open <filename>'componentContext.xml</filename>.</para>
- </listitem>
- <listitem>
- <para>Define a bean named <filename>eventNotificationBus</filename> as follows:</para>
- <itemizedlist>
- <listitem>
- <para>name : Specify a name for the bean.</para>
- </listitem>
- <listitem>
- <para>server : The name or the IP address of the RabbitMQ AMQP server.</para>
- </listitem>
- <listitem>
- <para>port : The port on which RabbitMQ server is running.</para>
- </listitem>
- <listitem>
- <para>username : The username associated with the account to access the RabbitMQ
- server.</para>
- </listitem>
- <listitem>
- <para>password : The password associated with the username of the account to access the
- RabbitMQ server.</para>
- </listitem>
- <listitem>
- <para>exchange : The exchange name on the RabbitMQ server where &PRODUCT; events are
- published.</para>
- <para>A sample bean is given below:</para>
- <programlisting><bean id="eventNotificationBus" class="org.apache.cloudstack.mom.rabbitmq.RabbitMQEventBus">
- <property name="name" value="eventNotificationBus"/>
- <property name="server" value="127.0.0.1"/>
- <property name="port" value="5672"/>
- <property name="username" value="guest"/>
- <property name="password" value="guest"/>
- <property name="exchange" value="cloudstack-events"/>
- </bean></programlisting>
- <para>The <filename>eventNotificationBus</filename> bean represents the
- <filename>org.apache.cloudstack.mom.rabbitmq.RabbitMQEventBus</filename> class.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Restart the Management Server.</para>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/event-log-queries.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/event-log-queries.xml b/docs/en-US/event-log-queries.xml
deleted file mode 100644
index a0dcaa6..0000000
--- a/docs/en-US/event-log-queries.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="event-log-queries">
- <title>Event Log Queries</title>
- <para>Database logs can be queried from the user interface. The list of events captured by the system includes:</para>
- <itemizedlist>
- <listitem><para>Virtual machine creation, deletion, and on-going management operations</para></listitem>
- <listitem><para>Virtual router creation, deletion, and on-going management operations</para>
- </listitem>
- <listitem><para>Template creation and deletion</para></listitem>
- <listitem><para>Network/load balancer rules creation and deletion</para></listitem>
- <listitem><para>Storage volume creation and deletion</para></listitem>
- <listitem><para>User login and logout</para></listitem>
- </itemizedlist>
- </section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/event-types.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/event-types.xml b/docs/en-US/event-types.xml
deleted file mode 100644
index 5ce5857..0000000
--- a/docs/en-US/event-types.xml
+++ /dev/null
@@ -1,220 +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.
--->
-
-<appendix id="event-types">
- <title>Event Types</title>
- <informaltable frame="all">
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" />
- <colspec colname="c2" />
- <tbody>
- <row>
- <entry><para>VM.CREATE</para></entry>
- <entry><para>TEMPLATE.EXTRACT</para></entry>
- <entry><para>SG.REVOKE.INGRESS</para></entry>
- </row>
- <row>
- <entry><para>VM.DESTROY</para></entry>
- <entry><para>TEMPLATE.UPLOAD</para></entry>
- <entry><para>HOST.RECONNECT</para></entry>
- </row>
- <row>
- <entry><para>VM.START</para></entry>
- <entry><para>TEMPLATE.CLEANUP</para></entry>
- <entry><para>MAINT.CANCEL</para></entry>
- </row>
- <row>
- <entry><para>VM.STOP</para></entry>
- <entry><para>VOLUME.CREATE</para></entry>
- <entry><para>MAINT.CANCEL.PS</para></entry>
- </row>
- <row>
- <entry><para>VM.REBOOT</para></entry>
- <entry><para>VOLUME.DELETE</para></entry>
- <entry><para>MAINT.PREPARE</para></entry>
- </row>
- <row>
- <entry><para>VM.UPGRADE</para></entry>
- <entry><para>VOLUME.ATTACH</para></entry>
- <entry><para>MAINT.PREPARE.PS</para></entry>
- </row>
- <row>
- <entry><para>VM.RESETPASSWORD</para></entry>
- <entry><para>VOLUME.DETACH</para></entry>
- <entry><para>VPN.REMOTE.ACCESS.CREATE</para></entry>
- </row>
- <row>
- <entry><para>ROUTER.CREATE</para></entry>
- <entry><para>VOLUME.UPLOAD</para></entry>
- <entry><para>VPN.USER.ADD</para></entry>
- </row>
- <row>
- <entry><para>ROUTER.DESTROY</para></entry>
- <entry><para>SERVICEOFFERING.CREATE</para></entry>
- <entry><para>VPN.USER.REMOVE</para></entry>
- </row>
- <row>
- <entry><para>ROUTER.START</para></entry>
- <entry><para>SERVICEOFFERING.UPDATE</para></entry>
- <entry><para>NETWORK.RESTART</para></entry>
- </row>
- <row>
- <entry><para>ROUTER.STOP</para></entry>
- <entry><para>SERVICEOFFERING.DELETE</para></entry>
- <entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
- </row>
- <row>
- <entry><para>ROUTER.REBOOT</para></entry>
- <entry><para>DOMAIN.CREATE</para></entry>
- <entry><para>UPLOAD.CUSTOM.CERTIFICATE</para></entry>
- </row>
- <row>
- <entry><para>ROUTER.HA</para></entry>
- <entry><para>DOMAIN.DELETE</para></entry>
- <entry><para>STATICNAT.DISABLE</para></entry>
- </row>
- <row>
- <entry><para>PROXY.CREATE</para></entry>
- <entry><para>DOMAIN.UPDATE</para></entry>
- <entry><para>SSVM.CREATE</para></entry>
- </row>
- <row>
- <entry><para>PROXY.DESTROY</para></entry>
- <entry><para>SNAPSHOT.CREATE</para></entry>
- <entry><para>SSVM.DESTROY</para></entry>
- </row>
- <row>
- <entry><para>PROXY.START</para></entry>
- <entry><para>SNAPSHOT.DELETE</para></entry>
- <entry><para>SSVM.START</para></entry>
- </row>
- <row>
- <entry><para>PROXY.STOP</para></entry>
- <entry><para>SNAPSHOTPOLICY.CREATE</para></entry>
- <entry><para>SSVM.STOP</para></entry>
- </row>
- <row>
- <entry><para>PROXY.REBOOT</para></entry>
- <entry><para>SNAPSHOTPOLICY.UPDATE</para></entry>
- <entry><para>SSVM.REBOOT</para></entry>
- </row>
- <row>
- <entry><para>PROXY.HA</para></entry>
- <entry><para>SNAPSHOTPOLICY.DELETE</para></entry>
- <entry><para>SSVM.H</para></entry>
- </row>
- <row>
- <entry><para>VNC.CONNECT</para></entry>
- <entry><para>VNC.DISCONNECT</para></entry>
- <entry><para>NET.IPASSIGN</para></entry>
- </row>
- <row>
- <entry><para>NET.IPRELEASE</para></entry>
- <entry><para>NET.RULEADD</para></entry>
- <entry><para>NET.RULEDELETE</para></entry>
- </row>
- <row>
- <entry><para>NET.RULEMODIFY</para></entry>
- <entry><para>NETWORK.CREATE</para></entry>
- <entry><para>NETWORK.DELETE</para></entry>
- </row>
- <row>
- <entry><para>LB.ASSIGN.TO.RULE</para></entry>
- <entry><para>LB.REMOVE.FROM.RULE</para></entry>
- <entry><para>LB.CREATE</para></entry>
- </row>
- <row>
- <entry><para>LB.DELETE</para></entry>
- <entry><para>LB.UPDATE</para></entry>
- <entry><para>USER.LOGIN</para></entry>
- </row>
- <row>
- <entry><para>USER.LOGOUT</para></entry>
- <entry><para>USER.CREATE</para></entry>
- <entry><para>USER.DELETE</para></entry>
- </row>
- <row>
- <entry><para>USER.UPDATE</para></entry>
- <entry><para>USER.DISABLE</para></entry>
- <entry><para>TEMPLATE.CREATE</para></entry>
- </row>
- <row>
- <entry><para>TEMPLATE.DELETE</para></entry>
- <entry><para>TEMPLATE.UPDATE</para></entry>
- <entry><para>TEMPLATE.COPY</para></entry>
- </row>
- <row>
- <entry><para>TEMPLATE.DOWNLOAD.START</para></entry>
- <entry><para>TEMPLATE.DOWNLOAD.SUCCESS</para></entry>
- <entry><para>TEMPLATE.DOWNLOAD.FAILED</para></entry>
- </row>
- <row>
- <entry><para>ISO.CREATE</para></entry>
- <entry><para>ISO.DELETE</para></entry>
- <entry><para>ISO.COPY</para></entry>
- </row>
- <row>
- <entry><para>ISO.ATTACH</para></entry>
- <entry><para>ISO.DETACH</para></entry>
- <entry><para>ISO.EXTRACT</para></entry>
- </row>
- <row>
- <entry><para>ISO.UPLOAD</para></entry>
- <entry><para>SERVICE.OFFERING.CREATE</para></entry>
- <entry><para>SERVICE.OFFERING.EDIT</para></entry>
- </row>
- <row>
- <entry><para>SERVICE.OFFERING.DELETE</para></entry>
- <entry><para>DISK.OFFERING.CREATE</para></entry>
- <entry><para>DISK.OFFERING.EDIT</para></entry>
- </row>
- <row>
- <entry><para>DISK.OFFERING.DELETE</para></entry>
- <entry><para>NETWORK.OFFERING.CREATE</para></entry>
- <entry><para>NETWORK.OFFERING.EDIT</para></entry>
- </row>
- <row>
- <entry><para>NETWORK.OFFERING.DELETE</para></entry>
- <entry><para>POD.CREATE</para></entry>
- <entry><para>POD.EDIT</para></entry>
- </row>
- <row>
- <entry><para>POD.DELETE</para></entry>
- <entry><para>ZONE.CREATE</para></entry>
- <entry><para>ZONE.EDIT</para></entry>
- </row>
- <row>
- <entry><para>ZONE.DELETE</para></entry>
- <entry><para>VLAN.IP.RANGE.CREATE</para></entry>
- <entry><para>VLAN.IP.RANGE.DELETE</para></entry>
- </row>
- <row>
- <entry><para>CONFIGURATION.VALUE.EDIT</para></entry>
- <entry><para>SG.AUTH.INGRESS</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/events-log.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/events-log.xml b/docs/en-US/events-log.xml
deleted file mode 100644
index fa97db4..0000000
--- a/docs/en-US/events-log.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="events-log">
- <title>Event Logs</title>
- <para>There are two types of events logged in the &PRODUCT; Event Log. Standard events log
- the success or failure of an event and can be used to identify jobs or processes that have
- failed. There are also long running job events. Events for asynchronous jobs log when a job
- is scheduled, when it starts, and when it completes. Other long running synchronous jobs log
- when a job starts, and when it completes. Long running synchronous and asynchronous event
- logs can be used to gain more information on the status of a pending job or can be used to
- identify a job that is hanging or has not started. The following sections provide more
- information on these events..</para>
-</section>
-
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/events.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/events.xml b/docs/en-US/events.xml
deleted file mode 100644
index 3b93ee0..0000000
--- a/docs/en-US/events.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="events">
- <title>Events</title>
- <para>An event is essentially a significant or meaningful change in the state of both virtual and
- physical resources associated with a cloud environment. Events are used by monitoring systems,
- usage and billing systems, or any other event-driven workflow systems to discern a pattern and
- make the right business decision. In &PRODUCT; an event could be a state change of virtual or
- physical resources, an action performed by an user (action events), or policy based events
- (alerts).</para>
- <xi:include href="events-log.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="event-framework.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="standard-events.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="long-running-job-events.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="event-log-queries.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="delete-event-alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/example-activedirectory-configuration.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/example-activedirectory-configuration.xml b/docs/en-US/example-activedirectory-configuration.xml
deleted file mode 100644
index 5a8178d..0000000
--- a/docs/en-US/example-activedirectory-configuration.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="example-activedirectory-configuration">
- <title>Example LDAP Configuration for Active Directory</title>
- <para>This shows the configuration settings required for using ActiveDirectory.</para>
- <itemizedlist>
- <listitem><para>samAccountName - Logon name</para></listitem>
- <listitem><para>mail - Email Address</para></listitem>
- <listitem><para>cn - Real name</para></listitem>
- </itemizedlist>
- <para>Along with this the ldap.user.object name needs to be modified, by default ActiveDirectory uses the value "user" for this.</para>
- <para>Map the following attributes accordingly as shown below:</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/add-ldap-configuration-ad.png"/>
- </imageobject>
- <textobject>
- <phrase>add-ldap-configuration-ad.png: example configuration for active directory.</phrase>
- </textobject>
- </mediaobject>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/example-openldap-configuration.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/example-openldap-configuration.xml b/docs/en-US/example-openldap-configuration.xml
deleted file mode 100644
index aa57a00..0000000
--- a/docs/en-US/example-openldap-configuration.xml
+++ /dev/null
@@ -1,44 +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="example-openldap-configuration">
- <title>Example LDAP Configuration for OpenLdap</title>
- <para>This shows the configuration settings required for using OpenLDAP.</para>
- <para>The default values supplied are suited for OpenLDAP.</para>
- <itemizedlist>
- <listitem><para>uid - Logon name</para></listitem>
- <listitem><para>mail - Email Address</para></listitem>
- <listitem><para>cn - Real name</para></listitem>
- </itemizedlist>
- <para>Along with this the ldap.user.object name needs to be modified, by default OpenLDAP uses the value "inetOrgPerson" for this.</para>
- <para>Map the following attributes accordingly as shown below within the cloudstack ldap configuration:</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/add-ldap-configuration-openldap.png"/>
- </imageobject>
- <textobject>
- <phrase>add-ldap-configuration-openldap.png: example configuration for OpenLdap.</phrase>
- </textobject>
- </mediaobject>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/example-response-from-listUsageRecords.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/example-response-from-listUsageRecords.xml b/docs/en-US/example-response-from-listUsageRecords.xml
deleted file mode 100644
index e0d7924..0000000
--- a/docs/en-US/example-response-from-listUsageRecords.xml
+++ /dev/null
@@ -1,56 +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="example-response-from-listUsageRecords">
- <title>Example response from listUsageRecords</title>
- <para>
- All &PRODUCT; API requests are submitted in the form of a HTTP GET/POST with an associated command and any parameters. A request is composed of the following whether in HTTP or HTTPS:</para>
-
- <programlisting>
- <listusagerecordsresponse>
- <count>1816</count>
- <usagerecord>
- <account>user5</account>
- <accountid>10004</accountid>
- <domainid>1</domainid>
- <zoneid>1</zoneid>
- <description>i-3-4-WC running time (ServiceOffering: 1) (Template: 3)</description>
- <usage>2.95288 Hrs</usage>
- <usagetype>1</usagetype>
- <rawusage>2.95288</rawusage>
- <virtualmachineid>4</virtualmachineid>
- <name>i-3-4-WC</name>
- <offeringid>1</offeringid>
- <templateid>3</templateid>
- <usageid>245554</usageid>
- <type>XenServer</type>
- <startdate>2009-09-15T00:00:00-0700</startdate>
- <enddate>2009-09-18T16:14:26-0700</enddate>
- </usagerecord>
-
- … (1,815 more usage records)
- </listusagerecordsresponse>
- </programlisting>
- </section>
-
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/export-template.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/export-template.xml b/docs/en-US/export-template.xml
deleted file mode 100644
index c225e36..0000000
--- a/docs/en-US/export-template.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="export-template">
- <title>Exporting Templates</title>
- <para>End users and Administrators may export templates from the &PRODUCT;. Navigate to the template in the UI and choose the Download function from the Actions menu.</para>
-
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/external-firewalls-and-load-balancers.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/external-firewalls-and-load-balancers.xml b/docs/en-US/external-firewalls-and-load-balancers.xml
deleted file mode 100644
index 42ecacf..0000000
--- a/docs/en-US/external-firewalls-and-load-balancers.xml
+++ /dev/null
@@ -1,34 +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="external-firewalls-and-load-balancers">
- <title>External Firewalls and Load Balancers</title>
- <para>&PRODUCT; is capable of replacing its Virtual Router with an external Juniper SRX device and
- an optional external NetScaler or F5 load balancer for gateway and load balancing services. In
- this case, the VMs use the SRX as their gateway.</para>
- <xi:include href="using-netscaler-load-balancers.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="configure-snmp-rhel.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="initial-setup-of-external-firewalls-loadbalancers.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="ongoing-config-of-external-firewalls-lb.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="load-balancer-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="autoscale.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>