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_debug" type="boolean">
  43           <name>Debug</name>
  44           <value>false</value>
  45           <description>Flag to turn debug on.</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       </variablelist>
  66     </category>
  67
  68     <!-- ======================================== -->
  69     <category id="sfa_registry">
  70       <name>Registry</name>
  71       <description>The settings that affect the registry that will run
  72       as part of this SFA instance.</description>
  73
  74       <variablelist>
  75         <variable id="enabled" type="boolean">
  76           <name>Enable Registry</name>
  77           <value>true</value>
  78           <description>Allows this local SFA instance to run as a
  79           registry.</description>
  80         </variable>
  81
  82         <variable id="type" type="string">
  83           <name>Registry type</name>
  84           <value>pl</value>
  85           <description>The type of backend server for this
  86           registry. Some registries may not be myplc.</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="type" type="string">
 127           <name>Aggregate type</name>
 128           <value>pl</value>
 129           <description>The type of backend server for this
 130           aggregate. Some aggregates may not be myplc.</description>
 131         </variable>
 132
 133     <variable id="rspec_schema" type="string">
 134       <name>RSpec Schema</name>
 135       <value>/etc/sfa/pl.rng</value>
 136       <description>The path to the default schema</description>
 137     </variable>
 138
 139         <variable id="host" type="hostname">
 140           <name>Hostname</name>
 141           <value>localhost</value>
 142           <description>The hostname where the aggregate is expected to
 143           be found.</description>
 144         </variable>
 145
 146         <variable id="port" type="int">
 147           <name>Port number</name>
 148           <value>12346</value>
 149           <description>The port where the aggregate is to be found.</description>
 150         </variable>
 151       </variablelist>
 152
 153     </category>
 154
 155     <!-- ======================================== -->
 156     <category id="sfa_sm">
 157       <name>Slice Manager</name>
 158       <description>The settings that affect the slice manager that will run
 159       as part of this SFA instance.</description>
 160
 161       <variablelist>
 162         <variable id="enabled" type="boolean">
 163           <name>Enable Slice Manager</name>
 164           <value>true</value>
 165           <description>Allows this local SFA instance to run as a
 166           slice manager.</description>
 167         </variable>
 168
 169         <variable id="type" type="string">
 170           <name>Slice Manager type</name>
 171           <value>pl</value>
 172           <description>The type of backend server for this
 173           slice manager. Not all slice managers are myplc.</description>
 174         </variable>
 175
 176         <variable id="host" type="hostname">
 177           <name>Hostname</name>
 178           <value>localhost</value>
 179           <description>The hostname where the slice manager is expected to
 180           be found.</description>
 181         </variable>
 182
 183         <variable id="port" type="int">
 184           <name>Port number</name>
 185           <value>12347</value>
 186           <description>The port where the slice manager is to be found.</description>
 187         </variable>
 188       </variablelist>
 189     </category>
 190
 191     <!-- ======================================== -->
 192     <category id="sfa_plc">
 193       <name></name>
 194       <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>
 195
 196       <variablelist>
 197         <variable id="user" type="string">
 198           <name>PLC login name for an admin user; SFA will carry on operations under this account.</name>
 199           <value>root@localhost.localdomain</value>
 200           <description></description>
 201         </variable>
 202
 203         <variable id="password" type="string">
 204           <name>Password</name>
 205           <value>root</value>
 206           <description>The PLC password for SFA_PLC_USER.</description>
 207         </variable>
 208
 209         <variable id="url" type="string">
 210           <name>URL</name>
 211           <value>https://localhost:443/PLCAPI/</value>
 212           <description>Full URL of PLC interface.</description>
 213         </variable>
 214
 215         <variable id="db_name" type="string">
 216           <name>Database name</name>
 217           <value>planetlab5</value>
 218           <description>Planetlab database name.</description>
 219         </variable>
 220
 221         <variable id="db_host" type="hostname">
 222           <name>Datbase host</name>
 223           <value>localhost</value>
 224           <description>The host where the PLC database can be reached.</description>
 225         </variable>
 226
 227         <variable id="db_port" type="int">
 228           <name>Database port</name>
 229           <value>5432</value>
 230           <description>The port where the PLC database can be reached.</description>
 231         </variable>
 232
 233         <variable id="db_user" type="string">
 234           <name>Database user</name>
 235           <value>pgsqluser</value>
 236           <description></description>
 237         </variable>
 238
 239         <variable id="db_password" type="string">
 240           <name>Database password</name>
 241           <value></value>
 242           <description>The password for PLC_DB_USER.</description>
 243         </variable>
 244
 245       </variablelist>
 246     </category>
 247
 248     <category id="sfa_flashpolicy">
 249       <name>SFA Flash Policy</name>
 250       <description>The settings that affect the flash policy server that will run
 251       as part of this SFA instance.</description>
 252
 253       <variablelist>
 254         <variable id="enabled" type="boolean">
 255           <name>Enable Flash Policy Server</name>
 256           <value>false</value>
 257           <description>Allows this local SFA instance to run a
 258           flash policy server.</description>
 259         </variable>
 260         <variable id="config_file" type="string">
 261           <name>Flash policy config file</name>
 262           <value>/etc/sfa/sfa_flashpolicy_config.xml</value>
 263           <description>The path to where the flash policy config file can be reached.</description>
 264         </variable>
 265         <variable id="port" type="int">
 266           <name>Flash policy port</name>
 267           <value>843</value>
 268           <description>The flash policy server port.</description>
 269         </variable>
 270       </variablelist>
 271     </category>
 272
 273   </variables>
 274
 275   <comps>
 276     <!-- deprecated - not used anymore - use .lst files instead -->
 277   </comps>
 278
 279 </configuration>