Revert "Persistent Networks Documentation:Reviewed by - Jessica Tomechak and Likitha Shetty"
This reverts commit eaf7767c8521e88f9d5b6f2865acafd34f9430fe. Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/f23ec61a Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/f23ec61a Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/f23ec61a Branch: refs/heads/qemu-img Commit: f23ec61a3212e2a298a2d1d781a202d3a4926f5b Parents: 0a9af54 Author: Pranav Saxena <[email protected]> Authored: Wed Feb 13 14:47:50 2013 +0530 Committer: Pranav Saxena <[email protected]> Committed: Wed Feb 13 14:47:50 2013 +0530 ---------------------------------------------------------------------- docs/en-US/creating-network-offerings.xml | 347 ++++++++++-------------- docs/en-US/networks.xml | 3 +- docs/en-US/persistent-network.xml | 99 ------- 3 files changed, 143 insertions(+), 306 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f23ec61a/docs/en-US/creating-network-offerings.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/creating-network-offerings.xml b/docs/en-US/creating-network-offerings.xml index 07f5a9e..0269ce0 100644 --- a/docs/en-US/creating-network-offerings.xml +++ b/docs/en-US/creating-network-offerings.xml @@ -22,209 +22,146 @@ under the License. --> <section id="creating-network-offerings"> - <title>Creating a New Network Offering</title> - <para>To create a network offering:</para> - <orderedlist> - <listitem> - <para>Log in with admin privileges to the &PRODUCT; UI.</para> - </listitem> - <listitem> - <para>In the left navigation bar, click Service Offerings.</para> - </listitem> - <listitem> - <para>In Select Offering, choose Network Offering.</para> - </listitem> - <listitem> - <para>Click Add Network Offering.</para> - </listitem> - <listitem> - <para>In the dialog, make 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">Guest Type</emphasis>. Choose whether the guest network is - isolated or shared. </para> - <para condition="admin">For a description of this term, see <xref - linkend="about-virtual-networks"/>.</para> - <para condition="install">For a description of this term, see the Administration Guide. - </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. For more information, see <xref - linkend="persistent-network"/>.</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">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">Supported Services</emphasis>. Select one or more of the - possible network services. For some services, you must also choose the service provider; - for example, if you select Load Balancer, you can choose the &PRODUCT; virtual router or - any other load balancers that have been configured in the cloud. Depending on which - services you choose, additional fields may appear in the rest of the dialog box.</para> - <para>Based on the guest network type selected, you can see the following supported - services:</para> - <informaltable> - <tgroup cols="4" align="left" colsep="1" rowsep="1"> - <thead> - <row> - <entry><para>Supported Services</para></entry> - <entry><para>Description</para></entry> - <entry><para>Isolated</para></entry> - <entry><para>Shared</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>DHCP</para></entry> - <entry><para>For more information, see <xref linkend="dns-dhcp"/>.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>DNS</para></entry> - <entry><para>For more information, see <xref linkend="dns-dhcp"/>.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Load Balancer</para></entry> - <entry><para>If you select Load Balancer, you can choose the &PRODUCT; virtual - router or any other load balancers that have been configured in the - cloud.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Firewall</para></entry> - <entry><para condition="admin">For more information, see <xref - linkend="firewall-rules"/>.</para> - <para condition="admin">For more information, see the Administration - Guide.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Source NAT</para></entry> - <entry><para>If you select Source NAT, you can choose the &PRODUCT; virtual router - or any other Source NAT providers that have been configured in the - cloud.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Static NAT</para></entry> - <entry><para>If you select Static NAT, you can choose the &PRODUCT; virtual router - or any other Static NAT providers that have been configured in the - cloud.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Port Forwarding</para></entry> - <entry><para>If you select Port Forwarding, you can choose the &PRODUCT; virtual - router or any other Port Forwarding providers that have been configured in the - cloud.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Not Supported</para></entry> - </row> - <row> - <entry><para>VPN</para></entry> - <entry><para>For more information, see <xref linkend="vpn"/>.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Not Supported</para></entry> - </row> - <row> - <entry><para>User Data</para></entry> - <entry><para condition="admin">For more information, see <xref - linkend="user-data-and-meta-data"/>.</para> - <para condition="install">For more information, see the Administration - Guide.</para></entry> - <entry><para>Not Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Network ACL</para></entry> - <entry><para>For more information, see <xref linkend="configure-acl" - />.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Not Supported</para></entry> - </row> - <row> - <entry><para>Security Groups</para></entry> - <entry><para>For more information, see <xref linkend="add-security-group" - />.</para></entry> - <entry><para>Not Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </listitem> - <listitem> - <para><emphasis role="bold">System Offering</emphasis>. If the service provider for any of - the services selected in Supported Services is a virtual router, the System Offering - field appears. Choose the system service offering that you want virtual routers to use - in this network. For example, if you selected Load Balancer in Supported Services and - selected a virtual router to provide load balancing, the System Offering field appears - so you can choose between the &PRODUCT; default system service offering and any custom - system service offerings that have been defined by the &PRODUCT; root - administrator.</para> - <para condition="admin">For more information, see <xref linkend="system-service-offerings"/>.</para> - <para condition="install">For more information, see the Administration Guide.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Redundant router capability</emphasis>. Available only when - Virtual Router is selected as the Source NAT provider. Select this option if you want to - use two virtual routers in the network for uninterrupted connection: one operating as - the master virtual router and the other as the backup. The master virtual router - receives requests from and sends responses to the userâs VM. The backup virtual router - is activated only when the master is down. After the failover, the backup becomes the - master virtual router. &PRODUCT; deploys the routers on different hosts to ensure - reliability if one host is down.</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. When conservative mode is off, the public IP can only be used for - a single service. For example, a public IP used for a port forwarding rule cannot be - used for defining other services, such as SaticNAT or load balancing. When the conserve - mode is on, you can define more than one service on the same public IP.</para> - <note> - <para>If StaticNAT is enabled, irrespective of the status of the conserve mode, no port - forwarding or load balancing rule can be created for the IP. However, you can add - firewall rules by using the createFirewallRule command.</para> - </note> - </listitem> - <listitem> - <para><emphasis role="bold">Tags</emphasis>. Network tag to specify which physical network - to use.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Click Add.</para> - </listitem> - </orderedlist> + <title>Creating a New Network Offering</title> + <para>To create a network offering:</para> + <orderedlist> + <listitem><para>Log in with admin privileges to the &PRODUCT; UI.</para></listitem> + <listitem><para>In the left navigation bar, click Service Offerings.</para></listitem> + <listitem><para>In Select Offering, choose Network Offering.</para></listitem> + <listitem><para>Click Add Network Offering.</para></listitem> + <listitem><para>In the dialog, make 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">Guest Type</emphasis>. Choose whether the guest network is isolated or + shared. For a description of these terms, see <xref + linkend="about-virtual-networks"/> + </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>. Select one or more of the possible + network services. For some services, you must also choose the service + provider; for example, if you select Load Balancer, you can choose the + &PRODUCT; virtual router or any other load balancers that have been + configured in the cloud. Depending on which services you choose, additional + fields may appear in the rest of the dialog box.</para><para>Based on the guest network type selected, you can see the following supported services:</para><informaltable> + <tgroup cols="4" align="left" colsep="1" rowsep="1"> + <thead> + <row> + <entry><para>Supported Services</para></entry> + <entry><para>Description</para></entry> + <entry><para>Isolated</para></entry> + <entry><para>Shared</para></entry> + </row> + </thead> + <tbody> + <row> + <entry><para>DHCP</para></entry> + <entry><para>For more information, see <xref linkend="dns-dhcp"/>.</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Supported</para></entry> + </row> + <row> + <entry><para>DNS</para></entry> + <entry><para>For more information, see <xref linkend="dns-dhcp"/>.</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Supported</para></entry> + </row> + <row> + <entry><para>Load Balancer</para></entry> + <entry><para>If you select Load Balancer, you can choose the &PRODUCT; virtual router or any other load + balancers that have been configured in the cloud.</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Supported</para></entry> + </row> + <row> + <entry><para>Source NAT</para></entry> + <entry><para>If you select Source NAT, you can choose the &PRODUCT; virtual router or any other Source + NAT providers that have been configured in the + cloud.</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Supported</para></entry> + </row> + <row> + <entry><para>Static NAT</para></entry> + <entry><para>If you select Static NAT, you can choose the &PRODUCT; virtual router or any other Static + NAT providers that have been configured in the + cloud.</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Supported</para></entry> + </row> + <row> + <entry><para>Port Forwarding</para></entry> + <entry><para>If you select Port Forwarding, you can choose the &PRODUCT; virtual router or any other + Port Forwarding providers that have been configured in + the cloud.</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Not Supported</para></entry> + </row> + <row> + <entry><para>VPN</para></entry> + <entry><para>For more information, see <xref linkend="vpn"/>.</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Not Supported</para></entry> + </row> + <row> + <entry><para>User Data</para></entry> + <entry><para>For more information, see <xref linkend="user-data-and-meta-data"/>.</para></entry> + <entry><para>Not Supported</para></entry> + <entry><para>Supported</para></entry> + </row> + <row> + <entry><para>Network ACL</para></entry> + <entry><para>For more information, see <xref linkend="configure-acl"/>.</para></entry> + <entry><para>Supported</para></entry> + <entry><para>Not Supported</para></entry> + </row> + <row> + <entry><para>Security Groups</para></entry> + <entry><para>For more information, see <xref linkend="add-security-group"/>.</para></entry> + <entry><para>Not Supported</para></entry> + <entry><para>Supported</para></entry> + </row> + </tbody> + </tgroup> + </informaltable> + </listitem> + <listitem><para><emphasis role="bold">System Offering</emphasis>. If the service provider for any of the + services selected in Supported Services is a virtual router, the System + Offering field appears. Choose the system service offering that you want + virtual routers to use in this network. For example, if you selected Load + Balancer in Supported Services and selected a virtual router to provide load + balancing, the System Offering field appears so you can choose between the + &PRODUCT; default system service offering and any custom system service + offerings that have been defined by the &PRODUCT; root administrator. + For more information, see System Service Offerings.</para></listitem> + <listitem><para><emphasis role="bold">Redundant router capability</emphasis>. Available + only when Virtual Router is selected as the Source NAT provider. Select this + option if you want to use two virtual routers in the network for + uninterrupted connection: one operating as the master virtual router and the + other as the backup. The master virtual router receives requests from and + sends responses to the userâs VM. The backup virtual router is activated + only when the master is down. After the failover, the backup becomes the + master virtual router. &PRODUCT; deploys the routers on different hosts + to ensure reliability if one host is down.</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. When the conservative mode is off, the public IP can + only be used for a single service. For example, a public IP used for a port + forwarding rule cannot be used for defining other services, such as SaticNAT + or load balancing. When the conserve mode is on, you can define more than + one service on the same public IP.</para> + <note><para>If StaticNAT is enabled, irrespective of the status of the conserve mode, no port forwarding + or load balancing rule can be created for the IP. However, you can add + the firewall rules by using the createFirewallRule command.</para></note></listitem> + <listitem><para><emphasis role="bold">Tags</emphasis>. Network tag to specify which physical network to + use.</para></listitem> + </itemizedlist></listitem> + <listitem><para>Click Add.</para></listitem> + </orderedlist> + + </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f23ec61a/docs/en-US/networks.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/networks.xml b/docs/en-US/networks.xml index 8305769..a7b9ea1 100644 --- a/docs/en-US/networks.xml +++ b/docs/en-US/networks.xml @@ -45,5 +45,4 @@ <xi:include href="vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="inter-vlan-routing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> <xi:include href="configure-vpc.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <xi:include href="persistent-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> -</chapter> +</chapter> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f23ec61a/docs/en-US/persistent-network.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/persistent-network.xml b/docs/en-US/persistent-network.xml deleted file mode 100644 index e371940..0000000 --- a/docs/en-US/persistent-network.xml +++ /dev/null @@ -1,99 +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="persistent-network"> - <title>Persistent Networks</title> - <para>The network that you can provision without having to deploy any VMs on it is called a - persistent network. A persistent network can be part of a VPC or a non-VPC environment.</para> - <para>When you create other types of network, a network is only a database entry until the first - VM is created on that network. When the first VM is created, a VLAN ID is assigned and the - network is provisioned. Also, when the last VM is destroyed, the VLAN ID is released and the - network is no longer available. With the addition of persistent network, you will have the - ability to create a network in &PRODUCT; in which physical devices can be deployed without - having to run any VMs. Additionally, you can deploy physical devices on that network.</para> - <para>One of the advantages of having a persistent network is that you can create a VPC with a tier - consisting of only physical devices. For example, you might create a VPC for a three-tier - application, deploy VMs for Web and Application tier, and use physical machines for the - Database tier. Another use case is that if you are providing services by using physical - hardware, you can define the network as persistent and therefore even if all its VMs are - destroyed the services will not be discontinued.</para> - <section id="persistent-network-consideration"> - <title>Persistent Network Considerations</title> - <itemizedlist> - <listitem> - <para>Persistent network is designed for isolated networks.</para> - </listitem> - <listitem> - <para>All default network offerings are non-persistent.</para> - </listitem> - <listitem> - <para>A network offering cannot be editable because changing it affects the behavior of the - existing networks that were created using this network offering.</para> - </listitem> - <listitem> - <para>When you create a guest network, the network offering that you select defines the - network persistence. This in turn depends on whether persistent network is enabled in the - selected network offering. </para> - </listitem> - <listitem> - <para>An existing network can be made persistent by changing its network offering to an - offering that has the Persistent option enabled. While setting this property, even if the - network has no running VMs, the network is provisioned. </para> - </listitem> - <listitem> - <para>An existing network can be made non-persistent by changing its network offering to an - offering that has the Persistent option disabled. If the network has no running VMs, - during the next network garbage collection run the network is shut down.</para> - </listitem> - <listitem> - <para>When the last VM on a network is destroyed, the network garbage collector checks if - the network offering associated with the network is persistent, and shuts down the network - only if it is non-persistent.</para> - </listitem> - </itemizedlist> - </section> - <section id="set-up-persistent-network"> - <title>Creating a Persistent Guest Network</title> - <para>To create a persistent network, perform the following:</para> - <orderedlist> - <listitem> - <para>Create a network offering with the Persistent option enabled.</para> - <para>See <xref linkend="creating-network-offerings"/>.</para> - </listitem> - <listitem> - <para>Select Network from the left navigation pane.</para> - </listitem> - <listitem> - <para>Select the guest network that you want to offer this network service to.</para> - </listitem> - <listitem> - <para>Click the Edit button.</para> - </listitem> - <listitem> - <para>From the Network Offering drop-down, select the persistent network offering you have - just created.</para> - </listitem> - <listitem> - <para>Click OK.</para> - </listitem> - </orderedlist> - </section> -</section>
