etan39
/
cloudstack
mirror of https://github.com/apache/cloudstack.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs for Elastic IP and display name in vCenter

This commit is contained in:
Radhika PC 2012-12-13 04:05:49 +05:30 committed by Pranav Saxena
parent 864ab37e13
commit 41dd38c86b
6 changed files with 460 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
docs/en-US/about-working-with-vms.xml
View File

@ -3,37 +3,62 @@
<!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.
<!--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="about-working-with-vms">
<title>About Working with Virtual Machines</title>
<para>&PRODUCT; provides administrators with complete control over the lifecycle of all guest VMs executing in the cloud. &PRODUCT; provides several guest management operations for end users and administrators. VMs may be stopped, started, rebooted, and destroyed.</para>
<para>Guest VMs have a name and group. VM names and groups are opaque to &PRODUCT; and are available for end users to organize their VMs. Each VM can have three names for use in different contexts. Only two of these names can be controlled by the user:</para>
<itemizedlist>
<listitem><para>Instance name &ndash; a unique, immutable ID that is generated by &PRODUCT; and can not be modified by the user. This name conforms to the requirements in IETF RFC 1123.</para></listitem>
<listitem><para>Display name &ndash; the name displayed in the &PRODUCT; web UI. Can be set by the user. Defaults to instance name.</para></listitem>
<listitem><para>Name &ndash; host name that the DHCP server assigns to the VM. Can be set by the user. Defaults to instance name</para></listitem>
</itemizedlist>
<para>Guest VMs can be configured to be Highly Available (HA). An HA-enabled VM is monitored by the system. If the system detects that the VM is down, it will attempt to restart the VM, possibly on a different host. For more information, see HA-Enabled Virtual Machines on </para>
<para>Each new VM is allocated one public IP address. When the VM is started, &PRODUCT; automatically creates a static NAT between this public IP address and the private IP address of the VM.</para>
<para>If elastic IP is in use (with the NetScaler load balancer), the IP address initially allocated to the new VM is not marked as elastic. The user must replace the automatically configured IP with a specifically acquired elastic IP, and set up the static NAT mapping between this new IP and the guest VM’s private IP. The VM’s original IP address is then released and returned to the pool of available public IPs.</para>
<para>&PRODUCT; cannot distinguish a guest VM that was shut down by the user (such as with the “shutdown” command in Linux) from a VM that shut down unexpectedly. If an HA-enabled VM is shut down from inside the VM, &PRODUCT; will restart it. To shut down an HA-enabled VM, you must go through the &PRODUCT; UI or API.</para>
<title>About Working with Virtual Machines</title>
<para>&PRODUCT; provides administrators with complete control over the lifecycle of all guest VMs
executing in the cloud. &PRODUCT; provides several guest management operations for end users and
administrators. VMs may be stopped, started, rebooted, and destroyed.</para>
<para>Guest VMs have a name and group. VM names and groups are opaque to &PRODUCT; and are
available for end users to organize their VMs. Each VM can have three names for use in different
contexts. Only two of these names can be controlled by the user:</para>
<itemizedlist>
<listitem>
<para>Instance name &ndash; a unique, immutable ID that is generated by &PRODUCT; and can not
be modified by the user. This name conforms to the requirements in IETF RFC 1123.</para>
</listitem>
<listitem>
<para>Display name &ndash; the name displayed in the &PRODUCT; web UI. Can be set by the user.
Defaults to instance name.</para>
</listitem>
<listitem>
<para>Name &ndash; host name that the DHCP server assigns to the VM. Can be set by the user.
Defaults to instance name</para>
</listitem>
</itemizedlist>
<note>
<para>You can append the display name of a guest VM to its internal name. For more information,
see <xref linkend="append-displayname-vms"/>.</para>
</note>
<para>Guest VMs can be configured to be Highly Available (HA). An HA-enabled VM is monitored by
the system. If the system detects that the VM is down, it will attempt to restart the VM,
possibly on a different host. For more information, see HA-Enabled Virtual Machines on </para>
<para>Each new VM is allocated one public IP address. When the VM is started, &PRODUCT;
automatically creates a static NAT between this public IP address and the private IP address of
the VM.</para>
<para>If elastic IP is in use (with the NetScaler load balancer), the IP address initially
allocated to the new VM is not marked as elastic. The user must replace the automatically
configured IP with a specifically acquired elastic IP, and set up the static NAT mapping between
this new IP and the guest VM’s private IP. The VM’s original IP address is then released and
returned to the pool of available public IPs. Optionally, you can also decide not to allocate a
public IP to a VM in an EIP-enabled Basic zone. For more information on Elastic IP, see <xref
linkend="elastic-ip"/>.</para>
<para>&PRODUCT; cannot distinguish a guest VM that was shut down by the user (such as with the
“shutdown” command in Linux) from a VM that shut down unexpectedly. If an HA-enabled VM is shut
down from inside the VM, &PRODUCT; will restart it. To shut down an HA-enabled VM, you must go
through the &PRODUCT; UI or API.</para>
</section>

