7e5dfdf304bd45187eb94afbca516867fd0777af
[sfa.git] / config / default_config.xml
1 <?xml version="1.0" encoding="utf-8"?>
2
3 <!--
4 Default SFA configuration file
5
6 Thierry Parmentelat 
7
8 $Id$
9 $URL$
10 -->
11
12 <!DOCTYPE configuration PUBLIC "-//PlanetLab Central//DTD PLC configuration//EN" "plc_config.dtd">
13
14 <configuration>
15   <variables>
16
17     <!-- ======================================== -->
18     <category id="sfa">
19       <name>General</name>
20       <description>Basic system variables.</description>
21
22       <variablelist>
23         <variable id="interface_hrn" type="string">
24           <name>Human readable name</name>
25           <value>plc</value>
26           <description>The human readable name for this interface.</description>
27         </variable>
28
29         <variable id="api_debug" type="boolean">
30           <name>Debug</name>
31           <value>false</value>
32           <description>Flag to turn debug on.</description>
33         </variable>
34
35       </variablelist>
36     </category>
37
38     <!-- ======================================== -->
39     <category id="sfa_registry">
40       <name>Registry</name>
41       <description>The settings that affect the registry that will run
42       as part of this SFA instance.</description>
43
44       <variablelist>
45         <variable id="enabled" type="boolean">
46           <name>Enable Registry</name>
47           <value>true</value>
48           <description>Allows this local SFA instance to run as a
49           registry.</description>
50         </variable>
51
52         <variable id="type" type="string">
53           <name>Registry type</name>
54           <value>pl</value>
55           <description>The type of backend server for this
56           registry. Some registries may not be myplc.</description>
57         </variable>
58
59         <variable id="host" type="hostname">
60           <name>Hostname</name>
61           <value>localhost</value>
62           <description>The hostname where the registry is expected to
63           be found; using localhost when the local registry is enabled
64           seems reasonable.</description>
65         </variable>
66
67         <variable id="port" type="int">
68           <name>Port number</name>
69           <value>12345</value>
70           <description>The port where the registry is to be found.</description>
71         </variable>
72
73         <variable id="root_auth" type="string">
74           <name>Root Authority</name>
75           <value>plc</value>
76           <description>The hrn of the registry's root auth.</description>
77         </variable>
78
79         <variable id="level1_auth" type="string">
80           <name>Level1 Authority</name>
81           <value></value>
82           <description>The hrn of the registry's level1 auth (sub
83           authority). The full name of this interface (only secify if
84           this interface is a sub authority).</description>
85         </variable>
86       </variablelist>
87     </category>
88
89     <!-- ======================================== -->
90     <category id="sfa_aggregate">
91       <name>Aggregate</name>
92       <description>The settings that affect the aggregate manager that will run
93       as part of this SFA instance.</description>
94
95       <variablelist>
96         <variable id="enabled" type="boolean">
97           <name>Enable Aggregate</name>
98           <value>true</value>
99           <description>Allows this local SFA instance to run as an
100           aggregate manager.</description>
101         </variable>
102
103         <variable id="type" type="string">
104           <name>Aggregate type</name>
105           <value>pl</value>
106           <description>The type of backend server for this
107           aggregate. Some aggregates may not be myplc.</description>
108         </variable>
109
110         <variable id="host" type="hostname">
111           <name>Hostname</name>
112           <value>localhost</value>
113           <description>The hostname where the aggregate is expected to
114           be found.</description>
115         </variable>
116
117         <variable id="port" type="int">
118           <name>Port number</name>
119           <value>12346</value>
120           <description>The port where the aggregate is to be found.</description>
121         </variable>
122       </variablelist>
123
124     </category>
125     <!-- ======================================== -->
126     <category id="sfa_geni_aggregate">
127       <name>GENI Aggregate</name>
128       <description>The settings that affect the geni aggregate manager that will run
129       as part of this SFA instance.</description>
130
131       <variablelist>
132         <variable id="enabled" type="boolean">
133           <name>Enable GENI Aggregate</name>
134           <value>true</value>
135           <description>Allows this local SFA instance to run as an
136           GENI aggregate manager.</description>
137         </variable>
138
139         <variable id="type" type="string">
140           <name>GENI Aggregate type</name>
141           <value>pl</value>
142           <description>The type of backend server for this
143           aggregate. Some aggregates may not be myplc.</description>
144         </variable>
145
146         <variable id="host" type="hostname">
147           <name>Hostname</name>
148           <value>localhost</value>
149           <description>The hostname where the aggregate is expected to
150           be found.</description>
151         </variable>
152
153         <variable id="port" type="int">
154           <name>Port number</name>
155           <value>12348</value>
156           <description>The port where the aggregate is to be found.</description>
157         </variable>
158       </variablelist>
159
160     </category>
161
162     <!-- ======================================== -->
163     <category id="sfa_sm">
164       <name>Slice Manager</name>
165       <description>The settings that affect the slice manager that will run
166       as part of this SFA instance.</description>
167
168       <variablelist>
169         <variable id="enabled" type="boolean">
170           <name>Enable Slice Manager</name>
171           <value>true</value>
172           <description>Allows this local SFA instance to run as a
173           slice manager.</description>
174         </variable>
175
176         <variable id="type" type="string">
177           <name>Slice Manager type</name>
178           <value>pl</value>
179           <description>The type of backend server for this
180           slice manager. Not all slice managers are myplc.</description>
181         </variable>
182
183         <variable id="host" type="hostname">
184           <name>Hostname</name>
185           <value>localhost</value>
186           <description>The hostname where the slice manager is expected to
187           be found.</description>
188         </variable>
189
190         <variable id="port" type="int">
191           <name>Port number</name>
192           <value>12347</value>
193           <description>The port where the slice manager is to be found.</description>
194         </variable>
195       </variablelist>
196     </category>
197
198     <!-- ======================================== -->
199     <category id="sfa_plc">
200       <name></name>
201       <description>The settings that tell this SFA instance how to interact with the underlying PLC. Refer to plc-config-tty on this installation for more information.</description>
202
203       <variablelist>
204         <variable id="user" type="string">
205           <name>PLC login name for an admin user; SFA will carry on operations under this account.</name>
206           <value>root@localhost.localdomain</value>
207           <description></description>
208         </variable>
209
210         <variable id="password" type="string">
211           <name>Password</name>
212           <value>root</value>
213           <description>The PLC password for SFA_PLC_USER.</description>
214         </variable>
215
216         <variable id="url" type="string">
217           <name>URL</name>
218           <value>https://localhost:443/PLCAPI/</value>
219           <description>Full URL of PLC interface.</description>
220         </variable>
221
222         <variable id="db_name" type="string">
223           <name>Database name</name>
224           <value>planetlab5</value>
225           <description>Planetlab database name.</description>
226         </variable>
227
228         <variable id="db_host" type="hostname">
229           <name>Datbase host</name>
230           <value>localhost</value>
231           <description>The host where the PLC database can be reached.</description>
232         </variable>
233
234         <variable id="db_port" type="int">
235           <name>Database port</name>
236           <value>5432</value>
237           <description>The port where the PLC database can be reached.</description>
238         </variable>
239
240         <variable id="db_user" type="string">
241           <name>Database user</name>
242           <value>pgsqluser</value>
243           <description></description>
244         </variable>
245
246         <variable id="db_password" type="string">
247           <name>Database password</name>
248           <value></value>
249           <description>The password for PLC_DB_USER.</description>
250         </variable>
251
252       </variablelist>
253     </category>
254
255   </variables>
256
257   <comps>
258     <!-- deprecated - not used anymore - use .lst files instead -->
259   </comps>
260
261 </configuration>