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_loglevel" type="int">
  43           <name>Debug</name>
  44           <value>0</value>
  45           <description>Logging level; 0=minimum, 1=info, 2=debug</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          <variable id="data_dir" type="string">
  66             <name>Data Directory </name>
  67             <value>/var/lib/sfa/</value>
  68             <description>Directory where cached certficiates and other data is stored.
  69             </description>
  70         </variable>
  71
  72       </variablelist>
  73     </category>
  74
  75     <!-- ======================================== -->
  76     <category id="sfa_registry">
  77       <name>Registry</name>
  78       <description>The settings that affect the registry that will run
  79       as part of this SFA instance.</description>
  80
  81       <variablelist>
  82         <variable id="enabled" type="boolean">
  83           <name>Enable Registry</name>
  84           <value>true</value>
  85           <description>Allows this local SFA instance to run as a
  86           registry.</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="host" type="hostname">
 127           <name>Hostname</name>
 128           <value>localhost</value>
 129           <description>The hostname where the slice manager is expected to
 130           be found.</description>
 131         </variable>
 132
 133         <variable id="port" type="int">
 134           <name>Port number</name>
 135           <value>12347</value>
 136           <description>The port where the slice manager is to be found.</description>
 137         </variable>
 138
 139         <variable id="caching" type="boolean">
 140           <name>Cache advertisement rspec</name>
 141           <value>false</value>
 142           <description>Enable caching of the global advertisement, as
 143           returned by ListResources without a slice argument. </description>
 144           </variable>
 145
 146       </variablelist>
 147     </category>
 148
 149     <!-- ======================================== -->
 150     <category id="sfa_aggregate">
 151       <name>Aggregate</name>
 152       <description>The settings that affect the aggregate manager that will run
 153       as part of this SFA instance.</description>
 154
 155       <variablelist>
 156         <variable id="enabled" type="boolean">
 157           <name>Enable Aggregate</name>
 158           <value>true</value>
 159           <description>Allows this local SFA instance to run as an
 160           aggregate manager.</description>
 161         </variable>
 162
 163         <variable id="host" type="hostname">
 164           <name>Hostname</name>
 165           <value>localhost</value>
 166           <description>The hostname where the aggregate is expected to
 167           be found.</description>
 168         </variable>
 169
 170         <variable id="port" type="int">
 171           <name>Port number</name>
 172           <value>12346</value>
 173           <description>The port where the aggregate is to be found.</description>
 174         </variable>
 175
 176         <variable id="caching" type="boolean">
 177           <name>Cache advertisement rspec</name>
 178           <value>true</value>
 179           <description>Enable caching of the global advertisement, as
 180           returned by ListResources without a slice argument. </description>
 181           </variable>
 182
 183       </variablelist>
 184
 185     </category>
 186
 187     <!-- ======================================== -->
 188     <category id="sfa_db">
 189       <name></name>
 190       <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>
 191
 192       <variablelist>
 193         <variable id="enabled" type="boolean">
 194           <name>Enabled</name>
 195           <value>true</value>
 196           <description>Enable the database server on this machine.</description>
 197         </variable>
 198
 199         <variable id="host" type="hostname">
 200           <name>Database host</name>
 201           <value>localhost</value>
 202           <description>The host where the SFA database can be reached.</description>
 203         </variable>
 204
 205         <variable id="port" type="int">
 206           <name>Database port</name>
 207           <value>5432</value>
 208           <description>The port where the SFA database can be reached.</description>
 209         </variable>
 210
 211         <variable id="user" type="string">
 212           <name>Database user</name>
 213           <value>sfadbuser</value>
 214           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
 215         </variable>
 216
 217         <variable id="password" type="string">
 218           <name>Database password</name>
 219           <value></value>
 220           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
 221         </variable>
 222
 223         <variable id="name" type="string">
 224           <name>Database name</name>
 225           <value>sfa</value>
 226           <description>SFA database name.</description>
 227         </variable>
 228
 229
 230       </variablelist>
 231     </category>
 232
 233     <!-- ======================================== -->
 234     <category id="sfa_flashpolicy">
 235       <name>SFA Flash Policy</name>
 236       <description>The settings that affect the flash policy server that will run
 237       as part of this SFA instance.</description>
 238
 239       <variablelist>
 240         <variable id="enabled" type="boolean">
 241           <name>Enable Flash Policy Server</name>
 242           <value>false</value>
 243           <description>Allows this local SFA instance to run a
 244           flash policy server.</description>
 245         </variable>
 246         <variable id="config_file" type="string">
 247           <name>Flash policy config file</name>
 248           <value>/etc/sfa/sfa_flashpolicy_config.xml</value>
 249           <description>The path to where the flash policy config file can be reached.</description>
 250         </variable>
 251         <variable id="port" type="int">
 252           <name>Flash policy port</name>
 253           <value>843</value>
 254           <description>The flash policy server port.</description>
 255         </variable>
 256       </variablelist>
 257     </category>
 258
 259     <!-- ======================================== -->
 260     <category id="sfa_plc">
 261       <name></name>
 262       <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>
 263
 264       <variablelist>
 265         <variable id="user" type="string">
 266           <name>PLC login name for an admin user; SFA will carry on operations under this account.</name>
 267           <value>root@localhost.localdomain</value>
 268           <description></description>
 269         </variable>
 270
 271         <variable id="password" type="string">
 272           <name>Password</name>
 273           <value>root</value>
 274           <description>The PLC password for SFA_PLC_USER.</description>
 275         </variable>
 276
 277         <variable id="url" type="string">
 278           <name>URL</name>
 279           <value>https://localhost:443/PLCAPI/</value>
 280           <description>Full URL of PLC interface.</description>
 281         </variable>
 282
 283       </variablelist>
 284     </category>
 285
 286     <!-- ======================================== -->
 287     <category id="sfa_federica">
 288       <name></name>
 289       <description>The settings that tell this SFA instance how to interact with the FEDERICA testbed.</description>
 290
 291       <variablelist>
 292         <variable id="url" type="string">
 293           <name>XMLRPC URL</name>
 294           <value>https://root:password@federica.sfa.wrapper.com:8443/fedewrapper/xmlrpc/</value>
 295           <description>URL for the federica xmlrpc API; login and password need to be set like in http://login:password@hostname:port/the/path </description>
 296         </variable>
 297       </variablelist>
 298     </category>
 299
 300     <!-- ======================================== -->
 301     <category id="sfa_nova">
 302       <name>SFA Flash Policy</name>
 303       <description>The settings that affect how SFA connects to
 304                    the Nova/EC2 API</description>
 305       <variablelist>
 306         <variable id="user" type="string">
 307           <name>Sfa nova user</name>
 308           <value>novaadmin</value>
 309           <description>Account/context to use when performing
 310                        administrative nova operations</description>
 311         </variable>
 312         <variable id="api_url" type="string">
 313           <name>Nova API url</name>
 314           <value>127.0.0.1</value>
 315           <description>The Nova/EC2 API url </description>
 316         </variable>
 317         <variable id="api_port" type="int">
 318           <name>Nova API Port</name>
 319           <value>8773</value>
 320           <description>The Nova/EC2 API port.</description>
 321         </variable>
 322         <variable id="novarc" type="string">
 323           <name>novarc</name>
 324           <value>/root/novarc</value>
 325           <description>Path to novarc client config file</description>
 326         </variable>
 327       </variablelist>
 328     </category>
 329
 330   </variables>
 331
 332   <comps>
 333     <!-- deprecated - not used anymore - use .lst files instead -->
 334   </comps>
 335
 336 </configuration>