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="aggregate_api_version" type="string">
  37           <name>Aggregate Manager API Version</name>
  38           <value>1</value>
  39           <description>The Aggregate API version</description>
  40         </variable>
  41
  42         <variable id="credential_schema" type="string">
  43           <name>Credential Schema</name>
  44           <value>/etc/sfa/credential.xsd</value>
  45           <description>The path to the default credential schema</description>
  46         </variable>
  47
  48         <variable id="api_debug" type="boolean">
  49           <name>Debug</name>
  50           <value>false</value>
  51           <description>Flag to turn debug on.</description>
  52         </variable>
  53
  54         <variable id="max_slice_renew" type="int">
  55           <name>Max Slice Renew</name>
  56           <value>60</value>
  57           <description>Maximum amout of days a user can extend/renew their slices to</description>
  58         </variable>
  59
  60         <variable id="session_key_path" type="string">
  61             <name>User Session Keys Path </name>
  62             <value>/var/lib/sfa/session_keys</value>
  63             <description>Some services will peform operations on behalf of a user, but make
  64             it look like the user is the one performing the operation. Doing this requires a
  65             valid key pair and credential for the user. This option defines the path where
  66             key pairs and credentials are generated and stored.
  67             This functionality is used by the SFA web GUI.
  68             </description>
  69         </variable>
  70
  71       </variablelist>
  72     </category>
  73
  74     <!-- ======================================== -->
  75     <category id="sfa_registry">
  76       <name>Registry</name>
  77       <description>The settings that affect the registry that will run
  78       as part of this SFA instance.</description>
  79
  80       <variablelist>
  81         <variable id="enabled" type="boolean">
  82           <name>Enable Registry</name>
  83           <value>true</value>
  84           <description>Allows this local SFA instance to run as a
  85           registry.</description>
  86         </variable>
  87
  88         <variable id="type" type="string">
  89           <name>Registry type</name>
  90           <value>pl</value>
  91           <description>The type of backend server for this
  92           registry. Some registries may not be myplc.</description>
  93         </variable>
  94
  95         <variable id="host" type="hostname">
  96           <name>Hostname</name>
  97           <value>localhost</value>
  98           <description>The hostname where the registry is expected to
  99           be found; using localhost when the local registry is enabled
 100           seems reasonable.</description>
 101         </variable>
 102
 103         <variable id="port" type="int">
 104           <name>Port number</name>
 105           <value>12345</value>
 106           <description>The port where the registry is to be found.</description>
 107         </variable>
 108
 109         <variable id="root_auth" type="string">
 110           <name>Root Authority</name>
 111           <value>plc</value>
 112           <description>The hrn of the registry's root auth.</description>
 113         </variable>
 114
 115     </variablelist>
 116     </category>
 117
 118     <!-- ======================================== -->
 119     <category id="sfa_sm">
 120       <name>Slice Manager</name>
 121       <description>The settings that affect the slice manager that will run
 122       as part of this SFA instance.</description>
 123
 124       <variablelist>
 125         <variable id="enabled" type="boolean">
 126           <name>Enable Slice Manager</name>
 127           <value>true</value>
 128           <description>Allows this local SFA instance to run as a
 129           slice manager.</description>
 130         </variable>
 131
 132         <variable id="type" type="string">
 133           <name>Slice Manager type</name>
 134           <value>pl</value>
 135           <description>The type of backend server for this
 136           slice manager. Not all slice managers are myplc.</description>
 137         </variable>
 138
 139         <variable id="host" type="hostname">
 140           <name>Hostname</name>
 141           <value>localhost</value>
 142           <description>The hostname where the slice manager is expected to
 143           be found.</description>
 144         </variable>
 145
 146         <variable id="port" type="int">
 147           <name>Port number</name>
 148           <value>12347</value>
 149           <description>The port where the slice manager is to be found.</description>
 150         </variable>
 151       </variablelist>
 152     </category>
 153
 154     <!-- ======================================== -->
 155     <category id="sfa_aggregate">
 156       <name>Aggregate</name>
 157       <description>The settings that affect the aggregate manager that will run
 158       as part of this SFA instance.</description>
 159
 160       <variablelist>
 161         <variable id="enabled" type="boolean">
 162           <name>Enable Aggregate</name>
 163           <value>true</value>
 164           <description>Allows this local SFA instance to run as an
 165           aggregate manager.</description>
 166         </variable>
 167
 168         <variable id="type" type="string">
 169           <name>Aggregate type</name>
 170           <value>pl</value>
 171           <description>The type of backend server for this
 172           aggregate. Some aggregates may not be myplc.</description>
 173         </variable>
 174
 175     <variable id="rspec_schema" type="string">
 176       <name>RSpec Schema</name>
 177       <value>/etc/sfa/pl.rng</value>
 178       <description>The path to the default schema</description>
 179     </variable>
 180
 181         <variable id="host" type="hostname">
 182           <name>Hostname</name>
 183           <value>localhost</value>
 184           <description>The hostname where the aggregate is expected to
 185           be found.</description>
 186         </variable>
 187
 188         <variable id="port" type="int">
 189           <name>Port number</name>
 190           <value>12346</value>
 191           <description>The port where the aggregate is to be found.</description>
 192         </variable>
 193       </variablelist>
 194
 195     </category>
 196
 197     <!-- ======================================== -->
 198     <category id="sfa_db">
 199       <name></name>
 200       <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>
 201
 202       <variablelist>
 203         <variable id="enabled" type="boolean">
 204           <name>Enabled</name>
 205           <value>true</value>
 206           <description>Enable the database server on this machine.</description>
 207         </variable>
 208
 209         <variable id="host" type="hostname">
 210           <name>Database host</name>
 211           <value>localhost</value>
 212           <description>The host where the SFA database can be reached.</description>
 213         </variable>
 214
 215         <variable id="port" type="int">
 216           <name>Database port</name>
 217           <value>5432</value>
 218           <description>The port where the SFA database can be reached.</description>
 219         </variable>
 220
 221         <variable id="user" type="string">
 222           <name>Database user</name>
 223           <value>sfadbuser</value>
 224           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
 225         </variable>
 226
 227         <variable id="password" type="string">
 228           <name>Database password</name>
 229           <value></value>
 230           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
 231         </variable>
 232
 233         <variable id="name" type="string">
 234           <name>Database name</name>
 235           <value>sfa</value>
 236           <description>SFA database name.</description>
 237         </variable>
 238
 239
 240       </variablelist>
 241     </category>
 242
 243     <!-- ======================================== -->
 244     <category id="sfa_plc">
 245       <name></name>
 246       <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>
 247
 248       <variablelist>
 249         <variable id="user" type="string">
 250           <name>PLC login name for an admin user; SFA will carry on operations under this account.</name>
 251           <value>root@localhost.localdomain</value>
 252           <description></description>
 253         </variable>
 254
 255         <variable id="password" type="string">
 256           <name>Password</name>
 257           <value>root</value>
 258           <description>The PLC password for SFA_PLC_USER.</description>
 259         </variable>
 260
 261         <variable id="url" type="string">
 262           <name>URL</name>
 263           <value>https://localhost:443/PLCAPI/</value>
 264           <description>Full URL of PLC interface.</description>
 265         </variable>
 266
 267       </variablelist>
 268     </category>
 269
 270
 271     <!-- ======================================== -->
 272     <category id="sfa_flashpolicy">
 273       <name>SFA Flash Policy</name>
 274       <description>The settings that affect the flash policy server that will run
 275       as part of this SFA instance.</description>
 276
 277       <variablelist>
 278         <variable id="enabled" type="boolean">
 279           <name>Enable Flash Policy Server</name>
 280           <value>false</value>
 281           <description>Allows this local SFA instance to run a
 282           flash policy server.</description>
 283         </variable>
 284         <variable id="config_file" type="string">
 285           <name>Flash policy config file</name>
 286           <value>/etc/sfa/sfa_flashpolicy_config.xml</value>
 287           <description>The path to where the flash policy config file can be reached.</description>
 288         </variable>
 289         <variable id="port" type="int">
 290           <name>Flash policy port</name>
 291           <value>843</value>
 292           <description>The flash policy server port.</description>
 293         </variable>
 294       </variablelist>
 295     </category>
 296
 297   </variables>
 298
 299   <comps>
 300     <!-- deprecated - not used anymore - use .lst files instead -->
 301   </comps>
 302
 303 </configuration>