doc/variables.xml

   1 <variablelist>
   2   <varlistentry>
   3     <term>PLC_NAME</term>
   4     <listitem>
   5       <para>
   6                   Type: string</para>
   7       <para>
   8                   Default: PlanetLab Test</para>
   9       <para>The name of this PLC installation. It is used in
  10           the name of the default system site (e.g., PlanetLab Central)
  11           and in the names of various administrative entities (e.g.,
  12           PlanetLab Support).</para>
  13     </listitem>
  14   </varlistentry>
  15   <varlistentry>
  16     <term>PLC_SLICE_PREFIX</term>
  17     <listitem>
  18       <para>
  19                   Type: string</para>
  20       <para>
  21                   Default: pl</para>
  22       <para>The abbreviated name of this PLC
  23           installation. It is used as the prefix for system slices
  24           (e.g., pl_conf). Warning: Currently, this variable should
  25           not be changed.</para>
  26     </listitem>
  27   </varlistentry>
  28   <varlistentry>
  29     <term>PLC_ROOT_USER</term>
  30     <listitem>
  31       <para>
  32                   Type: email</para>
  33       <para>
  34                   Default: root@localhost.localdomain</para>
  35       <para>The name of the initial administrative
  36           account. We recommend that this account be used only to create
  37           additional accounts associated with real
  38           administrators, then disabled.</para>
  39     </listitem>
  40   </varlistentry>
  41   <varlistentry>
  42     <term>PLC_ROOT_PASSWORD</term>
  43     <listitem>
  44       <para>
  45                   Type: password</para>
  46       <para>
  47                   Default: root</para>
  48       <para>The password of the initial administrative
  49           account. Also the password of the root account on the Boot
  50           CD.</para>
  51     </listitem>
  52   </varlistentry>
  53   <varlistentry>
  54     <term>PLC_ROOT_SSH_KEY_PUB</term>
  55     <listitem>
  56       <para>
  57                   Type: file</para>
  58       <para>
  59                   Default: /etc/planetlab/root_ssh_key.pub</para>
  60       <para>The SSH public key used to access the root
  61           account on your nodes.</para>
  62     </listitem>
  63   </varlistentry>
  64   <varlistentry>
  65     <term>PLC_ROOT_SSH_KEY</term>
  66     <listitem>
  67       <para>
  68                   Type: file</para>
  69       <para>
  70                   Default: /etc/planetlab/root_ssh_key.rsa</para>
  71       <para>The SSH private key used to access the root
  72           account on your nodes.</para>
  73     </listitem>
  74   </varlistentry>
  75   <varlistentry>
  76     <term>PLC_DEBUG_SSH_KEY_PUB</term>
  77     <listitem>
  78       <para>
  79                   Type: file</para>
  80       <para>
  81                   Default: /etc/planetlab/debug_ssh_key.pub</para>
  82       <para>The SSH public key used to access the root
  83           account on your nodes when they are in Debug mode.</para>
  84     </listitem>
  85   </varlistentry>
  86   <varlistentry>
  87     <term>PLC_DEBUG_SSH_KEY</term>
  88     <listitem>
  89       <para>
  90                   Type: file</para>
  91       <para>
  92                   Default: /etc/planetlab/debug_ssh_key.rsa</para>
  93       <para>The SSH private key used to access the root
  94           account on your nodes when they are in Debug mode.</para>
  95     </listitem>
  96   </varlistentry>
  97   <varlistentry>
  98     <term>PLC_ROOT_GPG_KEY_PUB</term>
  99     <listitem>
 100       <para>
 101                   Type: file</para>
 102       <para>
 103                   Default: /etc/planetlab/pubring.gpg</para>
 104       <para>The GPG public keyring used to sign the Boot
 105           Manager and all node packages.</para>
 106     </listitem>
 107   </varlistentry>
 108   <varlistentry>
 109     <term>PLC_ROOT_GPG_KEY</term>
 110     <listitem>
 111       <para>
 112                   Type: file</para>
 113       <para>
 114                   Default: /etc/planetlab/secring.gpg</para>
 115       <para>The SSH private key used to access the root
 116           account on your nodes.</para>
 117     </listitem>
 118   </varlistentry>
 119   <varlistentry>
 120     <term>PLC_NET_DNS1</term>
 121     <listitem>
 122       <para>
 123                   Type: ip</para>
 124       <para>
 125                   Default: 127.0.0.1</para>
 126       <para>Primary DNS server address.</para>
 127     </listitem>
 128   </varlistentry>
 129   <varlistentry>
 130     <term>PLC_NET_DNS2</term>
 131     <listitem>
 132       <para>
 133                   Type: ip</para>
 134       <para>
 135                   Default: </para>
 136       <para>Secondary DNS server address.</para>
 137     </listitem>
 138   </varlistentry>
 139   <varlistentry>
 140     <term>PLC_DNS_ENABLED</term>
 141     <listitem>
 142       <para>
 143                   Type: boolean</para>
 144       <para>
 145                   Default: true</para>
 146       <para>Enable the internal DNS server. The server does
 147           not provide reverse resolution and is not a production
 148           quality or scalable DNS solution. Use the internal DNS
 149           server only for small deployments or for
 150           testing.</para>
 151     </listitem>
 152   </varlistentry>
 153   <varlistentry>
 154     <term>PLC_MAIL_ENABLED</term>
 155     <listitem>
 156       <para>
 157                   Type: boolean</para>
 158       <para>
 159                   Default: false</para>
 160       <para>Set to false to suppress all e-mail notifications
 161           and warnings.</para>
 162     </listitem>
 163   </varlistentry>
 164   <varlistentry>
 165     <term>PLC_MAIL_SUPPORT_ADDRESS</term>
 166     <listitem>
 167       <para>
 168                   Type: email</para>
 169       <para>
 170                   Default: root+support@localhost.localdomain</para>
 171       <para>This address is used for support
 172           requests. Support requests may include traffic complaints,
 173           security incident reporting, web site malfunctions, and
 174           general requests for information. We recommend that the
 175           address be aliased to a ticketing system such as Request
 176           Tracker.</para>
 177     </listitem>
 178   </varlistentry>
 179   <varlistentry>
 180     <term>PLC_MAIL_BOOT_ADDRESS</term>
 181     <listitem>
 182       <para>
 183                   Type: email</para>
 184       <para>
 185                   Default: root+install-msgs@localhost.localdomain</para>
 186       <para>The API will notify this address when a problem
 187           occurs during node installation or boot.</para>
 188     </listitem>
 189   </varlistentry>
 190   <varlistentry>
 191     <term>PLC_MAIL_SLICE_ADDRESS</term>
 192     <listitem>
 193       <para>
 194                   Type: email</para>
 195       <para>
 196                   Default: root+SLICE@localhost.localdomain</para>
 197       <para>This address template is used for sending
 198           e-mail notifications to slices. SLICE will be replaced with
 199           the name of the slice.</para>
 200     </listitem>
 201   </varlistentry>
 202   <varlistentry>
 203     <term>PLC_DB_ENABLED</term>
 204     <listitem>
 205       <para>
 206                   Type: boolean</para>
 207       <para>
 208                   Default: true</para>
 209       <para>Enable the database server on this
 210           machine.</para>
 211     </listitem>
 212   </varlistentry>
 213   <varlistentry>
 214     <term>PLC_DB_TYPE</term>
 215     <listitem>
 216       <para>
 217                   Type: string</para>
 218       <para>
 219                   Default: postgresql</para>
 220       <para>The type of database server. Currently, only
 221           postgresql is supported.</para>
 222     </listitem>
 223   </varlistentry>
 224   <varlistentry>
 225     <term>PLC_DB_HOST</term>
 226     <listitem>
 227       <para>
 228                   Type: hostname</para>
 229       <para>
 230                   Default: localhost.localdomain</para>
 231       <para>The fully qualified hostname of the database
 232           server.</para>
 233     </listitem>
 234   </varlistentry>
 235   <varlistentry>
 236     <term>PLC_DB_IP</term>
 237     <listitem>
 238       <para>
 239                   Type: ip</para>
 240       <para>
 241                   Default: 127.0.0.1</para>
 242       <para>The IP address of the database server, if not
 243           resolvable by the configured DNS servers.</para>
 244     </listitem>
 245   </varlistentry>
 246   <varlistentry>
 247     <term>PLC_DB_PORT</term>
 248     <listitem>
 249       <para>
 250                   Type: int</para>
 251       <para>
 252                   Default: 5432</para>
 253       <para>The TCP port number through which the database
 254           server should be accessed.</para>
 255     </listitem>
 256   </varlistentry>
 257   <varlistentry>
 258     <term>PLC_DB_NAME</term>
 259     <listitem>
 260       <para>
 261                   Type: string</para>
 262       <para>
 263                   Default: planetlab3</para>
 264       <para>The name of the database to access.</para>
 265     </listitem>
 266   </varlistentry>
 267   <varlistentry>
 268     <term>PLC_DB_USER</term>
 269     <listitem>
 270       <para>
 271                   Type: string</para>
 272       <para>
 273                   Default: pgsqluser</para>
 274       <para>The username to use when accessing the
 275           database.</para>
 276     </listitem>
 277   </varlistentry>
 278   <varlistentry>
 279     <term>PLC_DB_PASSWORD</term>
 280     <listitem>
 281       <para>
 282                   Type: password</para>
 283       <para>
 284                   Default: </para>
 285       <para>The password to use when accessing the
 286           database. If left blank, one will be
 287           generated.</para>
 288     </listitem>
 289   </varlistentry>
 290   <varlistentry>
 291     <term>PLC_API_ENABLED</term>
 292     <listitem>
 293       <para>
 294                   Type: boolean</para>
 295       <para>
 296                   Default: true</para>
 297       <para>Enable the API server on this
 298           machine.</para>
 299     </listitem>
 300   </varlistentry>
 301   <varlistentry>
 302     <term>PLC_API_DEBUG</term>
 303     <listitem>
 304       <para>
 305                   Type: boolean</para>
 306       <para>
 307                   Default: false</para>
 308       <para>Enable verbose API debugging. Do not enable on
 309           a production system!</para>
 310     </listitem>
 311   </varlistentry>
 312   <varlistentry>
 313     <term>PLC_API_HOST</term>
 314     <listitem>
 315       <para>
 316                   Type: hostname</para>
 317       <para>
 318                   Default: localhost.localdomain</para>
 319       <para>The fully qualified hostname of the API
 320           server.</para>
 321     </listitem>
 322   </varlistentry>
 323   <varlistentry>
 324     <term>PLC_API_IP</term>
 325     <listitem>
 326       <para>
 327                   Type: ip</para>
 328       <para>
 329                   Default: 127.0.0.1</para>
 330       <para>The IP address of the API server, if not
 331           resolvable by the configured DNS servers.</para>
 332     </listitem>
 333   </varlistentry>
 334   <varlistentry>
 335     <term>PLC_API_PORT</term>
 336     <listitem>
 337       <para>
 338                   Type: int</para>
 339       <para>
 340                   Default: 80</para>
 341       <para>The TCP port number through which the API
 342           should be accessed. Warning: SSL (port 443) access is not
 343           fully supported by the website code yet. We recommend that
 344           port 80 be used for now and that the API server either run
 345           on the same machine as the web server, or that they both be
 346           on a secure wired network.</para>
 347     </listitem>
 348   </varlistentry>
 349   <varlistentry>
 350     <term>PLC_API_PATH</term>
 351     <listitem>
 352       <para>
 353                   Type: string</para>
 354       <para>
 355                   Default: /PLCAPI/</para>
 356       <para>The base path of the API URL.</para>
 357     </listitem>
 358   </varlistentry>
 359   <varlistentry>
 360     <term>PLC_API_MAINTENANCE_USER</term>
 361     <listitem>
 362       <para>
 363                   Type: string</para>
 364       <para>
 365                   Default: maint@localhost.localdomain</para>
 366       <para>The username of the maintenance account. This
 367           account is used by local scripts that perform automated
 368           tasks, and cannot be used for normal logins.</para>
 369     </listitem>
 370   </varlistentry>
 371   <varlistentry>
 372     <term>PLC_API_MAINTENANCE_PASSWORD</term>
 373     <listitem>
 374       <para>
 375                   Type: password</para>
 376       <para>
 377                   Default: </para>
 378       <para>The password of the maintenance account. If
 379           left blank, one will be generated. We recommend that the
 380           password be changed periodically.</para>
 381     </listitem>
 382   </varlistentry>
 383   <varlistentry>
 384     <term>PLC_API_MAINTENANCE_SOURCES</term>
 385     <listitem>
 386       <para>
 387                   Type: hostname</para>
 388       <para>
 389                   Default: </para>
 390       <para>A space-separated list of IP addresses allowed
 391           to access the API through the maintenance account. The value
 392           of this variable is set automatically to allow only the API,
 393           web, and boot servers, and should not be
 394           changed.</para>
 395     </listitem>
 396   </varlistentry>
 397   <varlistentry>
 398     <term>PLC_API_SSL_CRT</term>
 399     <listitem>
 400       <para>
 401                   Type: file</para>
 402       <para>
 403                   Default: /etc/planetlab/api_ssl.crt</para>
 404       <para>The signed SSL certificate to use for HTTPS
 405           access. If not specified or non-existent, a self-signed
 406           certificate will be generated.</para>
 407     </listitem>
 408   </varlistentry>
 409   <varlistentry>
 410     <term>PLC_API_SSL_KEY</term>
 411     <listitem>
 412       <para>
 413                   Type: file</para>
 414       <para>
 415                   Default: /etc/planetlab/api_ssl.key</para>
 416       <para>The corresponding SSL private key used for
 417           signing the certificate, and for signing slice tickets. If
 418           not specified or non-existent, one will be
 419           generated.</para>
 420     </listitem>
 421   </varlistentry>
 422   <varlistentry>
 423     <term>PLC_API_SSL_KEY_PUB</term>
 424     <listitem>
 425       <para>
 426                   Type: file</para>
 427       <para>
 428                   Default: /etc/planetlab/api_ssl.pub</para>
 429       <para>The corresponding SSL public key. If not
 430           specified or non-existent, one will be
 431           generated.</para>
 432     </listitem>
 433   </varlistentry>
 434   <varlistentry>
 435     <term>PLC_WWW_ENABLED</term>
 436     <listitem>
 437       <para>
 438                   Type: boolean</para>
 439       <para>
 440                   Default: true</para>
 441       <para>Enable the web server on this
 442           machine.</para>
 443     </listitem>
 444   </varlistentry>
 445   <varlistentry>
 446     <term>PLC_WWW_DEBUG</term>
 447     <listitem>
 448       <para>
 449                   Type: boolean</para>
 450       <para>
 451                   Default: false</para>
 452       <para>Enable debugging output on web pages. Do not
 453           enable on a production system!</para>
 454     </listitem>
 455   </varlistentry>
 456   <varlistentry>
 457     <term>PLC_WWW_HOST</term>
 458     <listitem>
 459       <para>
 460                   Type: hostname</para>
 461       <para>
 462                   Default: localhost.localdomain</para>
 463       <para>The fully qualified hostname of the web
 464           server.</para>
 465     </listitem>
 466   </varlistentry>
 467   <varlistentry>
 468     <term>PLC_WWW_IP</term>
 469     <listitem>
 470       <para>
 471                   Type: ip</para>
 472       <para>
 473                   Default: 127.0.0.1</para>
 474       <para>The IP address of the web server, if not
 475           resolvable by the configured DNS servers.</para>
 476     </listitem>
 477   </varlistentry>
 478   <varlistentry>
 479     <term>PLC_WWW_PORT</term>
 480     <listitem>
 481       <para>
 482                   Type: int</para>
 483       <para>
 484                   Default: 80</para>
 485       <para>The TCP port number through which the
 486           unprotected portions of the web site should be
 487           accessed.</para>
 488     </listitem>
 489   </varlistentry>
 490   <varlistentry>
 491     <term>PLC_WWW_SSL_PORT</term>
 492     <listitem>
 493       <para>
 494                   Type: int</para>
 495       <para>
 496                   Default: 443</para>
 497       <para>The TCP port number through which the protected
 498           portions of the web site should be accessed.</para>
 499     </listitem>
 500   </varlistentry>
 501   <varlistentry>
 502     <term>PLC_WWW_SSL_CRT</term>
 503     <listitem>
 504       <para>
 505                   Type: file</para>
 506       <para>
 507                   Default: /etc/planetlab/www_ssl.crt</para>
 508       <para>The signed SSL certificate to use for HTTPS
 509           access. If not specified or non-existent, a self-signed
 510           certificate will be generated.</para>
 511     </listitem>
 512   </varlistentry>
 513   <varlistentry>
 514     <term>PLC_WWW_SSL_KEY</term>
 515     <listitem>
 516       <para>
 517                   Type: file</para>
 518       <para>
 519                   Default: /etc/planetlab/www_ssl.key</para>
 520       <para>The corresponding SSL private key. If not
 521           specified or non-existent, one will be
 522           generated.</para>
 523     </listitem>
 524   </varlistentry>
 525   <varlistentry>
 526     <term>PLC_BOOT_ENABLED</term>
 527     <listitem>
 528       <para>
 529                   Type: boolean</para>
 530       <para>
 531                   Default: true</para>
 532       <para>Enable the boot server on this
 533           machine.</para>
 534     </listitem>
 535   </varlistentry>
 536   <varlistentry>
 537     <term>PLC_BOOT_HOST</term>
 538     <listitem>
 539       <para>
 540                   Type: hostname</para>
 541       <para>
 542                   Default: localhost.localdomain</para>
 543       <para>The fully qualified hostname of the boot
 544           server.</para>
 545     </listitem>
 546   </varlistentry>
 547   <varlistentry>
 548     <term>PLC_BOOT_IP</term>
 549     <listitem>
 550       <para>
 551                   Type: ip</para>
 552       <para>
 553                   Default: 127.0.0.1</para>
 554       <para>The IP address of the boot server, if not
 555           resolvable by the configured DNS servers.</para>
 556     </listitem>
 557   </varlistentry>
 558   <varlistentry>
 559     <term>PLC_BOOT_PORT</term>
 560     <listitem>
 561       <para>
 562                   Type: int</para>
 563       <para>
 564                   Default: 80</para>
 565       <para>The TCP port number through which the
 566           unprotected portions of the boot server should be
 567           accessed.</para>
 568     </listitem>
 569   </varlistentry>
 570   <varlistentry>
 571     <term>PLC_BOOT_SSL_PORT</term>
 572     <listitem>
 573       <para>
 574                   Type: int</para>
 575       <para>
 576                   Default: 443</para>
 577       <para>The TCP port number through which the protected
 578           portions of the boot server should be
 579           accessed.</para>
 580     </listitem>
 581   </varlistentry>
 582   <varlistentry>
 583     <term>PLC_BOOT_SSL_CRT</term>
 584     <listitem>
 585       <para>
 586                   Type: binary</para>
 587       <para>
 588                   Default: /etc/planetlab/boot_ssl.crt</para>
 589       <para>The signed SSL certificate to use for HTTPS
 590           access. If not specified, or non-existent a self-signed
 591           certificate will be generated.</para>
 592     </listitem>
 593   </varlistentry>
 594   <varlistentry>
 595     <term>PLC_BOOT_SSL_KEY</term>
 596     <listitem>
 597       <para>
 598                   Type: binary</para>
 599       <para>
 600                   Default: /etc/planetlab/boot_ssl.key</para>
 601       <para>The corresponding SSL private key. If not
 602           specified or non-existent, one will be
 603           generated.</para>
 604     </listitem>
 605   </varlistentry>
 606 </variablelist>