mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
CLOUDSTACK-2289 updated with all the granular parameter at cluster/zone level
This commit is contained in:
radhikap
parent
7c7faa627a
commit
f8f779158d
@ -1,40 +1,43 @@
|
||||
<?xml version='1.0' encoding='utf-8' ?>
|
||||
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||||
<!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.
|
||||
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.
|
||||
-->
|
||||
<chapter id="global-config">
|
||||
<section id="global-config">
|
||||
<title>Setting Configuration Parameters</title>
|
||||
<section id="about-global-config-parameters">
|
||||
<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 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. The following table
|
||||
shows a few of the more useful parameters.</para>
|
||||
<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 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. 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*"/>
|
||||
<colspec colnum="1" colname="c1" colwidth="1.0*"/>
|
||||
<colspec colnum="2" colname="c2" colwidth="5.22*"/>
|
||||
<thead>
|
||||
<row>
|
||||
<entry><para>Field</para></entry>
|
||||
@ -44,53 +47,59 @@
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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
|
||||
page size 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>
|
||||
<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>
|
||||
@ -98,33 +107,236 @@
|
||||
</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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<section id="granular-param">
|
||||
<title>Granular Global Configuration Parameters</title>
|
||||
<para>The following global configuration parameters have been made more granular. The parameters
|
||||
are listed under three different scopes: account, cluster, and zone. </para>
|
||||
<informaltable frame="all">
|
||||
<tgroup cols="3" align="left" colsep="1" rowsep="1">
|
||||
<colspec colnum="1" colname="c1" colwidth="1.0*"/>
|
||||
<colspec colnum="2" colname="c2" colwidth="2.08*"/>
|
||||
<colspec colnum="3" colname="c3" colwidth="11.86*"/>
|
||||
<thead>
|
||||
<row>
|
||||
<entry><para>Field</para></entry>
|
||||
<entry><para>Field</para></entry>
|
||||
<entry><para>Value</para></entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry><para>account</para></entry>
|
||||
<entry><para>remote.access.vpn.client.iprange </para></entry>
|
||||
<entry><para>The range of IPs to be allocated to remotely access the VPN clients. The
|
||||
first IP in the range is used by the VPN server.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>account</para></entry>
|
||||
<entry><para>allow.public.user.templates</para></entry>
|
||||
<entry><para>If false, users will not be able to create public templates.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>account</para></entry>
|
||||
<entry><para>use.system.public.ips</para></entry>
|
||||
<entry><para>If true and if an account has one or more dedicated public IP ranges, IPs
|
||||
are acquired from the system pool after all the IPs dedicated to the account have
|
||||
been consumed.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>account</para></entry>
|
||||
<entry><para>use.system.guest.vlans </para></entry>
|
||||
<entry><para>If true and if an account has one or more dedicated guest VLAN ranges,
|
||||
VLANs are allocated from the system pool after all the VLANs dedicated to the
|
||||
account have been consumed.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>cluster</para></entry>
|
||||
<entry><para>cluster.storage.allocated.capacity.notificationthreshold </para></entry>
|
||||
<entry><para>The percentage, as a value between 0 and 1, of allocated storage utilization above which
|
||||
alerts are sent that the storage is below the threshold.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>cluster</para></entry>
|
||||
<entry><para>cluster.storage.capacity.notificationthreshold </para></entry>
|
||||
<entry><para>The percentage, as a value between 0 and 1, of storage utilization above which alerts are sent
|
||||
that the available storage is below the threshold.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>cluster</para></entry>
|
||||
<entry><para>cluster.cpu.allocated.capacity.notificationthreshold </para></entry>
|
||||
<entry><para>The percentage, as a value between 0 and 1, of cpu utilization above which alerts are sent
|
||||
that the available CPU is below the threshold.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>cluster</para></entry>
|
||||
<entry><para>cluster.memory.allocated.capacity.notificationthreshold </para></entry>
|
||||
<entry><para>The percentage, as a value between 0 and 1, of memory utilization above which alerts are sent
|
||||
that the available memory is below the threshold.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>cluster</para></entry>
|
||||
<entry><para>cluster.cpu.allocated.capacity.disablethreshold </para></entry>
|
||||
<entry><para>The percentage, as a value between 0 and 1, of CPU utilization above which allocators will
|
||||
disable that cluster from further usage. Keep the corresponding notification
|
||||
threshold lower than this value to be notified beforehand.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>cluster</para></entry>
|
||||
<entry><para>cluster.memory.allocated.capacity.disablethreshold </para></entry>
|
||||
<entry><para>The percentage, as a value between 0 and 1, of memory utilization above which allocators will
|
||||
disable that cluster from further usage. Keep the corresponding notification
|
||||
threshold lower than this value to be notified beforehand.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>cluster</para></entry>
|
||||
<entry><para>cpu.overprovisioning.factor</para></entry>
|
||||
<entry><para>Used for CPU over-provisioning calculation; the available CPU will be the mathematical product
|
||||
of actualCpuCapacity and cpu.overprovisioning.factor.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>cluster</para></entry>
|
||||
<entry><para>mem.overprovisioning.factor </para></entry>
|
||||
<entry><para>Used for memory over-provisioning calculation.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>cluster</para></entry>
|
||||
<entry><para>vmware.reserve.cpu </para></entry>
|
||||
<entry><para>Specify whether or not to reserve CPU when not over-provisioning; In case of CPU
|
||||
over-provisioning, CPU is always reserved.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>cluster</para></entry>
|
||||
<entry><para>vmware.reserve.mem </para></entry>
|
||||
<entry><para>Specify whether or not to reserve memory when not over-provisioning; In case of memory
|
||||
over-provisioning memory is always reserved.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>zone</para></entry>
|
||||
<entry><para>pool.storage.allocated.capacity.disablethreshold </para></entry>
|
||||
<entry><para>The percentage, as a value between 0 and 1, of allocated storage utilization above which
|
||||
allocators will disable that pool because the available allocated storage is below
|
||||
the threshold.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>zone</para></entry>
|
||||
<entry><para>pool.storage.capacity.disablethreshold </para></entry>
|
||||
<entry><para>The percentage, as a value between 0 and 1, of storage utilization above which allocators will
|
||||
disable the pool because the available storage capacity is below the
|
||||
threshold.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>zone</para></entry>
|
||||
<entry><para>storage.overprovisioning.factor </para></entry>
|
||||
<entry><para>Used for storage over-provisioning calculation; available storage will be the mathematical
|
||||
product of actualStorageSize and storage.overprovisioning.factor.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>zone</para></entry>
|
||||
<entry><para>network.throttling.rate </para></entry>
|
||||
<entry><para>Default data transfer rate in megabits per second allowed in a network.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>zone</para></entry>
|
||||
<entry><para>guest.domain.suffix </para></entry>
|
||||
<entry><para>Default domain name for VMs inside a virtual networks with a router.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>zone</para></entry>
|
||||
<entry><para>router.template.xen </para></entry>
|
||||
<entry><para>Name of the default router template on Xenserver.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>zone</para></entry>
|
||||
<entry><para>router.template.kvm </para></entry>
|
||||
<entry><para>Name of the default router template on KVM.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>zone</para></entry>
|
||||
<entry><para>router.template.vmware </para></entry>
|
||||
<entry><para>Name of the default router template on VMware.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>zone</para></entry>
|
||||
<entry><para>enable.dynamic.scale.vm</para></entry>
|
||||
<entry><para>Enable or diable dynamically scaling of a VM.</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>zone</para></entry>
|
||||
<entry><para>use.external.dns </para></entry>
|
||||
<entry><para>Bypass internal DNS, and use the external DNS1 and DNS2</para></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><para>zone</para></entry>
|
||||
<entry><para>blacklisted.routes </para></entry>
|
||||
<entry><para>Routes that are blacklisted cannot be used for creating static routes for a VPC Private
|
||||
Gateway.</para></entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user