84
docs/en-US/append-displayname-vms.xml Normal file
View File

@ -0,0 +1,84 @@
<?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="append-displayname-vms">
<title>Appending a Display Name to the Guest VM’s Internal Name</title>
<para>Every guest VM has an internal name. The host uses the internal name to identify the guest
VMs. &PRODUCT; gives you an option to provide a guest VM with a display name. You can set this
display name as the internal name so that the vCenter can use it to identify the guest VM. A new
global parameter, vm.instancename.flag, has now been added to achieve this functionality.</para>
<para>The default format of the internal name is
i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;, where instance.name is a global
parameter. However, If vm.instancename.flag is set to true, and if a display name is provided
during the creation of a guest VM, the display name is appended to the internal name of the
guest VM on the host. This makes the internal name format as
i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;displayName&gt;. The default value of vm.instancename.flag
is set to false. This feature is intended to make the correlation between instance names and
internal names easier in large data center deployments.</para>
<para>The following table explains how a VM name is displayed in different scenarios.</para>
<informaltable>
<tgroup cols="5" align="left" colsep="1" rowsep="1">
<colspec colnum="1" colname="c1" colwidth="1.0*"/>
<colspec colnum="2" colname="c2" colwidth="1.31*"/>
<colspec colnum="3" colname="c3" colwidth="1.07*"/>
<colspec colnum="4" colname="c4" colwidth="2.6*"/>
<colspec colnum="5" colname="c5" colwidth="4.65*"/>
<thead>
<row>
<entry><para>User-Provided Display Name </para></entry>
<entry><para>vm.instancename.flag</para></entry>
<entry><para>Hostname on the VM</para></entry>
<entry><para>Name on vCenter</para></entry>
<entry><para>Internal Name</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>Yes</para></entry>
<entry><para>True</para></entry>
<entry><para>Display name</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-displayName</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-displayName</para></entry>
</row>
<row>
<entry><para>No</para></entry>
<entry><para>True</para></entry>
<entry><para>UUID</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
</row>
<row>
<entry><para>Yes</para></entry>
<entry><para>False</para></entry>
<entry><para>Display name</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
</row>
<row>
<entry><para>No</para></entry>
<entry><para>False</para></entry>
<entry><para>UUID</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
<entry><para>i-&lt;user_id&gt;-&lt;vm_id&gt;-&lt;instance.name&gt;</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>

353
docs/en-US/creating-network-offerings.xml
View File

@ -3,115 +3,252 @@
<!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.
<!--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="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>Name. Any desired name for the network offering</para></listitem>
<listitem><para>Description. A short description of the offering that can be displayed to users</para></listitem>
<listitem><para>Network Rate. Allowed data transfer rate in MB per second</para></listitem>
<listitem><para>Traffic Type. The type of network traffic that will be carried on the network</para></listitem>
<listitem><para>Guest Type. 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>Specify VLAN. (Isolated guest networks only) Indicate whether a VLAN should be specified when this offering is used</para></listitem>
<listitem><para>Supported Services. 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></para></entry>
<entry><para>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>DNS</para></entry>
<entry><para></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></para></entry>
<entry><para>Supported</para></entry>
<entry><para>Not Supported</para></entry>
</row>
<row>
<entry><para>User Data</para></entry>
<entry><para></para></entry>
<entry><para>Not Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
<row>
<entry><para>Security Groups</para></entry>
<entry><para>See <xref linkend="add-security-group"/>.</para></entry>
<entry><para>Not Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<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>
<para>The Add Network Offering dialog is displayed:</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>. Select 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)
Indicates 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>Not Supported</para></entry>
</row>
<row>
<entry><para>Firewall</para></entry>
<entry><para>For more information, see <xref linkend="firewall-rules"
/>.</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>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>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>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>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>Supported</para></entry>
<entry><para>Supported</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
<listitem>
<para><emphasis role="bold">System Offering</emphasis>: Available only when the service
provider for any of the services selected is Virtual Router. Choose the system service
offering that you want the virtual routers to use in this network. For example, if you
selected Load Balancer in Supported Services and select 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">LB Isolation</emphasis>: Specify what type of load balancer
isolation you want for the network: Shared or Dedicated.</para>
<para><emphasis role="bold">Dedicated</emphasis>: If you select dedicated LB isolation, a
dedicated load balancer device is assigned for the network from the pool of dedicated
load balancer devices provisioned in the zone. If no sufficient dedicated load balancer
devices are available in the zone, network creation fails. Dedicated device is a good
choice for the high-traffic networks that make full use of the device's
resources.</para>
<para><emphasis role="bold">Shared</emphasis>: If you select shared LB isolation, a shared
load balancer device is assigned for the network from the pool of shared load balancer
devices provisioned in the zone. While provisioning &PRODUCT; picks the shared load
balancer device that is used by the least number of accounts. Once the device reaches
its maximum capacity, the device will not be allocated to a new account.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Mode</emphasis>: You can select either Inline mode or Side by
Side mode:</para>
<para><emphasis role="bold">Inline mode</emphasis>: Supported only for Juniper SRX
firewall and BigF5 load balancer devices. In inline mode, a firewall device is placed in
front of a load balancing device. The firewall acts as the gateway for all the incoming
traffic, then redirect the load balancing traffic to the load balancer behind it. The
load balancer in this case will not have the direct access to the public network. </para>
<para><emphasis role="bold">Side by Side</emphasis>: In side by side mode, a firewall
device is deployed in parallel with the load balancer device. So the traffic to the load
balancer public IP is not routed through the firewall, and therefore, is exposed to the
public network.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Associate Public IP</emphasis>: Select this option if you want
to assign a public IP address to the VMs deployed in the guest network. This option is
available only if</para>
<itemizedlist>
<listitem>
<para>Guest network is shared.</para>
</listitem>
<listitem><para>System Offering. 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>Redundant router capability. (v3.0.3 and greater) 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>Conserve mode. 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>
<listitem><para>Tags. Network tag to specify which physical network to use</para></listitem>
</itemizedlist></listitem>
<listitem><para>Click Add.</para></listitem>
</orderedlist>
<listitem>
<para>Supported load balancer provider is Netscaler.</para>
</listitem>
<listitem>
<para>StaticNAT is enabled.</para>
</listitem>
<listitem>
<para>Elastic IP is enabled.</para>
</listitem>
</itemizedlist>
<para>For information on Elastic IP, see <xref linkend="elastic-ip"/>.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Redundant router capability</emphasis>: (v3.0.3 and greater)
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>: Specify 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>

