cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From anim...@apache.org
Subject [06/12] git commit: updated refs/heads/4.2 to abd3461
Date Thu, 29 Aug 2013 05:23:07 GMT
CLOUDSTACK-2289. DOC. Granular configuration parameters. You can now configure settings for
entities lower than the global level.
(cherry picked from commit bdc87ab91533b6a2147554dd5fa63c1074889f36)

Signed-off-by: animesh <animesh@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/aa585138
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/aa585138
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/aa585138

Branch: refs/heads/4.2
Commit: aa5851385a4aedf975c9bc6f05a81fd7ad673b42
Parents: f77b957
Author: Jessica <jessica.tomechak@citrix.com>
Authored: Wed Aug 28 10:07:10 2013 -0700
Committer: animesh <animesh@apache.org>
Committed: Wed Aug 28 22:13:44 2013 -0700

----------------------------------------------------------------------
 docs/en-US/global-config.xml | 189 +++++++++++++++++++-------------------
 1 file changed, 93 insertions(+), 96 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cloudstack/blob/aa585138/docs/en-US/global-config.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/global-config.xml b/docs/en-US/global-config.xml
index 11952c3..407d97d 100644
--- a/docs/en-US/global-config.xml
+++ b/docs/en-US/global-config.xml
@@ -1,5 +1,5 @@
 <?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"
[
+<!DOCTYPE chapter 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;
 ]>
@@ -19,115 +19,112 @@
   under the License.
 -->
 <chapter id="global-config">
-  <title>Global Configuration Parameters</title>
-  <section id="setting-global-config-parameters">
-  <title>Setting Global Configuration Parameters</title>
-  <para>&PRODUCT; provides parameters that you can set to control many aspects
of the cloud. When
-    &PRODUCT; is first installed, and periodically thereafter, you might need to modify
these
-    settings.</para>
-  <orderedlist>
-    <listitem>
-      <para>Log in to the UI as administrator.</para>
-    </listitem>
-    <listitem>
-      <para>In the left navigation bar, click Global Settings.</para>
-    </listitem>
-    <listitem>
-      <para>In Select View, choose one of the following:</para>
-      <itemizedlist>
-        <listitem>
-          <para>Global Settings. This displays a list of the parameters with brief
descriptions and
-            current values.</para>
-        </listitem>
-        <listitem>
-          <para>Hypervisor Capabilities. This displays a list of hypervisor versions
with the
-            maximum number of guests supported for each.</para>
-        </listitem>
-      </itemizedlist>
-    </listitem>
-    <listitem>
-      <para>Use the search box to narrow down the list to those you are interested
in.</para>
-    </listitem>
-    <listitem>
-      <para>Click the Edit icon to modify a value. If you are viewing Hypervisor Capabilities,
you
-        must click the name of the hypervisor first to display the editing screen.</para>
-    </listitem>
-  </orderedlist>
-  </section>
+  <title>Setting Configuration Parameters</title>
   <section id="about-global-config-parameters">
-  <title>About Global Configuration Parameters</title>
+    <title>About Configuration Parameters</title>
     <para>&PRODUCT; provides a variety of settings you can use to set limits, configure
features, 
       and enable or disable features in the cloud. Once your Management Server is running,
you might 
-      need to set some of these global configuration parameters, depending on what optional
features 
-      you are setting up.</para>
-    <para>To modify global configuration parameters, use the steps in "Setting Global
Configuration 
-      Parameters."</para>
+      need to set some of these configuration parameters, depending on what optional features

+      you are setting up.
+      You can set default values at the global level, which will be in effect throughout
the cloud unless you override them at a lower level.
+      You can make local settings, which will override the global configuration parameter
values, at the level of an account, zone, cluster, or primary storage.</para>
     <para>The documentation for each &PRODUCT; feature should direct you to the
names of the applicable
-      parameters. Many of them are discussed in the &PRODUCT; Administration Guide. The
following table 
+      parameters. The following table 
       shows a few of the more useful parameters.</para>
     <informaltable frame="all">
       <tgroup cols="2" align="left" colsep="1" rowsep="1">
         <colspec colnum="1" colname="c1" colwidth="2*"/>
         <colspec colnum="2" colname="c2" colwidth="1*"/>
         <thead>
