← Back to branch summary

~davewalker/ubuntu/maverick/eucalyptus/lp611144

« back to all changes in this revision

Viewing changes to tools/eucalyptus.conf.5

  • Committer: Dustin Kirkland
  • Date: 2010-07-22 08:41:57 UTC
  • mfrom: (1050.1.19 ubuntu)
  • Revision ID: kirkland@x200-20100722084157-zh2p8dkawznvxxpn
Approving Dave Walker's merge of new upstream Eucalyptus 2.0 release.

Dustin Kirkland <kirkland@canonical.com>

* New major upstream version merge, 2.0 (r1211).
  - 01-wsdl-stubs.patch, debian/wsdl.md5sums: wsdl stubs updated.
  - 11-state-cleanup-memleakfix.patch: Removed, fixed upstream.
  - 21-eucalyptus-1.7-with-gwt-1.6.4.patch: New patch, allows 
    eucalyptus-1.7 to be built against gwt 1.6.4. Based on patch courtesy 
    of Dmitrii Zagorodnov, upstream. (LP: #597330)
* debian/eucalyptus-java-common.links: 
  - Changed symlink for groovy, point to groovy.all.jar, making compatiable 
    with groovy versions >1.7. (LP: #595421)
  - Added ant.jar & jetty-rewrite-handler.jar as they are now required.
* debian/control
  - & debian/build-jars: Added libjavassist-java and libjetty-extra-java as 
    build dependencies.
  - Added libjetty-extra-java as a dependency of eucalyptus-java-common
* The binary resulting jar's have been renamed from eucalyptus-*-1.6.2.jar
  to eucalyptus-*-main.jar:    
  - debian/eucalyptus-cc.upstart
  - debian/eucalyptus-cloud.install
  - debian/eucalyptus-common.eucalyptus.upstart
  - debian/eucalyptus-java-common.install
  - debian/eucalyptus-network.upstart
  - debian/eucalyptus-sc.install
  - debian/eucalyptus-walrus.install
* debian/eucalyptus-java-common.install: New upstream jars that have been
  installed:
  - eucalyptus-db-hsqldb-ext-main.jar
  - eucalyptus-component-main.jar
* debian/control:
  - Updated Standards Version to 3.8.4 (no change)
  - Updated the upstream Homepage to: http://open.eucalyptus.com/
  - Changed Vcs-Bzr to reflect new location of Ubuntu hosted development branch.
  - Made the Build Dependency of groovy and the binary eucalyptus-java-common
    package depend on version >=1.7.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/eucalyptus.conf.5
 
1
.TH eucalyptus.conf 5 "8 January 2010" "eucalyptus.conf"
 
2
 
 
3
.SH NAME
 
4
eucalyptus.conf, eucalyptus.local.conf \- configuration files for Eucalyptus
 
5
 
 
6
.SH SYNOPSIS
 
7
.B /etc/eucalyptus/eucalyptus.conf
 
8
 
 
9
.B /etc/eucalyptus/eucalyptus.local.conf
 
10
 
 
11
.SH DESCRIPTION
 
12
This manual describes the configuration files used to configure and customize Eucalyptus.
 
13
 
 
14
\fI/etc/eucalyptus/eucalyptus.conf\fP is the traditional Eucalyptus configuration file.  In previous Eucalyptus versions (<1.6.2), and on non-Ubuntu versions, Eucalyptus is configured by this one monolithic file, with inline comments describing all options.  As of Ubuntu's Eucalyptus 1.6.2 version, the inline documentation has been extracted to two manpages, \fBeuca_conf\fP(8) and this page, \fBeucalyptus.conf\fP(5).
 
15
 
 
16
\fI/etc/eucalyptus/eucalyptus.conf\fP now contains a base set of your distribution's recommended configuration.  This file is managed by \fBdpkg\fP(1), and provides a vector for your distribution to add new variables/values and maintain a sane set of defaults.  It serves as the base configuration, which are easily overriden by the administrator.
 
17
 
 
18
\fI/etc/eucalyptus/eucalyptus.local.conf\fP contains values written by \fBeuca_conf\fP(8).  This file should never be edited directly.  Rather, the user should see the documentation at \fBeuca_conf\fP(8) and use the various options and interfaces for modifying this file.
 
19
 
 
20
.SH OPTIONS
 
21
 
 
22
Each option below may affect one or more of the following Eucalyptus components:
 
23
  - CLC = Cloud Controller
 
24
  - WC  = Walrus Controller
 
25
  - CC  = Cluster Controller
 
26
  - SC  = Storage Controller
 
27
  - NC  = Node Controller
 
28
 
 
29
\fB**NOTE**\fP: To activate changes of any parameters on a CC, you must:
 
30
  sudo restart eucalyptus-cc CLEAN=1
 
31
 
 
32
\fB**HOWEVER**\fP, if you do this, all currently running virtual machines in this cluster will lose network connectivity.
 
33
 
 
34
Options affecting CLC, WC, CC, SC, NC:
 
35
 
 
36
.BI EUCALYPTUS="/"
 
37
.RS
 
38
This variable points to where eucalyptus has been installed.
 
39
.RE
 
40
 
 
41
.BI EUCA_USER="eucalyptus"
 
42
.RS
 
43
This is the username that you would like eucalyptus to run as.
 
44
.RE
 
45
 
 
46
Options affecting CLC, WC, SC only:
 
47
 
 
48
.BI DISABLE_DNS="Y"
 
49
.RS
 
50
Enable/disable Eucalyptus dynamic DNS functionality.
 
51
.RE
 
52
 
 
53
.BI DISABLE_ISCSI="Y"
 
54
.RS
 
55
Use either iSCSI or AoE for dynamic block storage.
 
56
.RE
 
57
 
 
58
.BI JVM_MEM="512m"
 
59
.RS
 
60
Amount of memory to allocate to the JVM.  This number value will affect how many instances you can over a period of time.  These processes are memory hungry; give them as much memory as you can spare.  At least 2048m is recommended for very busy Eucalyptus deployments.
 
61
.RE
 
62
 
 
63
Options affecting CC, NC only:
 
64
 
 
65
.BI ENABLE_WS_SECURITY="Y"
 
66
.RS
 
67
This variable controls whether ws-security is enabled between eucalyptus components.  The default settings provide secure connections between the Cloud, Cluster, and Node Controllers and we recommend that this feature remains enabled.  If you wish to disable security, you must change this variable to "N" and manually configure the services.xml for both Cluster and Node Controllers (see documentation for more details).
 
68
.RE
 
69
 
 
70
.BI LOGLEVEL="DEBUG"
 
71
.RS
 
72
This variable controls the level of logging output that appears in various eucalyptus log files.  The options are, in descending order of verbosity, 'DEBUG, INFO, WARN, ERROR, and FATAL'. The default is DEBUG (everything).
 
73
.RE
 
74
 
 
75
.BI VNET_PUBINTERFACE="br0"
 
76
.BI VNET_PRIVINTERFACE="br0"
 
77
.RS
 
78
The 2 variable  VNET_PRIVINTERFACE and VNET_PUBINTERFACE specify the local physical ethernet interfaces that eucalyptus should use to manage the VM network.  On the front-end, VNET_PRIVINTERFACE should be set to the device that is attached to the same ethernet network as your nodes.  - VNET_PUBINTERFACE should be set to the device which is connected to the 'public' network.  If you have only one interface, these should be set to the same value.  On the nodes, both should be set to either the name of the bridge that has been set up by Xen (xenbr0, eth0, etc), or the physical ethernet device that is attached to the xen bridge (peth0, peth1, etc), depending on your xen configuration.  CAVEAT: These parameters in \fIeucalyptus.conf\fP do not affect Storage Controller interface settings--to do this, please use the administrative web interface.
 
79
.RE
 
80
 
 
81
.BI VNET_MODE="MANAGED-NOVLAN"
 
82
.RS
 
83
There are four modes to choose from (MANAGED, MANAGED-NOVLAN, SYSTEM, or STATIC) and each has its own sub-options.  The first modes (MANAGED, MANAGED-NOVLAN) configure eucalyptus to fully manage the VM networks, and enables the ability to use security groups and dynamic public IP assignment (with and without vlan tagging of security group networks, respectively).
 
84
.RE
 
85
 
 
86
Options affecting CC only:
 
87
 
 
88
.BI CC_PORT="8774"
 
89
.RS
 
90
This is the port the Cluster Controller will be listening on.
 
91
.RE
 
92
 
 
93
.BI SCHEDPOLICY="ROUNDROBIN"
 
94
.RS
 
95
This option configures the Cluster Controller's scheduling policy.  Currently, this option can be set to GREEDY (first node that is found that can run the VM will be chosen), ROUNDROBIN (nodes are selected one after another until one is found that can run the VM), or POWERSAVE (nodes are put to sleep when they are not running VMs, and reawakened when new resources are required.  VMs will be placed on the first awake machine, followed by machines that are asleep).
 
96
.RE
 
97
 
 
98
.BI POWER_IDLETHRESH="300"
 
99
.BI POWER_WAKETHRESH="300"
 
100
.RS
 
101
Powersave options.  POWER_IDLETHRESH is the number of seconds that a node can remain idle (i.e. no running VMs) before a powerdown is attempted.  POWER_WAKETHRESH is the number of seconds that Eucalyptus should wait after attempting a node wake-up before it will consider the node actually down (and not waking up).
 
102
.RE
 
103
 
 
104
.BI NC_SERVICE="axis2/services/EucalyptusNC"
 
105
.RS
 
106
The name of the Node Controller service. Change this if you want to plug in your own Node Controller service.
 
107
.RE
 
108
 
 
109
.BI VNET_DHCPDAEMON="/usr/sbin/dhcpd3"
 
110
.RS
 
111
This indicates where we have a dhcp server binary. We use it to provide the images with IPs: Eucalyptus provides its own configuration per instance.
 
112
.RE
 
113
 
 
114
.BI VNET_DHCPUSER="dhcpd"
 
115
.RS
 
116
Some systems have their DHCP daemon configured to run as a non-root user.  If this is the case, set the name of that user here (by default, Eucalyptus will set up DHCPD configuration files and directories as owned by root).
 
117
.RE
 
118
 
 
119
.BI NODES=""
 
120
.RS
 
121
The list of Node Controllers the Cluster Controller will communicate with. If you are running Rocks, you can run "rocks list host" to find out the list of machines available to you (in our case we are interested in the VM Container kind).
 
122
.RE
 
123
 
 
124
.BI VNET_SUBNET=""
 
125
.RS
 
126
VNET_SUBNET should be set to an IP subnet that is free for eucalyptus to use (i.e. no other system connected to your network directly is configured with addresses from this subnet).
 
127
.RE
 
128
 
 
129
.BI VNET_NETMASK=""
 
130
.RS
 
131
VNET_NETMASK defines the size of the subnet.
 
132
.RE
 
133
 
 
134
.BI VNET_DNS=""
 
135
.RS
 
136
VNET_DNS should be set to a DNS server that your systems use (usually safe to use the same DNS that is configured on the front-end).
 
137
.RE
 
138
 
 
139
.BI VNET_ADDRSPERNET="32"
 
140
.RS
 
141
VNET_ADDRSPERNET can be used to limit the number of instances that can be attached to each named security group simultaneously.
 
142
.RE
 
143
 
 
144
.BI VNET_PUBLICIPS=""
 
145
.RS
 
146
VNET_PUBLICIPS should be set to any public IPs, that are currently unused, that can be dynamically assigned to VMs.  Of these options, only VNET_PUBLICIPS can be left blank or undefined.
 
147
.RE
 
148
 
 
149
.BI VNET_LOCALIP="your-public-interface's-ip"
 
150
.RS
 
151
If you are running in multi-cluster mode (more than one CC), you should uncomment VNET_LOCALIP and set it to the local IP of the CC that is accessible by all other CCs in the system.  If VNET_LOCALIP is unset, the CC will try to determine the list of all IPs currently assigned to the machine at CC run time.
 
152
.RE
 
153
 
 
154
.BI VNET_CLOUDIP="your-cloud-controller's-ip"
 
155
.RS
 
156
If your CC and CLC are on different machines, uncomment VNET_CLOUDIP and set it to your cloud-contoller's IP address (must be an address that can be reached by the CC).
 
157
.RE
 
158
 
 
159
Options affecting the NC only:
 
160
 
 
161
.BI NC_PORT="8775"
 
162
.RS
 
163
This is the port the Node Controller will be listening on.
 
164
.RE
 
165
 
 
166
.BI HYPERVISOR="kvm"
 
167
.RS
 
168
The hypervisor that the Node Controller will interact with in order to manage virtual machines.  Currently, supported values are 'kvm' and 'xen'.
 
169
.RE
 
170
 
 
171
.BI MANUAL_INSTANCES_CLEANUP=0
 
172
.RS
 
173
Setting this to 1 disables the cleanup of instance files (root, kernel, ramdisk) for failed and terminated instances.  This is not recommended for normal use, but it can be useful in debugging VM startup.
 
174
.RE
 
175
 
 
176
.BI NC_CACHE_SIZE=99999
 
177
.RS
 
178
The maximum amount of disk space, in Megabytes, that Eucalyptus is allowed to use in the cache directory (INSTANCES_PATH/eucalyptus/cache).  A generous size is recommended.  Setting this to zero disables caching.
 
179
.RE
 
180
 
 
181
.BI VNET_BRIDGE="br0"
 
182
.RS
 
183
VNET_BRIDGE should be set to the name of the bridge that xen has configured.  This is typically named 'xenbr0, xenbr1, etc' on older Xen versions, and 'eth0, eth1, etc' on newer Xen versions.  The command 'brctl show' will give you more information on your local bridge setup.
 
184
.RE
 
185
 
 
186
.BI INSTANCE_PATH="/var/lib/eucalyptus/instances/"
 
187
.RS
 
188
This variable points to a directory which is used by the Node Controller to store images of running instances as well as local cached copies of images.  The running images will be deleted after the instance is terminated, but the cached copies will persist, subject to LRU cache replacement and the NC_CACHE_SIZE size limit, below.  So, this partition should be at least as big as the cache size (or the maximum space needed by all images, whichever is bigger) plus the maximum space needed by the maximum number of instances allowed on the node.  This directory should be local to the Node Controller (as opposed to a NFS share) for performance reasons.
 
189
.RE
 
190
 
 
191
.BI MAX_MEM=2048
 
192
.RS
 
193
The maximum amount of memory Eucalyptus is allowed to use on the node: if you leave this commented out, Eucalyptus will use all available memory, otherwise it will use at most this value for ALL running instances.
 
194
.RE
 
195
 
 
196
.BI MAX_CORES=2
 
197
.RS
 
198
The maximum number of CPU/cores Eucalyptus is allowed to use on the node (at the moment we don't differentiate between cores and CPU). If you leave this commented out, Eucalyptus will use all available CPU/cores it can find.
 
199
.RE
 
200
 
 
201
.BI SWAP_SIZE=512
 
202
.RS
 
203
The size of the swap partition, in MB, for each instance started on the node (default is 512MB).  If the maximum disk allowed for the instance is not big enough to accommodate the swap together with the root partition, then no swap is allocated.  If there is extra room left, then an "ephemeral" partition will be created, available as /dev/sda3 inside the VM.
 
204
.RE
 
205
 
 
206
.BI CONCURRENT_DISK_OPS=4
 
207
.RS
 
208
Set the number of 'disk intensive operations' that are allowed to take place in parallel on this machine.  If this value is set too high, we run the risk of driving the load on the machine too high when multiple instances are started on this single node.  The default is 4.
 
209
.RE
 
210
 
 
211
.SH SEE ALSO
 
212
.PD 0
 
213
.TP
 
214
\fBeuca_conf\fP(8)
 
215
.TP
 
216
\fIhttp://launchpad.net/eucalyptus\fP
 
217
.PD
 
218
 
 
219
.SH AUTHOR
 
220
This manpage was written by Dustin Kirkland <kirkland@canonical.com> (with extensive help from Daniel Nurmi, and some of it lifted from the original /etc/eucalyptus/eucalyptus.conf) for Ubuntu systems (but may be used by others).  Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation.
 
221
 
 
222
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.