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