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="max_slice_renew" type="int">
  40           <name>Max Slice Renew</name>
  41           <value>60</value>
  42           <description>Maximum amout of days a user can extend/renew their slices to</description>
  43         </variable>
  44
  45         <variable id="session_key_path" type="string">
  46             <name>User Session Keys Path </name>
  47             <value>/var/lib/sfa/session_keys</value>
  48             <description>Some services will peform operations on behalf of a user, but make
  49             it look like the user is the one performing the operation. Doing this requires a
  50             valid key pair and credential for the user. This option defines the path where
  51             key pairs and credentials are generated and stored.
  52             This functionality is used by the SFA web GUI.
  53             </description>
  54         </variable>
  55
  56         <variable id="generic_flavour" type="string">
  57           <name>Generic Flavour</name>
  58           <value>pl</value>
  59           <description>This string refers to a class located in sfa.generic that describes
  60           which specific implementation needs to be used for api, manager and driver objects.
  61           PlanetLab users do not need to change this setting.
  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_sm">
 114       <name>Slice Manager</name>
 115       <description>The settings that affect the slice manager that will run
 116       as part of this SFA instance.</description>
 117
 118       <variablelist>
 119         <variable id="enabled" type="boolean">
 120           <name>Enable Slice Manager</name>
 121           <value>true</value>
 122           <description>Allows this local SFA instance to run as a
 123           slice manager.</description>
 124         </variable>
 125
 126         <variable id="type" type="string">
 127           <name>Slice Manager type</name>
 128           <value>pl</value>
 129           <description>The type of backend server for this
 130           slice manager. Not all slice managers are myplc.</description>
 131         </variable>
 132
 133         <variable id="host" type="hostname">
 134           <name>Hostname</name>
 135           <value>localhost</value>
 136           <description>The hostname where the slice manager is expected to
 137           be found.</description>
 138         </variable>
 139
 140         <variable id="port" type="int">
 141           <name>Port number</name>
 142           <value>12347</value>
 143           <description>The port where the slice manager is to be found.</description>
 144         </variable>
 145       </variablelist>
 146     </category>
 147
 148     <!-- ======================================== -->
 149     <category id="sfa_aggregate">
 150       <name>Aggregate</name>
 151       <description>The settings that affect the aggregate manager that will run
 152       as part of this SFA instance.</description>
 153
 154       <variablelist>
 155         <variable id="enabled" type="boolean">
 156           <name>Enable Aggregate</name>
 157           <value>true</value>
 158           <description>Allows this local SFA instance to run as an
 159           aggregate manager.</description>
 160         </variable>
 161
 162         <variable id="type" type="string">
 163           <name>Aggregate type</name>
 164           <value>pl</value>
 165           <description>The type of backend server for this
 166           aggregate. Some aggregates may not be myplc.</description>
 167         </variable>
 168
 169     <variable id="rspec_schema" type="string">
 170       <name>RSpec Schema</name>
 171       <value>/etc/sfa/pl.rng</value>
 172       <description>The path to the default schema</description>
 173     </variable>
 174
 175         <variable id="host" type="hostname">
 176           <name>Hostname</name>
 177           <value>localhost</value>
 178           <description>The hostname where the aggregate is expected to
 179           be found.</description>
 180         </variable>
 181
 182         <variable id="port" type="int">
 183           <name>Port number</name>
 184           <value>12346</value>
 185           <description>The port where the aggregate is to be found.</description>
 186         </variable>
 187       </variablelist>
 188
 189     </category>
 190
 191     <!-- ======================================== -->
 192     <category id="sfa_db">
 193       <name></name>
 194       <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>
 195
 196       <variablelist>
 197         <variable id="host" type="hostname">
 198           <name>Database host</name>
 199           <value>localhost</value>
 200           <description>The host where the SFA database can be reached.</description>
 201         </variable>
 202
 203         <variable id="port" type="int">
 204           <name>Database port</name>
 205           <value>5432</value>
 206           <description>The port where the SFA database can be reached.</description>
 207         </variable>
 208
 209         <variable id="user" type="string">
 210           <name>Database user</name>
 211           <value>pgsqluser</value>
 212           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
 213         </variable>
 214
 215         <variable id="password" type="string">
 216           <name>Database password</name>
 217           <value></value>
 218           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
 219         </variable>
 220
 221         <variable id="name" type="string">
 222           <name>Database name</name>
 223           <value>sfa</value>
 224           <description>SFA database name.</description>
 225         </variable>
 226
 227
 228       </variablelist>
 229     </category>
 230
 231     <!-- ======================================== -->
 232     <category id="sfa_plc">
 233       <name></name>
 234       <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>
 235
 236       <variablelist>
 237         <variable id="user" type="string">
 238           <name>PLC login name for an admin user; SFA will carry on operations under this account.</name>
 239           <value>root@localhost.localdomain</value>
 240           <description></description>
 241         </variable>
 242
 243         <variable id="password" type="string">
 244           <name>Password</name>
 245           <value>root</value>
 246           <description>The PLC password for SFA_PLC_USER.</description>
 247         </variable>
 248
 249         <variable id="url" type="string">
 250           <name>URL</name>
 251           <value>https://localhost:443/PLCAPI/</value>
 252           <description>Full URL of PLC interface.</description>
 253         </variable>
 254
 255       </variablelist>
 256     </category>
 257
 258
 259     <!-- ======================================== -->
 260     <category id="sfa_flashpolicy">
 261       <name>SFA Flash Policy</name>
 262       <description>The settings that affect the flash policy server that will run
 263       as part of this SFA instance.</description>
 264
 265       <variablelist>
 266         <variable id="enabled" type="boolean">
 267           <name>Enable Flash Policy Server</name>
 268           <value>false</value>
 269           <description>Allows this local SFA instance to run a
 270           flash policy server.</description>
 271         </variable>
 272         <variable id="config_file" type="string">
 273           <name>Flash policy config file</name>
 274           <value>/etc/sfa/sfa_flashpolicy_config.xml</value>
 275           <description>The path to where the flash policy config file can be reached.</description>
 276         </variable>
 277         <variable id="port" type="int">
 278           <name>Flash policy port</name>
 279           <value>843</value>
 280           <description>The flash policy server port.</description>
 281         </variable>
 282       </variablelist>
 283     </category>
 284
 285   </variables>
 286
 287   <comps>
 288     <!-- deprecated - not used anymore - use .lst files instead -->
 289   </comps>
 290
 291 </configuration>