simple_ssl_context() is now a helper exposed in module sfa.util.ssl
[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="generic_flavour" type="string">
22           <name>Generic Flavour</name>
23           <value>pl</value>
24           <description>This string refers to a class located in sfa.generic that describes
25           which specific implementation needs to be used for api, manager and driver objects.
26           PlanetLab users do not need to change this setting.
27           </description>
28         </variable>
29
30         <variable id="interface_hrn" type="string">
31           <name>Human readable name</name>
32           <value>plc</value>
33           <description>The human readable name for this interface.</description>
34         </variable>
35
36         <variable id="credential_schema" type="string">
37           <name>Credential Schema</name>
38           <value>/etc/sfa/credential.xsd</value>
39           <description>The path to the default credential schema</description>
40         </variable>
41
42         <variable id="api_loglevel" type="int">
43           <name>Debug</name>
44           <value>0</value>
45           <description>Logging level; 0=minimum, 1=info, 2=debug</description>
46         </variable>
47
48         <variable id="max_slice_renew" type="int">
49           <name>Max Slice Renew</name>
50           <value>60</value>
51           <description>Maximum amout of days a user can extend/renew their slices to</description>
52         </variable>
53
54         <variable id="session_key_path" type="string">
55             <name>User Session Keys Path </name>
56             <value>/var/lib/sfa/session_keys</value>
57             <description>Some services will peform operations on behalf of a user, but make
58             it look like the user is the one performing the operation. Doing this requires a
59             valid key pair and credential for the user. This option defines the path where
60             key pairs and credentials are generated and stored.
61             This functionality is used by the SFA web GUI.
62             </description>
63         </variable>
64
65          <variable id="data_dir" type="string">
66             <name>Data Directory </name>
67             <value>/var/lib/sfa/</value>
68             <description>Directory where cached certificates and other data is stored.
69             </description>
70         </variable>
71
72       </variablelist>
73     </category>
74
75     <!-- ======================================== -->
76     <category id="sfa_registry">
77       <name>Registry</name>
78       <description>The settings that affect the registry that will run
79       as part of this SFA instance.</description>
80
81       <variablelist>
82         <variable id="enabled" type="boolean">
83           <name>Enable Registry</name>
84           <value>true</value>
85           <description>Allows this local SFA instance to run as a
86           registry.</description>
87         </variable>
88
89         <variable id="host" type="hostname">
90           <name>Hostname</name>
91           <value>localhost</value>
92           <description>The hostname where the registry is expected to
93           be found; using localhost when the local registry is enabled
94           seems reasonable.</description>
95         </variable>
96
97         <variable id="port" type="int">
98           <name>Port number</name>
99           <value>12345</value>
100           <description>The port where the registry is to be found.</description>
101         </variable>
102
103         <variable id="root_auth" type="string">
104           <name>Root Authority</name>
105           <value>plc</value>
106           <description>The hrn of the registry's root auth.</description>
107         </variable>
108
109     </variablelist>
110     </category>
111
112     <!-- ======================================== -->
113     <category id="sfa_aggregate">
114       <name>Aggregate</name>
115       <description>The settings that affect the aggregate manager that will run
116       as part of this SFA instance.</description>
117
118       <variablelist>
119         <variable id="enabled" type="boolean">
120           <name>Enable Aggregate</name>
121           <value>true</value>
122           <description>Allows this local SFA instance to run as an
123           aggregate manager.</description>
124         </variable>
125
126         <variable id="host" type="hostname">
127           <name>Hostname</name>
128           <value>localhost</value>
129           <description>The hostname where the aggregate is expected to
130           be found.</description>
131         </variable>
132
133         <variable id="port" type="int">
134           <name>Port number</name>
135           <value>12346</value>
136           <description>The port where the aggregate is to be found.</description>
137         </variable>
138
139         <variable id="caching" type="boolean">
140           <name>Cache advertisement rspec</name>
141           <value>true</value>
142           <description>Enable caching of the global advertisement, as
143           returned by ListResources without a slice argument. </description>
144           </variable>
145
146       </variablelist>
147
148     </category>
149
150     <!-- ======================================== -->
151     <category id="sfa_db">
152       <name></name>
153       <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>
154
155       <variablelist>
156         <variable id="enabled" type="boolean">
157           <name>Enabled</name>
158           <value>true</value>
159           <description>Enable the database server on this machine.</description>
160         </variable>
161
162         <variable id="host" type="hostname">
163           <name>Database host</name>
164           <value>localhost</value>
165           <description>The host where the SFA database can be reached.</description>
166         </variable>
167
168         <variable id="port" type="int">
169           <name>Database port</name>
170           <value>5432</value>
171           <description>The port where the SFA database can be reached.</description>
172         </variable>
173
174         <variable id="user" type="string">
175           <name>Database user</name>
176           <value>sfadbuser</value>
177           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
178         </variable>
179
180         <variable id="password" type="string">
181           <name>Database password</name>
182           <value></value>
183           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
184         </variable>
185
186         <variable id="name" type="string">
187           <name>Database name</name>
188           <value>sfa</value>
189           <description>SFA database name.</description>
190         </variable>
191
192
193       </variablelist>
194     </category>
195
196     <!-- ======================================== -->
197     <category id="sfa_plc">
198       <name></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
201       <variablelist>
202         <variable id="user" type="string">
203           <name>PLC login name for an admin user; SFA will carry on operations under this account.</name>
204           <value>root@localhost.localdomain</value>
205           <description></description>
206         </variable>
207
208         <variable id="password" type="string">
209           <name>Password</name>
210           <value>root</value>
211           <description>The PLC password for SFA_PLC_USER.</description>
212         </variable>
213
214         <variable id="url" type="string">
215           <name>URL</name>
216           <value>https://localhost:443/PLCAPI/</value>
217           <description>Full URL of PLC interface.</description>
218         </variable>
219
220       </variablelist>
221     </category>
222
223     <!-- ======================================== -->
224     <category id="sfa_dummy">
225       <name></name>
226       <description>The settings for using SFA with a demmy testbed.</description>
227
228       <variablelist>
229         <variable id="url" type="string">
230           <name>XMLRPC URL</name>
231           <value>http://127.0.0.1:8080</value>
232           <description>URL for the Dummy Testbed xmlrpc API</description>
233         </variable>
234       </variablelist>
235     </category>
236
237     <!-- ======================================== -->
238
239   </variables>
240
241   <comps>
242     <!-- deprecated - not used anymore - use .lst files instead -->
243   </comps>
244
245 </configuration>