Merge branch 'master' into senslab2
[sfa.git] / sfa / senslab / config / senslab / sfa_config.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <configuration>
3   <variables>
4     <category id="sfa">
5       <name>General</name>
6       <description>Basic system variables.</description>
7       <variablelist>
8         <variable id="generic_flavour" type="string">
9           <name>Generic Flavour</name>
10           <value>slab</value>
11           <description>This string refers to a class located in sfa.generic that describes 
12           which specific implementation needs to be used for api, manager and driver objects.
13           PlanetLab users do not need to change this setting.
14           </description>
15         </variable>
16         <variable id="interface_hrn" type="string">
17           <name>Human readable name</name>
18           <value>senslab</value>
19           <description>The human readable name for this interface.</description>
20         </variable>
21         <variable id="credential_schema" type="string">
22           <name>Credential Schema</name>
23           <value>/etc/sfa/credential.xsd</value>
24           <description>The path to the default credential schema</description>
25         </variable>
26         <variable id="api_loglevel" type="int">
27           <name>Debug</name>
28           <value>0</value>
29           <description>Logging level; 0=minimum, 1=info, 2=debug</description>
30         </variable>
31         <variable id="max_slice_renew" type="int">
32           <name>Max Slice Renew</name>
33           <value>60</value>
34           <description>Maximum amout of days a user can extend/renew their slices to</description>
35         </variable>
36         <variable id="session_key_path" type="string">
37           <name>User Session Keys Path </name>
38           <value>/var/lib/sfa/session_keys</value>
39           <description>Some services will peform operations on behalf of a user, but make
40             it look like the user is the one performing the operation. Doing this requires a 
41             valid key pair and credential for the user. This option defines the path where 
42             key pairs and credentials are generated and stored.
43             This functionality is used by the SFA web GUI. 
44             </description>
45         </variable>
46       </variablelist>
47     </category>
48     <category id="sfa_registry">
49       <name>Registry</name>
50       <description>The settings that affect the registry that will run
51       as part of this SFA instance.</description>
52       <variablelist>
53         <variable id="enabled" type="boolean">
54           <name>Enable Registry</name>
55           <value>true</value>
56           <description>Allows this local SFA instance to run as a
57           registry.</description>
58         </variable>
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         <variable id="port" type="int">
67           <name>Port number</name>
68           <value>12345</value>
69           <description>The port where the registry is to be found.</description>
70         </variable>
71         <variable id="root_auth" type="string">
72           <name>Root Authority</name>
73           <value>senslab</value>
74           <description>The hrn of the registry's root auth.</description>
75         </variable>
76       </variablelist>
77     </category>
78     <category id="sfa_sm">
79       <name>Slice Manager</name>
80       <description>The settings that affect the slice manager that will run
81       as part of this SFA instance.</description>
82       <variablelist>
83         <variable id="enabled" type="boolean">
84           <name>Enable Slice Manager</name>
85           <value>true</value>
86           <description>Allows this local SFA instance to run as a
87           slice manager.</description>
88         </variable>
89         <variable id="host" type="hostname">
90           <name>Hostname</name>
91           <value>localhost</value>
92           <description>The hostname where the slice manager is expected to
93           be found.</description>
94         </variable>
95         <variable id="port" type="int">
96           <name>Port number</name>
97           <value>12347</value>
98           <description>The port where the slice manager is to be found.</description>
99         </variable>
100         <variable id="caching" type="boolean">
101           <name>Cache advertisement rspec</name>
102           <value>false</value>
103           <description>Enable caching of the global advertisement, as
104           returned by ListResources without a slice argument. </description>
105         </variable>
106       </variablelist>
107     </category>
108     <category id="sfa_aggregate">
109       <name>Aggregate</name>
110       <description>The settings that affect the aggregate manager that will run
111       as part of this SFA instance.</description>
112       <variablelist>
113         <variable id="enabled" type="boolean">
114           <name>Enable Aggregate</name>
115           <value>true</value>
116           <description>Allows this local SFA instance to run as an
117           aggregate manager.</description>
118         </variable>
119         <variable id="host" type="hostname">
120           <name>Hostname</name>
121           <value>localhost</value>
122           <description>The hostname where the aggregate is expected to
123           be found.</description>
124         </variable>
125         <variable id="port" type="int">
126           <name>Port number</name>
127           <value>12346</value>
128           <description>The port where the aggregate is to be found.</description>
129         </variable>
130         <variable id="caching" type="boolean">
131           <name>Cache advertisement rspec</name>
132           <value>true</value>
133           <description>Enable caching of the global advertisement, as
134           returned by ListResources without a slice argument. </description>
135         </variable>
136       </variablelist>
137     </category>
138     <category id="sfa_db">
139       <name/>
140       <description>The settings that tell this SFA instance where to find its database. You can essentially leave this as-is unless you plan on hosting your data on some other box.</description>
141       <variablelist>
142         <variable id="enabled" type="boolean">
143           <name>Enabled</name>
144           <value>true</value>
145           <description>Enable the database server on this machine.</description>
146         </variable>
147         <variable id="host" type="hostname">
148           <name>Database host</name>
149           <value>localhost</value>
150           <description>The host where the SFA database can be reached.</description>
151         </variable>
152         <variable id="port" type="int">
153           <name>Database port</name>
154           <value>5432</value>
155           <description>The port where the SFA database can be reached.</description>
156         </variable>
157         <variable id="user" type="string">
158           <name>Database user</name>
159           <value>sfa</value>
160           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
161         </variable>
162         <variable id="password" type="string">
163           <name>Database password</name>
164           <value>sfa</value>
165           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
166         </variable>
167         <variable id="name" type="string">
168           <name>Database name</name>
169           <value>sfa</value>
170           <description>SFA database name.</description>
171         </variable>
172       </variablelist>
173     </category>
174     <category id="sfa_flashpolicy">
175       <name>SFA Flash Policy</name>
176       <description>The settings that affect the flash policy server that will run
177       as part of this SFA instance.</description>
178       <variablelist>
179         <variable id="enabled" type="boolean">
180           <name>Enable Flash Policy Server</name>
181           <value>false</value>
182           <description>Allows this local SFA instance to run a
183           flash policy server.</description>
184         </variable>
185         <variable id="config_file" type="string">
186           <name>Flash policy config file</name>
187           <value>/etc/sfa/sfa_flashpolicy_config.xml</value>
188           <description>The path to where the flash policy config file can be reached.</description>
189         </variable>
190         <variable id="port" type="int">
191           <name>Flash policy port</name>
192           <value>843</value>
193           <description>The flash policy server port.</description>
194         </variable>
195       </variablelist>
196     </category>
197     <category id="sfa_plc">
198       <name/>
199       <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>
200       <variablelist>
201         <variable id="user" type="string">
202           <name>PLC login name for an admin user; SFA will carry on operations under this account.</name>
203           <value>root@localhost.localdomain</value>
204           <description/>
205         </variable>
206         <variable id="password" type="string">
207           <name>Password</name>
208           <value>root</value>
209           <description>The PLC password for SFA_PLC_USER.</description>
210         </variable>
211         <variable id="url" type="string">
212           <name>URL</name>
213           <value>https://localhost:443/PLCAPI/</value>
214           <description>Full URL of PLC interface.</description>
215         </variable>
216       </variablelist>
217     </category>
218     <category id="sfa_federica">
219       <name/>
220       <description>The settings that tell this SFA instance how to interact with the FEDERICA testbed.</description>
221       <variablelist>
222         <variable id="url" type="string">
223           <name>XMLRPC URL</name>
224           <value>https://root:password@federica.sfa.wrapper.com:8443/fedewrapper/xmlrpc/</value>
225           <description>URL for the federica xmlrpc API; login and password need to be set like in http://login:password@hostname:port/the/path </description>
226         </variable>
227       </variablelist>
228     </category>
229     <category id="sfa_nova">
230       <name>SFA Flash Policy</name>
231       <description>The settings that affect how SFA connects to 
232                    the Nova/EC2 API</description>
233       <variablelist>
234         <variable id="user" type="string">
235           <name>Sfa nova user</name>
236           <value>novaadmin</value>
237           <description>Account/context to use when performing 
238                        administrative nova operations</description>
239         </variable>
240         <variable id="api_url" type="string">
241           <name>Nova API url</name>
242           <value>127.0.0.1</value>
243           <description>The Nova/EC2 API url </description>
244         </variable>
245         <variable id="api_port" type="int">
246           <name>Nova API Port</name>
247           <value>8773</value>
248           <description>The Nova/EC2 API port.</description>
249         </variable>
250       </variablelist>
251     </category>
252   </variables>
253 </configuration>