73
docs/en-US/elastic-ip.xml Normal file
View File

@ -0,0 +1,73 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="elastic-ip">
<title>About Elastic IP</title>
<para>Elastic IP (EIP) addresses are the IP addresses that are associated with an account, and act
as static IP addresses. The account owner has the complete control over the Elastic IP addresses
that belong to the account. You can allocate an Elastic IP to a VM of your choice from the EIP
pool of your account. Later if required you can reassign the IP address to a different VM. This
feature is extremely helpful during VM failure. Instead of replacing the VM which is down, the
IP address can be reassigned to a new VM in your account. Similar to the public IP address, EIPs
are mapped to their associated private IP addresses by using StacticNAT.</para>
<para>The EIP work flow is as follows:</para>
<itemizedlist>
<listitem>
<para>When a user VM is deployed, a public IP is automatically acquired from the pool of
public IPs configured in the zone. This IP is owned by the VM's account.</para>
</listitem>
<listitem>
<para>Each VM will have its own private IP. When the user VM starts, the public IP is mapped
to the private IP of the VM by using StaticNAT.</para>
</listitem>
<listitem>
<para>This default public IP will be released in two cases:</para>
<itemizedlist>
<listitem>
<para>When the VM is stopped. When the VM starts, it again receives a new public IP, not
necessarily be the one allocated initially, from the pool of Public IPs.</para>
</listitem>
<listitem>
<para>The user acquires a public IP. This public IP associated with the account will not
be mapped to any private IP. However, the user can enable StaticNAT to associate this IP
to the private IP of a VM in the account. The StaticNAT rule for the public IP can be
disabled at any time. When StaticNAT is disabled, a new public IP is allocated from the
pool, which is not necessarily be the one allocated initially.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>However, for the deployments where public IPs are limited resources, you have the
flexibility to choose not to allocate a public IP by default. From &PRODUCT; 3.0.6 onwards, you
can use the Associate public IP option to turn on or off the automatic public IP assignment in
the EIP-enabled Basic zones. If you turn off the automatic public IP assignment while creating a
network offering, only a private IP is assigned to a VM when it's deployed with the same network
offering. Later, the user can acquire an IP for the VM and enable staticNAT. The <xref
linkend="creating-network-offerings"/> section gives you more information on the Associate
public IP option.</para>
<note>
<para>The Associate public IP feature is designed only for the user VMs. The System VMs continue
to get both public IP and private by default irrespective of the network offering
configuration. </para>
</note>
<para>In the case of new deployments, which uses the default shared network offering with EIP
and ELB services to create shared network in the Basic zone, will continue allocating public IPs
to each user VMs.</para>
</section>

1
docs/en-US/networks.xml
View File

@ -43,6 +43,7 @@
<xi:include href="ip-load-balancing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="dns-dhcp.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="elastic-ip.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"/>
</chapter>

1
docs/en-US/virtual-machines.xml
View File

@ -27,6 +27,7 @@
<xi:include href="accessing-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="stopping-and-starting-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="changing-vm-name-os-group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="append-displayname-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="changing-service-offering-for-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="manual-live-migration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="deleting-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>