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>false</value>
 122           <description>Allows this local SFA instance to run as a
 123           slice manager. Warning, this feature is not really supported
 124           any longer.</description>
 125         </variable>
 126
 127         <variable id="host" type="hostname">
 128           <name>Hostname</name>
 129           <value>localhost</value>
 130           <description>The hostname where the slice manager is expected to
 131           be found.</description>
 132         </variable>
 133
 134         <variable id="port" type="int">
 135           <name>Port number</name>
 136           <value>12347</value>
 137           <description>The port where the slice manager is to be found.</description>
 138         </variable>
 139
 140         <variable id="caching" type="boolean">
 141           <name>Cache advertisement rspec</name>
 142           <value>false</value>
 143           <description>Enable caching of the global advertisement, as
 144           returned by ListResources without a slice argument. </description>
 145           </variable>
 146
 147       </variablelist>
 148     </category>
 149
 150     <!-- ======================================== -->
 151     <category id="sfa_aggregate">
 152       <name>Aggregate</name>
 153       <description>The settings that affect the aggregate manager that will run
 154       as part of this SFA instance.</description>
 155
 156       <variablelist>
 157         <variable id="enabled" type="boolean">
 158           <name>Enable Aggregate</name>
 159           <value>true</value>
 160           <description>Allows this local SFA instance to run as an
 161           aggregate manager.</description>
 162         </variable>
 163
 164         <variable id="host" type="hostname">
 165           <name>Hostname</name>
 166           <value>localhost</value>
 167           <description>The hostname where the aggregate is expected to
 168           be found.</description>
 169         </variable>
 170
 171         <variable id="port" type="int">
 172           <name>Port number</name>
 173           <value>12346</value>
 174           <description>The port where the aggregate is to be found.</description>
 175         </variable>
 176
 177         <variable id="caching" type="boolean">
 178           <name>Cache advertisement rspec</name>
 179           <value>true</value>
 180           <description>Enable caching of the global advertisement, as
 181           returned by ListResources without a slice argument. </description>
 182           </variable>
 183
 184       </variablelist>
 185
 186     </category>
 187
 188     <!-- ======================================== -->
 189     <category id="sfa_db">
 190       <name></name>
 191       <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>
 192
 193       <variablelist>
 194         <variable id="enabled" type="boolean">
 195           <name>Enabled</name>
 196           <value>true</value>
 197           <description>Enable the database server on this machine.</description>
 198         </variable>
 199
 200         <variable id="host" type="hostname">
 201           <name>Database host</name>
 202           <value>localhost</value>
 203           <description>The host where the SFA database can be reached.</description>
 204         </variable>
 205
 206         <variable id="port" type="int">
 207           <name>Database port</name>
 208           <value>5432</value>
 209           <description>The port where the SFA database can be reached.</description>
 210         </variable>
 211
 212         <variable id="user" type="string">
 213           <name>Database user</name>
 214           <value>sfadbuser</value>
 215           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
 216         </variable>
 217
 218         <variable id="password" type="string">
 219           <name>Database password</name>
 220           <value></value>
 221           <description>When SFA gets co-hosted with a myplc, this should match the PLC config.</description>
 222         </variable>
 223
 224         <variable id="name" type="string">
 225           <name>Database name</name>
 226           <value>sfa</value>
 227           <description>SFA database name.</description>
 228         </variable>
 229
 230
 231       </variablelist>
 232     </category>
 233
 234     <!-- ======================================== -->
 235     <category id="sfa_flashpolicy">
 236       <name>SFA Flash Policy</name>
 237       <description>The settings that affect the flash policy server that will run
 238       as part of this SFA instance.</description>
 239
 240       <variablelist>
 241         <variable id="enabled" type="boolean">
 242           <name>Enable Flash Policy Server</name>
 243           <value>false</value>
 244           <description>Allows this local SFA instance to run a
 245           flash policy server.</description>
 246         </variable>
 247         <variable id="config_file" type="string">
 248           <name>Flash policy config file</name>
 249           <value>/etc/sfa/sfa_flashpolicy_config.xml</value>
 250           <description>The path to where the flash policy config file can be reached.</description>
 251         </variable>
 252         <variable id="port" type="int">
 253           <name>Flash policy port</name>
 254           <value>843</value>
 255           <description>The flash policy server port.</description>
 256         </variable>
 257       </variablelist>
 258     </category>
 259
 260     <!-- ======================================== -->
 261     <category id="sfa_plc">
 262       <name></name>
 263       <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>
 264
 265       <variablelist>
 266         <variable id="user" type="string">
 267           <name>PLC login name for an admin user; SFA will carry on operations under this account.</name>
 268           <value>root@localhost.localdomain</value>
 269           <description></description>
 270         </variable>
 271
 272         <variable id="password" type="string">
 273           <name>Password</name>
 274           <value>root</value>
 275           <description>The PLC password for SFA_PLC_USER.</description>
 276         </variable>
 277
 278         <variable id="url" type="string">
 279           <name>URL</name>
 280           <value>https://localhost:443/PLCAPI/</value>
 281           <description>Full URL of PLC interface.</description>
 282         </variable>
 283
 284       </variablelist>
 285     </category>
 286
 287     <!-- ======================================== -->
 288     <category id="sfa_federica">
 289       <name></name>
 290       <description>The settings that tell this SFA instance how to interact with the FEDERICA testbed.</description>
 291
 292       <variablelist>
 293         <variable id="url" type="string">
 294           <name>XMLRPC URL</name>
 295           <value>https://root:password@federica.sfa.wrapper.com:8443/fedewrapper/xmlrpc/</value>
 296           <description>URL for the federica xmlrpc API; login and password need to be set like in http://login:password@hostname:port/the/path </description>
 297         </variable>
 298       </variablelist>
 299     </category>
 300
 301     <!-- ======================================== -->
 302     <category id="sfa_nova">
 303       <name>SFA Flash Policy</name>
 304       <description>The settings that affect how SFA connects to
 305                    the Nova/EC2 API</description>
 306       <variablelist>
 307         <variable id="user" type="string">
 308           <name>Sfa nova user</name>
 309           <value>novaadmin</value>
 310           <description>Account/context to use when performing
 311                        administrative nova operations</description>
 312         </variable>
 313         <variable id="api_url" type="string">
 314           <name>Nova API url</name>
 315           <value>127.0.0.1</value>
 316           <description>The Nova/EC2 API url </description>
 317         </variable>
 318         <variable id="api_port" type="int">
 319           <name>Nova API Port</name>
 320           <value>8773</value>
 321           <description>The Nova/EC2 API port.</description>
 322         </variable>
 323         <variable id="novarc" type="string">
 324           <name>novarc</name>
 325           <value>/root/novarc</value>
 326           <description>Path to novarc client config file</description>
 327         </variable>
 328       </variablelist>
 329     </category>
 330
 331     <!-- ======================================== -->
 332     <category id="sfa_nitos">
 333       <name></name>
 334       <description>The settings that tell this SFA instance how to interact with the NITOS testbed.</description>
 335
 336       <variablelist>
 337         <variable id="url" type="string">
 338           <name>XMLRPC URL</name>
 339           <value>http://195.251.17.239:8080/RPC2</value>
 340           <description>URL for the NITOS Scheduler xmlrpc API</description>
 341         </variable>
 342       </variablelist>
 343     </category>
 344
 345     <!-- ======================================== -->
 346     <category id="sfa_dummy">
 347       <name></name>
 348       <description>The settings for using SFA with a demmy testbed.</description>
 349
 350       <variablelist>
 351         <variable id="url" type="string">
 352           <name>XMLRPC URL</name>
 353           <value>http://127.0.0.1:8080</value>
 354           <description>URL for the Dummy Testbed xmlrpc API</description>
 355         </variable>
 356       </variablelist>
 357     </category>
 358
 359     <!-- ======================================== -->
 360
 361   </variables>
 362
 363   <comps>
 364     <!-- deprecated - not used anymore - use .lst files instead -->
 365   </comps>
 366
 367 </configuration>