trashed deprecated category 'sfa_geni_aggregate' in sfa-config-tty
[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 -->
9
10 <!DOCTYPE configuration PUBLIC "-//PlanetLab Central//DTD PLC configuration//EN" "plc_config.dtd">
11
12 <configuration>
13   <variables>
14
15     <!-- ======================================== -->
16     <category id="sfa">
17       <name>General</name>
18       <description>Basic system variables.</description>
19
20       <variablelist>
21         <variable id="interface_hrn" type="string">
22           <name>Human readable name</name>
23           <value>plc</value>
24           <description>The human readable name for this interface.</description>
25         </variable>
26
27         <variable id="credential_schema" type="string">
28           <name>Credential Schema</name>
29           <value>/etc/sfa/credential.xsd</value>
30           <description>The path to the default credential schema</description>
31         </variable>
32
33         <variable id="api_debug" type="boolean">
34           <name>Debug</name>
35           <value>false</value>
36           <description>Flag to turn debug on.</description>
37         </variable>
38
39         <variable id="session_key_path" type="string">
40             <name>User Session Keys Path </name>
41             <value>/var/lib/sfa/session_keys</value>
42             <description>Some services will peform operations on behalf of a user, but make
43             it look like the user is the one performing the operation. Doing this requires a 
44             valid key pair and credential for the user. This option defines the path where 
45             key pairs and credentials are generated and stored.
46             This functionality is used by the SFA web gui 
47             </description> 
48         </variable>
49       </variablelist>
50     </category>
51
52     <!-- ======================================== -->
53     <category id="sfa_registry">
54       <name>Registry</name>
55       <description>The settings that affect the registry that will run
56       as part of this SFA instance.</description>
57
58       <variablelist>
59         <variable id="enabled" type="boolean">
60           <name>Enable Registry</name>
61           <value>true</value>
62           <description>Allows this local SFA instance to run as a
63           registry.</description>
64         </variable>
65
66         <variable id="type" type="string">
67           <name>Registry type</name>
68           <value>pl</value>
69           <description>The type of backend server for this
70           registry. Some registries may not be myplc.</description>
71         </variable>
72
73         <variable id="host" type="hostname">
74           <name>Hostname</name>
75           <value>localhost</value>
76           <description>The hostname where the registry is expected to
77           be found; using localhost when the local registry is enabled
78           seems reasonable.</description>
79         </variable>
80
81         <variable id="port" type="int">
82           <name>Port number</name>
83           <value>12345</value>
84           <description>The port where the registry is to be found.</description>
85         </variable>
86
87         <variable id="root_auth" type="string">
88           <name>Root Authority</name>
89           <value>plc</value>
90           <description>The hrn of the registry's root auth.</description>
91         </variable>
92
93     </variablelist>
94     </category>
95
96     <!-- ======================================== -->
97     <category id="sfa_aggregate">
98       <name>Aggregate</name>
99       <description>The settings that affect the aggregate manager that will run
100       as part of this SFA instance.</description>
101
102       <variablelist>
103         <variable id="enabled" type="boolean">
104           <name>Enable Aggregate</name>
105           <value>true</value>
106           <description>Allows this local SFA instance to run as an
107           aggregate manager.</description>
108         </variable>
109
110         <variable id="type" type="string">
111           <name>Aggregate type</name>
112           <value>pl</value>
113           <description>The type of backend server for this
114           aggregate. Some aggregates may not be myplc.</description>
115         </variable>
116     
117     <variable id="rspec_schema" type="string">
118       <name>RSpec Schema</name>
119       <value>/etc/sfa/pl.rng</value>
120       <description>The path to the default schema</description>
121     </variable>
122
123         <variable id="host" type="hostname">
124           <name>Hostname</name>
125           <value>localhost</value>
126           <description>The hostname where the aggregate is expected to
127           be found.</description>
128         </variable>
129
130         <variable id="port" type="int">
131           <name>Port number</name>
132           <value>12346</value>
133           <description>The port where the aggregate is to be found.</description>
134         </variable>
135       </variablelist>
136
137     </category>
138
139     <!-- ======================================== -->
140     <category id="sfa_sm">
141       <name>Slice Manager</name>
142       <description>The settings that affect the slice manager that will run
143       as part of this SFA instance.</description>
144
145       <variablelist>
146         <variable id="enabled" type="boolean">
147           <name>Enable Slice Manager</name>
148           <value>true</value>
149           <description>Allows this local SFA instance to run as a
150           slice manager.</description>
151         </variable>
152
153         <variable id="type" type="string">
154           <name>Slice Manager type</name>
155           <value>pl</value>
156           <description>The type of backend server for this
157           slice manager. Not all slice managers are myplc.</description>
158         </variable>
159
160         <variable id="host" type="hostname">
161           <name>Hostname</name>
162           <value>localhost</value>
163           <description>The hostname where the slice manager is expected to
164           be found.</description>
165         </variable>
166
167         <variable id="port" type="int">
168           <name>Port number</name>
169           <value>12347</value>
170           <description>The port where the slice manager is to be found.</description>
171         </variable>
172       </variablelist>
173     </category>
174
175     <!-- ======================================== -->
176     <category id="sfa_plc">
177       <name></name>
178       <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>
179
180       <variablelist>
181         <variable id="user" type="string">
182           <name>PLC login name for an admin user; SFA will carry on operations under this account.</name>
183           <value>root@localhost.localdomain</value>
184           <description></description>
185         </variable>
186
187         <variable id="password" type="string">
188           <name>Password</name>
189           <value>root</value>
190           <description>The PLC password for SFA_PLC_USER.</description>
191         </variable>
192
193         <variable id="url" type="string">
194           <name>URL</name>
195           <value>https://localhost:443/PLCAPI/</value>
196           <description>Full URL of PLC interface.</description>
197         </variable>
198
199         <variable id="db_name" type="string">
200           <name>Database name</name>
201           <value>planetlab5</value>
202           <description>Planetlab database name.</description>
203         </variable>
204
205         <variable id="db_host" type="hostname">
206           <name>Datbase host</name>
207           <value>localhost</value>
208           <description>The host where the PLC database can be reached.</description>
209         </variable>
210
211         <variable id="db_port" type="int">
212           <name>Database port</name>
213           <value>5432</value>
214           <description>The port where the PLC database can be reached.</description>
215         </variable>
216
217         <variable id="db_user" type="string">
218           <name>Database user</name>
219           <value>pgsqluser</value>
220           <description></description>
221         </variable>
222
223         <variable id="db_password" type="string">
224           <name>Database password</name>
225           <value></value>
226           <description>The password for PLC_DB_USER.</description>
227         </variable>
228
229       </variablelist>
230     </category>
231
232     <category id="sfa_flashpolicy">
233       <name>SFA Flash Policy</name>
234       <description>The settings that affect the flash policy server that will run
235       as part of this SFA instance.</description>
236
237       <variablelist>
238         <variable id="enabled" type="boolean">
239           <name>Enable Flash Policy Server</name>
240           <value>false</value>
241           <description>Allows this local SFA instance to run a
242           flash policy server.</description>
243         </variable>
244         <variable id="config_file" type="string">
245           <name>Flash policy config file</name>
246           <value>/etc/sfa/sfa_flashpolicy_config.xml</value>
247           <description>The path to where the flash policy config file can be reached.</description>
248         </variable>
249         <variable id="port" type="int">
250           <name>Flash policy port</name>
251           <value>843</value>
252           <description>The flash policy server port.</description>
253         </variable>
254       </variablelist>
255     </category>
256
257   </variables>
258
259   <comps>
260     <!-- deprecated - not used anymore - use .lst files instead -->
261   </comps>
262
263 </configuration>