Skip to content

Commit 320ab0a

Browse files
author
Radhika PC
committed
cloudstack-850
1 parent d51e964 commit 320ab0a

3 files changed

Lines changed: 173 additions & 4 deletions

File tree

‎docs/en-US/advanced-zone-guest-ip-addresses.xml‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@
1111
to you under the Apache License, Version 2.0 (the
1212
"License"); you may not use this file except in compliance
1313
with the License. You may obtain a copy of the License at
14-
1514
http://www.apache.org/licenses/LICENSE-2.0
16-
1715
Unless required by applicable law or agreed to in writing,
1816
software distributed under the License is distributed on an
1917
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -22,6 +20,11 @@
2220
under the License.
2321
-->
2422
<section id="advanced-zone-guest-ip-addresses">
25-
<title>Advanced Zone Guest IP Addresses</title>
26-
<para>When advanced networking is used, the administrator can create additional networks for use by the guests. These networks can span the zone and be available to all accounts, or they can be scoped to a single account, in which case only the named account may create guests that attach to these networks. The networks are defined by a VLAN ID, IP range, and gateway. The administrator may provision thousands of these networks if desired.</para>
23+
<title>Advanced Zone Guest IP Addresses</title>
24+
<para>When advanced networking is used, the administrator can create additional networks for use
25+
by the guests. These networks can span the zone and be available to all accounts, or they can be
26+
scoped to a single account, in which case only the named account may create guests that attach
27+
to these networks. The networks are defined by a VLAN ID, IP range, and gateway. The
28+
administrator may provision thousands of these networks if desired. Additionally, a part of the
29+
IP address space can also be reserved for non-&PRODUCT; VMs and servers.</para>
2730
</section>

‎docs/en-US/networks.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,12 @@
3131
<xi:include href="advanced-zone-physical-network-configuration.xml"
3232
xmlns:xi="http://www.w3.org/2001/XInclude"/>
3333
<xi:include href="using-multiple-guest-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
34+
<xi:include href="reserved-ip-addresses-non-csvms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
3435
<xi:include href="security-groups.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
3536
<xi:include href="external-firewalls-and-load-balancers.xml"
3637
xmlns:xi="http://www.w3.org/2001/XInclude"/>
3738
<xi:include href="load-balancer-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
39+
<xi:include href="firewall-rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
3840
<xi:include href="guest-ip-ranges.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
3941
<xi:include href="acquire-new-ip-address.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
4042
<xi:include href="release-ip-address.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
@@ -43,6 +45,7 @@
4345
<xi:include href="ip-load-balancing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
4446
<xi:include href="dns-dhcp.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
4547
<xi:include href="vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
48+
<xi:include href="elastic-ip.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
4649
<xi:include href="inter-vlan-routing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
4750
<xi:include href="configure-vpc.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
4851
<xi:include href="persistent-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