-        <row>
-          <entry><para>Field</para></entry>
-          <entry><para>Value</para></entry>
-        </row>
+          <row>
+            <entry><para>Field</para></entry>
+            <entry><para>Value</para></entry>
+          </row>
         </thead>
         <tbody>
-        <row>
-          <entry><para>management.network.cidr</para></entry>
-          <entry><para>A CIDR that describes the network that the management
CIDRs reside on.  This 
-            variable must be set for deployments that use vSphere. It is recommended to be
set for 
-            other deployments as well. Example: 192.168.3.0/24.</para></entry>
-        </row>
-        <row>
-          <entry><para>xen.setup.multipath</para></entry>
-          <entry><para>For XenServer nodes, this is a true/false variable that
instructs CloudStack to 
-            enable iSCSI multipath on the XenServer Hosts when they are added. This defaults
to false. 
-            Set it to true if you would like CloudStack to enable multipath.</para>
-            <para>If this is true for a NFS-based deployment multipath will still be
enabled on the 
-            XenServer host. However, this does not impact NFS operation and is harmless.</para></entry>
-        </row>
-        <row>
-          <entry><para>secstorage.allowed.internal.sites</para></entry>
-          <entry><para>This is used to protect your internal network from rogue
attempts to download 
-            arbitrary files using the template download feature. This is a comma-separated
list of CIDRs. 
-            If a requested URL matches any of these CIDRs the Secondary Storage VM will use
the private 
-            network interface to fetch the URL. Other URLs will go through the public interface.

-            We suggest you set this to 1 or 2 hardened internal machines where you keep your
templates. 
-            For example, set it to 192.168.1.66/32.</para></entry>
-        </row>
-        <row>
-          <entry><para>use.local.storage</para></entry>
-          <entry><para>Determines whether CloudStack will use storage that is
local to the Host for data 
-          disks, templates, and snapshots. By default CloudStack will not use this storage.
You should 
-          change this to true if you want to use local storage and you understand the reliability
and 
-          feature drawbacks to choosing local storage.</para></entry>
-        </row>
-        <row>
-          <entry><para>host</para></entry>
-          <entry><para>This is the IP address of the Management Server. If you
are using multiple 
-            Management Servers you should enter a load balanced IP address that is reachable
via 
-            the private network.</para></entry>
-        </row>
-        <row>
-          <entry><para>default.page.size</para></entry>
-          <entry><para>Maximum number of items per page that can be returned
by a CloudStack API command. 
-            The limit applies at the cloud level and can vary from cloud to cloud. You can
override this 
-            with a lower value on a particular API call by using the page and pagesize API
command parameters. 
-            For more information, see the Developer's Guide. Default: 500.</para></entry>
-        </row>
-        <row>
-          <entry><para>ha.tag</para></entry>
-          <entry><para>The label you want to use throughout the cloud to designate
certain hosts as dedicated 
-            HA hosts. These hosts will be used only for HA-enabled VMs that are restarting
due to the failure 
-            of another host. For example, you could set this to ha_host. Specify the ha.tag
value as a host tag 
-            when you add a new host to the cloud.</para></entry>
-        </row>
+          <row>
+            <entry><para>management.network.cidr</para></entry>
+            <entry><para>A CIDR that describes the network that the management
CIDRs reside on.  This 
+              variable must be set for deployments that use vSphere. It is recommended to
be set for 
+              other deployments as well. Example: 192.168.3.0/24.</para></entry>
+          </row>
+          <row>
+            <entry><para>xen.setup.multipath</para></entry>
+            <entry><para>For XenServer nodes, this is a true/false variable that
instructs CloudStack to 
+              enable iSCSI multipath on the XenServer Hosts when they are added. This defaults
to false. 
+              Set it to true if you would like CloudStack to enable multipath.</para>
+              <para>If this is true for a NFS-based deployment multipath will still
be enabled on the 
+                XenServer host. However, this does not impact NFS operation and is harmless.</para></entry>
+          </row>
+          <row>
+            <entry><para>secstorage.allowed.internal.sites</para></entry>
+            <entry><para>This is used to protect your internal network from rogue
attempts to download 
+              arbitrary files using the template download feature. This is a comma-separated
list of CIDRs. 
+              If a requested URL matches any of these CIDRs the Secondary Storage VM will
use the private 
+              network interface to fetch the URL. Other URLs will go through the public interface.

