← Back to branch summary

~ubuntu-core-dev/ubuntu/maverick/eucalyptus/devel

« back to all changes in this revision

Viewing changes to tools/euca_conf.8

  • 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/euca_conf.8
1
 
.TH euca_conf 8 "August 2, 2009" "euca_conf"
2
 
 
3
 
.SH NAME
4
 
euca_conf \- configuration tool for Eucalyptus
5
 
 
6
 
.SH SYNOPSIS
7
 
.B euca_conf
8
 
 
9
 
.SH DESCRIPTION
10
 
This manual page describes the
11
 
.B euca_conf
12
 
command which is used to configure Eucalyptus. There are few component to
13
 
a Eucalyptus installation: the cloud controller (CLC), walrus, one or more
14
 
cluster controller (CC), one storage controller (SC) per CC and node
15
 
controller (NC).
16
 
 
17
 
CLC is the endpoint for the client tool, and contains the administrative
18
 
UI (reachable at https://localhost:8443 on the CLC machine).
19
 
 
20
 
walrus is the S3 compatible storage for Eucalyptus.
21
 
 
22
 
CC controls a number of NCs, provisions the network for VMs.
23
 
 
24
 
SC gives EBS functionality to a cluster.
25
 
 
26
 
NC interact with the local hypervisor to start/stop/control instances.
27
 
 
28
 
 
29
 
.SH OPTIONS
30
 
 
31
 
.BI --help
32
 
.RS
33
 
display some help
34
 
.RE
35
 
 
36
 
.BI --enable\ {walrus|sc|cloud}
37
 
.RS
38
 
Service to enable at the next start time. Needs to be run on the machine
39
 
which has the service to start.
40
 
.RE
41
 
 
42
 
.BI --disable\ {walrus|sc|cloud}
43
 
.RS
44
 
Disable services, preventing them to be started.
45
 
.RE
46
 
 
47
 
.BI --register-cluster\ <name>\ <hostname>
48
 
.RS
49
 
Register a CC with the CLC. To allow provisioning of instances, at least
50
 
one CC is needed on a running Eucalyptus installation.
51
 
This command needs to be ran on the CLC machine, and the
52
 
CC machine (possibly the same machine) needs to be reachable. The keys
53
 
needs to be transferred from the CLC to the CC machine to enable
54
 
secure operation, and ssh is used, so this command may ask for a password.
55
 
 
56
 
The user need to choose a name per CC.
57
 
.RE
58
 
 
59
 
.BI --deregister-cluster\ <name>\ <hostname>
60
 
.RS
61
 
Deregister a CC.
62
 
.RE
63
 
 
64
 
.BI --register-sc\ <CC>\ <hostname>
65
 
.RS
66
 
Register a SC with the CLC. The SC is needed to provide EBS support to a
67
 
cluster logically resides with the CC.
68
 
This command needs to be ran on the CLC machine, and the
69
 
SC machine (possibly the same machine) needs to be reachable. The keys
70
 
needs to be transferred from the CLC to the SC machine to enable
71
 
secure operation, and ssh is used, so this command may ask for a password.
72
 
 
73
 
There has to be a CC already registered, since the SC works in conjunction
74
 
with a CC.
75
 
.RE
76
 
 
77
 
.BI --deregister-sc\ <hostname>
78
 
.RS
79
 
Deregister a running SC. You will need to register another SC to
80
 
have EBS functionality for a named cluster.
81
 
 
82
 
.B WARNING:
83
 
running this command will invalidate volumes and snapshots which this SC
84
 
is responsible for.
85
 
.RE
86
 
 
87
 
.BI --register-walrus\ <hostname>
88
 
.RS
89
 
Register a walrus with the CLC. A walrus is needed for a running Eucalyptus
90
 
installation. This command needs to be ran on the CLC machine, and the
91
 
walrus machine (possibly the same machine) needs to be reachable. The keys
92
 
needs to be transferred from the CLC to the walrus machine to enable
93
 
secure operation, and ssh is used, so this command may ask for a password.
94
 
.RE
95
 
 
96
 
.BI --deregister-walrus\ <hostname>
97
 
.RS
98
 
Deregister a running walrus. You will need to register another walrus to
99
 
have a functional Eucalyptus installation.
100
 
 
101
 
.B WARNING:
102
 
running this command will invalidate the uploaded and running images,
103
 
kernels and ramdisk! So you (and all the users) will have to upload new
104
 
images.
105
 
.RE
106
 
 
107
 
.BI --register-nodes\ host\ [host ...]
108
 
.RS
109
 
Register NCs with a CC. NC and CC should be on the same network. This
110
 
command needs to be run the CC which will controll the NCs. The keys
111
 
needs to be transferred from the CC to the NC for enable secure operation,
112
 
and ssh is used, so this command may ask for a password.
113
 
.RE
114
 
 
115
 
.BI --deregister-nodes\ host\ [host ...]
116
 
.RS
117
 
Intruct the CC to ignore specified NCs.
118
 
.RE
119
 
 
120
 
.BI --list-walruses
121
 
.RS
122
 
List registered walruses. The command needs to be run on the CLC.
123
 
.RE
124
 
 
125
 
.BI --list-scs
126
 
.RS
127
 
List registered storage controllers. The command needs to be run on the CLC.
128
 
.RE
129
 
.
130
 
.BI --list-clusters
131
 
.RS
132
 
List registered cluster controllers. The command needs to be run on the CLC.
133
 
.RE
134
 
.
135
 
.BI --instances\ <path>
136
 
.RS
137
 
The NC needs disk space to keep a copy of the running instances. Some
138
 
copies are cached for faster startup time. This instruct the NC to user
139
 
.I path
140
 
as the local cache.
141
 
.I path
142
 
better be an empty directory, since the NC needs to initialized it every
143
 
time.
144
 
.RE
145
 
 
146
 
.BI --version
147
 
.RS
148
 
Print the version of Eucalyptus.
149
 
.RE
150
 
 
151
 
.BI --setup
152
 
.RS
153
 
This command needs to run as root, before the first-time startup or
154
 
Eucalyptus. Eucalyptus runs as an unprivileged user (EUCA_USER in config)
155
 
but to interact with hypervisor and disk image, it will need to escalate
156
 
privilege. To do so we use a command (euca_rootwrap) and this command set
157
 
it up properly.
158
 
.RE
159
 
 
160
 
.BI --check\ {nc|cc|cloud|sc|walrus}
161
 
.RS
162
 
This command is mainly used on the startup script for the specific
163
 
component, since it checks that the environment is properly setup for the
164
 
component (mainly permission on directory needs to be right for the
165
 
eucalyptus user).
166
 
.RE
167
 
 
168
 
.BI --cc-port\ <port>
169
 
.RS
170
 
.RE
171
 
.BI --nc-port\ <port>
172
 
.RS
173
 
.RE
174
 
.BI --user\ <euca_user>
175
 
.RS
176
 
.RE
177
 
.BI --dhcpd\ <dhcpd>
178
 
.RS
179
 
.RE
180
 
.BI --dhcp_user\ <user>
181
 
.RS
182
 
These commands modify eucalyptus.conf so the changes will be reflected at
183
 
the restart of the services.
184
 
.RE
185
 
 
186
 
.SH COPYRIGHT
187
 
Copyright © 2009 Eucalyptus Systems Inc.   License  GPLv3+: GNU GPL
188
 
version 3 or later <http://gnu.org/licenses/gpl.html>.  This  is  free
189
 
software:  you  are free to change and redistribute it.  There is NO
190
 
WARRANTY, to the extent permitted by law.
191
 
 
192
 
.SH AUTHOR
193
 
Eucalyptus Systems Inc. <http://www.eucalyptus.com>
194