‎docs/en-US/reserved-ip-addresses-non-csvms.xml‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
7+
<!-- Licensed to the Apache Software Foundation (ASF) under one
8+
or more contributor license agreements. See the NOTICE file
9+
distributed with this work for additional information
10+
regarding copyright ownership. The ASF licenses this file
11+
to you under the Apache License, Version 2.0 (the
12+
"License"); you may not use this file except in compliance
13+
with the License. You may obtain a copy of the License at
14+
http://www.apache.org/licenses/LICENSE-2.0
15+
Unless required by applicable law or agreed to in writing,
16+
software distributed under the License is distributed on an
17+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18+
KIND, either express or implied. See the License for the
19+
specific language governing permissions and limitations
20+
under the License.
21+
-->
22+
<section id="reserved-ip-addresses-non-csvms">
23+
<title>IP Reservation in Isolated Guest Networks</title>
24+
<para>In Isolated guest networks, a part of the guest IP address space can be reserved for
25+
non-&PRODUCT; VMs or physical servers. To do so, you configure a range of Reserved IP addresses
26+
by specifying the CIDR when a guest network is in Implemented state. If your customers wish to
27+
have non-&PRODUCT; controlled VMs or physical servers on the same network, they can share a part
28+
of the IP address space that is primarily provided to the guest network.</para>
29+
<para>In an Advanced zone, an IP address range or a CIDR is assigned to a network when the network
30+
is defined. The &PRODUCT; virtual router acts as the DHCP server and uses CIDR for assigning IP
31+
addresses to the guest VMs. If you decide to reserve IP ranges for non-&PRODUCT; purposes, you
32+
can specify a part of the IP address range or the CIDR that should only be allocated by the DHCP
33+
service of the virtual router to the guest VMs created in &PRODUCT;. The remaining IPs in that
34+
network are called Reserved IP Range. When IP Reservation is configured, the administrator can
35+
add additional VMs or physical servers that are not part of &PRODUCT; to the same network and
36+
assign them the Reserved IP addresses. &PRODUCT; guest VMs cannot acquire IPs from the Reserved
37+
IP Range.</para>
38+
<section id="ip-reserve-consider">
39+
<title>IP Reservation Considerations</title>
40+
<para>Consider the following before you reserve an IP range for non-&PRODUCT; machines:</para>
41+
<itemizedlist>
42+
<listitem>
43+
<para>IP Reservation can be applied only when the network is in Implemented state.</para>
44+
</listitem>
45+
<listitem>
46+
<para>No IP Reservation is done by default.</para>
47+
</listitem>
48+
<listitem>
49+
<para>Guest VM CIDR you specify must be a subset of the network CIDR.</para>
50+
</listitem>
51+
<listitem>
52+
<para>Specify a valid Guest VM CIDR. IP Reservation is applied only if no active IPs exist
53+
outside the Guest VM CIDR. </para>
54+
<para>You cannot apply IP Reservation if any VM is alloted with an IP address that is
55+
outside the Guest VM CIDR.</para>
56+
</listitem>
57+
<listitem>
58+
<para>To reset an existing IP Reservation, specify the new value for the Guest VM CIDR in
59+
the CIDR field.</para>
60+
<para>For example, the following table describes three scenarios of guest network
61+
creation:</para>
62+
<informaltable>
63+
<tgroup cols="5" align="left" colsep="1" rowsep="1">
64+
<colspec colnum="1" colname="c1" colwidth="33.0pt"/>
65+
<colspec colnum="2" colname="c2" colwidth="84.75pt"/>
66+
<colspec colnum="3" colname="c3" colwidth="97.5pt"/>
67+
<colspec colnum="4" colname="c4" colwidth="129.0pt"/>
68+
<colspec colnum="5" colname="c5" colwidth="336.0pt"/>
69+
<thead>
70+
<row>
71+
<entry><para>Case</para></entry>
72+
<entry><para> CIDR</para></entry>
73+
<entry><para>Network CIDR</para></entry>
74+
<entry><para>Reserved IP Range for Non-&PRODUCT; VMs</para></entry>
75+
<entry><para>Description</para></entry>
76+
</row>
77+
</thead>
78+
<tbody>
79+
<row>
80+
<entry><para>1</para></entry>
81+
<entry><para>10.1.1.0/24</para></entry>
82+
<entry><para>None</para></entry>
83+
<entry><para>None</para></entry>
84+
<entry><para>No IP Reservation.</para></entry>
85+
</row>
86+
<row>
87+
<entry><para>2</para></entry>
88+
<entry><para>10.1.1.0/26</para></entry>
89+
<entry><para>10.1.1.0/24</para></entry>
90+
<entry><para>10.1.1.64 to 10.1.1.254</para></entry>
91+
<entry><para>IP Reservation configured by the UpdateNetwork API with
92+
guestvmcidr=10.1.1.0/26 or enter 10.1.1.0/26 in the CIDR field in the
93+
UI.</para></entry>
94+
</row>
95+
<row>
96+
<entry><para>3</para></entry>
97+
<entry><para>10.1.1.0/24</para></entry>
98+
<entry><para>None</para></entry>
99+
<entry><para>None</para></entry>
100+
<entry><para>Removing IP Reservation by the UpdateNetwork API with
101+
guestvmcidr=10.1.1.0/24 or enter 10.1.1.0/24 in the CIDR field in the UI.
102+
</para></entry>
103+
</row>
104+
</tbody>
105+
</tgroup>
106+
</informaltable>
107+
</listitem>
108+
</itemizedlist>
109+
</section>
110+
<section id="ip-reserv-limition">
111+
<title>Limitations</title>
112+
<itemizedlist>
113+
<listitem>
114+
<para>The IP Reservation is not supported if active IPs are found outside the Guest VM CIDR.
115+
</para>
116+
</listitem>
117+
<listitem>
118+
<para>Upgrading network offering which causes a change in CIDR (such as upgrading an
119+
offering with no external devices to one with external devices) IP Reservation becomes
120+
void if any. Reconfigure IP Reservation in the reimplemented network.</para>
121+
</listitem>
122+
</itemizedlist>
123+
</section>
124+
<section id="best-practice-ipreserv">
125+
<title>Best Practices</title>
126+
<para>Apply IP Reservation to the guest network as soon as the network state changes to
127+
Implemented. If you apply reservation soon after the first guest VM is deployed, conflict is
128+
less likely to occur while applying reservation. </para>
129+
</section>
130+
<section id="reserve-ip">
131+
<title>Reserving an IP Range</title>
132+
<orderedlist>
133+
<listitem>
134+
<para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
135+
</listitem>
136+
<listitem>
137+
<para>In the left navigation, choose Network.</para>
138+
</listitem>
139+
<listitem>
140+
<para>Click the name of the network you want to modify.</para>
141+
</listitem>
142+
<listitem>
143+
<para>In the Details tab, click Edit.<inlinemediaobject>
144+
<imageobject>
145+
<imagedata fileref="./images/edit-icon.png"/>
146+
</imageobject>
147+
<textobject>
148+
<phrase>edit-icon.png: button to edit a network</phrase>
149+
</textobject>
150+
</inlinemediaobject></para>
151+
<para>The CIDR field changes to editable one.</para>
152+
</listitem>
153+
<listitem>
154+
<para>In CIDR, specify the Guest VM CIDR.</para>
155+
</listitem>
156+
<listitem>
157+
<para>Click Apply.</para>
158+
<para>Wait until the Network CIDR and the Reserved IP Range are displayed in the Details
159+
page.</para>
160+
</listitem>
161+
</orderedlist>
162+
</section>
163+
</section>

0 commit comments

Comments
 (0)