+              We suggest you set this to 1 or 2 hardened internal machines where you keep
your templates. 
+              For example, set it to 192.168.1.66/32.</para></entry>
+          </row>
+          <row>
+            <entry><para>use.local.storage</para></entry>
+            <entry><para>Determines whether CloudStack will use storage that
is local to the Host for data 
+              disks, templates, and snapshots. By default CloudStack will not use this storage.
You should 
+              change this to true if you want to use local storage and you understand the
reliability and 
+              feature drawbacks to choosing local storage.</para></entry>
+          </row>
+          <row>
+            <entry><para>host</para></entry>
+            <entry><para>This is the IP address of the Management Server. If
you are using multiple 
+              Management Servers you should enter a load balanced IP address that is reachable
via 
+              the private network.</para></entry>
+          </row>
+          <row>
+            <entry><para>default.page.size</para></entry>
+            <entry><para>Maximum number of items per page that can be returned
by a CloudStack API command. 
+              The limit applies at the cloud level and can vary from cloud to cloud. You
can override this 
+              with a lower value on a particular API call by using the page and pagesize
API command parameters. 
+              For more information, see the Developer's Guide. Default: 500.</para></entry>
+          </row>
+          <row>
+            <entry><para>ha.tag</para></entry>
+            <entry><para>The label you want to use throughout the cloud to designate
certain hosts as dedicated 
+              HA hosts. These hosts will be used only for HA-enabled VMs that are restarting
due to the failure 
+              of another host. For example, you could set this to ha_host. Specify the ha.tag
value as a host tag 
+              when you add a new host to the cloud.</para></entry>
+          </row>
         </tbody>
       </tgroup>
     </informaltable>
   </section>
+  <section id="global-config-howto">
+    <title>Setting Global Configuration Parameters</title>
+    <para>Use the following steps to set global configuration parameters. These values
will be the defaults in effect throughout your &PRODUCT; deployment.</para>
+    <orderedlist>
+      <listitem><para>Log in to the UI as administrator.</para></listitem>
+      <listitem><para>In the left navigation bar, click Global Settings.</para></listitem>
+      <listitem><para>In Select View, choose one of the following:</para>
+        <itemizedlist>
+          <listitem><para>Global Settings. This displays a list of the parameters
with brief descriptions and current values.</para></listitem>
+          <listitem><para>Hypervisor Capabilities. This displays a list of hypervisor
versions with the maximum number of guests supported for each.</para></listitem>
+        </itemizedlist>
+      </listitem>
+      <listitem><para>Use the search box to narrow down the list to those you
are interested in.</para></listitem>
+      <listitem><para>In the Actions column, click the Edit icon to modify a
value. If you are viewing Hypervisor Capabilities, you must click the name of the hypervisor
first to display the editing screen.</para></listitem>
+    </orderedlist> 
+  </section>
+  <section id="local-config-howto">
+    <title>Setting Local Configuration Parameters</title>
+    <para>Use the following steps to set local configuration parameters for an account,
zone, cluster, or primary storage.
+      These values will override the global configuration settings.</para>
+    <orderedlist>
+      <listitem><para>Log in to the UI as administrator.</para></listitem>
+      <listitem><para>In the left navigation bar, click Infrastructure or Accounts,
depending on where you want to set a value.</para></listitem>
+      <listitem><para>Find the name of the particular resource that you want
to work with. For example, if you are in Infrastructure,
+        click View All on the Zones, Clusters, or Primary Storage area.</para></listitem>
+      <listitem><para>Click the name of the resource where you want to set a
limit.</para></listitem>
+      <listitem><para>Click the Settings tab.</para></listitem>
+      <listitem><para>Use the search box to narrow down the list to those you
are interested in.</para></listitem>
+      <listitem><para>In the Actions column, click the Edit icon to modify a
value.</para></listitem>
+    </orderedlist>
+  </section>
 </chapter>


Mime
View raw message