Skip to content

Commit b506a3f

Browse files
dgrizzantijzb
authored andcommitted
CLOUDSTACK-1598: update global-config.xml doc to include new section "About Global Configuration Settings"
Signed-off-by: Joe Brockmeier <jzb@zonker.net>
1 parent 3541aa8 commit b506a3f

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed

docs/en-US/global-config.xml

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
under the License.
2020
-->
2121
<chapter id="global-config">
22+
<title>Global Configuration Parameters</title>
23+
<section id="setting-global-config-parameters">
2224
<title>Setting Global Configuration Parameters</title>
2325
<para>&PRODUCT; provides parameters that you can set to control many aspects of the cloud. When
2426
&PRODUCT; is first installed, and periodically thereafter, you might need to modify these
@@ -51,4 +53,81 @@
5153
must click the name of the hypervisor first to display the editing screen.</para>
5254
</listitem>
5355
</orderedlist>
56+
</section>
57+
<section id="about-global-config-parameters">
58+
<title>About Global Configuration Parameters</title>
59+
<para>&PRODUCT; provides a variety of settings you can use to set limits, configure features,
60+
and enable or disable features in the cloud. Once your Management Server is running, you might
61+
need to set some of these global configuration parameters, depending on what optional features
62+
you are setting up.</para>
63+
<para>To modify global configuration parameters, use the steps in "Setting Global Configuration
64+
Parameters."</para>
65+
<para>The documentation for each &PRODUCT; feature should direct you to the names of the applicable
66+
parameters. Many of them are discussed in the &PRODUCT; Administration Guide. The following table
67+
shows a few of the more useful parameters.</para>
68+
<informaltable frame="all">
69+
<tgroup cols="2" align="left" colsep="1" rowsep="1">
70+
<colspec colnum="1" colname="c1" colwidth="2*"/>
71+
<colspec colnum="2" colname="c2" colwidth="1*"/>
72+
<thead>
73+
<row>
74+
<entry><para>Field</para></entry>
75+
<entry><para>Value</para></entry>
76+
</row>
77+
</thead>
78+
<tbody>
79+
<row>
80+
<entry><para>management.network.cidr</para></entry>
81+
<entry><para>A CIDR that describes the network that the management CIDRs reside on. This
82+
variable must be set for deployments that use vSphere. It is recommended to be set for
83+
other deployments as well. Example: 192.168.3.0/24.</para></entry>
84+
</row>
85+
<row>
86+
<entry><para>xen.setup.multipath</para></entry>
87+
<entry><para>For XenServer nodes, this is a true/false variable that instructs CloudStack to
88+
enable iSCSI multipath on the XenServer Hosts when they are added. This defaults to false.
89+
Set it to true if you would like CloudStack to enable multipath.</para>
90+
<para>If this is true for a NFS-based deployment multipath will still be enabled on the
91+
XenServer host. However, this does not impact NFS operation and is harmless.</para></entry>
92+
</row>
93+
<row>
94+
<entry><para>secstorage.allowed.internal.sites</para></entry>
95+
<entry><para>This is used to protect your internal network from rogue attempts to download
96+
arbitrary files using the template download feature. This is a comma-separated list of CIDRs.
97+
If a requested URL matches any of these CIDRs the Secondary Storage VM will use the private
98+
network interface to fetch the URL. Other URLs will go through the public interface.
99+
We suggest you set this to 1 or 2 hardened internal machines where you keep your templates.
100+
For example, set it to 192.168.1.66/32.</para></entry>
101+
</row>
102+
<row>
103+
<entry><para>use.local.storage</para></entry>
104+
<entry><para>Determines whether CloudStack will use storage that is local to the Host for data
105+
disks, templates, and snapshots. By default CloudStack will not use this storage. You should
106+
change this to true if you want to use local storage and you understand the reliability and
107+
feature drawbacks to choosing local storage.</para></entry>
108+
</row>
109+
<row>
110+
<entry><para>host</para></entry>
111+
<entry><para>This is the IP address of the Management Server. If you are using multiple
112+
Management Servers you should enter a load balanced IP address that is reachable via
113+
the private network.</para></entry>
114+
</row>
115+
<row>
116+
<entry><para>default.page.size</para></entry>
117+
<entry><para>Maximum number of items per page that can be returned by a CloudStack API command.
118+
The limit applies at the cloud level and can vary from cloud to cloud. You can override this
119+
with a lower value on a particular API call by using the page and pagesize API command parameters.
120+
For more information, see the Developer's Guide. Default: 500.</para></entry>
121+
</row>
122+
<row>
123+
<entry><para>ha.tag</para></entry>
124+
<entry><para>The label you want to use throughout the cloud to designate certain hosts as dedicated
125+
HA hosts. These hosts will be used only for HA-enabled VMs that are restarting due to the failure
126+
of another host. For example, you could set this to ha_host. Specify the ha.tag value as a host tag
127+
when you add a new host to the cloud.</para></entry>
128+
</row>
129+
</tbody>
130+
</tgroup>
131+
</informaltable>
132+
</section>
54133
</chapter>

0 commit comments

Comments
 (0)