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="int">
  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="host" type="hostname">
  89           <name>Hostname</name>
  90           <value>localhost</value>
  91           <description>The hostname where the registry is expected to
  92           be found; using localhost when the local registry is enabled
  93           seems reasonable.</description>
  94         </variable>
  95
  96         <variable id="port" type="int">
  97           <name>Port number</name>
  98           <value>12345</value>
  99           <description>The port where the registry is to be found.</description>
 100         </variable>
 101
 102         <variable id="root_auth" type="string">
 103           <name>Root Authority</name>
 104           <value>plc</value>
 105           <description>The hrn of the registry's root auth.</description>
 106         </variable>
 107
 108     </variablelist>
 109     </category>
 110
 111     <!-- ======================================== -->
 112     <category id="sfa_sm">
 113       <name>Slice Manager</name>
 114       <description>The settings that affect the slice manager that will run
 115       as part of this SFA instance.</description>
 116
 117       <variablelist>
 118         <variable id="enabled" type="boolean">
 119           <name>Enable Slice Manager</name>
 120           <value>true</value>
 121           <description>Allows this local SFA instance to run as a
 122           slice manager.</description>
 123         </variable>
 124
 125         <variable id="host" type="hostname">
 126           <name>Hostname</name>
 127           <value>localhost</value>
 128           <description>The hostname where the slice manager is expected to
 129           be found.</description>
 130         </variable>
 131
 132         <variable id="port" type="int">
 133           <name>Port number</name>
 134           <value>12347</value>
 135           <description>The port where the slice manager is to be found.</description>
 136         </variable>
 137       </variablelist>
 138     </category>
 139
 140     <!-- ======================================== -->
 141     <category id="sfa_aggregate">
 142       <name>Aggregate</name>
 143       <description>The settings that affect the aggregate manager that will run
 144       as part of this SFA instance.</description>
 145
 146       <variablelist>
 147         <variable id="enabled" type="boolean">
 148           <name>Enable Aggregate</name>
 149           <value>true</value>
 150           <description>Allows this local SFA instance to run as an
 151           aggregate manager.</description>
 152         </variable>
 153
 154     <variable id="rspec_schema" type="string">
 155       <name>RSpec Schema</name>
 156       <value>/etc/sfa/pl.rng</value>
 157       <description>The path to the default schema</description>
 158     </variable>
 159
 160         <variable id="host" type="hostname">
 161           <name>Hostname</name>
 162           <value>localhost</value>
 163           <description>The hostname where the aggregate is expected to
 164           be found.</description>
 165         </variable>
 166
 167         <variable id="port" type="int">
 168           <name>Port number</name>
 169           <value>12346</value>
 170           <description>The port where the aggregate is to be found.</description>
 171         </variable>
 172       </variablelist>
 173
 174     </category>
 175
 176     <!-- ======================================== -->
 177     <category id="sfa_db">
 178       <name></name>
 179       <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>
 180
 181       <variablelist>
 182         <variable id="enabled" type="boolean">
 183           <name>Enabled</name>
 184           <value>true</value>
 185           <description>Enable the database server on this machine.</description>
 186         </variable>
 187
 188         <variable id="host" type="hostname">
 189           <name>Database host</name>
 190           <value>localhost</value>
 191           <description>The host where the SFA database can be reached.</description>
 192         </variable>
 193
 194         <variable id="port" type="int">
 195           <name>Database port</name>
 196           <value>5432</value>
 197           <description>The port where the SFA database can be reached.</description>
 198         </variable>
 199
 200         <variable id="user" type="string">
 201           <name>Database user</name>
 202           <value>sfadbuser</value>
 203           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
 204         </variable>
 205
 206         <variable id="password" type="string">
 207           <name>Database password</name>
 208           <value></value>
 209           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
 210         </variable>
 211
 212         <variable id="name" type="string">
 213           <name>Database name</name>
 214           <value>sfa</value>
 215           <description>SFA database name.</description>
 216         </variable>
 217
 218
 219       </variablelist>
 220     </category>
 221
 222     <!-- ======================================== -->
 223     <category id="sfa_plc">
 224       <name></name>
 225       <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>
 226
 227       <variablelist>
 228         <variable id="user" type="string">
 229           <name>PLC login name for an admin user; SFA will carry on operations under this account.</name>
 230           <value>root@localhost.localdomain</value>
 231           <description></description>
 232         </variable>
 233
 234         <variable id="password" type="string">
 235           <name>Password</name>
 236           <value>root</value>
 237           <description>The PLC password for SFA_PLC_USER.</description>
 238         </variable>
 239
 240         <variable id="url" type="string">
 241           <name>URL</name>
 242           <value>https://localhost:443/PLCAPI/</value>
 243           <description>Full URL of PLC interface.</description>
 244         </variable>
 245
 246       </variablelist>
 247     </category>
 248
 249
 250     <!-- ======================================== -->
 251     <category id="sfa_flashpolicy">
 252       <name>SFA Flash Policy</name>
 253       <description>The settings that affect the flash policy server that will run
 254       as part of this SFA instance.</description>
 255
 256       <variablelist>
 257         <variable id="enabled" type="boolean">
 258           <name>Enable Flash Policy Server</name>
 259           <value>false</value>
 260           <description>Allows this local SFA instance to run a
 261           flash policy server.</description>
 262         </variable>
 263         <variable id="config_file" type="string">
 264           <name>Flash policy config file</name>
 265           <value>/etc/sfa/sfa_flashpolicy_config.xml</value>
 266           <description>The path to where the flash policy config file can be reached.</description>
 267         </variable>
 268         <variable id="port" type="int">
 269           <name>Flash policy port</name>
 270           <value>843</value>
 271           <description>The flash policy server port.</description>
 272         </variable>
 273       </variablelist>
 274     </category>
 275
 276   </variables>
 277
 278   <comps>
 279     <!-- deprecated - not used anymore - use .lst files instead -->
 280   </comps>
 281
 282 </configuration>