diff --git a/docs/en-US/about-working-with-vms.xml b/docs/en-US/about-working-with-vms.xml
index 47153e2f374..df71f05f8ef 100644
--- a/docs/en-US/about-working-with-vms.xml
+++ b/docs/en-US/about-working-with-vms.xml
@@ -3,37 +3,62 @@
%BOOK_ENTITIES;
]>
-
-
-
- About Working with Virtual Machines
- &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.
- 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:
-
- Instance name – 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.
- Display name – the name displayed in the &PRODUCT; web UI. Can be set by the user. Defaults to instance name.
- Name – host name that the DHCP server assigns to the VM. Can be set by the user. Defaults to instance name
-
- 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
- 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.
- 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.
- &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.
+ About Working with Virtual Machines
+ &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.
+ 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:
+
+
+ Instance name – 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.
+
+
+ Display name – the name displayed in the &PRODUCT; web UI. Can be set by the user.
+ Defaults to instance name.
+
+
+ Name – host name that the DHCP server assigns to the VM. Can be set by the user.
+ Defaults to instance name
+
+
+
+ You can append the display name of a guest VM to its internal name. For more information,
+ see .
+
+ 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
+ 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.
+ 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 .
+ &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.
-
diff --git a/docs/en-US/append-displayname-vms.xml b/docs/en-US/append-displayname-vms.xml
new file mode 100644
index 00000000000..ff0752cadc1
--- /dev/null
+++ b/docs/en-US/append-displayname-vms.xml
@@ -0,0 +1,84 @@
+
+
+%BOOK_ENTITIES;
+]>
+
+
+ Appending a Display Name to the Guest VM’s Internal Name
+ 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.
+ The default format of the internal name is
+ i-<user_id>-<vm_id>-<instance.name>, 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-<user_id>-<vm_id>-<displayName>. 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.
+ The following table explains how a VM name is displayed in different scenarios.
+
+
+
+
+
+
+
+
+
+ User-Provided Display Name
+ vm.instancename.flag
+ Hostname on the VM
+ Name on vCenter
+ Internal Name
+
+
+
+
+ Yes
+ True
+ Display name
+ i-<user_id>-<vm_id>-displayName
+ i-<user_id>-<vm_id>-displayName
+
+
+ No
+ True
+ UUID
+ i-<user_id>-<vm_id>-<instance.name>
+ i-<user_id>-<vm_id>-<instance.name>
+
+
+ Yes
+ False
+ Display name
+ i-<user_id>-<vm_id>-<instance.name>
+ i-<user_id>-<vm_id>-<instance.name>
+
+
+ No
+ False
+ UUID
+ i-<user_id>-<vm_id>-<instance.name>
+ i-<user_id>-<vm_id>-<instance.name>
+
+
+
+
+
diff --git a/docs/en-US/creating-network-offerings.xml b/docs/en-US/creating-network-offerings.xml
index ab569200641..6e0315def69 100644
--- a/docs/en-US/creating-network-offerings.xml
+++ b/docs/en-US/creating-network-offerings.xml
@@ -3,115 +3,252 @@
%BOOK_ENTITIES;
]>
-
-
-
- Creating a New Network Offering
- To create a network offering:
-
- Log in with admin privileges to the &PRODUCT; UI.
- In the left navigation bar, click Service Offerings.
- In Select Offering, choose Network Offering.
- Click Add Network Offering.
- In the dialog, make the following choices:
-
- Name. Any desired name for the network offering
- Description. A short description of the offering that can be displayed to users
- Network Rate. Allowed data transfer rate in MB per second
- Traffic Type. The type of network traffic that will be carried on the network
- Guest Type. Choose whether the guest network is isolated or shared. For a description of these terms, see
- Specify VLAN. (Isolated guest networks only) Indicate whether a VLAN should be specified when this offering is used
- 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.Based on the guest network type selected, you can see the following supported services:
-
-
-
- Supported Services
- Description
- Isolated
- Shared
-
-
-
-
- DHCP
-
- Supported
- Supported
-
-
- DNS
-
- Supported
- Supported
-
-
- Load Balancer
- If you select Load Balancer, you can choose the &PRODUCT; virtual router or any other load balancers that have been configured in the cloud.
- Supported
- Supported
-
-
- Source NAT
- 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.
- Supported
- Supported
-
-
- Static NAT
- 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.
- Supported
- Supported
-
-
- Port Forwarding
- 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.
- Supported
- Not Supported
-
-
- VPN
-
- Supported
- Not Supported
-
-
- User Data
-
- Not Supported
- Supported
-
-
- Security Groups
- See .
- Not Supported
- Supported
-
-
-
-
+ Creating a New Network Offering
+ To create a network offering:
+
+
+ Log in with admin privileges to the &PRODUCT; UI.
+
+
+ In the left navigation bar, click Service Offerings.
+
+
+ In Select Offering, choose Network Offering.
+
+
+ Click Add Network Offering.
+ The Add Network Offering dialog is displayed:
+
+
+ In the dialog, make the following choices:
+
+
+ Name. Any desired name for the network
+ offering.
+
+
+ Description. A short description of the offering
+ that can be displayed to users.
+
+
+ Network Rate. Allowed data transfer rate in MB per
+ second.
+
+
+ Guest Type. Select whether the guest network is
+ isolated or shared. For a description of these terms, see .
+
+
+ Specify VLAN. (Isolated guest networks only)
+ Indicates whether a VLAN should be specified when this offering is used.
+
+
+ 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.
+ Based on the guest network type selected, you can see the following supported
+ services:
+
+
+
+
+ Supported Services
+ Description
+ Isolated
+ Shared
+
+
+
+
+ DHCP
+ For more information, see .
+ Supported
+ Supported
+
+
+ DNS
+ For more information, see .
+ Supported
+ Supported
+
+
+ Load Balancer
+ If you select Load Balancer, you can choose the &PRODUCT; virtual
+ router or any other load balancers that have been configured in the
+ cloud.
+ Supported
+ Not Supported
+
+
+ Firewall
+ For more information, see .
+ Supported
+ Supported
+
+
+ Source NAT
+ 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.
+ Supported
+ Supported
+
+
+ Static NAT
+ 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.
+ Supported
+ Supported
+
+
+ Port Forwarding
+ 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.
+ Supported
+ Supported
+
+
+ VPN
+ For more information, see .
+ Supported
+ Supported
+
+
+ User Data
+ For more information, see .
+ Supported
+ Supported
+
+
+ Network ACL
+ For more information, see .
+ Supported
+ Supported
+
+
+ Security Groups
+ For more information, see .
+ Supported
+ Supported
+
+
+
+
+
+
+ System Offering: 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.
+
+
+ LB Isolation: Specify what type of load balancer
+ isolation you want for the network: Shared or Dedicated.
+ Dedicated: 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.
+ Shared: 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.
+
+
+ Mode: You can select either Inline mode or Side by
+ Side mode:
+ Inline mode: 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.
+ Side by Side: 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.
+
+
+ Associate Public IP: 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
+
+
+ Guest network is shared.
- 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.
- 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.
- 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
- Tags. Network tag to specify which physical network to use
-
- Click Add.
-
+
+ Supported load balancer provider is Netscaler.
+
+
+ StaticNAT is enabled.
+
+
+ Elastic IP is enabled.
+
+
+ For information on Elastic IP, see .
+
+
+ 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.
+
+
+ Conserve mode: 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.
+
+ 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.
+
+
+
+ Tags: Network tag to specify which physical network
+ to use.
+
+
+
+
+ Click Add.
+
+
diff --git a/docs/en-US/elastic-ip.xml b/docs/en-US/elastic-ip.xml
new file mode 100644
index 00000000000..fa3795ae0de
--- /dev/null
+++ b/docs/en-US/elastic-ip.xml
@@ -0,0 +1,73 @@
+
+
+%BOOK_ENTITIES;
+]>
+
+
+ About Elastic IP
+ 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.
+ The EIP work flow is as follows:
+
+
+ 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.
+
+
+ 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.
+
+
+ This default public IP will be released in two cases:
+
+
+ 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.
+
+
+ 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.
+
+
+
+
+ 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 section gives you more information on the Associate
+ public IP option.
+
+ 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.
+
+ 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.
+
diff --git a/docs/en-US/networks.xml b/docs/en-US/networks.xml
index a7b9ea12466..8a0f9fa357f 100644
--- a/docs/en-US/networks.xml
+++ b/docs/en-US/networks.xml
@@ -43,6 +43,7 @@
+
\ No newline at end of file
diff --git a/docs/en-US/virtual-machines.xml b/docs/en-US/virtual-machines.xml
index 7c74932b649..d0ab01520fc 100644
--- a/docs/en-US/virtual-machines.xml
+++ b/docs/en-US/virtual-machines.xml
@@ -27,6 +27,7 @@
+