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:21 UTC
[19/51] [partial] Removing docs from master
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/vnmc-cisco.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vnmc-cisco.xml b/docs/en-US/vnmc-cisco.xml
deleted file mode 100644
index b0785fc..0000000
--- a/docs/en-US/vnmc-cisco.xml
+++ /dev/null
@@ -1,400 +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="vnmc-cisco">
- <title>External Guest Firewall Integration for Cisco VNMC (Optional)</title>
- <para>Cisco Virtual Network Management Center (VNMC) provides centralized multi-device and policy
- management for Cisco Network Virtual Services. You can integrate Cisco VNMC with &PRODUCT; to
- leverage the firewall and NAT service offered by ASA 1000v Cloud Firewall. Use it in a Cisco
- Nexus 1000v dvSwitch-enabled cluster in &PRODUCT;. In such a deployment, you will be able to: </para>
- <itemizedlist>
- <listitem>
- <para>Configure Cisco ASA 1000v firewalls. You can configure one per guest network.</para>
- </listitem>
- <listitem>
- <para>Use Cisco ASA 1000v firewalls to create and apply security profiles that contain ACL
- policy sets for both ingress and egress traffic.</para>
- </listitem>
- <listitem>
- <para>Use Cisco ASA 1000v firewalls to create and apply Source NAT, Port Forwarding, and
- Static NAT policy sets.</para>
- </listitem>
- </itemizedlist>
- <para>&PRODUCT; supports Cisco VNMC on Cisco Nexus 1000v dvSwich-enabled VMware
- hypervisors.</para>
- <section id="deploy-vnmc">
- <title>Using Cisco ASA 1000v Firewall, Cisco Nexus 1000v dvSwitch, and Cisco VNMC in a
- Deployment</title>
- <section id="notes-vnmc">
- <title>Guidelines</title>
- <itemizedlist>
- <listitem>
- <para>Cisco ASA 1000v firewall is supported only in Isolated Guest Networks.</para>
- </listitem>
- <listitem>
- <para>Cisco ASA 1000v firewall is not supported on VPC.</para>
- </listitem>
- <listitem>
- <para>Cisco ASA 1000v firewall is not supported for load balancing.</para>
- </listitem>
- <listitem>
- <para>When a guest network is created with Cisco VNMC firewall provider, an additional
- public IP is acquired along with the Source NAT IP. The Source NAT IP is used for the
- rules, whereas the additional IP is used to for the ASA outside interface. Ensure that
- this additional public IP is not released. You can identify this IP as soon as the
- network is in implemented state and before acquiring any further public IPs. The
- additional IP is the one that is not marked as Source NAT. You can find the IP used for
- the ASA outside interface by looking at the Cisco VNMC used in your guest
- network.</para>
- </listitem>
- <listitem>
- <para>Use the public IP address range from a single subnet. You cannot add IP addresses
- from different subnets.</para>
- </listitem>
- <listitem>
- <para>Only one ASA instance per VLAN is allowed because multiple VLANS cannot be trunked
- to ASA ports. Therefore, you can use only one ASA instance in a guest network.</para>
- </listitem>
- <listitem>
- <para>Only one Cisco VNMC per zone is allowed.</para>
- </listitem>
- <listitem>
- <para>Supported only in Inline mode deployment with load balancer.</para>
- </listitem>
- <listitem>
- <para>The ASA firewall rule is applicable to all the public IPs in the guest network.
- Unlike the firewall rules created on virtual router, a rule created on the ASA device is
- not tied to a specific public IP.</para>
- </listitem>
- <listitem>
- <para>Use a version of Cisco Nexus 1000v dvSwitch that support the vservice command. For
- example: nexus-1000v.4.2.1.SV1.5.2b.bin</para>
- <para>Cisco VNMC requires the vservice command to be available on the Nexus switch to
- create a guest network in &PRODUCT;. </para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="prereq-asa">
- <title>Prerequisites</title>
- <orderedlist>
- <listitem>
- <para>Configure Cisco Nexus 1000v dvSwitch in a vCenter environment.</para>
- <para>Create Port profiles for both internal and external network interfaces on Cisco
- Nexus 1000v dvSwitch. Note down the inside port profile, which needs to be provided
- while adding the ASA appliance to &PRODUCT;.</para>
- <para>For information on configuration, see <xref
- linkend="vmware-vsphere-cluster-config-nexus-vswitch"/>.</para>
- </listitem>
- <listitem>
- <para>Deploy and configure Cisco VNMC.</para>
- <para>For more information, see <ulink
- url="http://www.cisco.com/en/US/docs/switches/datacenter/vsg/sw/4_2_1_VSG_2_1_1/install_upgrade/guide/b_Cisco_VSG_for_VMware_vSphere_Rel_4_2_1_VSG_2_1_1_and_Cisco_VNMC_Rel_2_1_Installation_and_Upgrade_Guide_chapter_011.html"
- >Installing Cisco Virtual Network Management Center</ulink> and <ulink
- url="http://www.cisco.com/en/US/docs/unified_computing/vnmc/sw/1.2/VNMC_GUI_Configuration/b_VNMC_GUI_Configuration_Guide_1_2_chapter_010.html"
- >Configuring Cisco Virtual Network Management Center</ulink>.</para>
- </listitem>
- <listitem>
- <para>Register Cisco Nexus 1000v dvSwitch with Cisco VNMC.</para>
- <para>For more information, see <ulink
- url="http://www.cisco.com/en/US/docs/switches/datacenter/vsg/sw/4_2_1_VSG_1_2/vnmc_and_vsg_qi/guide/vnmc_vsg_install_5register.html#wp1064301"
- >Registering a Cisco Nexus 1000V with Cisco VNMC</ulink>.</para>
- </listitem>
- <listitem>
- <para>Create Inside and Outside port profiles in Cisco Nexus 1000v dvSwitch.</para>
- <para>For more information, see <xref
- linkend="vmware-vsphere-cluster-config-nexus-vswitch"/>.</para>
- </listitem>
- <listitem>
- <para>Deploy and Cisco ASA 1000v appliance.</para>
- <para>For more information, see <ulink
- url="http://www.cisco.com/en/US/docs/security/asa/quick_start/asa1000V/setup_vnmc.html"
- >Setting Up the ASA 1000V Using VNMC</ulink>.</para>
- <para>Typically, you create a pool of ASA 1000v appliances and register them with
- &PRODUCT;.</para>
- <para>Specify the following while setting up a Cisco ASA 1000v instance:</para>
- <itemizedlist>
- <listitem>
- <para>VNMC host IP. </para>
- </listitem>
- <listitem>
- <para>Ensure that you add ASA appliance in VNMC mode.</para>
- </listitem>
- <listitem>
- <para>Port profiles for the Management and HA network interfaces. This need to be
- pre-created on Cisco Nexus 1000v dvSwitch.</para>
- </listitem>
- <listitem>
- <para>Internal and external port profiles.</para>
- </listitem>
- <listitem>
- <para>The Management IP for Cisco ASA 1000v appliance. Specify the gateway such that
- the VNMC IP is reachable.</para>
- </listitem>
- <listitem>
- <para>Administrator credentials</para>
- </listitem>
- <listitem>
- <para>VNMC credentials</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Register Cisco ASA 1000v with VNMC.</para>
- <para>After Cisco ASA 1000v instance is powered on, register VNMC from the ASA
- console.</para>
- </listitem>
- </orderedlist>
- </section>
- <section id="how-to-asa">
- <title>Using Cisco ASA 1000v Services</title>
- <orderedlist>
- <listitem>
- <para>Ensure that all the prerequisites are met.</para>
- <para>See <xref linkend="prereq-asa"/>.</para>
- </listitem>
- <listitem>
- <para>Add a VNMC instance.</para>
- <para>See <xref linkend="add-vnmc"/>.</para>
- </listitem>
- <listitem>
- <para>Add a ASA 1000v instance.</para>
- <para>See <xref linkend="add-asa"/>.</para>
- </listitem>
- <listitem>
- <para>Create a Network Offering and use Cisco VNMC as the service provider for desired
- services.</para>
- <para>See <xref linkend="asa-offering"/>.</para>
- </listitem>
- <listitem>
- <para>Create an Isolated Guest Network by using the network offering you just
- created.</para>
- </listitem>
- </orderedlist>
- </section>
- </section>
- <section id="add-vnmc">
- <title>Adding a VNMC Instance</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 More.</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 Network Service Providers node of the diagram, click Configure. </para>
- <para>You might have to scroll down to see this.</para>
- </listitem>
- <listitem>
- <para>Click Cisco VNMC.</para>
- </listitem>
- <listitem>
- <para>Click View VNMC Devices.</para>
- </listitem>
- <listitem>
- <para>Click the Add VNMC Device and provide the following:</para>
- <itemizedlist>
- <listitem>
- <para>Host: The IP address of the VNMC instance.</para>
- </listitem>
- <listitem>
- <para>Username: The user name of the account on the VNMC instance that &PRODUCT; should
- use.</para>
- </listitem>
- <listitem>
- <para>Password: The password of the account.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Click OK.</para>
- </listitem>
- </orderedlist>
- </section>
- <section id="add-asa">
- <title>Adding an ASA 1000v Instance</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 More.</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 Network Service Providers node of the diagram, click Configure. </para>
- <para>You might have to scroll down to see this.</para>
- </listitem>
- <listitem>
- <para>Click Cisco VNMC.</para>
- </listitem>
- <listitem>
- <para>Click View ASA 1000v.</para>
- </listitem>
- <listitem>
- <para>Click the Add CiscoASA1000v Resource and provide the following:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Host</emphasis>: The management IP address of the ASA 1000v
- instance. The IP address is used to connect to ASA 1000V.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Inside Port Profile</emphasis>: The Inside Port Profile
- configured on Cisco Nexus1000v dvSwitch.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Cluster</emphasis>: The VMware cluster to which you are
- adding the ASA 1000v instance.</para>
- <para>Ensure that the cluster is Cisco Nexus 1000v dvSwitch enabled.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Click OK.</para>
- </listitem>
- </orderedlist>
- </section>
- <section id="asa-offering">
- <title>Creating a Network Offering Using Cisco ASA 1000v</title>
- <para>To have Cisco ASA 1000v support for a guest network, create a network offering as follows: </para>
- <orderedlist>
- <listitem>
- <para>Log in to the &PRODUCT; UI as a user or admin.</para>
- </listitem>
- <listitem>
- <para>From the Select Offering drop-down, choose Network Offering.</para>
- </listitem>
- <listitem>
- <para>Click Add Network Offering.</para>
- </listitem>
- <listitem>
- <para>In the dialog, make the following choices:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Name</emphasis>: Any desired name for the network
- offering.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Description</emphasis>: A short description of the offering
- that can be displayed to users.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Network Rate</emphasis>: Allowed data transfer rate in MB
- per second.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Traffic Type</emphasis>: The type of network traffic that
- will be carried on the network.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Guest Type</emphasis>: Choose whether the guest network is
- isolated or shared.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Persistent</emphasis>: Indicate whether the guest network is
- persistent or not. The network that you can provision without having to deploy a VM on
- it is termed persistent network. </para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">VPC</emphasis>: This option indicate whether the guest
- network is Virtual Private Cloud-enabled. A Virtual Private Cloud (VPC) is a private,
- isolated part of &PRODUCT;. A VPC can have its own virtual network topology that
- resembles a traditional physical network. For more information on VPCs, see <xref
- linkend="vpc"/>.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Specify VLAN</emphasis>: (Isolated guest networks only)
- Indicate whether a VLAN should be specified when this offering is used.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Supported Services</emphasis>: Use Cisco VNMC as the service
- provider for Firewall, Source NAT, Port Forwarding, and Static NAT to create an
- Isolated guest network offering.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">System Offering</emphasis>: Choose the system service
- offering that you want virtual routers to use in this network.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Conserve mode</emphasis>: Indicate whether to use conserve
- mode. In this mode, network resources are allocated only when the first virtual
- machine starts in the network.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Click OK </para>
- <para>The network offering is created.</para>
- </listitem>
- </orderedlist>
- </section>
- <section id="reuse-asa">
- <title>Reusing ASA 1000v Appliance in new Guest Networks</title>
- <para>You can reuse an ASA 1000v appliance in a new guest network after the necessary cleanup.
- Typically, ASA 1000v is cleaned up when the logical edge firewall is cleaned up in VNMC. If
- this cleanup does not happen, you need to reset the appliance to its factory settings for use
- in new guest networks. As part of this, enable SSH on the appliance and store the SSH
- credentials by registering on VNMC.</para>
- <orderedlist>
- <listitem>
- <para>Open a command line on the ASA appliance:</para>
- <orderedlist>
- <listitem>
- <para>Run the following:</para>
- <programlisting>ASA1000V(config)# reload</programlisting>
- <para>You are prompted with the following message:</para>
- <programlisting>System config has been modified. Save? [Y]es/[N]o:"</programlisting>
- </listitem>
- <listitem>
- <para>Enter N.</para>
- <para>You will get the following confirmation message:</para>
- <programlisting>"Proceed with reload? [confirm]"</programlisting>
- </listitem>
- <listitem>
- <para>Restart the appliance.</para>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- <para>Register the ASA 1000v appliance with the VNMC:</para>
- <programlisting>ASA1000V(config)# vnmc policy-agent
-ASA1000V(config-vnmc-policy-agent)# registration host vnmc_ip_address
-ASA1000V(config-vnmc-policy-agent)# shared-secret key where key is the shared secret for authentication of the ASA 1000V connection to the Cisco VNMC</programlisting>
- </listitem>
- </orderedlist>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/volume-deletion-garbage-collection.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/volume-deletion-garbage-collection.xml b/docs/en-US/volume-deletion-garbage-collection.xml
deleted file mode 100644
index 4186438..0000000
--- a/docs/en-US/volume-deletion-garbage-collection.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="volume-deletion-garbage-collection">
- <title>Volume Deletion and Garbage Collection</title>
- <para>The deletion of a volume does not delete the snapshots that have been created from the
- volume</para>
- <para>When a VM is destroyed, data disk volumes that are attached to the VM are not
- deleted.</para>
- <para>Volumes are permanently destroyed using a garbage collection process. The global
- configuration variables expunge.delay and expunge.interval determine when the physical deletion
- of volumes will occur.</para>
- <itemizedlist>
- <listitem>
- <para>expunge.delay: determines how old the volume must be before it is destroyed, in
- seconds</para>
- </listitem>
- <listitem>
- <para>expunge.interval: determines how often to run the garbage collection check</para>
- </listitem>
- </itemizedlist>
- <para>Administrators should adjust these values depending on site policies around data
- retention.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/volume-status.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/volume-status.xml b/docs/en-US/volume-status.xml
deleted file mode 100644
index 35802f9..0000000
--- a/docs/en-US/volume-status.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="volume-status">
- <title>Volume Status</title>
- <para>When a snapshot operation is triggered by means of a recurring snapshot
- policy, a snapshot is skipped if a volume has remained inactive since its
- last snapshot was taken. A volume is considered to be inactive if it is
- either detached or attached to a VM that is not running. &PRODUCT; ensures
- that at least one snapshot is taken since the volume last became inactive.
- </para>
- <para>When a snapshot is taken manually, a snapshot is always created
- regardless of whether a volume has been active or not.
- </para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/vpc.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vpc.xml b/docs/en-US/vpc.xml
deleted file mode 100644
index d1f0c52..0000000
--- a/docs/en-US/vpc.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="vpc">
- <title>About Virtual Private Clouds</title>
- <para>&PRODUCT; Virtual Private Cloud is a private, isolated part of &PRODUCT;. A VPC can have its
- own virtual network topology that resembles a traditional physical network. You can launch VMs
- in the virtual network that can have private addresses in the range of your choice, for example:
- 10.0.0.0/16. You can define network tiers within your VPC network range, which in turn enables
- you to group similar kinds of instances based on IP address range.</para>
- <para>For example, if a VPC has the private range 10.0.0.0/16, its guest networks can have the
- network ranges 10.0.1.0/24, 10.0.2.0/24, 10.0.3.0/24, and so on.</para>
- <formalpara>
- <title>Major Components of a VPC:</title>
- <para>A VPC is comprised of the following network components:</para>
- </formalpara>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">VPC</emphasis>: A VPC acts as a container for multiple isolated
- networks that can communicate with each other via its virtual router.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Network Tiers</emphasis>: Each tier acts as an isolated network
- with its own VLANs and CIDR list, where you can place groups of resources, such as VMs. The
- tiers are segmented by means of VLANs. The NIC of each tier acts as its gateway.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Virtual Router</emphasis>: A virtual router is automatically
- created and started when you create a VPC. The virtual router connect the tiers and direct
- traffic among the public gateway, the VPN gateways, and the NAT instances. For each tier, a
- corresponding NIC and IP exist in the virtual router. The virtual router provides DNS and
- DHCP services through its IP.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Public Gateway</emphasis>: The traffic to and from the Internet
- routed to the VPC through the public gateway. In a VPC, the public gateway is not exposed to
- the end user; therefore, static routes are not support for the public gateway.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Private Gateway</emphasis>: All the traffic to and from a private
- network routed to the VPC through the private gateway. For more information, see <xref
- linkend="add-gateway-vpc"/>.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">VPN Gateway</emphasis>: The VPC side of a VPN connection.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Site-to-Site VPN Connection</emphasis>: A hardware-based VPN
- connection between your VPC and your datacenter, home network, or co-location facility. For
- more information, see <xref linkend="site-to-site-vpn"/>.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Customer Gateway</emphasis>: The customer side of a VPN
- Connection. For more information, see <xref linkend="create-vpn-customer-gateway"/>.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">NAT Instance</emphasis>: An instance that provides Port Address
- Translation for instances to access the Internet via the public gateway. For more
- information, see <xref linkend="enable-disable-static-nat-vpc"/>.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Network ACL</emphasis>: Network ACL is a group of Network ACL
- items. Network ACL items are nothing but numbered rules that are evaluated in order,
- starting with the lowest numbered rule. These rules determine whether traffic is allowed in
- or out of any tier associated with the network ACL. For more information, see <xref linkend="configure-acl"/>.</para>
- </listitem>
- </itemizedlist>
- <formalpara>
- <title>Network Architecture in a VPC</title>
- <para>In a VPC, the following four basic options of network architectures are present:</para>
- </formalpara>
- <itemizedlist>
- <listitem>
- <para>VPC with a public gateway only</para>
- </listitem>
- <listitem>
- <para>VPC with public and private gateways</para>
- </listitem>
- <listitem>
- <para>VPC with public and private gateways and site-to-site VPN access</para>
- </listitem>
- <listitem>
- <para>VPC with a private gateway only and site-to-site VPN access</para>
- </listitem>
- </itemizedlist>
- <formalpara>
- <title>Connectivity Options for a VPC</title>
- <para>You can connect your VPC to:</para>
- </formalpara>
- <itemizedlist>
- <listitem>
- <para>The Internet through the public gateway.</para>
- </listitem>
- <listitem>
- <para>The corporate datacenter by using a site-to-site VPN connection through the VPN
- gateway.</para>
- </listitem>
- <listitem>
- <para>Both the Internet and your corporate datacenter by using both the public gateway and a
- VPN gateway.</para>
- </listitem>
- </itemizedlist>
- <formalpara>
- <title>VPC Network Considerations</title>
- <para>Consider the following before you create a VPC:</para>
- </formalpara>
- <itemizedlist>
- <listitem>
- <para>A VPC, by default, is created in the enabled state.</para>
- </listitem>
- <listitem>
- <para>A VPC can be created in Advance zone only, and can't belong to more than one zone at a
- time.</para>
- </listitem>
- <listitem>
- <para>The default number of VPCs an account can create is 20. However, you can change it by
- using the max.account.vpcs global parameter, which controls the maximum number of VPCs an
- account is allowed to create.</para>
- </listitem>
- <listitem>
- <para>The default number of tiers an account can create within a VPC is 3. You can configure
- this number by using the vpc.max.networks parameter.</para>
- </listitem>
- <listitem>
- <para>Each tier should have an unique CIDR in the VPC. Ensure that the tier's CIDR should be
- within the VPC CIDR range.</para>
- </listitem>
- <listitem>
- <para>A tier belongs to only one VPC. </para>
- </listitem>
- <listitem>
- <para>All network tiers inside the VPC should belong to the same account.</para>
- </listitem>
- <listitem>
- <para>When a VPC is created, by default, a SourceNAT IP is allocated to it. The Source NAT IP
- is released only when the VPC is removed.</para>
- </listitem>
- <listitem>
- <para>A public IP can be used for only one purpose at a time. If the IP is a sourceNAT, it
- cannot be used for StaticNAT or port forwarding.</para>
- </listitem>
- <listitem>
- <para>The instances can only have a private IP address that you provision. To communicate with
- the Internet, enable NAT to an instance that you launch in your VPC.</para>
- </listitem>
- <listitem>
- <para>Only new networks can be added to a VPC. The maximum number of networks per VPC is
- limited by the value you specify in the vpc.max.networks parameter. The default value is
- three.</para>
- </listitem>
- <listitem>
- <para>The load balancing service can be supported by only one tier inside the VPC.</para>
- </listitem>
- <listitem>
- <para>If an IP address is assigned to a tier:</para>
- <itemizedlist>
- <listitem>
- <para>That IP can't be used by more than one tier at a time in the VPC. For example, if
- you have tiers A and B, and a public IP1, you can create a port forwarding rule by using
- the IP either for A or B, but not for both.</para>
- </listitem>
- <listitem>
- <para>That IP can't be used for StaticNAT, load balancing, or port forwarding rules for
- another guest network inside the VPC.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Remote access VPN is not supported in VPC networks.</para>
- </listitem>
- </itemizedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/vpn.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vpn.xml b/docs/en-US/vpn.xml
deleted file mode 100644
index 1f8098c..0000000
--- a/docs/en-US/vpn.xml
+++ /dev/null
@@ -1,62 +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="vpn">
- <title>Remote Access VPN</title>
- <para>&PRODUCT; account owners can create virtual private networks (VPN) to access their virtual
- machines. If the guest network is instantiated from a network offering that offers the Remote
- Access VPN service, the virtual router (based on the System VM) is used to provide the service.
- &PRODUCT; provides a L2TP-over-IPsec-based remote access VPN service to guest virtual networks.
- Since each network gets its own virtual router, VPNs are not shared across the networks. VPN
- clients native to Windows, Mac OS X and iOS can be used to connect to the guest networks. The
- account owner can create and manage users for their VPN. &PRODUCT; does not use its account
- database for this purpose but uses a separate table. The VPN user database is shared across all
- the VPNs created by the account owner. All VPN users get access to all VPNs created by the
- account owner.</para>
- <note>
- <para>Make sure that not all traffic goes through the VPN. That is, the route installed by the
- VPN should be only for the guest network and not for all traffic.</para>
- </note>
- <para/>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Road Warrior / Remote Access</emphasis>. Users want to be able to
- connect securely from a home or office to a private network in the cloud. Typically, the IP
- address of the connecting client is dynamic and cannot be preconfigured on the VPN
- server.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Site to Site</emphasis>. In this scenario, two private subnets are
- connected over the public Internet with a secure VPN tunnel. The cloud user’s subnet (for
- example, an office network) is connected through a gateway to the network in the cloud. The
- address of the user’s gateway must be preconfigured on the VPN server in the cloud. Note
- that although L2TP-over-IPsec can be used to set up Site-to-Site VPNs, this is not the
- primary intent of this feature. For more information, see <xref linkend="site-to-site-vpn"
- /></para>
- </listitem>
- </itemizedlist>
- <xi:include href="configure-vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="using-vpn-with-windows.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="using-vpn-with-mac.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="site-to-site-vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/whatis.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/whatis.xml b/docs/en-US/whatis.xml
deleted file mode 100644
index 5103b2e..0000000
--- a/docs/en-US/whatis.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="whatis">
- <title>What Is &PRODUCT;?</title>
- <para>&PRODUCT; is an open source software platform that pools computing resources to build public, private, and hybrid Infrastructure as a Service (IaaS) clouds. &PRODUCT; manages the network, storage, and compute nodes that make up a cloud infrastructure. Use &PRODUCT; to deploy, manage, and configure cloud computing environments.</para>
- <para>Typical users are service providers and enterprises. With &PRODUCT;, you can:</para>
- <itemizedlist>
- <listitem>
- <para>Set up an on-demand, elastic cloud computing service. Service providers can sell self service virtual machine instances, storage volumes, and networking configurations over the Internet.</para></listitem>
- <listitem>
- <para>Set up an on-premise private cloud for use by employees. Rather than managing virtual machines in the same way as physical machines, with &PRODUCT; an enterprise can offer self-service virtual machines to users without involving IT departments.</para></listitem>
- </itemizedlist>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/1000-foot-view.png" />
- </imageobject>
- <textobject><phrase>1000-foot-view.png: Overview of &PRODUCT;</phrase></textobject>
- </mediaobject>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/whats-in-this-adminguide.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/whats-in-this-adminguide.xml b/docs/en-US/whats-in-this-adminguide.xml
deleted file mode 100644
index 68717dd..0000000
--- a/docs/en-US/whats-in-this-adminguide.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="whats-in-this-adminguide">
- <title>Who Should Read This</title>
- <para>If you have already installed &PRODUCT; or you want to learn more about the ongoing operation and maintenance of a &PRODUCT;-powered cloud, read this documentation. It will help you start using, configuring, and managing the ongoing operation of your cloud.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/whats-new.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/whats-new.xml b/docs/en-US/whats-new.xml
deleted file mode 100644
index 04733c7..0000000
--- a/docs/en-US/whats-new.xml
+++ /dev/null
@@ -1,55 +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="whats-new">
- <title>What's New in the API?</title>
- <para>The following describes any new major features of each &PRODUCT; version as it applies to
- API usage.</para>
- <section id="whats-new-in-api-4.2">
- <title>What's New in the API for 4.2</title>
- <xi:include href="added-API-commands-4.2.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="changed-API-commands-4.2.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="removed-api-4.2.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- </section>
- <section id="whats-new-in-api-4.1">
- <title>What's New in the API for 4.1</title>
- <xi:include href="add-remove-nic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="ipv6-support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="vmx-settings-dev.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="reset-ssh-key-dev.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="changed-apicommands-4.1.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="added-API-commands-4-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- </section>
- <section id="whats-new-in-api-4.0">
- <title>What's New in the API for 4.0</title>
- <xi:include href="changed-apicommands-4-0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="added-API-commands-4-0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- </section>
- <section id="whats-new-in-api-3.0">
- <title>What's New in the API for 3.0</title>
- <xi:include href="enabling-port-8096.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="stopped-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="change-to-behavior-of-list-commands.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="removed-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="added-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="added-error-codes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- </section>
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/who-should-read-installation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/who-should-read-installation.xml b/docs/en-US/who-should-read-installation.xml
deleted file mode 100644
index eb55ee4..0000000
--- a/docs/en-US/who-should-read-installation.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="who-should-read-installation">
- <title>Who Should Read This</title>
- <para>For those who have already gone through a design phase and planned a more sophisticated deployment, or those who are ready to start scaling up a trial installation. With the following procedures, you can start using the more powerful features of &PRODUCT;, such as advanced VLAN networking, high availability, additional network elements such as load balancers and firewalls, and support for multiple hypervisors including Citrix XenServer, KVM, and VMware vSphere.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/windows-installation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/windows-installation.xml b/docs/en-US/windows-installation.xml
deleted file mode 100644
index 29c84b4..0000000
--- a/docs/en-US/windows-installation.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="windows-installation">
- <title>Windows OS Installation</title>
- <para>Download the installer, CloudInstanceManager.msi, from <ulink
- url="http://cloudstack.org/download.html">Download page</ulink> and run the installer in the
- newly created Windows VM. </para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/work-with-usage.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/work-with-usage.xml b/docs/en-US/work-with-usage.xml
deleted file mode 100644
index 0017293..0000000
--- a/docs/en-US/work-with-usage.xml
+++ /dev/null
@@ -1,38 +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="work-with-usage">
- <title>Working with Usage</title>
- <para>The Usage Server is an optional, separately-installed part of &PRODUCT; that provides
- aggregated usage records which you can use to create billing integration for &PRODUCT;. The
- Usage Server works by taking data from the events log and creating summary usage records that
- you can access using the listUsageRecords API call. </para>
- <para>The usage records show the amount of resources, such as VM run time or template storage
- space, consumed by guest instances.</para>
- <para>The Usage Server runs at least once per day. It can be configured to run multiple times per
- day.</para>
- <xi:include href="configure-usage-server.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="set-usage-limit.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="globally-configured-limits.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="limit-accounts-domains.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/working-with-documentation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-documentation.xml b/docs/en-US/working-with-documentation.xml
deleted file mode 100644
index 6774842..0000000
--- a/docs/en-US/working-with-documentation.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.
--->
-
-<chapter id="working-with-documentation">
- <title>Preparing and Building &PRODUCT; Documentation</title>
- <para>This chapter describes how to install publican, how to write new documentation and build a guide as well as how to build a translated version of the documentation using transifex</para>
- <xi:include href="installing-publican.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="building-documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="writing-new-documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="building-translation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/working-with-hosts.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-hosts.xml b/docs/en-US/working-with-hosts.xml
deleted file mode 100644
index d1fc74f..0000000
--- a/docs/en-US/working-with-hosts.xml
+++ /dev/null
@@ -1,39 +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="working-with-hosts">
- <title>Working With Hosts</title>
- <section id="adding-hosts">
- <title>Adding Hosts</title>
- <para>Additional hosts can be added at any time to provide more capacity for guest VMs. For requirements and instructions, see <xref linkend="host-add"/>.</para>
- </section>
- <xi:include href="scheduled-maintenance-maintenance-mode-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="disable-enable-zones-pods-clusters.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="removing-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="re-install-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="maintain-hypervisors-on-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="change-host-password.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="over-provisioning-service-offering-limits.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="vlan-provisioning.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/working-with-iso.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-iso.xml b/docs/en-US/working-with-iso.xml
deleted file mode 100644
index 9872106..0000000
--- a/docs/en-US/working-with-iso.xml
+++ /dev/null
@@ -1,33 +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="working-with-iso">
- <title>Working with ISOs</title>
- <para>&PRODUCT; supports ISOs and their attachment to guest VMs. An ISO is a read-only file that has an ISO/CD-ROM style file system. Users can upload their own ISOs and mount them on their guest VMs.</para>
- <para>ISOs are uploaded based on a URL. HTTP is the supported protocol. Once the ISO is available via HTTP specify an upload URL such as http://my.web.server/filename.iso.</para>
- <para>ISOs may be public or private, like templates.ISOs are not hypervisor-specific. That is, a guest on vSphere can mount the exact same image that a guest on KVM can mount.</para>
- <para>ISO images may be stored in the system and made available with a privacy level similar to templates. ISO images are classified as either bootable or not bootable. A bootable ISO image is one that contains an OS image. &PRODUCT; allows a user to boot a guest VM off of an ISO image. Users can also attach ISO images to guest VMs. For example, this enables installing PV drivers into Windows. ISO images are not hypervisor-specific.</para>
- <xi:include href="add-iso.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="attach-iso-to-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="update-iso-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/working-with-snapshots.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-snapshots.xml b/docs/en-US/working-with-snapshots.xml
deleted file mode 100644
index 674b232..0000000
--- a/docs/en-US/working-with-snapshots.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="working-with-snapshots">
- <title>Working with Snapshots</title>
- <para>(Supported for the following hypervisors: <emphasis role="bold">XenServer</emphasis>, <emphasis role="bold">VMware vSphere</emphasis>, and <emphasis role="bold">KVM</emphasis>)</para>
- <para>&PRODUCT; supports snapshots of disk volumes. Snapshots are a point-in-time capture of virtual machine disks. Memory and CPU states are not captured. <!-- If you are using the Oracle VM hypervisor, you can not take snapshots, since OVM does not support them. --></para>
- <para>Snapshots may be taken for volumes, including both root and data disks. The administrator places a limit on the number of stored snapshots per user. Users can create new volumes from the snapshot for recovery of particular files and they can create templates from snapshots to boot from a restored disk.</para>
- <para>Users can create snapshots manually or by setting up automatic recurring snapshot policies. Users can also create disk volumes from snapshots, which may be attached to a VM like any other disk volume. Snapshots of both root disks and data disks are supported. However, &PRODUCT; does not currently support booting a VM from a recovered root disk. A disk recovered from snapshot of a root disk is treated as a regular data disk; the data on recovered disk can be accessed by attaching the disk to a VM.</para>
- <para>A completed snapshot is copied from primary storage to secondary storage, where it is stored until deleted or purged by newer snapshot.</para>
- <xi:include href="automatic-snapshot-creation-retention.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="incremental-snapshots-backup.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="volume-status.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="snapshot-restore.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="snapshot-throttling.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="snapshot-performance-vmware.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/working-with-system-vm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-system-vm.xml b/docs/en-US/working-with-system-vm.xml
deleted file mode 100644
index 073d077..0000000
--- a/docs/en-US/working-with-system-vm.xml
+++ /dev/null
@@ -1,40 +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="working-with-system-vm">
- <title>Working with System Virtual Machines</title>
- <para>&PRODUCT; uses several types of system virtual machines to perform tasks in the cloud. In
- general &PRODUCT; manages these system VMs and creates, starts, and stops them as needed based
- on scale and immediate needs. However, the administrator should be aware of them and their roles
- to assist in debugging issues.</para>
- <note>
- <para>You can configure the system.vm.random.password parameter to create a random system VM
- password to ensure higher security. If you reset the value for system.vm.random.password to
- true and restart the Management Server, a random password is generated and stored encrypted in
- the database. You can view the decrypted password under the system.vm.password global
- parameter on the &PRODUCT; UI or by calling the listConfigurations API.</para>
- </note>
- <xi:include href="system-vm-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="accessing-system-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="multiple-system-vm-vmware.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="console-proxy.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="virtual-router.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="secondary-storage-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/working-with-templates.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-templates.xml b/docs/en-US/working-with-templates.xml
deleted file mode 100755
index c66fd0c..0000000
--- a/docs/en-US/working-with-templates.xml
+++ /dev/null
@@ -1,45 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<chapter id="working-with-templates">
- <title>Working with Templates</title>
- <para>A template is a reusable configuration for virtual machines. When users launch VMs, they can choose from a list of templates in &PRODUCT;.</para>
- <para>Specifically, a template is a virtual disk image that includes one of a variety of operating systems, optional additional software such as office applications, and settings such as access control to determine who can use the template. Each template is associated with a particular type of hypervisor, which is specified when the template is added to &PRODUCT;.</para>
- <para>&PRODUCT; ships with a default template. In order to present more choices to users, &PRODUCT; administrators and users can create templates and add them to &PRODUCT;.</para>
- <xi:include href="create-templates-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="requirements-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="best-practices-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="default-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="private-public-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="create-template-from-existing-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="create-template-from-snapshot.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="upload-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="export-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="create-linux-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="create-windows-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="import-ami.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="convert-hyperv-vm-to-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="add-password-management-to-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="delete-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/working-with-usage-data.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-usage-data.xml b/docs/en-US/working-with-usage-data.xml
deleted file mode 100644
index 5324617..0000000
--- a/docs/en-US/working-with-usage-data.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<chapter id="working-with-usage-data">
- <title>Working With Usage Data</title>
- <para>The Usage Server provides aggregated usage records which you can use to create billing integration for the &PRODUCT; platform. The Usage Server works by taking data from the events log and creating summary usage records that you can access using the listUsageRecords API call.</para>
- <para>The usage records show the amount of resources, such as VM run time or template storage space, consumed by guest instances. In the special case of bare metal instances, no template storage resources are consumed, but records showing zero usage are still included in the Usage Server's output.</para>
- <para>The Usage Server runs at least once per day. It can be configured to run multiple times per day. Its behavior is controlled by configuration settings as described in the &PRODUCT; Administration Guide.</para>
- <xi:include href="usage-record-format.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="usage-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="example-response-from-listUsageRecords.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="dates-in-usage-record.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="globally-configured-limits.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/working-with-volumes.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/working-with-volumes.xml b/docs/en-US/working-with-volumes.xml
deleted file mode 100644
index 5de5e6c..0000000
--- a/docs/en-US/working-with-volumes.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="working-with-volumes">
- <title>Working With Volumes</title>
- <para>A volume provides storage to a guest VM. The volume can provide for a root disk or an
- additional data disk. &PRODUCT; supports additional volumes for guest VMs. </para>
- <para>Volumes are created for a specific hypervisor type. A volume that has been attached to guest
- using one hypervisor type (e.g, XenServer) may not be attached to a guest that is using another
- hypervisor type, for example:vSphere, KVM. This is because the different hypervisors use different
- disk image formats. </para>
- <para>&PRODUCT; defines a volume as a unit of storage available to a guest VM. Volumes are either
- root disks or data disks. The root disk has "/" in the file system and is usually the boot
- device. Data disks provide for additional storage, for example: "/opt" or "D:". Every guest VM
- has a root disk, and VMs can also optionally have a data disk. End users can mount multiple data
- disks to guest VMs. Users choose data disks from the disk offerings created by administrators.
- The user can create a template from a volume as well; this is the standard procedure for private
- template creation. Volumes are hypervisor-specific: a volume from one hypervisor type may not be
- used on a guest of another hypervisor type. </para>
- <note>
- <para>&PRODUCT; supports attaching up to 13 data disks to a VM on XenServer hypervisor versions
- 6.0 and above. For the VMs on other hypervisor types, the data disk limit is 6.</para>
- </note>
- <xi:include href="creating-new-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="upload-existing-volume-to-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="attaching-volume.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="detach-move-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="vm-storage-migration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="resizing-volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="reset-volume-on-reboot.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="volume-deletion-garbage-collection.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/writing-new-documentation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/writing-new-documentation.xml b/docs/en-US/writing-new-documentation.xml
deleted file mode 100644
index 7557359..0000000
--- a/docs/en-US/writing-new-documentation.xml
+++ /dev/null
@@ -1,100 +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="writing-new-documentation">
- <title>Writing &PRODUCT; Documentation</title>
- <para>&PRODUCT; documentation is written in DocBook xml format. Each guide defined with a publican configuration file refers to a DocBook <emphasis>book</emphasis>.</para>
- <para>These books are defined in xml files in docs/en-US, for instance if we look at the Developers guide, its configuration file contains:</para>
- <programlisting>
- xml_lang: en-US
- type: Book
- docname: Developers_Guide
- brand: cloudstack
- chunk_first: 1
- chunk_section_depth: 1
- </programlisting>
- <para>The <emphasis>docname</emphasis> key gives you the basename of the DocBook file located in the en-US directory that contains the description of the book.</para>
- <para>Looking closely at Developers_Guide.xml we see that it contains <emphasis>book</emphasis> tags and several references to other xml files. These are the chapters of the book, currently they are:</para>
- <programlisting>
- <![CDATA[
- <xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="building-with-maven.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="api-calls.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="working-with-documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="tools.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- ]]>
- </programlisting>
- <para>All these xml files are written in DocBook format.</para>
- <note>
- <para>DocBook format is well <ulink url="http://www.docbook.org/tdg5/en/html/docbook.html">documented</ulink>, refer to the documentation for any questions about DocBook tags</para>
- </note>
- <para>When writing documentation, you therefore need to located the book,chapter and section of the content you want to write/correct.
- Or create a new book,chapter,section.</para>
- <para>You will then learn much more about DocBook tagging. In order to write this chapter about documentation, I added the <emphasis>working-with-documentation.xml</emphasis>file describing a chapter in the Developer book and I created several sections within that chapter like so:</para>
- <programlisting>
- <![CDATA[
- <chapter id="working-with-documentation">
- <title>Preparing and Building &PRODUCT; Documentation</title>
- <para>This chapter describes how to install publican, how to write new documentation and build a guide as well as how to build a translated version of the documentation using transifex</para>
- <xi:include href="installing-publican.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="building-documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="writing-new-documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="building-translation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </chapter>
- ]]>
- </programlisting>
-
- <para>Note the id witin the chapter tag, it represents the basename of the xml file describing the chapter.</para>
- <para>For translation purposes it is important that this basename be less than 50 characters long.</para>
-
- <para>This chapter also refers to xml files which contains each section. While you could embed the sections directly in the chapter file and as a matter of fact also write the chapters within a single book file. Breaking things up in smaller files at the granularity of the section, allows us to re-use any section to build different books.</para>
- <para>For completeness here is an example of a section:</para>
- <programlisting>
- <![CDATA[
- <section id="building-documentation">
- <title>Building &PRODUCT; Documentation</title>
- <para>To build a specific guide, go to the source tree of the documentation in /docs and identify the guide you want to build.</para>
- <para>Currently there are four guides plus the release notes, all defined in publican configuration files:</para>
- <programlisting>
- publican-adminguide.cfg
- publican-devguide.cfg
- publican-installation.cfg
- publican-plugin-niciranvp.cfg
- publican-release-notes.cfg
- </programlisting>
- <para>To build the Developer guide for example, do the following:</para>
- <programlisting>publican build --config=publican-devguide.cfg --formats=pdf --langs=en-US</programlisting>
- <para>A pdf file will be created in tmp/en-US/pdf, you may choose to build the guide in a different format like html. In that case just replace the format value.</para>
- </section>
- ]]>
- </programlisting>
- <para>Happy Publicating and DocBooking.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/xenserver-maintenance-mode.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/xenserver-maintenance-mode.xml b/docs/en-US/xenserver-maintenance-mode.xml
deleted file mode 100644
index b947278..0000000
--- a/docs/en-US/xenserver-maintenance-mode.xml
+++ /dev/null
@@ -1,51 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<section id="xenserver-maintenance-mode">
- <title>XenServer and Maintenance Mode</title>
- <para>For XenServer, you can take a server offline temporarily by using the Maintenance Mode feature in XenCenter. When you place a server into Maintenance Mode, all running VMs are automatically migrated from it to another host in the same pool. If the server is the pool master, a new master will also be selected for the pool. While a server is Maintenance Mode, you cannot create or start any VMs on it.</para>
- <para><emphasis role="bold">To place a server in Maintenance Mode:</emphasis></para>
- <orderedlist>
- <listitem><para>In the Resources pane, select the server, then do one of the following:</para>
- <itemizedlist>
- <listitem><para>Right-click, then click Enter Maintenance Mode on the shortcut menu.</para>
- </listitem>
- <listitem><para>On the Server menu, click Enter Maintenance Mode.</para>
- </listitem>
- </itemizedlist></listitem>
- <listitem><para>Click Enter Maintenance Mode.</para></listitem>
- </orderedlist>
- <para>The server's status in the Resources pane shows when all running VMs have been successfully migrated off the server.</para>
- <para><emphasis role="bold">To take a server out of Maintenance Mode:</emphasis></para>
- <orderedlist>
- <listitem><para>In the Resources pane, select the server, then do one of the following:</para>
- <itemizedlist>
- <listitem><para>Right-click, then click Exit Maintenance Mode on the shortcut menu.</para>
- </listitem>
- <listitem><para>On the Server menu, click Exit Maintenance Mode.</para>
- </listitem>
- </itemizedlist></listitem>
- <listitem><para>Click Exit Maintenance Mode.</para></listitem>
- </orderedlist>
-
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/xenserver-topology-req.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/xenserver-topology-req.xml b/docs/en-US/xenserver-topology-req.xml
deleted file mode 100644
index 12b9b07..0000000
--- a/docs/en-US/xenserver-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="xenserver-topology-req">
- <title>XenServer Topology Requirements</title>
- <para>The Management Servers communicate with XenServer hosts on ports 22 (ssh), 80 (HTTP), and 443 (HTTPs).</para>
-</section>