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