You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by se...@apache.org on 2015/10/01 16:04:40 UTC
[30/51] [partial] cloudstack-docs git commit: Remove all old docbook
files
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/installation-steps-overview.xml
----------------------------------------------------------------------
diff --git a/en-US/installation-steps-overview.xml b/en-US/installation-steps-overview.xml
deleted file mode 100644
index ea00057..0000000
--- a/en-US/installation-steps-overview.xml
+++ /dev/null
@@ -1,67 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<section id="installation-steps-overview">
- <title>Overview of Installation Steps</title>
- <para>For anything more than a simple trial installation, you will need guidance for a variety of configuration choices. It is strongly recommended that you read the following:</para>
- <itemizedlist>
- <listitem><para>Choosing a Deployment Architecture</para></listitem>
- <listitem><para>Choosing a Hypervisor: Supported Features</para></listitem>
- <listitem><para>Network Setup</para></listitem>
- <listitem><para>Storage Setup</para></listitem>
- <listitem><para>Best Practices</para></listitem>
- </itemizedlist>
- <orderedlist>
- <listitem>
- <para>Make sure you have the required hardware ready. See <xref linkend="minimum-system-requirements"/></para>
- </listitem>
- <listitem>
- <para>Install the Management Server (choose single-node or multi-node). See <xref linkend="management-server-install-flow"/></para>
- </listitem>
- <listitem>
- <para>Log in to the UI. See <xref linkend="ui"/></para>
- </listitem>
- <listitem>
- <para>Add a zone. Includes the first pod, cluster, and host. See <xref linkend="zone-add"/></para>
- </listitem>
- <listitem>
- <para>Add more pods (optional). See <xref linkend="pod-add"/></para>
- </listitem>
- <listitem>
- <para>Add more clusters (optional). See <xref linkend="cluster-add"/></para>
- </listitem>
- <listitem>
- <para>Add more hosts (optional). See <xref linkend="host-add"/></para>
- </listitem>
- <listitem>
- <para>Add more primary storage (optional). See <xref linkend="primary-storage-add"/></para>
- </listitem>
- <listitem>
- <para>Add more secondary storage (optional). See <xref linkend="secondary-storage-add"/></para>
- </listitem>
- <listitem>
- <para>Try using the cloud. See <xref linkend="initialize-and-test"/></para>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/installation.xml
----------------------------------------------------------------------
diff --git a/en-US/installation.xml b/en-US/installation.xml
deleted file mode 100644
index 5fc550e..0000000
--- a/en-US/installation.xml
+++ /dev/null
@@ -1,32 +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="installation">
- <title>Installation</title>
- <xi:include href="who-should-read-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="installation-steps-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="minimum-system-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="configure-package-repository.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="management-server-install-flow.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/installation_steps_overview.xml
----------------------------------------------------------------------
diff --git a/en-US/installation_steps_overview.xml b/en-US/installation_steps_overview.xml
deleted file mode 100644
index 2632a4d..0000000
--- a/en-US/installation_steps_overview.xml
+++ /dev/null
@@ -1,84 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<section id="installation_steps_overview">
- <title>Overview of Installation Steps</title>
- <para>For anything more than a simple trial installation, you will need
- guidance for a variety of configuration choices. It is strongly
- recommended that you read the following:</para>
- <itemizedlist>
- <listitem><para>Choosing a Deployment Architecture</para></listitem>
- <listitem><para>Choosing a Hypervisor: Supported Features</para></listitem>
- <listitem><para>Network Setup</para></listitem>
- <listitem><para>Storage Setup</para></listitem>
- <listitem><para>Best Practices</para></listitem>
- </itemizedlist>
- <orderedlist>
- <listitem>
- <para>
- <emphasis role="bold">Prepare</emphasis>
- </para>
- <para>Make sure you have the required hardware ready</para>
- </listitem>
- <listitem>
- <para>(Optional) Fill out the preparation checklists</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Install the &PRODUCT; software</emphasis></para>
- </listitem>
- <listitem>
- <para>Install the Management Server (choose single-node or multi-node)</para>
- </listitem>
- <listitem>
- <para>Log in to the UI</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Provision your cloud infrastructure</emphasis></para>
- </listitem>
- <listitem>
- <para>Add a zone. Includes the first pod, cluster, and host</para>
- </listitem>
- <listitem>
- <para>Add more pods</para>
- </listitem>
- <listitem>
- <para>Add more clusters</para>
- </listitem>
- <listitem>
- <para>Add more hosts</para>
- </listitem>
- <listitem>
- <para>Add more primary storage</para>
- </listitem>
- <listitem>
- <para>Add more secondary storage</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Try using the cloud</emphasis></para>
- </listitem>
- <listitem>
- <para>Initialization and testing</para>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/installing-publican.xml
----------------------------------------------------------------------
diff --git a/en-US/installing-publican.xml b/en-US/installing-publican.xml
deleted file mode 100644
index 9f180aa..0000000
--- a/en-US/installing-publican.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="installing-publican">
- <title>Installing Publican</title>
- <para>&PRODUCT; documentation is built using publican. This section describes how to install publican on your own machine so that you can build the documentation guides.</para>
- <note>
- <para>The &PRODUCT; documentation source code is located under <emphasis>/docs</emphasis></para>
- <para>Publican documentation itself is also very <ulink url="http://docs.fedoraproject.org/en-US/Fedora_Contributor_Documentation/1/html/Users_Guide/chap-Users_Guide-Installing_Publican.html">useful</ulink>.</para>
- </note>
- <para>On RHEL and RHEL derivatives, install publican with the following command:</para>
- <programlisting>yum install publican publican-doc</programlisting>
- <para>On Ubuntu, install publican with the following command:</para>
- <programlisting>apt-get install publican publican-doc</programlisting>
- <para>For other distribution refer to the publican documentation listed above. For latest versions of OSX you may have to install from <ulink url="https://fedorahosted.org/publican/wiki/Installing_OSX">source</ulink> and tweak it to your own setup.</para>
- <para>Once publican is installed, you need to setup the so-called &PRODUCT; brand defined in the <emphasis>docs/publican-&PRODUCT;</emphasis> directory.</para>
- <para>To do so, enter the following commands:</para>
- <programlisting>
- sudo cp -R publican-cloudstack /usr/share/publican/Common_Content/cloudstack
- </programlisting>
- <para>If this fails or you later face errors related to the brand files, see the publican <ulink url="http://docs.fedoraproject.org/en-US/Fedora_Contributor_Documentation/1/html/Users_Guide/chap-Users_Guide-Branding.html#sect-Users_Guide-Installing_a_brand">documentation</ulink>.</para>
- <para>With publican installed and the &PRODUCT; brand files in place, you should be able to build any documentation guide.</para>
-
-
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/inter-vlan-routing.xml
----------------------------------------------------------------------
diff --git a/en-US/inter-vlan-routing.xml b/en-US/inter-vlan-routing.xml
deleted file mode 100644
index 59115de..0000000
--- a/en-US/inter-vlan-routing.xml
+++ /dev/null
@@ -1,107 +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="inter-vlan-routing">
- <title>About Inter-VLAN Routing (nTier Apps)</title>
- <para>Inter-VLAN Routing (nTier Apps) is the capability to route network traffic between VLANs.
- This feature enables you to build Virtual Private Clouds (VPC), an isolated segment of your
- cloud, that can hold multi-tier applications. These tiers are deployed on different VLANs that
- can communicate with each other. You provision VLANs to the tiers your create, and VMs can be
- deployed on different tiers. The VLANs are connected to a virtual router, which facilitates
- communication between the VMs. In effect, you can segment VMs by means of VLANs into different
- networks that can host multi-tier applications, such as Web, Application, or Database. Such
- segmentation by means of VLANs logically separate application VMs for higher security and lower
- broadcasts, while remaining physically connected to the same device.</para>
- <para>This feature is supported on XenServer, KVM, and VMware hypervisors.</para>
- <para>The major advantages are:</para>
- <itemizedlist>
- <listitem>
- <para>The administrator can deploy a set of VLANs and allow users to deploy VMs on these
- VLANs. A guest VLAN is randomly alloted to an account from a pre-specified set of guest
- VLANs. All the VMs of a certain tier of an account reside on the guest VLAN allotted to that
- account.</para>
- <note>
- <para>A VLAN allocated for an account cannot be shared between multiple accounts. </para>
- </note>
- </listitem>
- <listitem>
- <para>The administrator can allow users create their own VPC and deploy the application. In
- this scenario, the VMs that belong to the account are deployed on the VLANs allotted to that
- account.</para>
- </listitem>
- <listitem>
- <para>Both administrators and users can create multiple VPCs. The guest network NIC is plugged
- to the VPC virtual router when the first VM is deployed in a tier. </para>
- </listitem>
- <listitem>
- <para>The administrator can create the following gateways to send to or receive traffic from
- the VMs:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">VPN Gateway</emphasis>: For more information, see <xref
- linkend="create-vpn-gateway-for-vpc"/>.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Public Gateway</emphasis>: The public gateway for a VPC is
- added to the virtual router when the virtual router is created for VPC. The public
- gateway is not exposed to the end users. You are not allowed to list it, nor allowed to
- create any static routes.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Private Gateway</emphasis>: For more information, see <xref
- linkend="add-gateway-vpc"/>.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Both administrators and users can create various possible destinations-gateway
- combinations. However, only one gateway of each type can be used in a deployment.</para>
- <para>For example:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">VLANs and Public Gateway</emphasis>: For example, an
- application is deployed in the cloud, and the Web application VMs communicate with the
- Internet.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">VLANs, VPN Gateway, and Public Gateway</emphasis>: For
- example, an application is deployed in the cloud; the Web application VMs communicate
- with the Internet; and the database VMs communicate with the on-premise devices.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>The administrator can define Network Access Control List (ACL) on the virtual router to
- filter the traffic among the VLANs or between the Internet and a VLAN. You can define ACL
- based on CIDR, port range, protocol, type code (if ICMP protocol is selected) and
- Ingress/Egress type.</para>
- </listitem>
- </itemizedlist>
- <para>The following figure shows the possible deployment scenarios of a Inter-VLAN setup:</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/multi-tier-app.png"/>
- </imageobject>
- <textobject>
- <phrase>mutltier.png: a multi-tier setup.</phrase>
- </textobject>
- </mediaobject>
- <para>To set up a multi-tier Inter-VLAN deployment, see <xref linkend="configure-vpc"/>.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/introduction.xml
----------------------------------------------------------------------
diff --git a/en-US/introduction.xml b/en-US/introduction.xml
deleted file mode 100644
index 9aca8bd..0000000
--- a/en-US/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.
--->
-
-<section id="introduction">
- <title>Introduction</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" />
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/ip-forwarding-firewalling.xml
----------------------------------------------------------------------
diff --git a/en-US/ip-forwarding-firewalling.xml b/en-US/ip-forwarding-firewalling.xml
deleted file mode 100644
index d1beb2e..0000000
--- a/en-US/ip-forwarding-firewalling.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="ip-forwarding-firewalling">
- <title>IP Forwarding and Firewalling</title>
- <para>By default, all incoming traffic to the public IP address is rejected. All outgoing traffic
- from the guests is also blocked by default.</para>
- <para>To allow outgoing traffic, follow the procedure in <xref linkend="egress-firewall-rule"
- />.</para>
- <para>To allow incoming traffic, users may set up firewall rules and/or port forwarding rules. For
- example, you can use a firewall rule to open a range of ports on the public IP address, such as
- 33 through 44. Then use port forwarding rules to direct traffic from individual ports within
- that range to specific ports on user VMs. For example, one port forwarding rule could route
- incoming traffic on the public IP's port 33 to port 100 on one user VM's private IP.</para>
- <xi:include href="firewall-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="egress-firewall-rule.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="port-forwarding.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/ip-load-balancing.xml
----------------------------------------------------------------------
diff --git a/en-US/ip-load-balancing.xml b/en-US/ip-load-balancing.xml
deleted file mode 100644
index ae569e7..0000000
--- a/en-US/ip-load-balancing.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="ip-load-balancing">
- <title>IP Load Balancing</title>
- <para>The user may choose to associate the same public IP for multiple guests. &PRODUCT; implements a TCP-level load balancer with the following policies.</para>
- <itemizedlist>
- <listitem><para>Round-robin</para></listitem>
- <listitem><para>Least connection</para></listitem>
- <listitem><para>Source IP</para></listitem>
- </itemizedlist>
- <para>This is similar to port forwarding but the destination may be multiple IP addresses.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/ip-vlan-tenant.xml
----------------------------------------------------------------------
diff --git a/en-US/ip-vlan-tenant.xml b/en-US/ip-vlan-tenant.xml
deleted file mode 100644
index d58d49b..0000000
--- a/en-US/ip-vlan-tenant.xml
+++ /dev/null
@@ -1,212 +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="ip-vlan-tenant">
- <title>Reserving Public IP Addresses and VLANs for Accounts</title>
- <para>&PRODUCT; provides you the ability to reserve a set of public IP addresses and VLANs
- exclusively for an account. During zone creation, you can continue defining a set of VLANs and
- multiple public IP ranges. This feature extends the functionality to enable you to dedicate a
- fixed set of VLANs and guest IP addresses for a tenant.</para>
- <para>Note that if an account has consumed all the VLANs and IPs dedicated to it, the account can
- acquire two more resources from the system. &PRODUCT; provides the root admin with two
- configuration parameter to modify this default behavior—use.system.public.ips and
- use.system.guest.vlans. These global parameters enable the root admin to disallow an account
- from acquiring public IPs and guest VLANs from the system, if the account has dedicated
- resources and these dedicated resources have all been consumed. Both these configurations are
- configurable at the account level.</para>
- <para>This feature provides you the following capabilities:</para>
- <itemizedlist>
- <listitem>
- <para>Reserve a VLAN range and public IP address range from an Advanced zone and assign it to
- an account</para>
- </listitem>
- <listitem>
- <para>Disassociate a VLAN and public IP address range from an account</para>
- </listitem>
- <listitem>
- <para>View the number of public IP addresses allocated to an account</para>
- </listitem>
- <listitem>
- <para>Check whether the required range is available and is conforms to account limits.</para>
- <para>The maximum IPs per account limit cannot be superseded.</para>
- </listitem>
- </itemizedlist>
- <section id="howto-dedicate-ip">
- <title>Dedicating IP Address Ranges to an Account</title>
- <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 All.</para>
- </listitem>
- <listitem>
- <para>Choose the zone you want to work with.</para>
- </listitem>
- <listitem>
- <para>Click the Physical Network tab.</para>
- </listitem>
- <listitem>
- <para>In the Public node of the diagram, click Configure.</para>
- </listitem>
- <listitem>
- <para>Click the IP Ranges tab.</para>
- <para>You can either assign an existing IP range to an account, or create a new IP range and
- assign to an account.</para>
- </listitem>
- <listitem>
- <para>To assign an existing IP range to an account, perform the following:</para>
- <orderedlist numeration="loweralpha">
- <listitem>
- <para>Locate the IP range you want to work with.</para>
- </listitem>
- <listitem>
- <para>Click Add Account <inlinemediaobject>
- <imageobject>
- <imagedata fileref="./images/addAccount-icon.png"/>
- </imageobject>
- <textobject>
- <phrase>addAccount-icon.png: button to assign an IP range to an account.</phrase>
- </textobject>
- </inlinemediaobject>button.</para>
- <para>The Add Account dialog is displayed.</para>
- </listitem>
- <listitem>
- <para>Specify the following:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Account</emphasis>: The account to which you want to
- assign the IP address range.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Domain</emphasis>: The domain associated with the
- account.</para>
- </listitem>
- </itemizedlist>
- <para>To create a new IP range and assign an account, perform the following:</para>
- <orderedlist numeration="loweralpha">
- <listitem>
- <para>Specify the following:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Gateway</emphasis></para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Netmask</emphasis></para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">VLAN</emphasis></para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Start IP</emphasis></para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">End IP</emphasis></para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Account</emphasis>: Perform the following:</para>
- <orderedlist numeration="lowerroman">
- <listitem>
- <para>Click Account.</para>
- <para>The Add Account page is displayed.</para>
- </listitem>
- <listitem>
- <para>Specify the following:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold"><emphasis role="bold"
- >Account</emphasis></emphasis>: The account to which you want to
- assign an IP address range.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold"><emphasis role="bold"
- >Domain</emphasis></emphasis>: The domain associated with the
- account.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Click OK.</para>
- </listitem>
- </orderedlist>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Click Add.</para>
- </listitem>
- </orderedlist>
- </listitem>
- </orderedlist>
- </listitem>
- </orderedlist>
- </section>
- <section id="howto-dedicate-vlan">
- <title>Dedicating VLAN Ranges to an Account</title>
- <orderedlist>
- <listitem>
- <para>After the &PRODUCT; Management Server is installed, 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 All.</para>
- </listitem>
- <listitem>
- <para>Choose the zone you want to work with.</para>
- </listitem>
- <listitem>
- <para>Click the Physical Network tab.</para>
- </listitem>
- <listitem>
- <para>In the Guest node of the diagram, click Configure.</para>
- </listitem>
- <listitem>
- <para>Select the Dedicated VLAN Ranges tab.</para>
- </listitem>
- <listitem>
- <para>Click Dedicate VLAN Range.</para>
- <para>The Dedicate VLAN Range dialog is displayed.</para>
- </listitem>
- <listitem>
- <para>Specify the following:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold"><emphasis role="bold">VLAN Range</emphasis></emphasis>: The
- VLAN range that you want to assign to an account.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold"><emphasis role="bold">Account</emphasis></emphasis>: The
- account to which you want to assign the selected VLAN range.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold"><emphasis role="bold">Domain</emphasis></emphasis>: The
- domain associated with the account.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </orderedlist>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/ipaddress-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/en-US/ipaddress-usage-record-format.xml b/en-US/ipaddress-usage-record-format.xml
deleted file mode 100644
index 1a0385b..0000000
--- a/en-US/ipaddress-usage-record-format.xml
+++ /dev/null
@@ -1,42 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<section id="ipaddress-usage-record-format">
- <title>IP Address Usage Record Format</title>
- <para>For IP address usage 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</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 - IP address ID</para></listitem>
- <listitem><para>startdate, enddate - The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
- <listitem><para>issourcenat - Whether source NAT is enabled for the IP address</para></listitem>
- <listitem><para>iselastic - True if the IP address is elastic.</para></listitem>
- </itemizedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/ipv6-support.xml
----------------------------------------------------------------------
diff --git a/en-US/ipv6-support.xml b/en-US/ipv6-support.xml
deleted file mode 100644
index bc14c8e..0000000
--- a/en-US/ipv6-support.xml
+++ /dev/null
@@ -1,191 +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="ipv6-support">
- <title>IPv6 Support in &PRODUCT;</title>
- <para>&PRODUCT; supports Internet Protocol version 6 (IPv6), the recent version of the Internet
- Protocol (IP) that defines routing the network traffic. IPv6 uses a 128-bit address that
- exponentially expands the current address space that is available to the users. IPv6 addresses
- consist of eight groups of four hexadecimal digits separated by colons, for example,
- 5001:0dt8:83a3:1012:1000:8s2e:0870:7454. &PRODUCT; supports IPv6 for public IPs in shared
- networks. With IPv6 support, VMs in shared networks can obtain both IPv4 and IPv6 addresses from
- the DHCP server. You can deploy VMs either in a IPv6 or IPv4 network, or in a dual network
- environment. If IPv6 network is used, the VM generates a link-local IPv6 address by itself, and
- receives a stateful IPv6 address from the DHCPv6 server.</para>
- <para>IPv6 is supported only on KVM and XenServer hypervisors. The IPv6 support is only an
- experimental feature.</para>
- <para>Here's the sequence of events when IPv6 is used: </para>
- <orderedlist>
- <listitem>
- <para>The administrator creates an IPv6 shared network in an advanced zone.</para>
- </listitem>
- <listitem>
- <para>The user deploys a VM in an IPv6 shared network.</para>
- </listitem>
- <listitem>
- <para>The user VM generates an IPv6 link local address by itself, and gets an IPv6 global or
- site local address through DHCPv6.</para>
- <para>For information on API changes, see <xref linkend="changed-apicommands-4.1"/>.</para>
- </listitem>
- </orderedlist>
- <section id="guidelines-ipv6">
- <title>Prerequisites and Guidelines</title>
- <para>Consider the following:</para>
- <itemizedlist>
- <listitem>
- <para>CIDR size must be 64 for IPv6 networks.</para>
- </listitem>
- <listitem>
- <para>The DHCP client of the guest VMs should support generating DUID based on Link-layer
- Address (DUID- LL). DUID-LL derives from the MAC address of guest VMs, and therefore the
- user VM can be identified by using DUID. See <ulink
- url="http://tools.ietf.org/html/rfc3315">Dynamic Host Configuration Protocol for IPv6
- </ulink>for more information.</para>
- </listitem>
- <listitem>
- <para>The gateway of the guest network generates Router Advisement and Response messages to
- Router Solicitation. The M (Managed Address Configuration) flag of Router Advisement
- should enable stateful IP address configuration. Set the M flag to where the end nodes
- receive their IPv6 addresses from the DHCPv6 server as opposed to the router or
- switch.</para>
- <note>
- <para>The M flag is the 1-bit Managed Address Configuration flag for Router Advisement.
- When set, Dynamic Host Configuration Protocol (DHCPv6) is available for address
- configuration in addition to any IPs set by using stateless address
- auto-configuration.</para>
- </note>
- </listitem>
- <listitem>
- <para>Use the System VM template exclusively designed to support IPv6. Download the System
- VM template from <ulink url="http://cloudstack.apt-get.eu/systemvm/"
- >http://cloudstack.apt-get.eu/systemvm/</ulink>.</para>
- </listitem>
- <listitem>
- <para>The concept of Default Network applies to IPv6 networks. However, unlike IPv4
- &PRODUCT; does not control the routing information of IPv6 in shared network; the choice
- of Default Network will not affect the routing in the user VM.</para>
- </listitem>
- <listitem>
- <para>In a multiple shared network, the default route is set by the rack router, rather than
- the DHCP server, which is out of &PRODUCT; control. Therefore, in order for the user VM to
- get only the default route from the default NIC, modify the configuration of the user VM,
- and set non-default NIC's <code>accept_ra</code> to 0 explicitly. The
- <code>accept_ra</code> parameter accepts Router Advertisements and auto-configure
- <code>/proc/sys/net/ipv6/conf/interface</code> with received data.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="limitsipv6">
- <title>Limitations of IPv6 in &PRODUCT; </title>
- <para>The following are not yet supported:</para>
- <orderedlist>
- <listitem>
- <para>Security groups</para>
- </listitem>
- <listitem>
- <para>Userdata and metadata</para>
- </listitem>
- <listitem>
- <para>Passwords</para>
- </listitem>
- </orderedlist>
- </section>
- <section id="network-conf-dhcpv6">
- <title>Guest VM Configuration for DHCPv6</title>
- <para>For the guest VMs to get IPv6 address, run dhclient command manually on each of the VMs.
- Use DUID-LL to set up dhclient. </para>
- <note><para>The IPv6 address is lost when a VM is stopped and started. Therefore, use the same procedure
- to get an IPv6 address when a VM is stopped and started.</para></note>
- <orderedlist>
- <listitem>
- <para>Set up dhclient by using DUID-LL.</para>
- <para>Perform the following for DHCP Client 4.2 and above:</para>
- <orderedlist numeration="loweralpha">
- <listitem>
- <para>Run the following command on the selected VM to get the dhcpv6 offer from
- VR:</para>
- <programlisting>dhclient -6 -D LL <dev></programlisting>
- </listitem>
- </orderedlist>
- <para>Perform the following for DHCP Client 4.1:</para>
- <orderedlist numeration="loweralpha">
- <listitem>
- <para>Open the following to the dhclient configuration file:</para>
- <programlisting>vi /etc/dhcp/dhclient.conf</programlisting>
- </listitem>
- <listitem>
- <para>Add the following to the dhclient configuration file:</para>
- <programlisting>send dhcp6.client-id = concat(00:03:00, hardware);</programlisting>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- <para>Get IPv6 address from DHCP server as part of the system or network restart.</para>
- <para>Based on the operating systems, perform the following:</para>
- <para>On CentOS 6.2:</para>
- <orderedlist numeration="loweralpha">
- <listitem>
- <para>Open the Ethernet interface configuration file:</para>
- <programlisting>vi /etc/sysconfig/network-scripts/ifcfg-eth0</programlisting>
- <para>The <code>ifcfg-eth0</code> file controls the first NIC in a system.</para>
- </listitem>
- <listitem>
- <para>Make the necessary configuration changes, as given below:</para>
- <programlisting>DEVICE=eth0
-HWADDR=06:A0:F0:00:00:38
-NM_CONTROLLED=no
-ONBOOT=yes
-BOOTPROTO=dhcp6
-TYPE=Ethernet
-USERCTL=no
-PEERDNS=yes
-IPV6INIT=yes
-DHCPV6C=yes</programlisting>
- </listitem>
- <listitem>
- <para>Open the following:</para>
- <programlisting>vi /etc/sysconfig/network</programlisting>
- </listitem>
- <listitem>
- <para>Make the necessary configuration changes, as given below:</para>
- <programlisting>NETWORKING=yes
-HOSTNAME=centos62mgmt.lab.vmops.com
-NETWORKING_IPV6=yes
-IPV6_AUTOCONF=no</programlisting>
- </listitem>
- </orderedlist>
- <para>On Ubuntu 12.10</para>
- <orderedlist numeration="loweralpha">
- <listitem>
- <para>Open the following:</para>
- <programlisting>etc/network/interfaces:</programlisting>
- </listitem>
- <listitem>
- <para>Make the necessary configuration changes, as given below:</para>
- <programlisting>iface eth0 inet6 dhcp
-autoconf 0
-accept_ra 1</programlisting>
- </listitem>
- </orderedlist>
- </listitem>
- </orderedlist>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/isolated-networks.xml
----------------------------------------------------------------------
diff --git a/en-US/isolated-networks.xml b/en-US/isolated-networks.xml
deleted file mode 100644
index c856044..0000000
--- a/en-US/isolated-networks.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="isolated-networks">
- <title>Isolated Networks</title>
- <para>An isolated network can be accessed only by virtual machines of a single account. Isolated
- networks have the following properties.</para>
- <itemizedlist>
- <listitem>
- <para>Resources such as VLAN are allocated and garbage collected dynamically</para>
- </listitem>
- <listitem>
- <para>There is one network offering for the entire network</para>
- </listitem>
- <listitem>
- <para>The network offering can be upgraded or downgraded but it is for the entire
- network</para>
- </listitem>
- </itemizedlist>
- <para>For more information, see <xref linkend="configure-guest-traffic-in-advanced-zone"/>.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/job-status.xml
----------------------------------------------------------------------
diff --git a/en-US/job-status.xml b/en-US/job-status.xml
deleted file mode 100644
index da0f76c..0000000
--- a/en-US/job-status.xml
+++ /dev/null
@@ -1,34 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE bookinfo 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="job-status">
- <title>Job Status</title>
- <para>The key to using an asynchronous command is the job ID that is returned immediately once the command has been executed. With the job ID, you can periodically check the job status by making calls to queryAsyncJobResult command. The command will return three possible job status integer values:</para>
- <itemizedlist>
- <listitem><para>0 - Job is still in progress. Continue to periodically poll for any status changes.</para></listitem>
- <listitem><para>1 - Job has successfully completed. The job will return any successful response values associated with command that was originally executed.</para></listitem>
- <listitem><para>2 - Job has failed to complete. Please check the "jobresultcode" tag for failure reason code and "jobresult" for the failure reason.</para></listitem>
- </itemizedlist>
-</section>
-
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/kvm-topology-req.xml
----------------------------------------------------------------------
diff --git a/en-US/kvm-topology-req.xml b/en-US/kvm-topology-req.xml
deleted file mode 100644
index 0dff491..0000000
--- a/en-US/kvm-topology-req.xml
+++ /dev/null
@@ -1,24 +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="kvm-topology-req">
- <title>KVM Topology Requirements</title>
- <para>The Management Servers communicate with KVM hosts on port 22 (ssh).</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/large_scale_redundant_setup.xml
----------------------------------------------------------------------
diff --git a/en-US/large_scale_redundant_setup.xml b/en-US/large_scale_redundant_setup.xml
deleted file mode 100644
index 427a42d..0000000
--- a/en-US/large_scale_redundant_setup.xml
+++ /dev/null
@@ -1,42 +0,0 @@
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0.
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<section id="large_scale_redundant_setup">
- <title>Large-Scale Redundant Setup</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/large-scale-redundant-setup.png" />
- </imageobject>
- <textobject><phrase>Large-Scale Redundant Setup</phrase></textobject>
- </mediaobject>
- <para>This diagram illustrates the network architecture of a large-scale &PRODUCT; deployment.</para>
- <itemizedlist>
- <listitem><para>A layer-3 switching layer is at the core of the data center. A router redundancy protocol like VRRP should be deployed. Typically high-end core switches also include firewall modules. Separate firewall appliances may also be used if the layer-3 switch does not have integrated firewall capabilities. The firewalls are configured in NAT mode. The firewalls provide the following functions:</para>
- <itemizedlist>
- <listitem><para>Forwards HTTP requests and API calls from the Internet to the Management Server. The Management Server resides on the management network.</para></listitem>
- <listitem><para>When the cloud spans multiple zones, the firewalls should enable site-to-site VPN such that servers in different zones can directly reach each other.</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para>A layer-2 access switch layer is established for each pod. Multiple switches can be stacked to increase port count. In either case, redundant pairs of layer-2 switches should be deployed.</para></listitem>
- <listitem><para>The Management Server cluster (including front-end load balancers, Management Server nodes, and the MySQL database) is connected to the management network through a pair of load balancers.</para></listitem>
- <listitem><para>Secondary storage servers are connected to the management network.</para></listitem>
- <listitem><para>Each pod contains storage and computing servers. Each storage and computing server should have redundant NICs connected to separate layer-2 access switches.</para></listitem>
- </itemizedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/layer2-switch.xml
----------------------------------------------------------------------
diff --git a/en-US/layer2-switch.xml b/en-US/layer2-switch.xml
deleted file mode 100644
index acef5a7..0000000
--- a/en-US/layer2-switch.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="layer2-switch">
- <title>Layer-2 Switch</title>
- <para>The layer-2 switch is the access switching layer inside the pod.</para>
- <itemizedlist>
- <listitem>
- <para>It should trunk all VLANs into every computing host.</para>
- </listitem>
- <listitem>
- <para>It should switch traffic for the management network containing computing and storage
- hosts. The layer-3 switch will serve as the gateway for the management network.</para>
- </listitem>
- </itemizedlist>
- <formalpara>
- <title>Example Configurations</title>
- <para>This section contains example configurations for specific switch models for pod-level
- layer-2 switching. It assumes VLAN management protocols such as VTP or GVRP have been
- disabled. The scripts must be changed appropriately if you choose to use VTP or GVRP.</para>
- </formalpara>
- <xi:include href="dell62xx-layer2.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="cisco3750-layer2.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/lb-policy-pfwd-rule-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/en-US/lb-policy-pfwd-rule-usage-record-format.xml b/en-US/lb-policy-pfwd-rule-usage-record-format.xml
deleted file mode 100644
index e27a49d..0000000
--- a/en-US/lb-policy-pfwd-rule-usage-record-format.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="loadbalancer-policy-port-forwarding-rule-usage-record-format">
- <title>Load Balancer Policy or Port Forwarding Rule Usage Record Format</title>
- <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 - ID of the load balancer policy or port forwarding rule</para></listitem>
- <listitem><para>usagetype - A number representing the usage type (see Usage Types)</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-docs/blob/f42520a5/en-US/ldap-config.xml
----------------------------------------------------------------------
diff --git a/en-US/ldap-config.xml b/en-US/ldap-config.xml
deleted file mode 100644
index b0d2af8..0000000
--- a/en-US/ldap-config.xml
+++ /dev/null
@@ -1,189 +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="ldap-config">
- <title>Configuring an LDAP Server</title>
- <para>You can configure &PRODUCT; to authenticate user access with a LDAP server. To set up LDAP
- authentication, provide the following:</para>
- <itemizedlist>
- <listitem>
- <para>Hostname or IP address and listening port of the LDAP server.</para>
- </listitem>
- <listitem>
- <para>The LDAP global parameters.</para>
- </listitem>
- <listitem>
- <para>Base directory and query filter.</para>
- </listitem>
- <listitem>
- <para>Search user DN credentials, which give &PRODUCT; permission to search on the LDAP
- server.</para>
- </listitem>
- <listitem>
- <para>SSL keystore and password, if SSL is used.</para>
- </listitem>
- </itemizedlist>
- <section id="add-ldap">
- <title>Adding an LDAP Server</title>
- <orderedlist>
- <listitem>
- <para>Log in to the &PRODUCT; UI.</para>
- </listitem>
- <listitem>
- <para>From the left navigational bar, click Global Settings.</para>
- </listitem>
- <listitem>
- <para>From the Select view drop down, select LDAP Configuration.</para>
- </listitem>
- <listitem>
- <para>Click Configure LDAP.</para>
- <para>The Configure LDAP dialog is displayed.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/ldap-config.png"/>
- </imageobject>
- <textobject>
- <phrase>ldap-config.png: LDAP configuration</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- <listitem>
- <para>Specify the following:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Hostname</emphasis>: Hostname or IP address of the LDAP
- server.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Port</emphasis>: The Listening port of the LDAP
- server.</para>
- <para>The port numbers for LDAP connections are: </para>
- <itemizedlist>
- <listitem>
- <para>389 for unsecured LDAP connections. This is the default value.</para>
- </listitem>
- <listitem>
- <para>636 for secure LDAP connections.</para>
- </listitem>
- <listitem>
- <para>3268 for Microsoft unsecure LDAP connections.</para>
- </listitem>
- <listitem>
- <para>3269 for Microsoft secure LDAP connections.</para>
- </listitem>
- <listitem>
- <para>10389 for ApacheDS.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Click OK.</para>
- </listitem>
- </orderedlist>
- </section>
- <section id="ldap-param">
- <title>Configuring LDAP Attributes in &PRODUCT;</title>
- <para>&PRODUCT; provides the following global LDAP configuration parameters. You can locate them
- by searching for ldap in the Global settings.</para>
- <itemizedlist>
- <listitem>
- <para><parameter>ldap basedn</parameter>: Defines the location of the users. This is usually
- derived from the <code>binddn</code>. Remove the user name from <code>bind dn</code> and
- specify the group where users are located. The entire subtree under the
- <code>binddn</code> will be searched for user accounts.</para>
- <para>For example:
- <programlisting>cn=users,dc=<sub-domain>,dc=<domain>. dc=com</programlisting></para>
- </listitem>
- <listitem>
- <para><parameter>ldap bind password</parameter>: The password used in association with the
- administrator bind DN. This is used for querying the LDAP directory. If this is left blank
- along with bind principal then anonymous binding is used.</para>
- </listitem>
- <listitem>
- <para><parameter>ldap bind principal</parameter>: The principle to bind to the LDAP server
- for creating the system context. The value is frequently the DN (Distinguished Name) of
- the user entry with the user ID. If this field is left blank along with the bind password
- then anonymous binding is used.</para>
- </listitem>
- <listitem>
- <para><parameter>ldap email attribute</parameter>: The attribute that your LDAP directory
- uses to hold the user’s e-mail address. Default attribute name is
- <parameter>mail</parameter>.</para>
- </listitem>
- <listitem>
- <para><parameter>ldap firstname attribute</parameter>: The attribute that your LDAP
- directory uses to hold the first name of the user. Default is <parameter>cn</parameter>.</para>
- </listitem>
- <listitem>
- <para><parameter>ldap group object</parameter>: The attribute that sets the object types for
- groups.</para>
- </listitem>
- <listitem>
- <para><parameter>ldap group user uniquemember</parameter>: The attribute that your LDAP
- directory uses to hold the unique members of the group.</para>
- </listitem>
- <listitem>
- <para><parameter>ldap lastname attribute</parameter>: The attribute that your LDAP directory
- uses to hold the last name of the user.</para>
- </listitem>
- <listitem>
- <para><parameter>ldap search group principle</parameter>: Sets the principle of the group
- that the LDAP users must be part of.</para>
- </listitem>
- <listitem>
- <para><parameter>ldap trust store</parameter>: Sets the path to the trust store to be used
- for secure connections. You can use the trust store to install CA certificates and client
- certificates.</para>
- </listitem>
- <listitem>
- <para><parameter>ldap trust store password</parameter>: Sets the password for the trust
- store. Password protects the trust store.</para>
- </listitem>
- <listitem>
- <para><parameter>ldap user object</parameter>: The object type of user accounts within LDAP.
- The default is <parameter>inetOrgperson</parameter>.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="remove-ldap">
- <title>Removing an LDAP Configuration</title>
- <orderedlist>
- <listitem>
- <para>Log in to the &PRODUCT;.</para>
- </listitem>
- <listitem>
- <para>From the left navigational bar, click Global Settings.</para>
- </listitem>
- <listitem>
- <para>From the Select view drop down, select LDAP Configuration.</para>
- </listitem>
- <listitem>
- <para>In the Quick View, click Remove LDAP.</para>
- <para>Alternatively, you can click Remove LDAP in the LDAP Configuration Details
- page.</para>
- </listitem>
- </orderedlist>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/ldap-user-add.xml
----------------------------------------------------------------------
diff --git a/en-US/ldap-user-add.xml b/en-US/ldap-user-add.xml
deleted file mode 100644
index 1fadd5a..0000000
--- a/en-US/ldap-user-add.xml
+++ /dev/null
@@ -1,80 +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="ldap-provision">
- <title>Provisioning LDAP Users in &PRODUCT;</title>
- <para>You can import LDAP users without creating users individually in &PRODUCT;. After users are
- imported to &PRODUCT; they can by authenticated to use &PRODUCT; by using their LDAP
- credentials. You can either directly import users from a given basedn, or alternatively, specify
- the search string or user attributes for &PRODUCT; to search the LDAP directory tree based on
- the query strings.</para>
- <orderedlist>
- <listitem>
- <para>Log in to the CloudPlatform UI as an administrator.</para>
- </listitem>
- <listitem>
- <para>In the left navigation bar, click Accounts.</para>
- <para>The Account page is displayed.</para>
- </listitem>
- <listitem>
- <para>In the Account page, click Add LDAP Users.</para>
- <para>The Add LDAP User screen lists all the users associated with the LDAP server you have
- configured.</para>
- </listitem>
- <listitem>
- <para>In the Add LDAP Account screen, perform either of the following:</para>
- <itemizedlist>
- <listitem>
- <para>Manually select the users from the user list.</para>
- <para>&PRODUCT; displays all the users from the LDAP group configured.</para>
- </listitem>
- <listitem>
- <para>Specify the search string or desired user attribute, then import users.</para>
- <itemizedlist>
- <listitem>
- <para>Domain</para>
- </listitem>
- <listitem>
- <para>Account</para>
- </listitem>
- <listitem>
- <para>User type</para>
- </listitem>
- <listitem>
- <para>Timezone</para>
- </listitem>
- <listitem>
- <para>Network Domain</para>
- </listitem>
- <listitem>
- <para>LDAP Group</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Click Add.</para>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/libcloud-examples.xml
----------------------------------------------------------------------
diff --git a/en-US/libcloud-examples.xml b/en-US/libcloud-examples.xml
deleted file mode 100644
index d2db526..0000000
--- a/en-US/libcloud-examples.xml
+++ /dev/null
@@ -1,75 +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="libcloud-examples">
- <title>Apache Libcloud</title>
- <para>There are many tools available to interface with the &PRODUCT; API. Apache Libcloud is one of those. In this section
- we provide a basic example of how to use Libcloud with &PRODUCT;. It assumes that you have access to a &PRODUCT; endpoint and that you have the API access key and secret key of a user.</para>
- <para>To install Libcloud refer to the libcloud website. If you are familiar with Pypi simply do:</para>
- <programlisting>pip install apache-libcloud</programlisting>
- <para>You should see the following output:</para>
- <programlisting>
-pip install apache-libcloud
-Downloading/unpacking apache-libcloud
- Downloading apache-libcloud-0.12.4.tar.bz2 (376kB): 376kB downloaded
- Running setup.py egg_info for package apache-libcloud
-
-Installing collected packages: apache-libcloud
- Running setup.py install for apache-libcloud
-
-Successfully installed apache-libcloud
-Cleaning up...
- </programlisting>
-
- <para>You can then open a Python interactive shell, create an instance of a &PRODUCT; driver and call the available methods via the libcloud API.</para>
-
- <programlisting>
- <![CDATA[
->>> from libcloud.compute.types import Provider
->>> from libcloud.compute.providers import get_driver
->>> Driver = get_driver(Provider.CLOUDSTACK)
->>> apikey='plgWJfZK4gyS3mOMTVmjUVg-X-jlWlnfaUJ9GAbBbf9EdM-kAYMmAiLqzzq1ElZLYq_u38zCm0bewzGUdP66mg'
->>> secretkey='VDaACYb0LV9eNjTetIOElcVQkvJck_J_QljX_FcHRj87ZKiy0z0ty0ZsYBkoXkY9b7eq1EhwJaw7FF3akA3KBQ'
->>> host='http://localhost:8080'
->>> path='/client/api'
->>> conn=Driver(apikey,secretkey,secure='False',host='localhost:8080',path=path)
->>> conn=Driver(key=apikey,secret=secretkey,secure=False,host='localhost',port='8080',path=path)
->>> conn.list_images()
-[<NodeImage: id=13ccff62-132b-4caf-b456-e8ef20cbff0e, name=tiny Linux, driver=CloudStack ...>]
->>> conn.list_sizes()
-[<NodeSize: id=ef2537ad-c70f-11e1-821b-0800277e749c, name=tinyOffering, ram=100 disk=0 bandwidth=0 price=0 driver=CloudStack ...>, <NodeSize: id=c66c2557-12a7-4b32-94f4-48837da3fa84, name=Small Instance, ram=512 disk=0 bandwidth=0 price=0 driver=CloudStack ...>, <NodeSize: id=3d8b82e5-d8e7-48d5-a554-cf853111bc50, name=Medium Instance, ram=1024 disk=0 bandwidth=0 price=0 driver=CloudStack ...>]
->>> images=conn.list_images()
->>> offerings=conn.list_sizes()
->>> node=conn.create_node(name='toto',image=images[0],size=offerings[0])
->>> help(node)
->>> node.get_uuid()
-'b1aa381ba1de7f2d5048e248848993d5a900984f'
->>> node.name
-u'toto'
-]]>
- </programlisting>
-
- <para>One of the interesting use cases of Libcloud is that you can use multiple Cloud Providers, such as AWS, Rackspace, OpenNebula, vCloud and so on. You can then create Driver instances to each of these clouds and create your own multi cloud application.</para>
-
- </section>