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     <category id="sfa_geni_aggregate">
 140       <name>GENI Aggregate</name>
 141       <description>The settings that affect the geni aggregate manager that will run
 142       as part of this SFA instance.</description>
 143
 144       <variablelist>
 145         <variable id="enabled" type="boolean">
 146           <name>Enable GENI Aggregate</name>
 147           <value>true</value>
 148           <description>Allows this local SFA instance to run as an
 149           GENI aggregate manager.</description>
 150         </variable>
 151
 152         <variable id="type" type="string">
 153           <name>GENI Aggregate type</name>
 154           <value>pl</value>
 155           <description>The type of backend server for this
 156           aggregate. Some aggregates may not be myplc.</description>
 157         </variable>
 158
 159         <variable id="host" type="hostname">
 160           <name>Hostname</name>
 161           <value>localhost</value>
 162           <description>The hostname where the aggregate is expected to
 163           be found.</description>
 164         </variable>
 165
 166         <variable id="port" type="int">
 167           <name>Port number</name>
 168           <value>12348</value>
 169           <description>The port where the aggregate is to be found.</description>
 170         </variable>
 171       </variablelist>
 172
 173     </category>
 174
 175     <!-- ======================================== -->
 176     <category id="sfa_sm">
 177       <name>Slice Manager</name>
 178       <description>The settings that affect the slice manager that will run
 179       as part of this SFA instance.</description>
 180
 181       <variablelist>
 182         <variable id="enabled" type="boolean">
 183           <name>Enable Slice Manager</name>
 184           <value>true</value>
 185           <description>Allows this local SFA instance to run as a
 186           slice manager.</description>
 187         </variable>
 188
 189         <variable id="type" type="string">
 190           <name>Slice Manager type</name>
 191           <value>pl</value>
 192           <description>The type of backend server for this
 193           slice manager. Not all slice managers are myplc.</description>
 194         </variable>
 195
 196         <variable id="host" type="hostname">
 197           <name>Hostname</name>
 198           <value>localhost</value>
 199           <description>The hostname where the slice manager is expected to
 200           be found.</description>
 201         </variable>
 202
 203         <variable id="port" type="int">
 204           <name>Port number</name>
 205           <value>12347</value>
 206           <description>The port where the slice manager is to be found.</description>
 207         </variable>
 208       </variablelist>
 209     </category>
 210
 211     <!-- ======================================== -->
 212     <category id="sfa_plc">
 213       <name></name>
 214       <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>
 215
 216       <variablelist>
 217         <variable id="user" type="string">
 218           <name>PLC login name for an admin user; SFA will carry on operations under this account.</name>
 219           <value>root@localhost.localdomain</value>
 220           <description></description>
 221         </variable>
 222
 223         <variable id="password" type="string">
 224           <name>Password</name>
 225           <value>root</value>
 226           <description>The PLC password for SFA_PLC_USER.</description>
 227         </variable>
 228
 229         <variable id="url" type="string">
 230           <name>URL</name>
 231           <value>https://localhost:443/PLCAPI/</value>
 232           <description>Full URL of PLC interface.</description>
 233         </variable>
 234
 235         <variable id="db_name" type="string">
 236           <name>Database name</name>
 237           <value>planetlab5</value>
 238           <description>Planetlab database name.</description>
 239         </variable>
 240
 241         <variable id="db_host" type="hostname">
 242           <name>Datbase host</name>
 243           <value>localhost</value>
 244           <description>The host where the PLC database can be reached.</description>
 245         </variable>
 246
 247         <variable id="db_port" type="int">
 248           <name>Database port</name>
 249           <value>5432</value>
 250           <description>The port where the PLC database can be reached.</description>
 251         </variable>
 252
 253         <variable id="db_user" type="string">
 254           <name>Database user</name>
 255           <value>pgsqluser</value>
 256           <description></description>
 257         </variable>
 258
 259         <variable id="db_password" type="string">
 260           <name>Database password</name>
 261           <value></value>
 262           <description>The password for PLC_DB_USER.</description>
 263         </variable>
 264
 265       </variablelist>
 266     </category>
 267
 268     <category id="sfa_flashpolicy">
 269       <name>SFA Flash Policy</name>
 270       <description>The settings that affect the flash policy server that will run
 271       as part of this SFA instance.</description>
 272
 273       <variablelist>
 274         <variable id="enabled" type="boolean">
 275           <name>Enable Flash Policy Server</name>
 276           <value>false</value>
 277           <description>Allows this local SFA instance to run a
 278           flash policy server.</description>
 279         </variable>
 280         <variable id="config_file" type="string">
 281           <name>Flash policy config file</name>
 282           <value>/etc/sfa/sfa_flashpolicy_config.xml</value>
 283           <description>The path to where the flash policy config file can be reached.</description>
 284         </variable>
 285         <variable id="port" type="int">
 286           <name>Flash policy port</name>
 287           <value>843</value>
 288           <description>The flash policy server port.</description>
 289         </variable>
 290       </variablelist>
 291     </category>
 292
 293   </variables>
 294
 295   <comps>
 296     <!-- deprecated - not used anymore - use .lst files instead -->
 297   </comps>
 298
 299 </configuration>