You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by pr...@apache.org on 2013/04/11 00:26:22 UTC
[41/54] [abbrv] git commit: updated refs/heads/affinity_groups to
6ec7e25
CLOUDSTACK-809
Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/38a8db90
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/38a8db90
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/38a8db90
Branch: refs/heads/affinity_groups
Commit: 38a8db9046eb680f368335634be838499d7b2aa5
Parents: c2fb870
Author: radhikap <ra...@citrix.com>
Authored: Tue Apr 9 13:32:08 2013 +0530
Committer: radhikap <ra...@citrix.com>
Committed: Wed Apr 10 17:26:35 2013 +0530
----------------------------------------------------------------------
docs/en-US/added-API-commands-4.2.xml | 38 ++++++++
docs/en-US/multiple-ip-nic.xml | 134 ++++++++++++++++++++++++++++
docs/en-US/networks.xml | 1 +
docs/en-US/whats-new.xml | 6 +-
4 files changed, 178 insertions(+), 1 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/38a8db90/docs/en-US/added-API-commands-4.2.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/added-API-commands-4.2.xml b/docs/en-US/added-API-commands-4.2.xml
new file mode 100644
index 0000000..3b765f2
--- /dev/null
+++ b/docs/en-US/added-API-commands-4.2.xml
@@ -0,0 +1,38 @@
+<?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="added-API-commands-4.2">
+ <title>Added API Commands in 4.2</title>
+ <itemizedlist>
+ <listitem>
+ <para>addIpToNic (Adds an IP address to the NIC from the guest subnet. The request parameters
+ are: nicid, ipaddress)</para>
+ </listitem>
+ <listitem>
+ <para>removeIpFromNic (Removes the reserved IP for the NIC. The request parameters is:
+ id)</para>
+ </listitem>
+ <listitem>
+ <para>listNics (Lists the NIC details of the user VM; the API response also contains the
+ Secondary IP addresses of the NIC. The request parameters are: nicid,
+ virtualmachineid)</para>
+ </listitem>
+ </itemizedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/38a8db90/docs/en-US/multiple-ip-nic.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/multiple-ip-nic.xml b/docs/en-US/multiple-ip-nic.xml
new file mode 100644
index 0000000..fb9a331
--- /dev/null
+++ b/docs/en-US/multiple-ip-nic.xml
@@ -0,0 +1,134 @@
+<?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="multiple-ip-nic">
+ <title>Configuring Multiple IP Addresses on a Single NIC</title>
+ <para>&PRODUCT; now provides you the ability to associate multiple private IP addresses per NIC.
+ This feature is supported on all the network configurations—Basic, Advanced, and VPC.
+ Security Groups, Static NAT and Port forwarding services are supported on these additional IPs.
+ In addition to the primary IP, you can assign additional IPs to the guest VM NIC. Up to 256 IP
+ addresses are allowed per NIC.</para>
+ <para>As always, you can specify an IP from the guest subnet; if not specified, an IP is
+ automatically picked up from the guest subnet. You can view the IPs and associated NICs
+ for each VMs on the UI. You can apply NAT on these additional guest IPs by using firewall
+ configuration in the &PRODUCT; UI. You must specify the NIC to which the IP should be
+ associated.</para>
+ <para>This feature is supported on XenServer, KVM, and VMware hypervisors.</para>
+ <para>Some of the use cases are described below:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Building network appliances: Network appliances, such as firewalls and load
+ balancers, generally work best when they have access to multiple IP addresses on the
+ network interface.</para>
+ </listitem>
+ <listitem>
+ <para>Moving private IP addresses between interfaces or instances. Applications that are
+ bound to specific IP addresses can be moved between instances. </para>
+ </listitem>
+ <listitem>
+ <para>Hosting multiple SSL Websites on a single instance. You can install multiple SSL
+ certificates on a single instance, each associated with a distinct IP address.</para>
+ </listitem>
+ </itemizedlist>
+ <section id="workflow-rn">
+ <title>Assigning Additional IPs to a VM</title>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation bar, click Instances.</para>
+ </listitem>
+ <listitem>
+ <para>Click the name of the instance you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>In the Details tab, click NICs.</para>
+ </listitem>
+ <listitem>
+ <para>Click View All.</para>
+ </listitem>
+ <listitem>
+ <para>Click Acquire New IP, and click Yes in the confirmation dialog.</para>
+ <para>You are prompted for confirmation because, typically, IP addresses are a limited
+ resource. Within a few moments, the new IP address should appear with the state Allocated.
+ You can now use the IP address in Port Forwarding or StaticNAT rules.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section id="api-nic">
+ <title>API Changes</title>
+ <para>The following APIs have been added:</para>
+ <informaltable>
+ <tgroup cols="4" align="left" colsep="1" rowsep="1">
+ <thead>
+ <row>
+ <entry><para>Parameter Name</para></entry>
+ <entry><para>Description</para></entry>
+ <entry><para>Request Parameter</para></entry>
+ <entry><para>Response Parameter</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>addIpToNic</para></entry>
+ <entry><para>Adds an IP address to the NIC from the guest subnet.</para></entry>
+ <entry>
+ <para>nicid</para>
+ <para>(optional) ipaddress </para>
+ </entry>
+ <entry><para>nicid</para>
+ <para>ipaddress</para>
+ <para>networkid </para></entry>
+ </row>
+ <row>
+ <entry><para>removeIpFromNic</para></entry>
+ <entry><para>Removes the reserved IP for the NIC.</para></entry>
+ <entry>
+ <para>id</para>
+ </entry>
+ <entry><para>true</para>
+ <para>false</para></entry>
+ </row>
+ <row>
+ <entry><para>listNics</para></entry>
+ <entry><para>Lists the NIC details of the user VM; the API response also contains
+ the Secondary IP addresses of the NIC.</para></entry>
+ <entry>
+ <para>virtualmachineid</para>
+ <para>(optional) nicid</para>
+ </entry>
+ <entry><para>Lists the NIC details including secondary IP address </para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+ <section id="caveats-rn">
+ <title>Port Forwarding and StaticNAT Services Changes</title>
+ <para>Because multiple IPs can be associated per NIC, you are allowed to select a desired IP for
+ the Port Forwarding and StaticNAT services. The default is the primary IP. To enable this
+ functionality, an extra optional parameter 'vmguestip' is added to the Port forwarding and
+ StaticNAT APIs (enableStaticNat, createIpForwardingRule) to indicate on what IP address NAT
+ need to be configured. If vmguestip is passed, NAT is configured on the specified private IP
+ of the VM. if not passed, NAT is configured on the primary IP of the VM.</para>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/38a8db90/docs/en-US/networks.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/networks.xml b/docs/en-US/networks.xml
index f877aa5..cb7493c 100644
--- a/docs/en-US/networks.xml
+++ b/docs/en-US/networks.xml
@@ -32,6 +32,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="using-multiple-guest-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="reserved-ip-addresses-non-csvms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="multiple-ip-nic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="security-groups.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="external-firewalls-and-load-balancers.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/38a8db90/docs/en-US/whats-new.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/whats-new.xml b/docs/en-US/whats-new.xml
index 252f87d..295b532 100644
--- a/docs/en-US/whats-new.xml
+++ b/docs/en-US/whats-new.xml
@@ -21,7 +21,11 @@
<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>
+ 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"/>
+ </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"/>